gnash::RunResources Class Reference

Class to group together per-run and external resources for Gnash. More...

#include <RunResources.h>

List of all members.

Public Member Functions
	RunResources ()
	Constructs a RunResources instance with an immutable base URL.
void	setStreamProvider (boost::shared_ptr< StreamProvider > sp)
	Set the StreamProvider.
const StreamProvider &	streamProvider () const
	Get a StreamProvider instance.
void	setSoundHandler (boost::shared_ptr< sound::sound_handler > s)
	Set the sound::sound_handler.
sound::sound_handler *	soundHandler () const
	Get a pointer to a sound::sound_handler set by a hosting application.
void	setMediaHandler (boost::shared_ptr< media::MediaHandler > s)
media::MediaHandler *	mediaHandler () const
void	setRenderer (boost::shared_ptr< Renderer > r)
Renderer *	renderer () const
void	setTagLoaders (boost::shared_ptr< const SWF::TagLoadersTable > loaders)
	Set the loader functions for SWF parsing.
const SWF::TagLoadersTable &	tagLoaders () const
	Get the loader function table for parsing a SWF.
void	setRenderBackend (const std::string &x)
std::string &	getRenderBackend ()
std::string &	getHWAccelBackend ()
void	setHWAccelBackend (const std::string &x)

---

Detailed Description

Class to group together per-run and external resources for Gnash.

This holds the following resources:

• sound::sound_handler
• StreamProvider In addition, it stores the constant base URL for the run. This must be kept alive for the entire duration of a run (presently until the last SWFMovieDefinition has been destroyed).

  Todo:

  Check the lifetime and update documentation if it changes.

---

Constructor & Destructor Documentation

gnash::RunResources::RunResources

(

)

[inline]

Constructs a RunResources instance with an immutable base URL.

Parameters:

baseURL

The base URL for the run. This cannot be changed after construction.

---

Member Function Documentation

std::string& gnash::RunResources::getHWAccelBackend

(

)

[inline]

Set the hardware video accleration backend, none, vaapi, xv, or cairo. This is set in the users gnashrc file, or can be overridden with the --render-mode option to gnash.

Referenced by gnash::GtkGui::init().

std::string& gnash::RunResources::getRenderBackend

(

)

[inline]

Referenced by gnash::gui::FBGui::init(), gnash::GtkGui::init(), and gnash::Qt4Gui::init().

media::MediaHandler* gnash::RunResources::mediaHandler

(

)

const [inline]

Referenced by gnash::DumpGui::init(), gnash::SWF::StreamSoundBlockTag::loader(), gnash::SWF::define_sound_loader(), and gnash::Video::Video().

Renderer* gnash::RunResources::renderer

(

)

const [inline]

Referenced by gnash::BitmapData_as::BitmapData_as(), gnash::BitmapData_as::draw(), gnash::SWF::DefineBitsTag::loader(), gnash::movie_root::display(), and gnash::movie_root::setQuality().

void gnash::RunResources::setHWAccelBackend

(

const std::string &

x

)

[inline]

References x.

void gnash::RunResources::setMediaHandler

(

boost::shared_ptr< media::MediaHandler >

s

)

[inline]

References gnash::key::s.

Referenced by main().

void gnash::RunResources::setRenderBackend

(

const std::string &

x

)

[inline]

Set the renderer backend, agg, opengl, or cairo. This is set in the users gnashrc file, or can be overridden with the --hwaccel option to gnash.

References x.

void gnash::RunResources::setRenderer

(

boost::shared_ptr< Renderer >

r

)

[inline]

References gnash::key::r.

Referenced by gnash::AOS4Gui::createWindow(), gnash::AquaGui::init(), gnash::DumpGui::init(), gnash::gui::FBGui::createWindow(), gnash::FltkGui::createWindow(), gnash::GtkGui::init(), gnash::HaikuGui::createWindow(), gnash::KdeGui::createWindow(), main(), gnash::Qt4Gui::createWindow(), and gnash::SDLGui::createWindow().

void gnash::RunResources::setSoundHandler

(

boost::shared_ptr< sound::sound_handler >

s

)

[inline]

Set the sound::sound_handler.

Parameters:

s	A pointer to the sound::sound_handler for use by Gnash core. This may also be NULL. This is cached in various places, so changing it during a run will lead to unexpected behaviour.

References gnash::key::s.

Referenced by gnash::DumpGui::init(), and main().

void gnash::RunResources::setStreamProvider

(

boost::shared_ptr< StreamProvider >

sp

)

[inline]

Set the StreamProvider.

This can probably be changed during a run without ill effects.

Referenced by main().

void gnash::RunResources::setTagLoaders

(

boost::shared_ptr< const SWF::TagLoadersTable >

loaders

)

[inline]

Set the loader functions for SWF parsing.

This must be present before parsing. It is a pointer to const so that the same table can be shared between simultaneous runs if desired.

Referenced by main().

sound::sound_handler* gnash::RunResources::soundHandler

(

)

const [inline]

Get a pointer to a sound::sound_handler set by a hosting application.

Returns:

A pointer to a sound::sound_handler, or NULL if none has yet been set.

Referenced by gnash::Button::mouseEvent(), gnash::DumpGui::init(), gnash::DumpGui::writeSamples(), gnash::Gui::toggleSound(), gnash::Gui::play(), gnash::Gui::stop(), gnash::Gui::pause(), gnash::Gui::start(), gnash::movie_root::reset(), gnash::movie_root::advance(), gnash::sound_sample::~sound_sample(), gnash::SWF::SoundStreamHeadTag::loader(), gnash::SWF::StartSoundTag::loader(), gnash::SWF::StartSoundTag::executeActions(), gnash::SWF::StreamSoundBlockTag::executeActions(), gnash::SWF::StreamSoundBlockTag::loader(), and gnash::SWF::define_sound_loader().

const StreamProvider& gnash::RunResources::streamProvider

(

)

const [inline]

Get a StreamProvider instance.

This isn't optional. It must always be available, or nothing can be loaded.

Returns:

A StreamProvider

References assert.

Referenced by gnash::Gui::takeScreenShot(), gnash::movie_root::getURL(), gnash::MovieClip::loadVariables(), gnash::MovieLoader::loadMovie(), gnash::NetConnection_as::validateURL(), gnash::NetConnection_as::connect(), gnash::NetConnection_as::getStream(), gnash::SharedObjectLibrary::SharedObjectLibrary(), and gnash::SharedObjectLibrary::getLocal().

const SWF::TagLoadersTable& gnash::RunResources::tagLoaders

(

)

const [inline]

Get the loader function table for parsing a SWF.

References assert.

Referenced by gnash::SWFParser::read().

---

The documentation for this class was generated from the following file:

• RunResources.h