A class that contains playback settings for a time sequence of multimedia data. More...

#include <omEnginePlayback.h>

Public Member Functions
	Playback ()
	Create a new playback object with the default settings. More...

Public Attributes
PlaybackFlags	flags
	An object that contains boolean flags for the playback of a sequence. More...

Float	speed
	A scale factor for the playback speed, where 1 is the normal speed. More...

Float	mix
	A value indicating the strength of the playback of the sequence, where 1 is the default. More...

Float	priority
	A value indicating a user-defined priority for the playback of the sequence. More...

Time	fadeInTime
	The length of time that should be used to fade in the sequence to its full strength. More...

Time	fadeOutTime
	The length of time that should be used to fade out the sequence from its full strength to no playback. More...

Static Public Attributes
static const PlaybackID	INVALID_ID = PlaybackID(-1)
	A special playback ID value that indicates an invalid playback instance. More...

Detailed Description

A class that contains playback settings for a time sequence of multimedia data.

Constructor & Destructor Documentation

om::engine::base::Playback::Playback ( )

inline

Create a new playback object with the default settings.

const PlaybackID om::engine::base::Playback::INVALID_ID = PlaybackID(-1)

static

A special playback ID value that indicates an invalid playback instance.

PlaybackFlags om::engine::base::Playback::flags

An object that contains boolean flags for the playback of a sequence.

Float om::engine::base::Playback::speed

A scale factor for the playback speed, where 1 is the normal speed.

Float om::engine::base::Playback::mix

A value indicating the strength of the playback of the sequence, where 1 is the default.

Float om::engine::base::Playback::priority

A value indicating a user-defined priority for the playback of the sequence.

Time om::engine::base::Playback::fadeInTime

The length of time that should be used to fade in the sequence to its full strength.

A value of zero indicates there is no fading performed.

Time om::engine::base::Playback::fadeOutTime

The length of time that should be used to fade out the sequence from its full strength to no playback.

A value of zero indicates there is no fading performed.

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