VideoOS.Platform.Live.LiveSourceContent Class Reference

This class is used for receiving live content. More...

Inheritance diagram for VideoOS.Platform.Live.LiveSourceContent:

Public Member Functions
virtual void	Dispose ()
	Releases resources and signals that the client is done using this frame.
void	Dispose (bool disposing)
	This method does nothing and should never be called!

Properties
DateTime	BeginTime [get, set]
	The time stamp for the beginning of the content.
byte[]	Content [get, set]
	Contains the requested content. Be aware that this can be of zero length in certain cases, and should simply be ignored in that instance.
double	CropHeight [get, set]
	When the CroppingDefined is true, this field contains the cropping definition. The definition contains the same values as used on the SetCropping call.
bool	CroppingDefined [get, set]
	Is set to true if the returned content has been cropped.
double	CropWidth [get, set]
	When the CroppingDefined is true, this field contains the cropping definition. The definition contains the same values as used on the SetCropping call.
double	CropX [get, set]
	When the CroppingDefined is true, this field contains the cropping definition. The definition contains the same values as used on the SetCropping call.
double	CropY [get, set]
	When the CroppingDefined is true, this field contains the cropping definition. The definition contains the same values as used on the SetCropping call.
object	CustomData [get, set]
	Contains the CustomData set on the LiveSource (e.g. JPEGLiveSource).
DateTime	EndTime [get, set]
	The time stamp for the end of the content. This field is only relevant for audio data.
virtual String	HardwareDecodingStatus [get, set]
	Defines how the decoding of the current frame is performed. Values can be: 'hardware' - Decoded by GPU 'software' - Decoded by Intel Media SDK 'fallback' - Decoded by Intel Media SDK, even though it was requested to be Hardware (or Auto) 'ipp' - Decoded by Intel UMC
int	Height [get]
	Get the Height of the returned JPEG. 0 returned when height cannot be detected.
Dictionary< String, string >	Properties [get, set]
	Any additional properties containing information about the content.
int	Width [get]
	Get the width of the returned JPEG. 0 returned when width cannot be detected.

Detailed Description

This class is used for receiving live content.

Member Function Documentation

Dispose() [1/2]

virtual void VideoOS.Platform.Live.LiveSourceContent.Dispose ( )

inlinevirtual

Releases resources and signals that the client is done using this frame.

This method is not thread-safe!

Reimplemented in VideoOS.Platform.Live.LiveSourceBitmapContent.

Dispose() [2/2]

void VideoOS.Platform.Live.LiveSourceContent.Dispose ( bool disposing )

inline

This method does nothing and should never be called!

Property Documentation

BeginTime

DateTime VideoOS.Platform.Live.LiveSourceContent.BeginTime

getset

The time stamp for the beginning of the content.

Content

byte [] VideoOS.Platform.Live.LiveSourceContent.Content

getset

Contains the requested content.
Be aware that this can be of zero length in certain cases, and should simply be ignored in that instance.

CropHeight

double VideoOS.Platform.Live.LiveSourceContent.CropHeight

getset

When the CroppingDefined is true, this field contains the cropping definition. The definition contains the same values as used on the SetCropping call.

CroppingDefined

bool VideoOS.Platform.Live.LiveSourceContent.CroppingDefined

getset

Is set to true if the returned content has been cropped.

CropWidth

double VideoOS.Platform.Live.LiveSourceContent.CropWidth

getset

When the CroppingDefined is true, this field contains the cropping definition. The definition contains the same values as used on the SetCropping call.

CropX

double VideoOS.Platform.Live.LiveSourceContent.CropX

getset

When the CroppingDefined is true, this field contains the cropping definition. The definition contains the same values as used on the SetCropping call.

CropY

double VideoOS.Platform.Live.LiveSourceContent.CropY

getset

When the CroppingDefined is true, this field contains the cropping definition. The definition contains the same values as used on the SetCropping call.

CustomData

object VideoOS.Platform.Live.LiveSourceContent.CustomData

getset

Contains the CustomData set on the LiveSource (e.g. JPEGLiveSource).

EndTime

DateTime VideoOS.Platform.Live.LiveSourceContent.EndTime

getset

The time stamp for the end of the content. This field is only relevant for audio data.

HardwareDecodingStatus

virtual String VideoOS.Platform.Live.LiveSourceContent.HardwareDecodingStatus

getset

Defines how the decoding of the current frame is performed.
Values can be:
'hardware' - Decoded by GPU
'software' - Decoded by Intel Media SDK
'fallback' - Decoded by Intel Media SDK, even though it was requested to be Hardware (or Auto)
'ipp' - Decoded by Intel UMC

Height

int VideoOS.Platform.Live.LiveSourceContent.Height

get

Get the Height of the returned JPEG. 0 returned when height cannot be detected.

Properties

Dictionary<String, string> VideoOS.Platform.Live.LiveSourceContent.Properties

getset

Any additional properties containing information about the content.

Width

int VideoOS.Platform.Live.LiveSourceContent.Width

get

Get the width of the returned JPEG. 0 returned when width cannot be detected.