Share via

XACT_CUE_PROPERTIES

  • Article

XACT_CUE_PROPERTIES

Reports cue properties back to the client.

typedef struct XACT_CUE_PROPERTIES {
    CHAR friendlyName[XACT_CUE_NAME_LENGTH];
    BOOL interactive;
    XACTINDEX iaVariableIndex;
    XACTINDEX numVariations;
    XACTINSTANCELIMIT maxInstances;
    XACTINSTANCELIMIT currentInstances;
} XACT_CUE_PROPERTIES, *LPXACT_CUE_PROPERTIES;

Members

  • friendlyName
    Friendly name of the cue. If the soundbank does not contain of friendly names, an empty string is returned.
  • interactive
    TRUE if the cue is an interactive audio cue. Otherwise, FALSE.
  • iaVariableIndex
    For interactive audio cues, the index of the variable to control the cue.
  • numVariations
    Number of sound variations for this cue.
  • maxInstances
    Maximum number of instances that are allowed for this cue.
  • currentInstances
    Number of currently active instances of this cue.

Remarks

This structure returns the non-instance specific cue properties for a cue. That is, it returns the properties that are shared across all instances of a cue.

Requirements

Header: Declared in Xact.h.

See Also

XACT Structures