This class is responsible for delivering live bitmap images from a camera.
Only supported in Smart Client and standalone environments. More...

Inheritance diagram for VideoOS.Platform.Live.BitmapLiveSource:

Public Member Functions
	BitmapLiveSource (Item item, BitmapFormat bitmapFormat)
	Initialize an instance of BitmapLiveSource and set the camera and Bitmap format.

Public Member Functions inherited from VideoOS.Platform.Live.VideoLiveSource
override void	Close ()
	Close the source.

override void	Init ()
	Initialize the source.

void	ResumeSettingsUpdate ()
	Calling this method will allow the system to perform the peding settings changes done between calling the SuspendSettingUpdate and this method.

void	SetCropRectangle (double x, double y, double width, double height)
	Define a cropping rectangle of what part of the image to pick out. The values are all between 0.0 up to 1.0 as a relative part of the original image. To crop out a lower right hand rectangle these values could apply: SetCropRectangle( 0.5, 0.5, 0.25, 0.25 );.

void	SetKeepAspectRatio (bool keepAspectRatio, bool fillSpace)
	Instruct the Media Toolkit to keep the aspect ratio for the transcoded frames. This method must be called before the Init call. For this feature to work, remember to fill (and update) the Width and Height according to the actual display area being used.

void	SetWidthHeight ()
	Enforce the changed width and height properties.

void	SuspendSettingsUpdate ()
	Calling this method will suspend the change to any settings, until a ResumeSettingsUpdate has been called.

Public Member Functions inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceContent, LiveContentEventArgs >
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)

Protected Member Functions inherited from VideoOS.Platform.Live.VideoLiveSource
override void	HandleLiveDataContent (LiveSourceContent data)

override void	OnUpdateLiveStart ()

override void	OnUpdateSettings ()

	VideoLiveSource (Item item)

Protected Member Functions inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceContent, LiveContentEventArgs >
	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 ()

Additional Inherited Members
Package Functions inherited from VideoOS.Platform.Live.VideoLiveSource
Package Functions inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceContent, LiveContentEventArgs >
Properties inherited from VideoOS.Platform.Live.VideoLiveSource
bool	AllowUpscaling `[get, set]`
	Gets or sets whether upscaling is allowed.

int	Compression `[get, set]`
	The compression of the JPEGs. A value between 1..100. The default value is 75.

object	CustomData `[get, set]`
	Can be set to any value or class that is used by the application. The current value will be 'returned' in any subsequent JPEGData on next received frame.

bool	EnableMulticast `[get, set]`
	Specify whether multicast should be used if supported by and enabled on the server. Must be set before calling Init() Default is false. Only supported in Smart Client and standalone.

bool	FillWithBlack `[get]`
	Specify if black bars to be inserted in the picture in order to achive desired aspect.

int	FPS `[get, set]`
	Possible downscale of FPS.

int	Height `[get, set]`
	The requested height of the images. You can set this field to retrieve images in a specific size.

bool	KeepAspectRatio `[get]`
	Specify if aspect of the picture should be kept or not.

bool	KeyFramesOnly `[get, set]`
	Specify if the underlying decoding should only decode the key frames. Default is false -> all frames decoded.

int	Width `[get, set]`
	The requested width of the images. You can set this field to retrieve images in a specific size.

Properties inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceContent, LiveContentEventArgs >
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.

Events inherited from VideoOS.Platform.Live.BaseLiveSource< LiveSourceContent, LiveContentEventArgs >
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

This class is responsible for delivering live bitmap images from a camera.
Only supported in Smart Client and standalone environments.

Constructor & Destructor Documentation

◆ BitmapLiveSource()

VideoOS.Platform.Live.BitmapLiveSource.BitmapLiveSource	(	Item	item,
		BitmapFormat	bitmapFormat )

inline

Initialize an instance of BitmapLiveSource and set the camera and Bitmap format.

Member Function Documentation

◆ ConnectLiveSource()

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

inlineprotected

Parameters

media

Returns

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BitmapLiveSource()

Member Function Documentation

◆ ConnectLiveSource()