om::engine::base::Sequence Class Reference

A class that represents a generic time sequence of multimedia data. More...

#include <omEngineSequence.h>

Public Member Functions
	Sequence ()
	Construct a new sequence with the default initial state and no tracks. More...
const Time &	getStart () const
	Return the nominal start time of this sequence on its internal timeline. More...
void	setStart (const Time &newStart)
	Set the nominal start time of this sequence on its internal timeline. More...
const Time &	getLength () const
	Return the nominal length of this sequence on its internal timeline after the start time. More...
void	setLength (const Time &newLength)
	Set the nominal length of this sequence on its internal timeline after the start time. More...
Float	getSpeed () const
	Return the nominal playback speed for this sequence. More...
void	setSpeed (Float newSpeed)
	Set the nominal playback speed for this sequence. More...
Size	getTrackCount () const
	Return the number of tracks that this sequence has. More...
SequencerTrack *	getTrack (Index trackIndex) const
	Return a pointer to the track for this sequence at the specified index. More...
Bool	addTrack (SequencerTrack *newTrack, Index trackSequenceIndex)
	Add a new track to this sequence, associating the sequence with the specified ID within the track. More...
Bool	removeTrack (const SequencerTrack *track)
	Remove the specified sequencer track from this sequence. More...
void	clearTracks ()
	Remove all tracks from this sequence. More...
void	play (PlaybackID playbackID, const Playback &playback)
	Play this sequence with the given playback state and unique playback ID. More...
void	update (PlaybackID playbackID, const Playback &playback)
	Update the playback state for the playback instance with the given ID in this sequence. More...
void	pause (PlaybackID playbackID)
	Pause a currently playing playback instance of this sequence. More...
void	resume (PlaybackID playbackID)
	Resume playback for a currently paused playback instance of this sequence. More...
void	stop (PlaybackID playbackID)
	Completely stop playback for the specified playback instance of this sequence. More...
void	pauseAll ()
	Simultaneously pause the playback of all playback instances of this sequence. More...
void	resumeAll ()
	Simultaneously resume the playback of all playback instances of this sequence. More...
void	stopAll ()
	Simultaneously stop the playback of all playback instances of this sequence. More...

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

Detailed Description

A class that represents a generic time sequence of multimedia data.

Constructor & Destructor Documentation

om::engine::base::Sequence::Sequence

(

)

Construct a new sequence with the default initial state and no tracks.

Member Function Documentation

const Time& om::engine::base::Sequence::getStart ( ) const

inline

Return the nominal start time of this sequence on its internal timeline.

void om::engine::base::Sequence::setStart ( const Time &  newStart )

inline

Set the nominal start time of this sequence on its internal timeline.

const Time& om::engine::base::Sequence::getLength ( ) const

inline

Return the nominal length of this sequence on its internal timeline after the start time.

void om::engine::base::Sequence::setLength ( const Time &  newLength )

inline

Set the nominal length of this sequence on its internal timeline after the start time.

Float om::engine::base::Sequence::getSpeed ( ) const

inline

Return the nominal playback speed for this sequence.

void om::engine::base::Sequence::setSpeed ( Float  newSpeed )

inline

Set the nominal playback speed for this sequence.

Size om::engine::base::Sequence::getTrackCount ( ) const

inline

Return the number of tracks that this sequence has.

SequencerTrack* om::engine::base::Sequence::getTrack ( Index  trackIndex ) const

inline

Return a pointer to the track for this sequence at the specified index.

Bool om::engine::base::Sequence::addTrack	(	SequencerTrack *	newTrack,
		Index	trackSequenceIndex
	)

Add a new track to this sequence, associating the sequence with the specified ID within the track.

Bool om::engine::base::Sequence::removeTrack

(

const SequencerTrack *

track

)

Remove the specified sequencer track from this sequence.

void om::engine::base::Sequence::clearTracks

(

)

Remove all tracks from this sequence.

void om::engine::base::Sequence::play	(	PlaybackID	playbackID,
		const Playback &	playback
	)

Play this sequence with the given playback state and unique playback ID.

void om::engine::base::Sequence::update	(	PlaybackID	playbackID,
		const Playback &	playback
	)

Update the playback state for the playback instance with the given ID in this sequence.

void om::engine::base::Sequence::pause

(

PlaybackID

playbackID

)

Pause a currently playing playback instance of this sequence.

void om::engine::base::Sequence::resume

(

PlaybackID

playbackID

)

Resume playback for a currently paused playback instance of this sequence.

void om::engine::base::Sequence::stop

(

PlaybackID

playbackID

)

Completely stop playback for the specified playback instance of this sequence.

void om::engine::base::Sequence::pauseAll

(

)

Simultaneously pause the playback of all playback instances of this sequence.

void om::engine::base::Sequence::resumeAll

(

)

Simultaneously resume the playback of all playback instances of this sequence.

void om::engine::base::Sequence::stopAll

(

)

Simultaneously stop the playback of all playback instances of this sequence.

Member Data Documentation

const ResourceType om::engine::base::Sequence::RESOURCE_TYPE

static

The resource type for a sequence.

---

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

• omEngineSequence.h