Media Controller
A GStreamer implementation using the VideoXpert SDK
MediaController::IStream Class Referenceabstract

Defines the stream interface. More...

#include <IStream.h>

Public Types

enum  Mode {
  kStopped,
  kLive,
  kPlayback
}
 Values that represent the different playback modes. More...
 

Public Member Functions

virtual ~IStream ()
 Virtual destructor. More...
 
virtual bool Play (float speed=0, unsigned int unixTime=0)=0
 Call Play on the stream. More...
 
virtual void PlayStream (float speed, unsigned int unixTime)=0
 
virtual void Pause ()=0
 Call Pause on the stream. More...
 
virtual void Stop ()=0
 Call TearDown on the stream. More...
 
virtual bool GoToLive ()=0
 Set the stream to Live and call Play. More...
 
virtual void NewRequest (MediaRequest &request)=0
 Set the stream to a new source. More...
 
virtual Mode GetMode ()=0
 Get the current playback mode. More...
 

Detailed Description

Defines the stream interface.

Definition at line 11 of file IStream.h.

Inherited by MediaController::IController, and MediaController::StreamBase.

Member Enumeration Documentation

Values that represent the different playback modes.

Enumerator
kStopped 

The stream is stopped.

kLive 

The stream is playing live video.

kPlayback 

The stream is playing recorded video.

Definition at line 16 of file IStream.h.

16  {
18  kStopped,
19 
21  kLive,
22 
24  kPlayback
25  };
The stream is playing live video.
Definition: IStream.h:21
The stream is playing recorded video.
Definition: IStream.h:24
The stream is stopped.
Definition: IStream.h:18

Constructor & Destructor Documentation

virtual MediaController::IStream::~IStream ( )
inlinevirtual

Virtual destructor.

Definition at line 30 of file IStream.h.

30 {}

Member Function Documentation

virtual Mode MediaController::IStream::GetMode ( )
pure virtual

Get the current playback mode.

Returns
The current stream Mode.

Implemented in MediaController::StreamBase, and MediaController::Controller.

virtual bool MediaController::IStream::GoToLive ( )
pure virtual

Set the stream to Live and call Play.

Implemented in MediaController::Rtsp::Stream, MediaController::MjpegPull::Stream, and MediaController::Controller.

virtual void MediaController::IStream::NewRequest ( MediaRequest request)
pure virtual

Set the stream to a new source.

Parameters
requestThe new MediaRequest to reset the stream to.

Implemented in MediaController::Rtsp::Stream, MediaController::MjpegPull::Stream, MediaController::Controller, and MediaController::StreamBase.

virtual void MediaController::IStream::Pause ( )
pure virtual
virtual bool MediaController::IStream::Play ( float  speed = 0,
unsigned int  unixTime = 0 
)
pure virtual

Call Play on the stream.

Parameters
speedThe playback speed. Negative values can be used for reverse playback. A value of 0 will resume a paused stream.
unixTimeThe start time for playback. A value of 0 will start a live stream.

Implemented in MediaController::Rtsp::Stream, MediaController::MjpegPull::Stream, MediaController::Controller, and MediaController::StreamBase.

virtual void MediaController::IStream::PlayStream ( float  speed,
unsigned int  unixTime 
)
pure virtual
virtual void MediaController::IStream::Stop ( )
pure virtual

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