CPPCli::MediaControl Class Reference

The MediaControl class creates a controller object that provides the ability to create and control video streams. More...

#include <MediaControl.h>

Public Types
enum	Modes {   Modes::Stopped,   Modes::Live,   Modes::Playback }
	Values that represent the different playback modes. More...

Public Member Functions
delegate void	TimestampCallbackDelegate (MediaController::TimestampEvent *timeEvent)
	The native event callback delegate. More...
delegate void	TimestampEventDelegate (MediaEvent^ mediaEvent)
	The managed event delegate. More...
	MediaControl (DataSource^ videoSource, DataInterface^ videoInterface, DataSource^ audioSource, DataInterface^ audioInterface)
	Constructor. More...
virtual	~MediaControl ()
	Virtual destructor. More...
	!MediaControl ()
	Finaliser. More...
void	GoToLive ()
	Call GoToLive on the stream. More...
void	Pause ()
	Call Pause on the stream. More...
bool	Play (float speed)
	Call Play on the stream. More...
bool	Seek (System::DateTime time, float speed)
	Call Play on the stream with the supplied start time, resulting in a playback stream. More...
void	SetDataSource (DataSource^ videoDataSource, DataInterface^ videoDataInterface, DataSource^ audioDataSource, DataInterface^ audioDataInterface)
	Set the stream to a new data source. More...
void	SetVideoWindow (System::IntPtr windowHandle)
	Set the display window using the given window handle. More...
void	Stop ()
	Call TearDown on the stream. More...

Package Functions
void	_FireTimestampEvent (MediaController::TimestampEvent *timeEvent)

Package Attributes
MediaController::IController *	_control
TimestampCallbackDelegate^	_timestampCallback
TimestampEventDelegate^	_timestampEvent
DataSource^	_currentdataSource

Properties
DataSource^	CurrentDataSource [get]
	Gets the current data source. More...
bool	IsPipelineActive [get]
	Get the status of the pipeline. More...
Modes	Mode [get]
	Gets the current playback mode. More...

Events
TimestampEventDelegate^	TimestampEvent [add, remove]
	TimestampEvent is raised whenever a new timestamp is received from the stream. More...

Detailed Description

The MediaControl class creates a controller object that provides the ability to create and control video streams.

Definition at line 15 of file MediaControl.h.

Member Enumeration Documentation

enum CPPCli::MediaControl::Modes

strong

Values that represent the different playback modes.

Enumerator
Stopped	The stream is stopped.
Live	The stream is playing live video.
Playback	The stream is playing recorded video.

Definition at line 21 of file MediaControl.h.

                         {
            Stopped,

            Live,

            Playback
        };

Constructor & Destructor Documentation

CPPCli::MediaControl::MediaControl	(	DataSource^	videoSource,
		DataInterface^	videoInterface,
		DataSource^	audioSource,
		DataInterface^	audioInterface
	)

Constructor.

Parameters

videoSource	The data source to use to create the video stream.
videoInterface	The data interface to use to create the video stream.
audioSource	The data source to use to create the audio stream.
audioInterface	The data interface to use to create the audio stream.

Definition at line 9 of file MediaControl.cpp.

                                                                                                                                               {
    // Create a new MediaRequest object
    MediaController::MediaRequest request;
    if (videoSource != nullptr) {
        request.dataSource = videoSource->_dataSource;
        request.dataInterface = *videoInterface->_dataInterface;
    }
    
    if (audioSource != nullptr) {
        request.audioDataSource = audioSource->_dataSource;
        request.audioDataInterface = *audioInterface->_dataInterface;
    }

    // Get the MediaController which allows the client to control streams
    MediaController::IController* control = nullptr;
    MediaController::GetController(&request, &control);

    // Set the callback for timestamp events
    _timestampCallback = gcnew TimestampCallbackDelegate(this, &CPPCli::MediaControl::_FireTimestampEvent);
    control->AddObserver(MediaController::TimestampEventCallback(Marshal::GetFunctionPointerForDelegate(_timestampCallback).ToPointer()));

    _control = control;
    _currentdataSource = videoSource;
}

virtual CPPCli::MediaControl::~MediaControl ( )

inlinevirtual

Virtual destructor.

Definition at line 58 of file MediaControl.h.

                                {
            this->!MediaControl();
        }

CPPCli::MediaControl::!MediaControl

(

)

Finaliser.

Definition at line 34 of file MediaControl.cpp.

                                  {
    // Clear all subscriptions to the timestamp events
    _control->ClearObservers();
    delete _control;
    _control = nullptr;
}

Member Function Documentation

void CPPCli::MediaControl::_FireTimestampEvent ( MediaController::TimestampEvent *  timeEvent )

package

Definition at line 99 of file MediaControl.cpp.

                                                                                     {
    // Fire the notification if there is a subscription to the timestamp events
    if (_timestampEvent != nullptr)
        return _timestampEvent(gcnew MediaEvent(timeEvent));
}

