Media Class Reference

#include <Media.h>

Inheritance diagram for Media:

Collaboration diagram for Media:

Public Member Functions
	Media (const string &, const string &, const string &)
virtual	~Media ()
string	getObjectTypeAsString () override
string	toString () override
void	setProperty (const string &, const string &, Time dur=0) override
void	sendKeyEvent (const string &, bool) override
void	sendTickEvent (Time, Time, Time) override
bool	startTransition (Event *, Event::Transition) override
void	endTransition (Event *, Event::Transition) override
virtual bool	isFocused ()
virtual bool	getZ (int *, int *)
virtual void	redraw (cairo_t *)
string	getId ()
Document *	getDocument ()
void	initDocument (Document *)
Composition *	getParent ()
void	initParent (Composition *)
const list< string > *	getAliases ()
bool	hasAlias (const string &)
void	addAlias (const string &)
const set< Event * > *	getEvents ()
Event *	getEvent (Event::Type, const string &)
Event *	getAttributionEvent (const string &)
void	addAttributionEvent (const string &)
Event *	getPresentationEvent (const string &)
void	addPresentationEvent (const string &, Time, Time)
Event *	getSelectionEvent (const string &)
void	addSelectionEvent (const string &)
Event *	getLambda ()
bool	isOccurring ()
bool	isPaused ()
bool	isSleeping ()
virtual string	getProperty (const string &)
list< pair< Action, Time > > *	getDelayedActions ()
void	addDelayedAction (Event *, Event::Transition, const string &value="", Time delay=0)
bool	getData (const string &, void **)
bool	setData (const string &, void *, UserDataCleanFunc fn=nullptr)

Protected Member Functions
void	doStop () override
virtual void	doStart ()

Protected Attributes
string	_mime
string	_uri
Player *	_player
string	_id
Document *	_doc
Composition *	_parent
list< string >	_aliases
Time	_time
map< string, string >	_properties
Event *	_lambda
set< Event * >	_events
list< pair< Action, Time > >	_delayed
UserData	_udata

Constructor & Destructor Documentation

Media::Media	(	const string &	id,
		const string &	mime,
		const string &	uri
	)

References _mime, _player, _uri, and mime_table_index().

Media::~Media ( )

virtual

References doStop().

Member Function Documentation

void Object::addAlias ( const string &  alias )

inherited

References Object::_aliases, and tryinsert.

Referenced by ParserState::pushContext(), ParserState::pushMedia(), ParserState::pushNcl(), and Formatter::start().

void Object::addAttributionEvent ( const string &  propName )

inherited

References Object::_events, Event::ATTRIBUTION, and Object::getAttributionEvent().

Referenced by MediaSettings::MediaSettings(), Formatter::obtainEvent(), and ParserState::pushProperty().

void Object::addDelayedAction ( Event *  event, Event::Transition  transition, const string &  value = "", Time  delay = 0  )

inherited

References Object::_delayed, Object::_time, Action::event, Action::transition, and Action::value.

Referenced by endTransition().

void Object::addPresentationEvent ( const string &  id, Time  begin, Time  end  )

inherited

References Object::_events, Object::getPresentationEvent(), Event::PRESENTATION, and Event::setInterval().

Referenced by Object::Object(), Formatter::obtainEvent(), and ParserState::pushArea().

void Object::addSelectionEvent ( const string &  key )

inherited

References Object::_events, Object::getSelectionEvent(), and Event::SELECTION.

Referenced by Formatter::obtainEvent(), and ParserState::popNcl().

void Object::doStart ( )

protectedvirtualinherited

References Object::_time.

Referenced by Switch::endTransition(), endTransition(), and Context::endTransition().

void Media::doStop ( )

overrideprotectedvirtual

Reimplemented from Object.

References _player, Object::doStop(), Player::getState(), GINGA_NAMESPACE_END, Player::SLEEPING, and Player::stop().

Referenced by endTransition(), and ~Media().

void Media::endTransition ( Event *  evt, Event::Transition  transition  )

overridevirtual

Implements Object.

References Object::_doc, Object::_events, _player, Object::_time, Object::addDelayedAction(), Event::ATTRIBUTION, Object::doStart(), doStop(), Document::evalAction(), Document::evalPropertyRef(), g_assert(), g_assert_nonnull(), Event::getFullId(), Event::getId(), Event::getInterval(), Event::getParameter(), Event::getType(), GINGA_TIME_ARGS, GINGA_TIME_FORMAT, Event::isLambda(), Object::isOccurring(), parse_time(), Event::PRESENTATION, Event::SELECTION, setProperty(), Event::START, Event::STOP, and TRACE.

