VideoOS.Platform.Live.LiveSource Class Reference

An abstract class to be used for implementation of a LiveSources.
Within the MIP Environment there are currently these built-in implementations:
JPEGLiveSource
BitmapLiveSource
RawLiveSource
More...

Inheritance diagram for VideoOS.Platform.Live.LiveSource:

Public Member Functions
virtual void	Close ()
	See the specific LiveSource implementation for documentation.
virtual void	Init ()
	See the specific LiveSource implementation for documentation.

Protected Member Functions
	LiveSource ()
	Construct a LiveSource. The Item need to be initialized before the Init call.
	LiveSource (Item item)
	Construct a LiveSource based on the Item given as parameter.
void	ProcessingNewFrame ()
	Signal that an implementation has passed on a new frame to a client.
bool	ProcessNextFrame ()
	Tells if the client is not ready to process the next frame when SingleFrameQueue is active.

Properties
virtual Item	Item [get, set]
	See the specific LiveSource implementation for documentation.
virtual bool	LiveModeStart [get, set]
	This flag controls the ongoing stream of live packages. When the user UI is shortly doing something else, this flag can be set to false, to avoid packages passing the network but not used.
bool	SingleFrameQueue [get, set]
	Defines if only ONE frame should be forwarded to the application at any given time.

Events
EventHandler	LiveContentEvent
	This event is fired for every new live frame. The EventArgs passed on with this event is the LiveContentEventArgs or LiveContentRawEventArgs containing the frame and properties.
EventHandler	LiveStatusEvent
	This event is fired when new live status information is available. The EventArgs passed on with this event is the LiveStatusEventArgs containing flag information about the current status of the camera connection.

Detailed Description

An abstract class to be used for implementation of a LiveSources.
Within the MIP Environment there are currently these built-in implementations:
JPEGLiveSource
BitmapLiveSource
RawLiveSource

Construct one of these classes with the Item as parameter, e.g.

JPEGLiveSource myJpeg = new JPEGLiveSource( cameraItem )

;

Constructor & Destructor Documentation

LiveSource() [1/2]

VideoOS.Platform.Live.LiveSource.LiveSource ( )

inlineprotected

Construct a LiveSource. The Item need to be initialized before the Init call.

LiveSource() [2/2]

VideoOS.Platform.Live.LiveSource.LiveSource ( Item item )

inlineprotected

Construct a LiveSource based on the Item given as parameter.

Parameters

item

Member Function Documentation

Close()

virtual void VideoOS.Platform.Live.LiveSource.Close ( )

inlinevirtual

See the specific LiveSource implementation for documentation.

Reimplemented in VideoOS.Platform.Live.BaseLiveSource< TLiveContent, TLiveContentEventArgs >.

Init()

virtual void VideoOS.Platform.Live.LiveSource.Init ( )

inlinevirtual

See the specific LiveSource implementation for documentation.

Reimplemented in VideoOS.Platform.Live.BaseLiveSource< TLiveContent, TLiveContentEventArgs >.

ProcessingNewFrame()

void VideoOS.Platform.Live.LiveSource.ProcessingNewFrame ( )

inlineprotected

Signal that an implementation has passed on a new frame to a client.

ProcessNextFrame()

bool VideoOS.Platform.Live.LiveSource.ProcessNextFrame ( )

inlineprotected

Tells if the client is not ready to process the next frame when SingleFrameQueue is active.

Returns

true if the client is still processing the old frame

Property Documentation

Item

virtual Item VideoOS.Platform.Live.LiveSource.Item

getset

See the specific LiveSource implementation for documentation.

LiveModeStart

virtual bool VideoOS.Platform.Live.LiveSource.LiveModeStart

getset

This flag controls the ongoing stream of live packages. When the user UI is shortly doing something else, this flag can be set to false, to avoid packages passing the network but not used.

SingleFrameQueue

bool VideoOS.Platform.Live.LiveSource.SingleFrameQueue

getset

Defines if only ONE frame should be forwarded to the application at any given time.

Event Documentation

LiveContentEvent

EventHandler VideoOS.Platform.Live.LiveSource.LiveContentEvent

abstract

This event is fired for every new live frame.
The EventArgs passed on with this event is the LiveContentEventArgs or LiveContentRawEventArgs containing the frame and properties.

LiveStatusEvent

EventHandler VideoOS.Platform.Live.LiveSource.LiveStatusEvent

abstract

This event is fired when new live status information is available.
The EventArgs passed on with this event is the LiveStatusEventArgs containing flag information about the current status of the camera connection.