nw::snd::SoundArchive::SoundInfo Structure

Header file: nw/snd/snd_SoundArchive.h

Syntax

struct SoundInfo
{
   FileId fileId;
   ItemId playerId;
   int actorPlayerId;
   int playerPriority;
   int volume;
   PanMode panMode;
   PanCurve panCurve;
   bool isFrontBypass;
};

Description

Structure storing a sound's settings information.

If isFrontBypass is true and the output mode set using SoundSystem::SetOutputMode is OUTPUT_MODE_SURROUND, the corresponding sound bypasses the front channel.

Member Variables

fileId FileId A file ID in a sound archive.
playerId ItemId Represents the player ID used when playing sounds.
actorPlayerId int Actor player number used when playing sounds with an actor.
playerPriority int Represents the player priority value when playing sounds.
volume int Volume when playing a sound.
panMode PanMode Pan mode type.
panCurve PanCurve Pan curve type.
isFrontBypass bool Flag indicating whether to bypass the front channel.

See Also

ReadSoundInfo
FileId
ItemId
PanMode
PanCurve
nn::snd::Voice::SetFrontBypassFlag

Revision History

2010/07/14
Added isFrontBypass.
2010/01/15
Initial version.

CONFIDENTIAL