A class that manages the playback of arbitrary time sequences of multimedia data. More...

#include <omEngineSequencer.h>

Public Member Functions
	Sequencer ()
	Create a new sequencer with no tracks or sequences. More...

PlaybackID	playSequence (Sequence *sequence, const Playback &playback=Playback())
	Play the specified sequence with the given playback state using this sequencer. More...

PlaybackID	playSequence (Index sequenceIndex, const Playback &playback=Playback())
	Play the sequence at the specified index with the given playback state using this sequencer. More...

void	updatePlayback (PlaybackID playbackID, const Playback &playback)
	Update the playback state for a current playback instance in this sequencer. More...

void	pausePlayback (PlaybackID playbackID)
	Pause the currently playing playback instance with the specified ID. More...

void	resumePlayback (PlaybackID playbackID)
	Resume playback for the paused playback instance with the specified ID. More...

void	stopPlayback (PlaybackID playbackID)
	Completely stop playback for the playback instance with the specified ID. More...

void	pauseAll ()
	Simultaneously pause the playback of all playing playback instances in this sequencer. More...

void	resumeAll ()
	Simultaneously resume the playback of all paused playback instances in this sequencer. More...

void	stopAll ()
	Simultaneously stop the playback of all playback instances in this sequencer. More...

Size	getSequenceCount () const
	Return the number of sequences that this sequencer can play. More...

Sequence *	getSequence (Index sequenceIndex) const
	Return a pointer to the sequence at the specified index in this sequencer. More...

Bool	setSequence (Index sequenceIndex, Sequence *newSequence)
	Set a pointer to the sequence at the specified index in this sequencer. More...

Bool	getSequenceIndex (Sequence *sequence, Index &sequenceIndex) const
	Get the index of the specified sequence in this sequencer. More...

Bool	addSequence (Sequence *sequence)
	Add a new sequence with to this sequencer. More...

Bool	removeSequence (Sequence *sequence)
	Remove the specified sequence from this sequencer. More...

void	removeSequence (Index sequenceIndex)
	Remove the sequence at the specified index from this sequencer. More...

void	clearSequences ()
	Clear all sequences from this sequencer. More...

Static Public Attributes
static const ResourceType	RESOURCE_TYPE
	The resource type for a sequencer. More...

Detailed Description

A class that manages the playback of arbitrary time sequences of multimedia data.

Constructor & Destructor Documentation

om::engine::base::Sequencer::Sequencer ( )

Create a new sequencer with no tracks or sequences.

Member Function Documentation

PlaybackID om::engine::base::Sequencer::playSequence	(	Sequence *	sequence,
		const Playback &	playback = `Playback()`
	)

Play the specified sequence with the given playback state using this sequencer.

The method returns the ID of the new playback instance in the sequencer if playing succeeds. If the method fails, Playback::INVALID_ID is returned.

PlaybackID om::engine::base::Sequencer::playSequence	(	Index	sequenceIndex,
		const Playback &	playback = `Playback()`
	)

Play the sequence at the specified index with the given playback state using this sequencer.

The method returns the ID of the new playback instance in the sequencer if playing succeeds. If the method fails, Playback::INVALID_ID is returned.

void om::engine::base::Sequencer::updatePlayback	(	PlaybackID	playbackID,
		const Playback &	playback
	)

Update the playback state for a current playback instance in this sequencer.

void om::engine::base::Sequencer::pausePlayback ( PlaybackID playbackID )

Pause the currently playing playback instance with the specified ID.

void om::engine::base::Sequencer::resumePlayback ( PlaybackID playbackID )

Resume playback for the paused playback instance with the specified ID.

void om::engine::base::Sequencer::stopPlayback ( PlaybackID playbackID )

Completely stop playback for the playback instance with the specified ID.

void om::engine::base::Sequencer::pauseAll ( )

Simultaneously pause the playback of all playing playback instances in this sequencer.

void om::engine::base::Sequencer::resumeAll ( )

Simultaneously resume the playback of all paused playback instances in this sequencer.

void om::engine::base::Sequencer::stopAll ( )

Simultaneously stop the playback of all playback instances in this sequencer.

Size om::engine::base::Sequencer::getSequenceCount ( ) const

inline

Return the number of sequences that this sequencer can play.

Sequence* om::engine::base::Sequencer::getSequence ( Index sequenceIndex ) const

inline

Return a pointer to the sequence at the specified index in this sequencer.

Bool om::engine::base::Sequencer::setSequence	(	Index	sequenceIndex,
		Sequence *	newSequence
	)

inline

Set a pointer to the sequence at the specified index in this sequencer.

Bool om::engine::base::Sequencer::getSequenceIndex	(	Sequence *	sequence,
		Index &	sequenceIndex
	)		const

Get the index of the specified sequence in this sequencer.

Bool om::engine::base::Sequencer::addSequence ( Sequence * sequence )

Add a new sequence with to this sequencer.

Bool om::engine::base::Sequencer::removeSequence ( Sequence * sequence )

Remove the specified sequence from this sequencer.

void om::engine::base::Sequencer::removeSequence ( Index sequenceIndex )

Remove the sequence at the specified index from this sequencer.

void om::engine::base::Sequencer::clearSequences ( )

Clear all sequences from this sequencer.

Member Data Documentation

const ResourceType om::engine::base::Sequencer::RESOURCE_TYPE

static

The resource type for a sequencer.

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

omEngineSequencer.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation