SND_FlushCommand

Syntax

#include <nitro/snd.h>
BOOL SND_FlushCommand( u32 flags );

Arguments

flags The flags

Return Values

TRUE if command flush has succeeded. FALSE if it has failed.

Description

This function issues reserved commands. ARM7 commands are not processed by the ARM7 until this function is called.

SND_COMMAND_BLOCK or SND_COMMAND_NOBLOCK can be specified in flags. When SND_COMMAND_BLOCK is specified, a block inside the function persists until the command issues successfully. When SND_COMMAND_NOBLOCK is specified, then FALSE is returned if the command fails to be issued.

SND_COMMAND_IMMEDIATE can also be by specified for the flags flag by including it with a logical OR operation. When SND_COMMAND_IMMEDIATE is specified, the issued command is processed immediately when the command issues successfully. When it is not specified, the command is processed when the next sound frame starts.

Note

If there are no reserved commands, this function immediately returns TRUE, but note that there is no command process response.

See Also

None.

Revision History

2005/03/01 Added the SND_COMMAND_IMMEDIATE flag
2005/02/17 Changed "flush" to "issue" in Description
2004/07/20 Initial version

CONFIDENTIAL