const list< string > * Object::getAliases ( )

inherited

References Object::_aliases.

Event * Object::getAttributionEvent ( const string &  propName )

inherited

References Event::ATTRIBUTION, and Object::getEvent().

Referenced by Object::addAttributionEvent(), Formatter::obtainEvent(), ParserState::resolveInterfaceRef(), and MediaSettings::updateCurrentFocus().

bool Object::getData ( const string &  key, void **  value  )

inherited

References Object::_udata, and UserData::getData().

list< pair< Action, Time > > * Object::getDelayedActions ( )

inherited

References Object::_delayed.

Document * Object::getDocument ( )

inherited

References Object::_doc.

Event * Object::getEvent ( Event::Type  type, const string &  id  )

inherited

References Object::_events.

Referenced by Object::getAttributionEvent(), Object::getPresentationEvent(), Object::getSelectionEvent(), and Formatter::obtainEvent().

const set< Event * > * Object::getEvents ( )

inherited

References Object::_events.

string Object::getId ( )

inherited

References Object::_id.

Referenced by Document::addObject(), Event::getFullId(), ParserState::resolveComponentRef(), ParserState::resolveGhostBindRef(), ParserState::resolveInterfaceRef(), Object::toString(), and Event::toString().

Event * Object::getLambda ( )

inherited

References Object::_lambda, and g_assert_nonnull().

Referenced by Formatter::obtainFormatterEventFromBind(), ParserState::resolveInterfaceRef(), sendTickEvent(), Formatter::start(), and Switch::startTransition().

string Media::getObjectTypeAsString ( )

overridevirtual

Implements Object.

Reimplemented in MediaSettings.

Composition * Object::getParent ( )

inherited

References Object::_parent.

Referenced by Document::evalAction().

Event * Object::getPresentationEvent ( const string &  id )

inherited

References Object::getEvent(), and Event::PRESENTATION.

Referenced by Object::addPresentationEvent(), Object::Object(), Formatter::obtainEvent(), and ParserState::resolveInterfaceRef().

string Object::getProperty ( const string &  name )

virtualinherited

Reimplemented in Context.

References Object::_properties.

Referenced by Document::evalPropertyRef(), Context::getProperty(), and setProperty().

Event * Object::getSelectionEvent ( const string &  key )

inherited

References Object::getEvent(), and Event::SELECTION.

Referenced by Object::addSelectionEvent(), Formatter::obtainEvent(), and ParserState::popNcl().

bool Media::getZ ( int *  z, int *  zorder  )

virtual

Reimplemented in MediaSettings.

References _player, g_assert_nonnull(), Player::getZ(), and Object::isSleeping().

Referenced by cmpz().

bool Object::hasAlias ( const string &  alias )

inherited

References Object::_aliases.

Referenced by Composition::getChildByIdOrAlias(), Document::getObjectByIdOrAlias(), and ParserState::resolveComponentRef().

void Object::initDocument ( Document *  doc )

inherited

References Object::_doc, and g_assert_nonnull().

Referenced by Document::addObject().

void Object::initParent ( Composition *  parent )

inherited

References Object::_parent, and g_assert_nonnull().

Referenced by Composition::addChild().

bool Media::isFocused ( )

virtual

Reimplemented in MediaSettings.

References _player, g_assert_nonnull(), Player::isFocused(), and Object::isOccurring().

bool Object::isOccurring ( )

inherited

References Object::_lambda, g_assert_nonnull(), Event::getState(), and Event::OCCURRING.

Referenced by endTransition(), Document::evalAction(), isFocused(), Object::sendTickEvent(), and startTransition().

bool Object::isPaused ( )

inherited

References Object::_lambda, g_assert_nonnull(), Event::getState(), and Event::PAUSED.

bool Object::isSleeping ( )

inherited

References Object::_lambda, g_assert_nonnull(), Event::getState(), and Event::SLEEPING.

Referenced by getZ(), and redraw().

void Media::redraw ( cairo_t *  cr )

virtual

Reimplemented in MediaSettings.

References _player, Object::isSleeping(), and Player::redraw().

void Media::sendKeyEvent ( const string &  key, bool  press  )

overridevirtual

Reimplemented from Object.

