NW4F Snd
Loading...
Searching...
No Matches
nw::snd::SequenceSoundHandle Class Reference

#include <snd_SequenceSoundHandle.h>

Public Member Functions

 SequenceSoundHandle ()
 SequenceSoundHandle (SoundHandle *handle)
 ~SequenceSoundHandle ()
void StartPrepared ()
void Stop (int fadeFrames)
void Pause (bool flag, int fadeFrames)
bool IsPrepared () const
bool IsPause () const
void FadeIn (int frames)
void SetVolume (f32 volume, int frames=0)
void SetPitch (f32 pitch)
void SetChannelPriority (int priority)
void SetTempoRatio (f32 tempoRatio)
void SetPan (f32 pan)
bool ReadVariable (int varNo, signed short *var) const
bool ReadTrackVariable (int trackNo, int varNo, signed short *var) const
bool WriteVariable (int varNo, signed short var)
bool WriteTrackVariable (int trackNo, int varNo, signed short var)
void SetTrackMute (u32 trackBitFlag, SeqMute mute)
void SetTrackMute (u32 trackBitFlag, bool muteFlag)
void SetTrackSilence (u32 trackBitFlag, bool silenceFlag, int fadeTimes)
void SetTrackVolume (u32 trackBitFlag, f32 volume)
void SetTrackPitch (u32 trackBitFlag, f32 pitch)
bool SetTrackBankIndex (u32 trackBitFlag, int bankIndex)
bool SetTrackTranspose (u32 trackBitFlag, s8 transpose)
bool SetTrackVelocityRange (u32 trackBitFlag, u8 range)
void SetTrackOutputLine (u32 trackBitFlag, u32 lineFlag)
void ResetTrackOutputLine (u32 trackBitFlag)
void SetTrackMainOutVolume (u32 trackBitFlag, f32 volume)
void SetTrackPan (u32 trackBitFlag, f32 pan)
void SetTrackSurroundPan (u32 trackBitFlag, f32 surroundPan)
void SetTrackMainSend (u32 trackBitFlag, f32 send)
void SetTrackFxSend (u32 trackBitFlag, AuxBus bus, f32 send)
void SetTrackDrcOutVolume (u32 trackBitFlag, f32 volume, u32 drcIndex=0)
void SetTrackDrcPan (u32 trackBitFlag, f32 pan, u32 drcIndex=0)
void SetTrackDrcSurroundPan (u32 trackBitFlag, f32 span, u32 drcIndex=0)
void SetTrackDrcMainSend (u32 trackBitFlag, f32 send, u32 drcIndex=0)
void SetTrackDrcFxSend (u32 trackBitFlag, AuxBus bus, f32 send, u32 drcIndex=0)
bool IsAttachedSound () const
void DetachSound ()
void SetId (u32 id)
u32 GetId () const
const SoundParam * GetAmbientParam () const
unsigned long GetTick () const
void detail_AttachSoundAsTempHandle (internal::SequenceSound *sound)
internal::SequenceSound * detail_GetAttachedSound ()
const internal::SequenceSound * detail_GetAttachedSound () const

Static Public Member Functions

static bool ReadGlobalVariable (int varNo, signed short *var)
static bool WriteGlobalVariable (int varNo, signed short var)

Static Public Attributes

static const int BANK_INDEX_MIN = internal::SequenceSound::BANK_INDEX_MIN
static const int BANK_INDEX_MAX = internal::SequenceSound::BANK_INDEX_MAX
static const s8 TRANSPOSE_MIN = internal::SequenceSound::TRANSPOSE_MIN
static const s8 TRANSPOSE_MAX = internal::SequenceSound::TRANSPOSE_MAX
static const u8 VELOCITY_RANGE_MIN = internal::SequenceSound::VELOCITY_RANGE_MIN
static const u8 VELOCITY_RANGE_MAX = internal::SequenceSound::VELOCITY_RANGE_MAX

Private Member Functions

 NW_DISALLOW_COPY_AND_ASSIGN (SequenceSoundHandle)

Private Attributes

internal::SequenceSound * m_pSound

Constructor & Destructor Documentation

◆ SequenceSoundHandle() [1/2]

nw::snd::SequenceSoundHandle::SequenceSoundHandle ( )
inline

◆ SequenceSoundHandle() [2/2]

nw::snd::SequenceSoundHandle::SequenceSoundHandle ( SoundHandle * handle)
explicit

