MediaController::StreamBase Class Reference

The base class for the different stream types. More...

#include <StreamBase.h>

Public Member Functions
virtual	~StreamBase ()
	Virtual destructor. More...
bool	Play (float speed=0, unsigned int unixTime=0) override
	Call Play on the stream. More...
void	Pause () override
	Call Pause on the stream. More...
void	Stop () override
	Call TearDown on the stream. More...
void	NewRequest (MediaRequest &request) override
	Set the stream to a new source. More...
virtual bool	Resume (float speed=0, unsigned int unixTime=0)
	Send PLAY on an existing stream. More...
GstWrapper *	GetGstreamer () const
	Get the current GStreamer wrapper instance. More...
unsigned int	GetLastTimestamp () const
	Gets the current time of the stream. More...
Mode	GetMode () override
	Get the current playback mode. More...
Public Member Functions inherited from MediaController::IStream
virtual	~IStream ()
	Virtual destructor. More...
virtual void	PlayStream (float speed, unsigned int unixTime)=0
virtual bool	GoToLive ()=0
	Set the stream to Live and call Play. More...

Public Attributes
StreamState *	state
	The current state of the stream. More...
VxSdk::VxStreamProtocol::Value	protocol
	The protocol of the stream. More...

Protected Member Functions
	StreamBase (MediaRequest &request)
	Constructor. More...

Protected Attributes
MediaRequest	_mediaRequest
GstWrapper *	_gst

Private Member Functions
	StreamBase ()
	Default constructor. More...

Additional Inherited Members
Public Types inherited from MediaController::IStream
enum	Mode {   kStopped,   kLive,   kPlayback }
	Values that represent the different playback modes. More...

Detailed Description

The base class for the different stream types.

Definition at line 14 of file StreamBase.h.

Inherits MediaController::IStream.

Inherited by MediaController::MjpegPull::Stream, and MediaController::Rtsp::Stream.

Constructor & Destructor Documentation

StreamBase::~StreamBase ( )

virtual

Virtual destructor.

Definition at line 18 of file StreamBase.cpp.

                        {

}

StreamBase::StreamBase ( MediaRequest &  request )

protected

Constructor.

Parameters

request

The requested media.

Definition at line 12 of file StreamBase.cpp.

                                            :
   _mediaRequest(request)  {
    // Build a new pipeline using the description generated above.
    this->_gst = new GstWrapper();
}

StreamBase::StreamBase ( )

private

Default constructor.

Definition at line 10 of file StreamBase.cpp.

{}

Member Function Documentation

GstWrapper * StreamBase::GetGstreamer

(

)

const

Get the current GStreamer wrapper instance.

Returns

The current GstWrapper instance.

Definition at line 32 of file StreamBase.cpp.

                                           {
    return this->_gst;
}

unsigned int StreamBase::GetLastTimestamp

(

)

const

Gets the current time of the stream.

Returns

The last timestamp received.

Definition at line 36 of file StreamBase.cpp.

                                                {
    return this->_gst->GetLastTimestamp();
}

Controller::Mode StreamBase::GetMode ( )

overridevirtual

Get the current playback mode.

Returns

The current stream Mode.

Implements MediaController::IStream.

Definition at line 40 of file StreamBase.cpp.

                                   {
    return this->_gst->GetMode();
}

void StreamBase::NewRequest ( MediaRequest &  request )

overridevirtual

Set the stream to a new source.

Parameters

request

The new MediaRequest to reset the stream to.

Implements MediaController::IStream.

Definition at line 28 of file StreamBase.cpp.

{}

void StreamBase::Pause ( )

overridevirtual

Call Pause on the stream.

Implements MediaController::IStream.

Definition at line 24 of file StreamBase.cpp.

{}

bool StreamBase::Play ( float  speed = 0, unsigned int  unixTime = 0  )

overridevirtual

Call Play on the stream.

Parameters

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

Implements MediaController::IStream.

Definition at line 22 of file StreamBase.cpp.

{ return false; }

bool StreamBase::Resume ( float  speed = 0, unsigned int  unixTime = 0  )

virtual

Send PLAY on an existing stream.

Parameters

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

Reimplemented in MediaController::Rtsp::Stream, and MediaController::MjpegPull::Stream.

Definition at line 30 of file StreamBase.cpp.

{ return false; }

void StreamBase::Stop ( )

overridevirtual

Call TearDown on the stream.

Implements MediaController::IStream.

Definition at line 26 of file StreamBase.cpp.

{}

Member Data Documentation

GstWrapper* MediaController::StreamBase::_gst

protected

Definition at line 73 of file StreamBase.h.

MediaRequest MediaController::StreamBase::_mediaRequest

protected

Definition at line 72 of file StreamBase.h.

VxSdk::VxStreamProtocol::Value MediaController::StreamBase::protocol

The protocol of the stream.

Definition at line 56 of file StreamBase.h.

StreamState* MediaController::StreamBase::state

The current state of the stream.

Definition at line 49 of file StreamBase.h.

---

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

• C:/Git/VxSDK-Samples/MediaController/Include/StreamBase.h
• C:/Git/VxSDK-Samples/MediaController/Source/StreamBase.cpp