CPPCli::MonitorCell Class Reference

The MonitorCell class represents a single viewport, hosted on a monitor, that can play media from a data source. More...

#include <MonitorCell.h>

Public Member Functions
	MonitorCell (VxSdk::IVxMonitorCell *vxMonitorCell)
	Constructor. More...
virtual	~MonitorCell ()
	Destructor. More...
	!MonitorCell ()
	Finaliser. More...
Results::Value	Disconnect ()
	Removes the active data source from this cell. More...
Results::Value	GoToLive ()
	Sets the position of the display data to live. More...
Results::Value	Refresh ()
	Refreshes this instances properties. More...

Package Attributes
VxSdk::IVxMonitorCell *	_monitorCell

Properties
System::String^	DataSourceId [get, set]
	Gets or sets the unique identifier of the data source that this cell shall display. More...
int	Index [get]
	Gets the unique index of this cell based on its position within the current layout. More...
float	Speed [get, set]
	Gets or sets the play speed of the display data. More...
System::DateTime	Time [get, set]
	Gets or sets the time at which the data should seek to (does not track time as the data plays). More...
System::DateTime	TimeAnchor [get]
	Gets the wall clock time at which the data playback should begin. More...

Detailed Description

The MonitorCell class represents a single viewport, hosted on a monitor, that can play media from a data source.

Definition at line 13 of file MonitorCell.h.

Constructor & Destructor Documentation

CPPCli::MonitorCell::MonitorCell

(

VxSdk::IVxMonitorCell *

vxMonitorCell

)

Constructor.

Implements the MonitorCell class.

Parameters

vxMonitorCell

The monitor cell.

Definition at line 6 of file MonitorCell.cpp.

                                                                 {
    _monitorCell = vxMonitorCell;
}

virtual CPPCli::MonitorCell::~MonitorCell ( )

inlinevirtual

Destructor.

Definition at line 25 of file MonitorCell.h.

                               {
            this->!MonitorCell();
        }

CPPCli::MonitorCell::!MonitorCell

(

)

Finaliser.

Definition at line 10 of file MonitorCell.cpp.

                                {
    _monitorCell->Delete();
    _monitorCell = nullptr;
}

Member Function Documentation

CPPCli::Results::Value CPPCli::MonitorCell::Disconnect

(

)

Removes the active data source from this cell.

Returns

The Result of removing the active data source.

Definition at line 15 of file MonitorCell.cpp.

                                                 {
    // Call SetDataSource with a nullptr to remove the current data source
    return (CPPCli::Results::Value)_monitorCell->SetDataSource(nullptr);
}

CPPCli::Results::Value CPPCli::MonitorCell::GoToLive

(

)

Sets the position of the display data to live.

Returns

The Result of going to live.

Definition at line 20 of file MonitorCell.cpp.

                                               {
    // Call SetTime with a nullptr to move the playback position to live
    return (CPPCli::Results::Value)_monitorCell->SetTime(nullptr);
}

CPPCli::Results::Value CPPCli::MonitorCell::Refresh

(

)

Refreshes this instances properties.

Returns

The Result of updating the properties.

Definition at line 25 of file MonitorCell.cpp.

                                              {
    return (CPPCli::Results::Value)_monitorCell->Refresh();
}

Member Data Documentation

VxSdk::IVxMonitorCell* CPPCli::MonitorCell::_monitorCell

package

Definition at line 109 of file MonitorCell.h.

Property Documentation

System:: String^ CPPCli::MonitorCell::DataSourceId

getset

Gets or sets the unique identifier of the data source that this cell shall display.

The unique identifier of the data source.

Definition at line 56 of file MonitorCell.h.

int CPPCli::MonitorCell::Index

get

Gets the unique index of this cell based on its position within the current layout.

The index.

Definition at line 70 of file MonitorCell.h.

float CPPCli::MonitorCell::Speed

getset

Gets or sets the play speed of the display data.

The speed.

Definition at line 79 of file MonitorCell.h.

System:: DateTime CPPCli::MonitorCell::Time

getset

Gets or sets the time at which the data should seek to (does not track time as the data plays).

The seek time.

Definition at line 89 of file MonitorCell.h.

System:: DateTime CPPCli::MonitorCell::TimeAnchor

get

Gets the wall clock time at which the data playback should begin.

The time.

Definition at line 103 of file MonitorCell.h.

---

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

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