SoundSample

Scaleform::Sound

Scaleform::Sound::SoundSample

Declaration

class SoundSample : public NewOverrideBase<Stat_Sound_Mem>;

Description

SoundSample represents a sound renderer-specific version of a sound that should be associated with an instance of SoundDataBase class which is loaded from a SWF file. An instance of this class is created by calling to one of the CreateSample... methods of SoundRenderer. To play a sound sample, an instance of SoundChannel should be created by calls to SoundRenderer::PlaySample. There could be multiple instances of SoundChannel class associated with the same instance of SoundSample class.

This class has a custom reference count implementation and care should be taken when this class is detached from SoundRenderer in a multi-threaded environment.

Methods

Method	Description
AddRef	Increments the reference count of the SoundSample object.
AddRef_NotZero	Increments the reference count of sound sample object if it is not zero.
GetBytesLoaded	Returns the number of bytes loaded for the sound sample object.
GetBytesTotal	Returns the size of the sample sound object in bytes.
GetDuration	Obtains the duration of the sound.
GetSoundRenderer	Obtains the sound renderer that created this sound sample object.
IsDataValid	Determines whether the sound sample has a valid sound data or not.
Release	Decrements the reference count of SoundSample object and releases the resources.
SoundSample	Initializes a sound sample object.

File

Sound_SoundRenderer.h