VideoOS.Platform.Client.BitmapSource Class Reference

Public Member Functions
	BitmapSource ()
void	Close (bool wait=false)
	Close the initialized class. The background thread is flagged to stop, and if the wait parameter is true the method will wait for it to finish, max wait time is 5 seconds.
void	Init ()
	Initalizes the class and starts a background thread.
void	LiveStart ()
void	LiveStop ()
delegate void	NewBitmapEventHandler (Bitmap bitmap)

Properties
FQID	InstanceFQID [get]
bool	IsInitialized [get]
	Returns true when Init() has been called, and false after the Close() has been called.
Item	Item [get, set]
FQID	PlaybackFQID [get, set]
bool	Selected [get, set]
Size	Size [get, set]
Guid	StreamId [get, set]
	The id of the stream to be used for the live stream.

Events
NewBitmapEventHandler	NewBitmapEvent

Constructor & Destructor Documentation

BitmapSource()

VideoOS.Platform.Client.BitmapSource.BitmapSource ( )

inline

Member Function Documentation

Close()

void VideoOS.Platform.Client.BitmapSource.Close ( bool wait = false )

inline

Close the initialized class. The background thread is flagged to stop, and if the wait parameter is true the method will wait for it to finish, max wait time is 5 seconds.

Init()

void VideoOS.Platform.Client.BitmapSource.Init ( )

inline

Initalizes the class and starts a background thread.

This method may only be called once, until Close(bool) has been called.

LiveStart()

void VideoOS.Platform.Client.BitmapSource.LiveStart ( )

inline

LiveStop()

void VideoOS.Platform.Client.BitmapSource.LiveStop ( )

inline

NewBitmapEventHandler()

delegate void VideoOS.Platform.Client.BitmapSource.NewBitmapEventHandler

(

Bitmap

bitmap

)

Parameters

bitmap

Property Documentation

InstanceFQID

FQID VideoOS.Platform.Client.BitmapSource.InstanceFQID

get

IsInitialized

bool VideoOS.Platform.Client.BitmapSource.IsInitialized

get

Returns true when Init() has been called, and false after the Close() has been called.

Item

Item VideoOS.Platform.Client.BitmapSource.Item

getset

PlaybackFQID

FQID VideoOS.Platform.Client.BitmapSource.PlaybackFQID

getset

Selected

bool VideoOS.Platform.Client.BitmapSource.Selected

getset

Size

Size VideoOS.Platform.Client.BitmapSource.Size

getset

StreamId

Guid VideoOS.Platform.Client.BitmapSource.StreamId

getset

The id of the stream to be used for the live stream.

Default value is Guid.Empty and will provide the default live stream.

When changing the StreamId while a live stream is being shown, call LiveStop / LiveStart to utilize the new StreamId.

Event Documentation

NewBitmapEvent

NewBitmapEventHandler VideoOS.Platform.Client.BitmapSource.NewBitmapEvent