A class that handles playback of time sequences of sound data for a single sound stream. More...

#include <omEngineSoundSequencerTrack.h>

Inheritance diagram for om::engine::sound::SoundSequencerTrack:

Public Member Functions
	SoundSequencerTrack ()
	Create a new sound sequencer track that has no sequences that is can play. More...

virtual Size	getSequenceCount () const
	Return the number of sequences that this track supports playing. More...

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

void	setSequence (Index sequenceIndex, Sequence *newSequence)
	Set a pointer to the sequence at the given index. More...

SoundTrack *	getSequenceTrack (Index sequenceIndex) const
	Return a pointer to the sound track that is associated with the sequence with the given index. More...

void	setSequenceTrack (Index sequenceIndex, SoundTrack *newTrack)
	Set a pointer to the sound track that is associated with the sequence with the given index. More...

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

Bool	addSequence (Sequence sequence, SoundTrack track)
	Add a new sequence to this sequencer track that plays the specified sound track. More...

void	clearSequences ()
	Remove all sequences from this sound sequencer track. More...

virtual Bool	playSequence (Index sequenceIndex, PlaybackID playbackID, const Playback &playback)
	Play the specified sequence with the given playback state using this sequencer track. More...

virtual void	updatePlayback (PlaybackID playbackID, const Playback &playback)
	Update the playback state for a currently playing sequence in this sequencer track. More...

virtual void	pausePlayback (PlaybackID playbackID)
	Pause a currently playing sequence. More...

virtual void	resumePlayback (PlaybackID playbackID)
	Resume playback for a currently paused sequence. More...

virtual void	stopPlayback (PlaybackID playbackID)
	Completely stop playback for the specified sequence. More...

virtual void	pauseAll ()
	Simultaneously pause the playback of all sequences in this sequencer track. More...

virtual void	resumeAll ()
	Simultaneously resume the playback of all sequences in this sequencer track. More...

virtual void	stopAll ()
	Simultaneously stop the playback of all sequences in this sequencer track. More...

const ChannelLayout &	getOutputChannelLayout () const
	Return the channel layout that is used for the output of this track. More...

void	setOutputChannelLayout (const ChannelLayout &newChannelLayout)
	Set the channel layout that is used for the output of this track. More...

SampleRate	getOutputSampleRate () const
	Return the sample rate that is used for the output of this track. More...

void	setOutputSampleRate (SampleRate newSampleRate)
	Set the sample rate that is used for the output of this track. More...

SoundResult	process (const SoundFrame &input, SoundFrame &output, Size numSamples)
	Render the output of this track given the specified input frame. More...

virtual const ResourceType &	getResourceType () const
	Return the resource type of this object's concrete type. More...

Public Member Functions inherited from om::engine::base::SequencerTrack
virtual	~SequencerTrack ()
	Destroy a sequencer track and release internal resources. More...

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

Detailed Description

A class that handles playback of time sequences of sound data for a single sound stream.

Constructor & Destructor Documentation

om::engine::sound::SoundSequencerTrack::SoundSequencerTrack ( )

Create a new sound sequencer track that has no sequences that is can play.

Member Function Documentation

virtual Size om::engine::sound::SoundSequencerTrack::getSequenceCount ( ) const

virtual

Return the number of sequences that this track supports playing.

Implements om::engine::base::SequencerTrack.

virtual Sequence* om::engine::sound::SoundSequencerTrack::getSequence ( Index sequenceIndex ) const

virtual

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

Implements om::engine::base::SequencerTrack.

void om::engine::sound::SoundSequencerTrack::setSequence	(	Index	sequenceIndex,
		Sequence *	newSequence
	)

inline

Set a pointer to the sequence at the given index.

SoundTrack* om::engine::sound::SoundSequencerTrack::getSequenceTrack ( Index sequenceIndex ) const

inline

Return a pointer to the sound track that is associated with the sequence with the given index.

void om::engine::sound::SoundSequencerTrack::setSequenceTrack	(	Index	sequenceIndex,
		SoundTrack *	newTrack
	)

inline

Set a pointer to the sound track that is associated with the sequence with the given index.

virtual Bool om::engine::sound::SoundSequencerTrack::getSequenceIndex	(	Sequence *	sequence,
		Index &	sequenceIndex
	)		const

virtual

Get the index of the specified sequence in this track.

Implements om::engine::base::SequencerTrack.

Bool om::engine::sound::SoundSequencerTrack::addSequence	(	Sequence *	sequence,
		SoundTrack *	track
	)

Add a new sequence to this sequencer track that plays the specified sound track.

void om::engine::sound::SoundSequencerTrack::clearSequences ( )

Remove all sequences from this sound sequencer track.

virtual Bool om::engine::sound::SoundSequencerTrack::playSequence	(	Index	sequenceIndex,
		PlaybackID	playbackID,
		const Playback &	playback
	)

virtual

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

Implements om::engine::base::SequencerTrack.

virtual void om::engine::sound::SoundSequencerTrack::updatePlayback	(	PlaybackID	playbackID,
		const Playback &	playback
	)

virtual

Update the playback state for a currently playing sequence in this sequencer track.

Implements om::engine::base::SequencerTrack.

virtual void om::engine::sound::SoundSequencerTrack::pausePlayback ( PlaybackID playbackID )

virtual

Pause a currently playing sequence.

Implements om::engine::base::SequencerTrack.

virtual void om::engine::sound::SoundSequencerTrack::resumePlayback ( PlaybackID playbackID )

virtual

Resume playback for a currently paused sequence.

Implements om::engine::base::SequencerTrack.

virtual void om::engine::sound::SoundSequencerTrack::stopPlayback ( PlaybackID playbackID )

virtual

Completely stop playback for the specified sequence.

Implements om::engine::base::SequencerTrack.

virtual void om::engine::sound::SoundSequencerTrack::pauseAll ( )

virtual

Simultaneously pause the playback of all sequences in this sequencer track.

Implements om::engine::base::SequencerTrack.

virtual void om::engine::sound::SoundSequencerTrack::resumeAll ( )

virtual

Simultaneously resume the playback of all sequences in this sequencer track.

Implements om::engine::base::SequencerTrack.

virtual void om::engine::sound::SoundSequencerTrack::stopAll ( )

virtual

Simultaneously stop the playback of all sequences in this sequencer track.

Implements om::engine::base::SequencerTrack.

const ChannelLayout& om::engine::sound::SoundSequencerTrack::getOutputChannelLayout ( ) const

inline

Return the channel layout that is used for the output of this track.

void om::engine::sound::SoundSequencerTrack::setOutputChannelLayout ( const ChannelLayout & newChannelLayout )

inline

Set the channel layout that is used for the output of this track.

SampleRate om::engine::sound::SoundSequencerTrack::getOutputSampleRate ( ) const

inline

Return the sample rate that is used for the output of this track.

void om::engine::sound::SoundSequencerTrack::setOutputSampleRate ( SampleRate newSampleRate )

inline

Set the sample rate that is used for the output of this track.

SoundResult om::engine::sound::SoundSequencerTrack::process	(	const SoundFrame &	input,
		SoundFrame &	output,
		Size	numSamples
	)

Render the output of this track given the specified input frame.

virtual const ResourceType& om::engine::sound::SoundSequencerTrack::getResourceType ( ) const

virtual

Return the resource type of this object's concrete type.

Implements om::engine::base::SequencerTrack.

Member Data Documentation

const ResourceType om::engine::sound::SoundSequencerTrack::RESOURCE_TYPE

static

The resource type for a sound sequencer track.

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

omEngineSoundSequencerTrack.h

Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation