gnash::RunResources Class Reference

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

#include <RunResources.h>

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

RunResources()

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

getHWAccelBackend()

std::string& gnash::RunResources::getHWAccelBackend ( )

inline

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

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

getRenderBackend()

std::string& gnash::RunResources::getRenderBackend ( )

inline

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

mediaHandler()

media::MediaHandler* gnash::RunResources::mediaHandler ( ) const

inline

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

renderer()

Renderer* gnash::RunResources::renderer ( ) const

inline

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

setHWAccelBackend()

void gnash::RunResources::setHWAccelBackend ( const std::string &  x )

inline

References x.

setMediaHandler()

void gnash::RunResources::setMediaHandler ( std::shared_ptr< media::MediaHandler >  s )

inline

References gnash::key::s.

setRenderBackend()

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.

setRenderer()

void gnash::RunResources::setRenderer ( std::shared_ptr< Renderer >  r )

inline

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

setSoundHandler()

void gnash::RunResources::setSoundHandler ( std::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().

setStreamProvider()

void gnash::RunResources::setStreamProvider ( std::shared_ptr< StreamProvider >  sp )

inline

Set the StreamProvider.

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

setTagLoaders()

void gnash::RunResources::setTagLoaders ( std::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.

soundHandler()

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::movie_root::advance(), gnash::SWF::define_sound_loader(), gnash::SWF::StreamSoundBlockTag::executeActions(), gnash::SWF::StartSoundTag::executeActions(), gnash::DumpGui::init(), gnash::SWF::SoundStreamHeadTag::loader(), gnash::SWF::StreamSoundBlockTag::loader(), gnash::SWF::StartSoundTag::loader(), gnash::Button::mouseEvent(), gnash::Gui::pause(), gnash::Gui::play(), gnash::registerSystemNative(), gnash::movie_root::reset(), gnash::MovieClip::setStreamSoundId(), gnash::Gui::start(), gnash::Gui::stop(), gnash::Gui::toggleSound(), gnash::DumpGui::writeSamples(), and gnash::sound_sample::~sound_sample().

streamProvider()

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

Referenced by gnash::MovieFactory::clear(), gnash::NetConnection_as::connect(), gnash::SWF::ImportAssetsTag::executeState(), gnash::externalinterface_class_init(), gnash::NetConnection_as::getStream(), gnash::movie_root::getURL(), gnash::MovieLoader::loadMovie(), gnash::MovieClip::loadVariables(), gnash::registerLocalConnectionNative(), gnash::registerSoundNative(), gnash::Gui::takeScreenShot(), and gnash::NetConnection_as::validateURL().

tagLoaders()

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

inline

Get the loader function table for parsing a SWF.

References x.

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

---

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

• RunResources.h