VxSdk::IVxMonitorCell Struct Reference

Represents a single viewport, hosted on a monitor, that can play media from a data source. More...

#include <IVxMonitorCell.h>

Public Member Functions
virtual VxResult::Value	Delete () const =0
	Deletes this instance. More...
virtual VxResult::Value	Refresh ()=0
	Refreshes the member values for this object by retrieving its current information from the VideoXpert system. More...
virtual VxResult::Value	SetDataSource (char dataSourceId[64])=0
	Sets the data source that this cell shall display. A value of nullptr will remove the current data source. More...
virtual VxResult::Value	SetSpeed (float speed)=0
	Sets the play speed of the monitor data. Negative values indicate reverse speeds while positive values indicate forward speeds (1 is normal speed). A value of 0 will pause the data playback. More...
virtual VxResult::Value	SetTime (char time[64])=0
	Sets the time to seek to on the monitor. A value of nullptr will set the stream to live. If no frame is available for the given time the stream will remain unchanged. More...

Public Attributes
char	dataSourceId [64]
	The unique identifier of the data source displayed in the cell. More...
int	index
	The unique index of the cell based on its position within the current layout. More...
float	speed
	The play speed of the display data. More...
char	time [64]
	The time at which the data should initially seek to (does not track time as the data plays). More...
char	timeAnchor [64]
	The wall clock time at which the data playback should begin. More...

Protected Member Functions
void	Clear ()
	Clears this instance. More...

Detailed Description

Represents a single viewport, hosted on a monitor, that can play media from a data source.

Definition at line 12 of file IVxMonitorCell.h.

Member Function Documentation

void VxSdk::IVxMonitorCell::Clear ( )

inlineprotected

Clears this instance.

Definition at line 71 of file IVxMonitorCell.h.

                     {
            VxZeroArray(this->dataSourceId);
            this->index = 0;
            this->speed = 0;
            VxZeroArray(this->time);
            VxZeroArray(this->timeAnchor);
        }

virtual VxResult::Value VxSdk::IVxMonitorCell::Delete ( ) const

pure virtual

Deletes this instance.

Returns

The Result of deleting this instance.

virtual VxResult::Value VxSdk::IVxMonitorCell::Refresh ( )

pure virtual

Refreshes the member values for this object by retrieving its current information from the VideoXpert system.

Returns

The Result of refreshing the member values for this object.

virtual VxResult::Value VxSdk::IVxMonitorCell::SetDataSource ( char  dataSourceId[64] )

pure virtual

Sets the data source that this cell shall display. A value of nullptr will remove the current data source.

Parameters

dataSourceId

The ID of the data source to display, nullptr to remove the current data source.

Returns

The Result of setting the property.

virtual VxResult::Value VxSdk::IVxMonitorCell::SetSpeed ( float  speed )

pure virtual

Sets the play speed of the monitor data. Negative values indicate reverse speeds while positive values indicate forward speeds (1 is normal speed). A value of 0 will pause the data playback.

Parameters

speed

The playback speed.

Returns

The Result of the request.

virtual VxResult::Value VxSdk::IVxMonitorCell::SetTime ( char  time[64] )

pure virtual

Sets the time to seek to on the monitor. A value of nullptr will set the stream to live. If no frame is available for the given time the stream will remain unchanged.

Parameters

time	The time to seek to, nullptr for live.

Returns

The Result of setting the property.

Member Data Documentation

char VxSdk::IVxMonitorCell::dataSourceId[64]

The unique identifier of the data source displayed in the cell.

Definition at line 49 of file IVxMonitorCell.h.

int VxSdk::IVxMonitorCell::index

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

Definition at line 53 of file IVxMonitorCell.h.

float VxSdk::IVxMonitorCell::speed

The play speed of the display data.

Definition at line 57 of file IVxMonitorCell.h.

char VxSdk::IVxMonitorCell::time[64]

The time at which the data should initially seek to (does not track time as the data plays).

Definition at line 61 of file IVxMonitorCell.h.

char VxSdk::IVxMonitorCell::timeAnchor[64]

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

Definition at line 65 of file IVxMonitorCell.h.

---

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

• C:/Git/VXSDK_M3/VxSdk/Include/IVxMonitorCell.h