VideoOS.Platform.Data.BitmapData Class Reference

Contains the Bitmap information. More...

Inheritance diagram for VideoOS.Platform.Data.BitmapData:

Public Member Functions
BitmapSource	ConvertToBitmapSource ()
	Utility method used to convert the contained bitmap into a BitmapSource which can be directly applied as a source to an WPF Image control.
void	Dispose ()
	Call this to dispose the related memory (Unmanaged)
void	Dispose (bool native)
	Call this to dispose the related memory.
Bitmap	GetBitmap ()
	Get a Bitmap class pointing to the original plane data. The resulting Bitmap needs to be Disposed.
byte[]	GetPlaneBytes (int plane)
	Returns the bytes in one plane.
Int32	GetPlaneHeight (int plane)
	Get the height of a given plane.
IntPtr	GetPlanePointer (int plane)
	Get a pointer to the start of a plane. The pointer is pointing into unmanaged memory!
Int32	GetPlaneStride (int plane)
	Get the width of one scan line in bytes (including filler bytes)
Int32	GetPlaneWidth (int plane)
	Get the width of one plane.

Public Attributes
DateTime	DateTime
	The date and time the image was taken.
bool	IsNextAvailable
	Defines if the NextDateTime is filled.
bool	IsPreviousAvailable
	Defines if the PreviousDateTime is filled.
DateTime	NextDateTime
	The time stamp for the next image. This field is not always available.
DateTime	PreviousDateTime
	The time stamp for the previous image. This field is not always available.

Properties
BitmapColorSpace	ColorSpace [get]
	For BitmapFormat of types YCbCr, the BitmapColorSpace defines what color space is used.
BitmapFormat	Format [get]
	The format of the received bitmap.
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
IDisposable	ObjectToDispose [get, set]
	Reserved for internal use. DO NOT ACCESS THIS FIELD!
double	PixelAspectRatio [get]
	How each pixel should be spaced.
Properties inherited from VideoOS.Platform.CroppingInfo
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.

Detailed Description

Contains the Bitmap information.

Member Function Documentation

ConvertToBitmapSource()

BitmapSource VideoOS.Platform.Data.BitmapData.ConvertToBitmapSource ( )

inline

Utility method used to convert the contained bitmap into a BitmapSource which can be directly applied as a source to an WPF Image control.

Returns

Dispose() [1/2]

void VideoOS.Platform.Data.BitmapData.Dispose ( )

inline

Call this to dispose the related memory (Unmanaged)

Dispose() [2/2]

void VideoOS.Platform.Data.BitmapData.Dispose ( bool native )

inline

Call this to dispose the related memory.

Parameters

native

Ignored

GetBitmap()

Bitmap VideoOS.Platform.Data.BitmapData.GetBitmap ( )

inline

Get a Bitmap class pointing to the original plane data. The resulting Bitmap needs to be Disposed.

Returns

GetPlaneBytes()

byte[] VideoOS.Platform.Data.BitmapData.GetPlaneBytes ( int plane )

abstract

Returns the bytes in one plane.

Parameters

plane

Returns

GetPlaneHeight()

Int32 VideoOS.Platform.Data.BitmapData.GetPlaneHeight ( int plane )

abstract

Get the height of a given plane.

Parameters

plane

Returns

GetPlanePointer()

IntPtr VideoOS.Platform.Data.BitmapData.GetPlanePointer ( int plane )

abstract

Get a pointer to the start of a plane. The pointer is pointing into unmanaged memory!

Parameters

plane

Returns

GetPlaneStride()

Int32 VideoOS.Platform.Data.BitmapData.GetPlaneStride ( int plane )

abstract

Get the width of one scan line in bytes (including filler bytes)

Parameters

plane

Returns

GetPlaneWidth()

Int32 VideoOS.Platform.Data.BitmapData.GetPlaneWidth ( int plane )

abstract

Get the width of one plane.

Parameters

plane

Returns

Member Data Documentation

DateTime

DateTime VideoOS.Platform.Data.BitmapData.DateTime

The date and time the image was taken.

IsNextAvailable

bool VideoOS.Platform.Data.BitmapData.IsNextAvailable

Defines if the NextDateTime is filled.

IsPreviousAvailable

bool VideoOS.Platform.Data.BitmapData.IsPreviousAvailable

Defines if the PreviousDateTime is filled.

NextDateTime

DateTime VideoOS.Platform.Data.BitmapData.NextDateTime

The time stamp for the next image.
This field is not always available.

PreviousDateTime

DateTime VideoOS.Platform.Data.BitmapData.PreviousDateTime

The time stamp for the previous image.
This field is not always available.

Property Documentation

ColorSpace

BitmapColorSpace VideoOS.Platform.Data.BitmapData.ColorSpace

getabstract

For BitmapFormat of types YCbCr, the BitmapColorSpace defines what color space is used.

Format

BitmapFormat VideoOS.Platform.Data.BitmapData.Format

getabstract

The format of the received bitmap.

HardwareDecodingStatus

virtual String VideoOS.Platform.Data.BitmapData.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

ObjectToDispose

IDisposable VideoOS.Platform.Data.BitmapData.ObjectToDispose

getset

Reserved for internal use. DO NOT ACCESS THIS FIELD!

PixelAspectRatio

double VideoOS.Platform.Data.BitmapData.PixelAspectRatio

getabstract

How each pixel should be spaced.