References Object::_doc, Object::_events, _player, Document::evalAction(), g_assert_nonnull(), Player::getProperty(), Document::getSettings(), Player::isFocused(), MediaSettings::scheduleFocusUpdate(), Event::SELECTION, Player::sendKeyEvent(), Event::START, Event::STOP, TRACE, and xstrhasprefix().

void Media::sendTickEvent ( Time  total, Time  diff, Time  frame  )

overridevirtual

Reimplemented from Object.

Reimplemented in MediaSettings.

References Object::_doc, _player, Object::_time, Document::evalAction(), g_assert_nonnull(), Player::getDuration(), Player::getEOS(), Event::getFullId(), Object::getLambda(), GINGA_TIME_ARGS, GINGA_TIME_FORMAT, GINGA_TIME_IS_VALID, Player::incTime(), Object::sendTickEvent(), Event::STOP, and TRACE.

Referenced by MediaSettings::sendTickEvent().

bool Object::setData ( const string &  key, void *  value, UserDataCleanFunc  fn = nullptr  )

inherited

References Object::_udata, and UserData::setData().

void Media::setProperty ( const string &  name, const string &  value, Time  dur = 0  )

overridevirtual

Reimplemented from Object.

Reimplemented in MediaSettings.

References _player, g_assert(), Object::getProperty(), GINGA_TIME_IS_VALID, Player::schedulePropertyAnimation(), Object::setProperty(), and Player::setProperty().

Referenced by endTransition(), and MediaSettings::setProperty().

bool Media::startTransition ( Event *  evt, Event::Transition  transition  )

overridevirtual

Implements Object.

References Object::_doc, Object::_id, _mime, _player, Object::_properties, _uri, Event::ATTRIBUTION, Player::createPlayer(), g_assert(), Document::getData(), Event::getType(), Event::isLambda(), Object::isOccurring(), Event::PRESENTATION, Event::SELECTION, Player::setProperty(), Event::START, Player::start(), Event::STOP, and unlikely.

string Media::toString ( )

overridevirtual

Reimplemented from Object.

References _mime, _player, _uri, Object::toString(), and xstrbuild().

Member Data Documentation

list<string> Object::_aliases

protectedinherited

Referenced by Object::addAlias(), Object::getAliases(), Object::hasAlias(), and Object::toString().

list<pair<Action, Time> > Object::_delayed

protectedinherited

Referenced by Object::addDelayedAction(), Object::doStop(), Object::getDelayedActions(), and Object::sendTickEvent().

Document* Object::_doc

protectedinherited

Referenced by Composition::addChild(), Switch::endTransition(), endTransition(), Context::endTransition(), Object::getDocument(), Object::initDocument(), Object::Object(), sendKeyEvent(), sendTickEvent(), Object::sendTickEvent(), Switch::startTransition(), startTransition(), and MediaSettings::updateCurrentFocus().

set<Event *> Object::_events

protectedinherited

Referenced by Object::addAttributionEvent(), Object::addPresentationEvent(), Object::addSelectionEvent(), Object::doStop(), endTransition(), Object::getEvent(), Object::getEvents(), sendKeyEvent(), Object::toString(), and Object::~Object().

string Object::_id

protectedinherited

Referenced by Object::getId(), Object::Object(), startTransition(), and Object::toString().

Event* Object::_lambda

protectedinherited

Referenced by Object::getLambda(), Object::isOccurring(), Object::isPaused(), Object::isSleeping(), and Object::Object().

string Media::_mime

protected

Referenced by Media(), startTransition(), and toString().

Composition* Object::_parent

protectedinherited

Referenced by Object::getParent(), Object::initParent(), Object::Object(), and Object::toString().

Player* Media::_player

protected

Referenced by doStop(), endTransition(), getZ(), isFocused(), Media(), redraw(), sendKeyEvent(), sendTickEvent(), setProperty(), startTransition(), and toString().

map<string, string> Object::_properties

protectedinherited

Referenced by Object::getProperty(), Object::setProperty(), startTransition(), and Object::toString().

Time Object::_time

protectedinherited

Referenced by Object::addDelayedAction(), Object::doStart(), Object::doStop(), endTransition(), Object::Object(), sendTickEvent(), Object::sendTickEvent(), and Object::toString().

UserData Object::_udata

protectedinherited

Referenced by Object::getData(), and Object::setData().

string Media::_uri

protected

Referenced by Media(), startTransition(), and toString().

---

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

• Media.h
• Media.cpp