OSDL::Rendering::AudioRenderer Class Reference

This basic audio renderer manages the sound rendering of all registered views. More...

#include <OSDLAudioRenderer.h>

Inheritance diagram for OSDL::Rendering::AudioRenderer:

[legend]

Collaboration diagram for OSDL::Rendering::AudioRenderer:

[legend]

List of all members.

Public Member Functions
	AudioRenderer (bool registerToRootRenderer=true)
	Constructs a new audio renderer.
virtual	~AudioRenderer () throw ()
	Virtual destructor, no view is destroyed.
virtual void	render (Events::RenderingTick currentRenderingTick=0)
	Triggers the actual audio rendering of all views, for specified rendering tick, if any.
virtual void	onRenderingSkipped (Events::RenderingTick skippedRenderingTick)
	Allows the audio renderer to be aware that a rendering step has to be skipped.
virtual const std::string	toString (Ceylan::VerbosityLevels level=Ceylan::high) const
	Returns an user-friendly description of the state of this object.
Static Public Member Functions
static bool	HasExistingRootRenderer ()
	Tells whether a root renderer is available.
static Renderer &	GetExistingRootRenderer ()
	Returns the one and only one root renderer instance that may be already available.
static void	DeleteExistingRootRenderer ()
	Deletes the existing root renderer.
static void	DeleteRootRenderer ()
	Deletes the root renderer, if any.
Protected Attributes
RenderCount	_renderingDone
	Counts the number of renderings achieved.
RenderCount	_renderingSkipped
	Counts the number of renderings skipped.
Events::RenderingTick	_lastRender
	Records the last rendering tick.
Private Member Functions
	AudioRenderer (const AudioRenderer &source)
	Copy constructor made private to ensure that it will be never called.
AudioRenderer &	operator= (const AudioRenderer &source)
	Assignment operator made private to ensure that it will be never called.

Detailed Description

This basic audio renderer manages the sound rendering of all registered views.

Its rendering is mainly triggered by the root renderer, if it exists and if this audio renderer has been registered to this root renderer.

Specialized audio renderers can take in charge for example sound propagation, multi-channel output and points of perception.

See also:: Ceylan::View

Definition at line 62 of file OSDLAudioRenderer.h.

Constructor & Destructor Documentation

AudioRenderer::AudioRenderer ( bool registerToRootRenderer = true ) [explicit]

Constructs a new audio renderer.

Parameters:

registerToRootRenderer

iff true, this audio renderer will register itself automatically to the root renderer, which must implement the MultimediaRenderer interface so that this audio renderer can be plugged.

Exceptions:

RenderingException

if registerToRootRenderer is true and no root renderer is available, or if the root renderer is not able to register audio renderers (which means it is not a Multimedia renderer).

See also:: MultimediaRenderer

Definition at line 55 of file OSDLAudioRenderer.cc.

References OSDL::Rendering::Renderer::GetExistingRootRenderer(), and OSDL::Rendering::MultimediaRenderer::setAudioRenderer().

AudioRenderer::~AudioRenderer ( ) throw () [virtual]

Virtual destructor, no view is destroyed.

Definition at line 96 of file OSDLAudioRenderer.cc.

OSDL::Rendering::AudioRenderer::AudioRenderer ( const AudioRenderer & source ) [private]

Copy constructor made private to ensure that it will be never called.

The compiler should complain whenever this undefined constructor is called, implicitly or not.

Member Function Documentation

void Renderer::DeleteExistingRootRenderer ( ) [static, inherited]

Deletes the existing root renderer.

Exceptions:

RenderingException

if not renderer was available.

Definition at line 185 of file OSDLRenderer.cc.

void Renderer::DeleteRootRenderer ( ) [static, inherited]

Deletes the root renderer, if any.

Definition at line 201 of file OSDLRenderer.cc.

Renderer & Renderer::GetExistingRootRenderer ( ) [static, inherited]

Returns the one and only one root renderer instance that may be already available.

Note:: The returned value is a reference and not a pointer, to help avoiding any abnormal deallocation by its users, that should never deallocate the root renderer.

Exceptions:

RenderingException

if there is no root renderer already available.

Note:: There is no 'GetRootRenderer' method that would create a root renderer if none was already set, since various renderers could be chosen as the root one.

Definition at line 173 of file OSDLRenderer.cc.

Referenced by AudioRenderer(), OSDL::Events::EventsModule::enterBasicMainLoop(), and OSDL::Rendering::VideoRenderer::VideoRenderer().

bool Renderer::HasExistingRootRenderer ( ) [static, inherited]

Tells whether a root renderer is available.

Returns:: true iff a root renderer is already available.

Definition at line 164 of file OSDLRenderer.cc.

References OSDL::Rendering::Renderer::_internalRootRenderer.

Referenced by OSDL::Events::EventsModule::enterBasicMainLoop().

virtual void OSDL::Rendering::AudioRenderer::onRenderingSkipped ( Events::RenderingTick skippedRenderingTick ) [virtual]

Allows the audio renderer to be aware that a rendering step has to be skipped.

It may be a chance of it to trigger counter-measures, such as decreasing the level of detail in order not to slow down the whole process.

Parameters:

skippedRenderingTick

the rendering tick that had to be skipped.

Reimplemented from OSDL::Rendering::Renderer.

AudioRenderer& OSDL::Rendering::AudioRenderer::operator= ( const AudioRenderer & source ) [private]

Assignment operator made private to ensure that it will be never called.

The compiler should complain whenever this undefined operator is called, implicitly or not.

virtual void OSDL::Rendering::AudioRenderer::render ( Events::RenderingTick currentRenderingTick = 0 ) [virtual]

Triggers the actual audio rendering of all views, for specified rendering tick, if any.

Parameters:

currentRenderingTick

the rendering tick corresponding to this render step. If the renderer is called from a basic event loop (no scheduler is used), then the rendering tick is meaningless and is always zero.

Reimplemented from OSDL::Rendering::Renderer.

const string AudioRenderer::toString ( Ceylan::VerbosityLevels level = Ceylan::high ) const [virtual]

Returns an user-friendly description of the state of this object.

Parameters:

level

the requested verbosity level.