◆ ~SequenceSoundHandle()

nw::snd::SequenceSoundHandle::~SequenceSoundHandle ( )
inline

Member Function Documentation

◆ StartPrepared()

void nw::snd::SequenceSoundHandle::StartPrepared ( )
inline

◆ Stop()

void nw::snd::SequenceSoundHandle::Stop ( int fadeFrames)
inline

◆ Pause()

void nw::snd::SequenceSoundHandle::Pause ( bool flag,
int fadeFrames )
inline

◆ IsPrepared()

bool nw::snd::SequenceSoundHandle::IsPrepared ( ) const
inline

◆ IsPause()

bool nw::snd::SequenceSoundHandle::IsPause ( ) const
inline

◆ FadeIn()

void nw::snd::SequenceSoundHandle::FadeIn ( int frames)
inline

◆ SetVolume()

void nw::snd::SequenceSoundHandle::SetVolume ( f32 volume,
int frames = 0 )
inline

◆ SetPitch()

void nw::snd::SequenceSoundHandle::SetPitch ( f32 pitch)
inline

◆ SetChannelPriority()

void nw::snd::SequenceSoundHandle::SetChannelPriority ( int priority)
inline

◆ SetTempoRatio()

void nw::snd::SequenceSoundHandle::SetTempoRatio ( f32 tempoRatio)
inline

◆ SetPan()

void nw::snd::SequenceSoundHandle::SetPan ( f32 pan)
inline

◆ ReadVariable()

bool nw::snd::SequenceSoundHandle::ReadVariable ( int varNo,
signed short * var ) const
inline

◆ ReadGlobalVariable()

bool nw::snd::SequenceSoundHandle::ReadGlobalVariable ( int varNo,
signed short * var )
inlinestatic

◆ ReadTrackVariable()

bool nw::snd::SequenceSoundHandle::ReadTrackVariable ( int trackNo,
int varNo,
signed short * var ) const
inline

◆ WriteVariable()

bool nw::snd::SequenceSoundHandle::WriteVariable ( int varNo,
signed short var )
inline

◆ WriteGlobalVariable()

bool nw::snd::SequenceSoundHandle::WriteGlobalVariable ( int varNo,
signed short var )
inlinestatic

◆ WriteTrackVariable()

bool nw::snd::SequenceSoundHandle::WriteTrackVariable ( int trackNo,
int varNo,
signed short var )
inline

◆ SetTrackMute() [1/2]

void nw::snd::SequenceSoundHandle::SetTrackMute ( u32 trackBitFlag,
SeqMute mute )
inline

◆ SetTrackMute() [2/2]

void nw::snd::SequenceSoundHandle::SetTrackMute ( u32 trackBitFlag,
bool muteFlag )
inline

◆ SetTrackSilence()

void nw::snd::SequenceSoundHandle::SetTrackSilence ( u32 trackBitFlag,
bool silenceFlag,
int fadeTimes )
inline

◆ SetTrackVolume()

void nw::snd::SequenceSoundHandle::SetTrackVolume ( u32 trackBitFlag,
f32 volume )
inline

◆ SetTrackPitch()

void nw::snd::SequenceSoundHandle::SetTrackPitch ( u32 trackBitFlag,
f32 pitch )
inline

◆ SetTrackBankIndex()

bool nw::snd::SequenceSoundHandle::SetTrackBankIndex ( u32 trackBitFlag,
int bankIndex )
inline

◆ SetTrackTranspose()

bool nw::snd::SequenceSoundHandle::SetTrackTranspose ( u32 trackBitFlag,
s8 transpose )
inline

◆ SetTrackVelocityRange()

bool nw::snd::SequenceSoundHandle::SetTrackVelocityRange ( u32 trackBitFlag,
u8 range )
inline

◆ SetTrackOutputLine()

void nw::snd::SequenceSoundHandle::SetTrackOutputLine ( u32 trackBitFlag,
u32 lineFlag )
inline

◆ ResetTrackOutputLine()

void nw::snd::SequenceSoundHandle::ResetTrackOutputLine ( u32 trackBitFlag)
inline

◆ SetTrackMainOutVolume()

void nw::snd::SequenceSoundHandle::SetTrackMainOutVolume ( u32 trackBitFlag,
f32 volume )
inline

◆ SetTrackPan()

