Play back video resources. More...

#include <deVideoPlayer.h>

Inheritance diagram for deVideoPlayer:

Public Types
enum	ePlayState { epsStopped , epsPlaying , epsPaused }
	Play state. More...

typedef deTObjectReference< deVideoPlayer >	Ref
	Type holding strong reference. More...

Public Types inherited from deResource
typedef deTObjectReference< deResource >	Ref
	Type holding strong reference. More...

Public Types inherited from deObject
typedef deTObjectReference< deObject >	Ref
	Type holding strong reference. More...

Public Member Functions
Management
deVideo *	GetVideo () const
	Video or NULL if not set. More...

void	SetVideo (deVideo *video)
	Set video or NULL if not set. More...

bool	GetLooping () const
	Video is looping instead of being played back once. More...

void	SetLooping (bool looping)
	Set if video is looping instead of being played back once. More...

float	GetPlayFrom () const
	Start play position in seconds. More...

float	GetPlayTo () const
	End play position in seconds. More...

void	SetPlayRange (float fromTime, float toTime)
	Set play range. More...

float	GetPlaySpeed () const
	Play speed. More...

void	SetPlaySpeed (float playSpeed)
	Set play speed. More...

float	GetPlayPosition () const
	Current play position in seconds. More...

void	SetPlayPosition (float position)
	Set current play position in seconds. More...

ePlayState	GetPlayState () const
	play state. More...

bool	GetPlaying () const
	Video is playing back. More...

bool	GetPaused () const
	Video is paused. More...

bool	GetStopped () const
	Video is stopped. More...

void	SetPlayState (ePlayState playState)
	Set play state. More...

void	Play ()
	Start playing back if not already playing back. More...

void	Stop ()
	Stops playing back if not stopped. More...

void	Pause ()
	Pause playing back if not paused. More...

void	Update (float elapsed)
	Update video player. More...

Public Member Functions inherited from deResource
deResourceManager *	GetResourceManager () const
	Resource manager or NULL if resource is leaking. More...

deEngine *	GetEngine () const
	Game engine object from resource manager. More...

deResource *	GetLLManagerPrev () const
	Previous resource in the resource manager linked list. More...

void	SetLLManagerPrev (deResource *resource)
	Set next resource in the resource manager linked list. More...

deResource *	GetLLManagerNext () const
	Next resource in the resource manager linked list. More...

void	SetLLManagerNext (deResource *resource)
	Set next resource in the resource manager linked list. More...

void	MarkLeaking ()
	Marks the resource leaking. More...

	deResource (deResourceManager *resourceManager)
	Create resource. More...

Public Member Functions inherited from deObject
int	GetRefCount () const
	Reference count. More...

void	AddReference ()
	Add reference increasing reference count by 1. More...

void	FreeReference ()
	Decrease reference count by one and delete object if count reaches 0. More...

	deObject ()
	Create object with reference count of 1. More...

Constructors and Destructors
	deVideoPlayer (deVideoPlayerManager *manager)
	Create video player. More...

virtual	~deVideoPlayer ()
	Clean up video player. More...

System Peers
deBaseGraphicVideoPlayer *	GetPeerGraphic () const
	Graphic system peer. More...

void	SetPeerGraphic (deBaseGraphicVideoPlayer *peer)
	Set graphic system peer. More...

deBaseAudioVideoPlayer *	GetPeerAudio () const
	Audio system peer. More...

void	SetPeerAudio (deBaseAudioVideoPlayer *peer)
	Set audio system peer. More...

Additional Inherited Members
Protected Member Functions inherited from deResource
virtual	~deResource ()
	Clean up resource. More...

Protected Member Functions inherited from deObject
virtual	~deObject ()
	Clean up object. More...

Detailed Description

Play back video resources.

Member Typedef Documentation

◆ Ref

typedef deTObjectReference<deVideoPlayer> deVideoPlayer::Ref

Type holding strong reference.

Member Enumeration Documentation

◆ ePlayState

enum deVideoPlayer::ePlayState

Play state.

Enumerator
epsStopped	Playback is stopped.
epsPlaying	Video is being played back.
epsPaused	Playback is paused.

Constructor & Destructor Documentation

◆ deVideoPlayer()

deVideoPlayer::deVideoPlayer ( deVideoPlayerManager * manager )

