SoundRenderer

Scaleform::Sound

Scaleform::Sound::SoundRenderer

Declaration

class SoundRenderer : public RefCountBase<SoundRenderer,Stat_Sound_Mem>;

Description

SoundRenderer is a base sound renderer class used for playing all sounds in a SWF file; it is essentially a low level interface to the hardware. The default implementation of the sound renderer is provided by GFx and is based on FMOD cross-platform sound library which can be used on all supported platforms. To create an instance of this implementation, SoundRendererFMOD::CreateSoundRenderer should be called, after which the created object must be initialized with FMOD::System object.

Example:

   FMOD::System* pFMOD = NULL;
   result = FMOD::System_Create(&pFMOD);
   if (result != FMOD_OK)
      exit(1);
   result = pFMOD->getVersion(&version);

   if (result != FMOD_OK || version < FMOD_VERSION)
      exit(1);
   result = pFMOD->init(64, FMOD_INIT_NORMAL, 0);

   if (result != FMOD_OK)
      exit(1);
   Ptr<SoundRenderer> psoundRenderer = *SoundRendererFMOD::CreateSoundRenderer();

   if (!psoundRenderer->Initialize(pFMOD))
      exit(1);

Classes

Class	Description
AuxStreamer	AuxStreamer is an interface which provides uncompressed PCM data for streaming sound. This interface is used to access the audio from a video source.

Enumerations

Enumeration	Description
SoundRendererCapBits	Capability flags added to the sound renderer to indicate support for video/sound data.

Methods

Method	Description
CreateSampleFromAuxStreamer	Returns the created sound sample objects with a reference count of 1.
CreateSampleFromData	Convenient function used to create and initialize a sample sound object with the given sound data.
CreateSampleFromFile	Returns the sound sample objects created from a SWF streaming file with a reference count of 1.
GetMasterVolume	Retrieves the master volume level for the sound renderer.
GetRenderCaps	Helper function to obtain the capabilities flag set for the sound renderer.
Mute	Mutes or unmute all sounds playing by the sound renderer.
PlaySample	Creates a sound channel object from a given sound sample object.
SetMasterVolume	Sets the master volume level for all sounds created by the sound renderer.
SoundRenderer	SoundRenderer constructor.
Update	Updates internal sound renderer systems.

File

Sound_SoundRenderer.h