void nw::snd::SequenceSoundHandle::SetTrackPan ( u32 trackBitFlag,
f32 pan )
inline

◆ SetTrackSurroundPan()

void nw::snd::SequenceSoundHandle::SetTrackSurroundPan ( u32 trackBitFlag,
f32 surroundPan )
inline

◆ SetTrackMainSend()

void nw::snd::SequenceSoundHandle::SetTrackMainSend ( u32 trackBitFlag,
f32 send )
inline

◆ SetTrackFxSend()

void nw::snd::SequenceSoundHandle::SetTrackFxSend ( u32 trackBitFlag,
AuxBus bus,
f32 send )
inline

◆ SetTrackDrcOutVolume()

void nw::snd::SequenceSoundHandle::SetTrackDrcOutVolume ( u32 trackBitFlag,
f32 volume,
u32 drcIndex = 0 )
inline

◆ SetTrackDrcPan()

void nw::snd::SequenceSoundHandle::SetTrackDrcPan ( u32 trackBitFlag,
f32 pan,
u32 drcIndex = 0 )
inline

◆ SetTrackDrcSurroundPan()

void nw::snd::SequenceSoundHandle::SetTrackDrcSurroundPan ( u32 trackBitFlag,
f32 span,
u32 drcIndex = 0 )
inline

◆ SetTrackDrcMainSend()

void nw::snd::SequenceSoundHandle::SetTrackDrcMainSend ( u32 trackBitFlag,
f32 send,
u32 drcIndex = 0 )
inline

◆ SetTrackDrcFxSend()

void nw::snd::SequenceSoundHandle::SetTrackDrcFxSend ( u32 trackBitFlag,
AuxBus bus,
f32 send,
u32 drcIndex = 0 )
inline

◆ IsAttachedSound()

bool nw::snd::SequenceSoundHandle::IsAttachedSound ( ) const
inline

◆ DetachSound()

void nw::snd::SequenceSoundHandle::DetachSound ( )

◆ SetId()

void nw::snd::SequenceSoundHandle::SetId ( u32 id)
inline

◆ GetId()

u32 nw::snd::SequenceSoundHandle::GetId ( ) const
inline

◆ GetAmbientParam()

const SoundParam * nw::snd::SequenceSoundHandle::GetAmbientParam ( ) const
inline

◆ GetTick()

unsigned long nw::snd::SequenceSoundHandle::GetTick ( ) const
inline

◆ detail_AttachSoundAsTempHandle()

void nw::snd::SequenceSoundHandle::detail_AttachSoundAsTempHandle ( internal::SequenceSound * sound)

◆ detail_GetAttachedSound() [1/2]

internal::SequenceSound * nw::snd::SequenceSoundHandle::detail_GetAttachedSound ( )
inline

◆ detail_GetAttachedSound() [2/2]

const internal::SequenceSound * nw::snd::SequenceSoundHandle::detail_GetAttachedSound ( ) const
inline

◆ NW_DISALLOW_COPY_AND_ASSIGN()

nw::snd::SequenceSoundHandle::NW_DISALLOW_COPY_AND_ASSIGN ( SequenceSoundHandle )
private

Member Data Documentation

◆ BANK_INDEX_MIN

const int nw::snd::SequenceSoundHandle::BANK_INDEX_MIN = internal::SequenceSound::BANK_INDEX_MIN
static

◆ BANK_INDEX_MAX

const int nw::snd::SequenceSoundHandle::BANK_INDEX_MAX = internal::SequenceSound::BANK_INDEX_MAX
static

◆ TRANSPOSE_MIN

const s8 nw::snd::SequenceSoundHandle::TRANSPOSE_MIN = internal::SequenceSound::TRANSPOSE_MIN
static

◆ TRANSPOSE_MAX

const s8 nw::snd::SequenceSoundHandle::TRANSPOSE_MAX = internal::SequenceSound::TRANSPOSE_MAX
static

◆ VELOCITY_RANGE_MIN

const u8 nw::snd::SequenceSoundHandle::VELOCITY_RANGE_MIN = internal::SequenceSound::VELOCITY_RANGE_MIN
static

◆ VELOCITY_RANGE_MAX

const u8 nw::snd::SequenceSoundHandle::VELOCITY_RANGE_MAX = internal::SequenceSound::VELOCITY_RANGE_MAX
static

◆ m_pSound

internal::SequenceSound* nw::snd::SequenceSoundHandle::m_pSound
private