Create video player.

◆ ~deVideoPlayer()

virtual deVideoPlayer::~deVideoPlayer ( )

protectedvirtual

Clean up video player.

Note: Subclasses should set their destructor protected too to avoid users accidently deleting a reference counted object through the object pointer. Only FreeReference() is allowed to delete the object.

Member Function Documentation

◆ GetLooping()

bool deVideoPlayer::GetLooping ( ) const

inline

Video is looping instead of being played back once.

◆ GetPaused()

bool deVideoPlayer::GetPaused ( ) const

inline

Video is paused.

◆ GetPeerAudio()

deBaseAudioVideoPlayer* deVideoPlayer::GetPeerAudio ( ) const

inline

Audio system peer.

◆ GetPeerGraphic()

deBaseGraphicVideoPlayer* deVideoPlayer::GetPeerGraphic ( ) const

inline

Graphic system peer.

◆ GetPlayFrom()

float deVideoPlayer::GetPlayFrom ( ) const

inline

Start play position in seconds.

◆ GetPlaying()

bool deVideoPlayer::GetPlaying ( ) const

inline

Video is playing back.

◆ GetPlayPosition()

float deVideoPlayer::GetPlayPosition ( ) const

inline

Current play position in seconds.

◆ GetPlaySpeed()

float deVideoPlayer::GetPlaySpeed ( ) const

inline

Play speed.

◆ GetPlayState()

ePlayState deVideoPlayer::GetPlayState ( ) const

inline

play state.

◆ GetPlayTo()

float deVideoPlayer::GetPlayTo ( ) const

inline

End play position in seconds.

◆ GetStopped()

bool deVideoPlayer::GetStopped ( ) const

inline

Video is stopped.

◆ GetVideo()

deVideo* deVideoPlayer::GetVideo ( ) const

inline

Video or NULL if not set.

◆ Pause()

void deVideoPlayer::Pause ( )

Pause playing back if not paused.

◆ Play()

void deVideoPlayer::Play ( )

Start playing back if not already playing back.

◆ SetLooping()

void deVideoPlayer::SetLooping ( bool looping )

Set if video is looping instead of being played back once.

◆ SetPeerAudio()

void deVideoPlayer::SetPeerAudio ( deBaseAudioVideoPlayer * peer )

Set audio system peer.

◆ SetPeerGraphic()

void deVideoPlayer::SetPeerGraphic ( deBaseGraphicVideoPlayer * peer )

Set graphic system peer.

◆ SetPlayPosition()

void deVideoPlayer::SetPlayPosition ( float position )

Set current play position in seconds.

◆ SetPlayRange()

void deVideoPlayer::SetPlayRange	(	float	fromTime,
		float	toTime
	)

Set play range.

◆ SetPlaySpeed()

void deVideoPlayer::SetPlaySpeed ( float playSpeed )

Set play speed.

◆ SetPlayState()

void deVideoPlayer::SetPlayState ( ePlayState playState )

Set play state.

◆ SetVideo()

void deVideoPlayer::SetVideo ( deVideo * video )

Set video or NULL if not set.

◆ Stop()

void deVideoPlayer::Stop ( )

Stops playing back if not stopped.

◆ Update()

void deVideoPlayer::Update ( float elapsed )

Update video player.

Advances the play position if playing back.

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

deVideoPlayer.h

Public Types

Public Member Functions

Constructors and Destructors

System Peers

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Ref

Member Enumeration Documentation

◆ ePlayState

Constructor & Destructor Documentation

◆ deVideoPlayer()

◆ ~deVideoPlayer()

Member Function Documentation

◆ GetLooping()

◆ GetPaused()

◆ GetPeerAudio()

◆ GetPeerGraphic()

◆ GetPlayFrom()

◆ GetPlaying()

◆ GetPlayPosition()

◆ GetPlaySpeed()

◆ GetPlayState()

◆ GetPlayTo()

◆ GetStopped()

◆ GetVideo()

◆ Pause()

◆ Play()

◆ SetLooping()

◆ SetPeerAudio()

◆ SetPeerGraphic()

◆ SetPlayPosition()

◆ SetPlayRange()

◆ SetPlaySpeed()

◆ SetPlayState()

◆ SetVideo()

◆ Stop()

◆ Update()