Unigine::Plugins::FMOD::Channel Class
| Header: | #include <plugins/UnigineFMOD.h> |
Notice
This set of functions is available when the FMOD plugin is loaded.
A source of audio signal that connects to the ChannelGroup mixing hierarchy.
Channel Class
Members
void setPaused ( bool value ) #
Sets the pause state for the channel.Arguments
- bool value - true to pause the channel, false to unpause it.
bool getPaused ( ) #
Returns the pause state of the channel.void setVolume ( float volume ) #
Sets the volume level.Arguments
- float volume - Volume level in range [-inf; inf]. 0 = silent, 1 = full. Negative level inverts the signal. Values larger than 1 amplify the signal.
float getVolume ( ) #
Returns the current volume level.Return value
Volume level.bool isPlaying ( ) #
Returns the playing state.Return value
true if the channel is playing, otherwise, false.void stop ( ) #
Stops the Channel (or all Channels in nested ChannelGroups) from playing.void setMinMaxDistance ( float min, float max ) #
Sets the minimum and maximum distances used to calculate the 3D rolloff attenuation.Arguments
- float min - Distance from the source where attenuation begins. Range: [0; max]. Default: 1
- float max - Distance from the source where attenuation ends. Range: [min; inf]. Default: 10000.
void setPosition ( const Math::Vec3& position ) #
Sets the 3D position used to apply panning and attenuation.Arguments
- const Math::Vec3& position - Position in 3D space used for panning and attenuation.
void setPositionTimeLine ( unsigned int position, FMODEnums::TIME_UNIT time_unit ) #
Sets the current playback position.Arguments
- unsigned int position - Playback position.
- FMODEnums::TIME_UNIT time_unit - Time units for position.
void getPositionTimeLine ( unsigned int & position, FMODEnums::TIME_UNIT time_unit ) #
Returns the current playback position.Arguments
- unsigned int & position - Playback position.
- FMODEnums::TIME_UNIT time_unit - Time units for position.
void release ( ) #
Releases the channel object.void setVelocity ( const Math::Vec3& velocity ) #
Sets the velocity used to apply doppler.Arguments
- const Math::Vec3& velocity - Velocity in 3D space used for doppler.
DSP * addDSP ( int index, DSPType::TYPE dsp_type ) #
Adds a DSP unit to the specified index in the DSP chain.Arguments
- int index - Offset into the DSP chain.
- DSPType::TYPE dsp_type - Type of the DSP.
Return value
Added DSP.void removeDSP ( int index ) #
Removes the specified DSP unit from the DSP chain.Arguments
- int index - Index of the DSP unit.
DSP * getDSP ( int index ) #
Returns the DSP unit at the specified index in the DSP chain.Arguments
- int index - Index of the DSP unit.
Return value
DSP unit at the specified index.Last update:
10.10.2022
Помогите сделать статью лучше
Была ли эта статья полезной?
(или выберите слово/фразу и нажмите Ctrl+Enter