VideoOS.Platform.Live.RawLiveSource Class Reference

Provides raw video frames, including GenericByteHeader, for further analysis and decoding. More...

Inheritance diagram for VideoOS.Platform.Live.RawLiveSource:

Public Member Functions
	RawLiveSource (Item item)
	Construct the class for use of video from the defined Item. The Item can be an ImageServer owned camera, or a Corporate database file.
Public Member Functions inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceRawContent, LiveContentRawEventArgs >
override void	Close ()
	See the specific LiveSource implementation for documentation.
override void	Init ()
	Initialize and connect to the source of the video.
void	ReleaseObject (IDisposable usedObject)
	Deprecated. May be deleted in the future.

Protected Member Functions
override object	ConnectLiveSource (string media)
	ConnectLiveSource(string media) base class overritable.
override void	HandleLiveDataContent (LiveSourceRawContent data)
	HandleLiveDataContent(LiveSourceRawContent data) base class overritable.
override void	OnUpdateLiveStart ()
	OnUpdateLiveStart() base class overritable.
override void	OnUpdateSettings ()
	OnUpdateSettings() base class overritable.
Protected Member Functions inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceRawContent, LiveContentRawEventArgs >
	BaseLiveSource (Item item, IEnumerable< Guid > supportedTypes, bool isRawSource)
	Construct the class for use of video from the defined Item. The Item can be an ImageServer owned camera, or a Corporate database file.
void	ConnectAndStartLiveSource ()
object	ConnectLiveSource (string media)
	Method to be overriten in the inheritors.
void	HandleLiveDataContent (TLiveContent data)
	Called on received data. Should be overrriten in the inheritors.
bool	OnLiveContentEvent (EventArgs eventArgs)
	Called when data is received.
void	OnLiveStatusEvent (EventArgs eventArgs)
	Called when status is received.
void	OnUpdateLiveStart ()
	Called when Live start is updated. Used from inheritors to do specific intializations.
void	OnUpdateSettings ()
	Used by inheritors to update some settings.
void	StopAndDisconnectLiveSource ()

Properties
bool	EnableMulticast [get, set]
	Specify whether multicast should be used if supported by and enabled on the server. Must be set before calling BaseLiveSource<LiveSourceRawContent, LiveContentRawEventArgs>.Init() Default is false. Only supported in Smart Client and standalone.
bool	RequestSignatures [get, set]
	Defines if the signatures should be passed from the DB layer to the application - can be used when the video database is signed. The Application can use this to validate the frames as being authentic.
Properties inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceRawContent, LiveContentRawEventArgs >
TimeSpan	ConnectTimeout [get, set]
	Timeout for connecting. If not set the timeout is infinite.
StatusFlags	CurrentStatusFlags [get]
	Holds the current status. It is also possible to be immediately informed about status changes by subscribing to the LiveStatusEvent.
bool	IsInitialized [get]
	Returns true when Init has been called, and false after Close() has been called.
bool	IsRawSource [get, set]
	Property describing if the live source will get raw data or not.
override Item	Item [get, set]
	The camera Item to receive live video from.
override bool	LiveModeStart [get, set]
	Start the live feed. Frames will be passed through the LiveNotificationEvent event.
bool	MulticastEnabled [get, protected set]
	Tells whether multicast is enabled for current stream.
bool	SendInitialImage [get, set]
	Informs RS to send cached old image in case of missing live at the moment.
object	SessionId [get]
	Session object that can be used by the inheritors or users of the component.
Guid	StreamId [get, set]
	Can be used to identify which stream to use, when more than one is available. Multiple streams are available in XProtect Corporate. When set to Guid.Empty, the default stream will be used.
virtual IStreamSelectionParams	StreamSelectionParams [get]
	Allows configuration/selection of the specific camera stream.
IEnumerable< Guid >	SupportedItemTypes [get, set]
	List of supported item Types.

Additional Inherited Members
Package Functions inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceRawContent, LiveContentRawEventArgs >
Events inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceRawContent, LiveContentRawEventArgs >
override EventHandler	LiveContentEvent
	This event is fired for every new live frame. The EventArgs passed on with this event is the LiveContentEventArgs/LiveContentRawEventArgs containing the frame and properties.
override 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

Provides raw video frames, including GenericByteHeader, for further analysis and decoding.

Note: Is only implemented in the Smart Client and in the MIP SDK for component integration.

Constructor & Destructor Documentation

RawLiveSource()

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

inline

Construct the class for use of video from the defined Item. The Item can be an ImageServer owned camera, or a Corporate database file.

Parameters

item

Member Function Documentation

ConnectLiveSource()

override object VideoOS.Platform.Live.RawLiveSource.ConnectLiveSource ( string media )

inlineprotected

ConnectLiveSource(string media) base class overritable.

Parameters

media

HandleLiveDataContent()

override void VideoOS.Platform.Live.RawLiveSource.HandleLiveDataContent ( LiveSourceRawContent data )

inlineprotected

HandleLiveDataContent(LiveSourceRawContent data) base class overritable.

Parameters

data

OnUpdateLiveStart()

override void VideoOS.Platform.Live.RawLiveSource.OnUpdateLiveStart ( )

inlineprotected

OnUpdateLiveStart() base class overritable.

OnUpdateSettings()

override void VideoOS.Platform.Live.RawLiveSource.OnUpdateSettings ( )

inlineprotected

OnUpdateSettings() base class overritable.

Property Documentation

EnableMulticast

bool VideoOS.Platform.Live.RawLiveSource.EnableMulticast

getset

Specify whether multicast should be used if supported by and enabled on the server. Must be set before calling BaseLiveSource<LiveSourceRawContent, LiveContentRawEventArgs>.Init() Default is false.
Only supported in Smart Client and standalone.

RequestSignatures

bool VideoOS.Platform.Live.RawLiveSource.RequestSignatures

getset

Defines if the signatures should be passed from the DB layer to the application - can be used when the video database is signed. The Application can use this to validate the frames as being authentic.