Share via

XACT_SOUND_PROPERTIES

  • Article

XACT_SOUND_PROPERTIES

Returns the properties for a sound that is referenced by the active variation.

typedef struct XACT_SOUND_PROPERTIES {
    XACTCATEGORY category;
    BYTE priority;
    XACTPITCH pitch;
    XACTVOLUME volume;
    XACTINDEX numTracks;
    XACT_TRACK_PROPERTIES arrTrackProperties[1];
} XACT_SOUND_PROPERTIES, *LPXACT_SOUND_PROPERTIES;

Members

  • category
    Category that this sound belongs to.
  • priority
    Priority that is assigned to this sound.
  • pitch
    Current pitch of the sound.
  • volume
    Current volume of the sound.
  • numTracks
    Number of tracks that are contained in this sound.
  • arrTrackProperties
    A contiguous array of track properties, represented by XACT_TRACK_PROPERTIES structures. This array contains numTracks number of elements.

Remarks

The following is an example of iterating through the track properties represented by the arrTrackProperties member:

void EnumerateTrackProperties(LPXACT_SOUND_PROPERTIES pSoundProperties)
{
  for (XACTINDEX nIndex = 0; nIndex < pSoundProperties->numTracks; ++nIndex)
  {
    // Do something with pSoundProperties->arrTrackProperties[nIndex];
  }
}

Requirements

Header: Declared in Xact.h.

See Also

XACT Structures