void CPPCli::MediaControl::GoToLive

(

)

Call GoToLive on the stream.

Definition at line 41 of file MediaControl.cpp.

                                  {
    _control->GoToLive();
}

void CPPCli::MediaControl::Pause

(

)

Call Pause on the stream.

Definition at line 45 of file MediaControl.cpp.

                               {
    _control->Pause();
}

bool CPPCli::MediaControl::Play

(

float

speed

)

Call Play on the stream.

Parameters

speed

The playback speed. Negative values can be used for reverse playback.

Definition at line 49 of file MediaControl.cpp.

                                         {
    return _control->Play(speed);
}

bool CPPCli::MediaControl::Seek	(	System::DateTime	time,
		float	speed
	)

Call Play on the stream with the supplied start time, resulting in a playback stream.

Parameters

time	The start time for playback.
speed	The playback speed. Negative values can be used for reverse playback.

Definition at line 53 of file MediaControl.cpp.

                                                              {
    // Convert the seek time from a DateTime format to unix time format
    System::TimeSpan ts = (time - System::DateTime(1970, 1, 1, 0, 0, 0));
    unsigned int seekTime = safe_cast<unsigned int>(ts.TotalSeconds);

    return _control->Play(speed, seekTime);
}

void CPPCli::MediaControl::SetDataSource	(	DataSource^	videoDataSource,
		DataInterface^	videoDataInterface,
		DataSource^	audioDataSource,
		DataInterface^	audioDataInterface
	)

Set the stream to a new data source.

Parameters

videoDataSource	The data source to use to create the video stream.
videoDataInterface	The data interface to use to create the video stream.
audioDataSource	The data source to use to create the audio stream.
audioDataInterface	The data interface to use to create the audio stream.

Definition at line 61 of file MediaControl.cpp.

                                                                                                                                                     {
    // Create a new MediaRequest object
    MediaController::MediaRequest request;
    if (videoSource != nullptr) {
        request.dataSource = videoSource->_dataSource;
        request.dataInterface = *videoInterface->_dataInterface;
    }

    if (audioSource != nullptr) {
        request.audioDataSource = audioSource->_dataSource;
        request.audioDataInterface = *audioInterface->_dataInterface;
    }

    // Update the stream settings for the MediaController using the MediaRequest
    _control->NewRequest(request);
    _currentdataSource = videoSource;
}

void CPPCli::MediaControl::SetVideoWindow

(

System::IntPtr

windowHandle

)

Set the display window using the given window handle.

Parameters

windowHandle

An IntPtr to the window handle.

Definition at line 79 of file MediaControl.cpp.

                                                                 {
    // Set the display for the MediaController using windowHandle
    HWND VideoWindow = static_cast<HWND>(windowHandle.ToPointer());
    _control->SetWindow(VideoWindow);
}

void CPPCli::MediaControl::Stop

(

)

Call TearDown on the stream.

Definition at line 85 of file MediaControl.cpp.

                              {
    _control->Stop();
}

delegate void CPPCli::MediaControl::TimestampCallbackDelegate

(

MediaController::TimestampEvent *

timeEvent

)

The native event callback delegate.

Parameters

timeEvent

The time event sent from the stream.

delegate void CPPCli::MediaControl::TimestampEventDelegate

(

MediaEvent^

mediaEvent

)

The managed event delegate.

Parameters

mediaEvent

The media event sent from the stream as a managed type.

Member Data Documentation

MediaController::IController* CPPCli::MediaControl::_control

package

Definition at line 143 of file MediaControl.h.

DataSource ^ CPPCli::MediaControl::_currentdataSource

package

Definition at line 147 of file MediaControl.h.

TimestampCallbackDelegate ^ CPPCli::MediaControl::_timestampCallback

package

Definition at line 145 of file MediaControl.h.

TimestampEventDelegate ^ CPPCli::MediaControl::_timestampEvent

package

Definition at line 146 of file MediaControl.h.

Property Documentation

DataSource^ CPPCli::MediaControl::CurrentDataSource

get

Gets the current data source.

The current data source.

Definition at line 114 of file MediaControl.h.

bool CPPCli::MediaControl::IsPipelineActive

get

Get the status of the pipeline.

Returns

True if pipeline is active, otherwise false.

Definition at line 122 of file MediaControl.h.

Modes CPPCli::MediaControl::Mode

get

Gets the current playback mode.

The current stream mode.

Definition at line 130 of file MediaControl.h.

Event Documentation

TimestampEventDelegate^ CPPCli::MediaControl::TimestampEvent

addremove

TimestampEvent is raised whenever a new timestamp is received from the stream.

Definition at line 137 of file MediaControl.h.

---

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

• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Include/MediaControl.h
• C:/Git/VxSDK-Samples/CSharpSample/CSharpWrapper/Source/MediaControl.cpp