Public Types

deVideoPlayer Class Reference

Video Player Class. More...

#include <deVideoPlayer.h>

Inheritance diagram for deVideoPlayer:
deResource deObject

List of all members.

Public Types

enum  pPlayState { epsStopped, epsPlaying, epsPaused }

Public Member Functions

Constructors and Destructors
 deVideoPlayer (deVideoPlayerManager *manager)
 Creates a new video player object.
virtual ~deVideoPlayer ()
 Cleans up the video player object.
Management
deVideoGetVideo () const
 Retrieves the video or NULL if not set.
void SetVideo (deVideo *video)
 Sets the video or NULL if not set.
bool GetLooping () const
 Determines if the video is playing once or is looping.
void SetLooping (bool looping)
 Sets if the video is playing once or is looping.
float GetPlayFrom () const
 Retrieves the start play position.
float GetPlayTo () const
 Retrieves the end play position.
void SetPlayRange (float fromTime, float toTime)
 Sets the play range.
float GetPlaySpeed () const
 Retrieves the play speed.
void SetPlaySpeed (float playSpeed)
 Sets the play speed.
float GetPlayPosition () const
 Retrieves the current play position.
void SetPlayPosition (float position)
 Sets the current play position.
int GetPlayState () const
 Retrieves the play state.
bool GetPlaying () const
 Determines if the speaker is playing.
bool GetPaused () const
 Determines if the speaker is paused.
bool GetStopped () const
 Determines if the speaker is stopped.
void SetPlayState (int playState)
 Sets if the play state.
void Play ()
 Starts playing.
void Stop ()
 Stops playing.
void Pause ()
 Pauses playing.
void Update (float elapsed)
 Update the video player.
deBaseVideoDecoderGetDecoder () const
 Retrieves the video decoder or NULL if non-streaming.
System Peers
deBaseGraphicVideoPlayerGetGraphicPeer () const
 Retrieves the graphic system peer.
void SetGraphicPeer (deBaseGraphicVideoPlayer *peer)
 Sets the graphic system peer.

Detailed Description

Video Player Class.

Provides support to play back a video resource.

Video sources can be of streaming or non-streaming type. If a non-streaming viudeo is attached the data is taken from the shared buffer inside the video object. If the video is a streaming video a Video Decoder is created to retrieve video frames from the file. The Video Decoder operates on the file specified in the video object.

Author:
Plüss Roland
Version:
1.0
Date:
2010

Member Enumeration Documentation

Enumerator:
epsStopped 
epsPlaying 
epsPaused 

Constructor & Destructor Documentation

deVideoPlayer::deVideoPlayer ( deVideoPlayerManager manager )

Creates a new video player object.

virtual deVideoPlayer::~deVideoPlayer (  ) [virtual]

Cleans up the video player object.


Member Function Documentation

deBaseVideoDecoder* deVideoPlayer::GetDecoder (  ) const [inline]

Retrieves the video decoder or NULL if non-streaming.

deBaseGraphicVideoPlayer* deVideoPlayer::GetGraphicPeer (  ) const [inline]

Retrieves the graphic system peer.

bool deVideoPlayer::GetLooping (  ) const [inline]

Determines if the video is playing once or is looping.

bool deVideoPlayer::GetPaused (  ) const [inline]

Determines if the speaker is paused.

References epsPaused.

float deVideoPlayer::GetPlayFrom (  ) const [inline]

Retrieves the start play position.

bool deVideoPlayer::GetPlaying (  ) const [inline]

Determines if the speaker is playing.

References epsPlaying.

float deVideoPlayer::GetPlayPosition (  ) const [inline]

Retrieves the current play position.

float deVideoPlayer::GetPlaySpeed (  ) const [inline]

Retrieves the play speed.

int deVideoPlayer::GetPlayState (  ) const [inline]

Retrieves the play state.

float deVideoPlayer::GetPlayTo (  ) const [inline]

Retrieves the end play position.

bool deVideoPlayer::GetStopped (  ) const [inline]

Determines if the speaker is stopped.

References epsStopped.

deVideo* deVideoPlayer::GetVideo (  ) const [inline]

Retrieves the video or NULL if not set.

void deVideoPlayer::Pause (  )

Pauses playing.

void deVideoPlayer::Play (  )

Starts playing.

void deVideoPlayer::SetGraphicPeer ( deBaseGraphicVideoPlayer peer )

Sets the graphic system peer.

void deVideoPlayer::SetLooping ( bool  looping )

Sets if the video is playing once or is looping.

void deVideoPlayer::SetPlayPosition ( float  position )

Sets the current play position.

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

Sets the play range.

void deVideoPlayer::SetPlaySpeed ( float  playSpeed )

Sets the play speed.

void deVideoPlayer::SetPlayState ( int  playState )

Sets if the play state.

void deVideoPlayer::SetVideo ( deVideo video )

Sets the video or NULL if not set.

void deVideoPlayer::Stop (  )

Stops playing.

void deVideoPlayer::Update ( float  elapsed )

Update the video player.


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