nn::snd::CTR::Voice Class

Syntax

class Voice

Description

A class used to control Voice objects.

Use this to control valid voice objects obtained with the nn::snd::AllocVoice function. Behavior is not guaranteed if you attempt to control any other voice object.

Enumerated Types

State Enumerated type that indicates the voice states.

Member Functions

Voice Constructor.
~Voice Destructor.
SetChannelCount Sets the number of voice channels.
SetSampleFormat Sets the format of the samples to link to a voice.
SetFrontBypassFlag Sets whether to bypass the front channels when 3D surround sound is enabled.
SetStartFrameFadeInFlag Specifies whether to use a short fade-in starting at volume 0 when playback starts.
SetSampleRate Sets the sampling rate of a voice.
SetPitch Sets the pitch of a voice.
GetPitch Gets the pitch of a voice.
SetAdpcmParam Sets ADPCM coefficients.
SetPriority Sets the priority of a voice.
GetPriority Gets the priority of a voice.
AppendWaveBuffer Appends sample data information corresponding to a voice.
SetState Sets the current state of a voice.
GetState Gets the state of a voice.
SetMixParam Sets the gain for each voice channel.
GetMixParam Gets the gain for each voice channel.
SetVolume Sets the volume of a voice.
GetVolume Gets the volume of a voice.
GetPlayPosition Gets the playback position within the buffer that is currently in use.
IsPlaying Gets the playback state of a voice.
SetInterpolationType Sets the interpolation method of a voice.
GetInterpolationType Gets the interpolation method of a voice.
SetFilterType Sets the filter type.
GetFilterType Gets the usage status of a filter.
SetMonoFilterCoefficients Sets the coefficients for a monopole filter.
GetMonoFilterCoefficients Gets the coefficients for a monopole filter.
SetBiquadFilterCoefficients Sets the coefficients for a biquad filter.
GetBiquadFilterCoefficients Gets the coefficients for a biquad filter.
SetupBcwav Parses a BCWAV file and prepares for playback.

Revision History

2010/01/29
Initial version.

CONFIDENTIAL