SoundChannel

Scaleform::Sound::SoundChannel

Declaration

class SoundChannel : public RefCountBase<SoundChannel,Stat_Sound_Mem>;

Description

SoundChannel represents an active (playing) sound and is used to control its attributes such as volume level, and status (paused, stopped or playing).

SoundChannel is created by calls to SoundRenderer::PlaySample.

Methods

Method	Description
GetPan	Obtains the current pan of the sound.
GetPosition	Obtains the currently playing position in the sound data.
GetSample	Obtains the sound sample that was used to create this sound channel.
GetSoundRenderer	Obtains the sound renderer that created this sound channel.
GetVolume	Retrieves the current volume level of the sound.
IsPlaying	Determines whether the active sound has stopped playing or not.
Loop	Sets the sound's loop attributes to play repeatedly for a specific number of times.
Pause	Pauses/resumes the active sound.
SetPan	SetPan sets the currrent pan of the sound.
SetPosition	Sets the playing position (in seconds) in the sound data.
SetSpatialInfo	Sets the sound spatial information such as position, orientation and velocity.
SetTransforms	Sets a volume level transformation vector to transform attributes of the sound.
SetVolume	Sets the current volume level at which the sound data is to be played.
SoundChannel	Initializes the SoundChannel object.
Stop	Stops the active sound.

Structures

Structure	Description
Transform	A sound volume transformation descriptor to change the volume and position properties of a playing sound.
Vector	Structure describing the sound spatial position, orientation, velocity etc.

File

Sound_SoundRenderer.h