XACT_NOTIFICATION_DESCRIPTION

Notification description used for registering, unregistering, and flushing notifications.

typedef struct XACT_NOTIFICATION_DESCRIPTION {
    XACTNOTIFICATIONTYPE type;
    BYTE flags;
    IXACTSoundBank *pSoundBank;
    IXACTWaveBank *pWaveBank;
    IXACTCue *pCue;
    XACTINDEX cueIndex;
    PVOID pvContext;
} XACT_NOTIFICATION_DESCRIPTION, *LPXACT_NOTIFICATION_DESCRIPTION;

typedef const XACT_NOTIFICATION_DESCRIPTION *LPCXACT_NOTIFICATION_DESCRIPTION;

Members

type

Notification type. Can be one of the following values:

Value	Supported Fields
XACTNOTIFICATIONTYPE_CUEPREPARED	None, sound bank, sound bank and cue index, cue instance
XACTNOTIFICATIONTYPE_CUEPLAY	None, sound bank, sound bank and cue index, cue instance
XACTNOTIFICATIONTYPE_CUESTOP	None, sound bank, sound bank and cue index, cue instance
XACTNOTIFICATIONTYPE_CUEDESTROYED	None, sound bank, sound bank and cue index, cue instance
XACTNOTIFICATIONTYPE_MARKER	None, sound bank, sound bank and cue index, cue instance
XACTNOTIFICATIONTYPE_SOUNDBANKDESTROYED	None, sound bank
XACTNOTIFICATIONTYPE_WAVEBANKDESTROYED	None, wave bank
XACTNOTIFICATIONTYPE_LOCALVARIABLECHANGED	None, sound bank, sound bank and cue index, cue instance
XACTNOTIFICATIONTYPE_GLOBALVARIABLECHANGED	None
XACTNOTIFICATIONTYPE_GUICONNECTED	None
XACTNOTIFICATIONTYPE_GUIDISCONNECTED	None
XACTNOTIFICATIONTYPE_WAVEPLAY	None, sound bank, sound bank and cue index, cue instance, wave bank
XACTNOTIFICATIONTYPE_WAVESTOP	None, sound bank, sound bank and cue index, cue instance, wave bank
XACTNOTIFICATIONTYPE_WAVEBANKPREPARED	None, wave bank

flags

Flag indicating the notification behavior. Can be zero or one of the following:

Value	Description
XACT_FLAG_NOTIFICATION_PERSIST	Indicates that the notification should persist. If this flag is not set, the user will receive no more than one notification of the type registered.

pSoundBank

Pointer to the IXACTSoundBank instance. If this entry is set to NULL, then the notification applies to all sound banks.

pWaveBank

Pointer to the IXACTWaveBank instance (optional). This entry may be NULL if no wave bank applies.

pCue

Pointer to the IXACTCue instance (optional). This entry may be NULL if no cue applies.

cueIndex

Cue index. If pSoundBank is NULL, then this entry should contain XACTINDEX_INVALID.

pvContext

User context (optional). This entry may be NULL if no user context applies.

Requirements

Header: Declared in Xact.h.

See Also

XACT Structures