VideoControl is an easy to use UI component for showing a camera view in MIP plugin UI. The control creates a view of cameras having the same functionality as a normal view in the Smart Client. This means that features like live mode, playback mode, playback synchronization, camera selection, camera maximization, PTZ, independent playback, camera toolbar, timeline etc. is handled automatically by the control. More...

Inheritance diagram for VideoOS.Platform.Client.VideoControl:

Public Member Functions
virtual void	ClearOverlay (int cameraIndex, int id)
	Clear a specific overlay placed earlier. The id used during the SetOverlay() call is used in this method for clearing that overlay again.

void	Close ()
	Closes the VideoControl. Call this method when it is removed from the UI.

virtual Size	GetPaintSize (int cameraIndex)
	Get the paint size of the image viewer control at the specified index. Use this for generating overlay of the correct dimensions.

virtual void	SetOverlay (int cameraIndex, Bitmap bitmap, int id, bool keepAspectRatio, bool scaleWithDigitalZoom, bool scaleOverlay, double scaleFactor, DockStyle verticalDock, DockStyle horizontalDock, double absolutePosX, double absolutePosY)
	Set an overlay on top of the video being displayed.

virtual void	SetTimelineSelection (DateTime from, DateTime to)
	Enables time selection mode and applies the provided selection times.

virtual Guid	ShapesOverlayAdd (int cameraIndex, List< Shape > overlayShapes, ShapesOverlayRenderParameters renderParameters)
	Set an overlay on top of the video being displayed. The returned id is used for updating and removing the overlay. If the specified cameraIndex is invalid, Guid.Empty will be retuned.

virtual void	ShapesOverlayRemove (int cameraIndex, Guid id)
	Clear a specific overlay placed earlier. The id used during the ShapesOverlayAdd() call is used in this method for clearing that overlay again.

virtual bool	ShapesOverlayUpdate (int cameraIndex, Guid id, List< Shape > overlayShapes, ShapesOverlayRenderParameters renderParameters)
	Update a specific overlay placed earlier. The id used during the ShapesOverlayAdd() call is used in this method for updating that overlay.

Protected Member Functions
virtual void	OnPlaybackTimeChanged ()
	Internally used to call on event PlaybackTimeChanged.

	VideoControl ()

Properties
bool	AutoSelectFirstCamera `[get, set]`
	Gets or sets whether the first camera should be auto selected by the control when the camera view is loaded.

List< FQID >	Cameras `[get, set]`
	Gets or sets the list of cameras shown by the control. When set a layout matching the numbers of cameras will automatically be created.

bool	Live `[get, set]`
	Gets or sets whether the control is in live mode or not. If set to false then the control is in playback mode.

DateTime	PlaybackTime `[get, set]`
	Gets or sets the current playback time.

FQID	SelectedCamera `[get, set]`
	Gets or sets the current selected camera.

virtual TimelineMode	TimelineMode `[get, set]`
	Gets or sets the timeline mode shown by the control.

virtual TimeSpan	TimelineSpan `[get, set]`
	Gets or sets the timeline span.

Guid	WindowId `[get, protected set]`
	Gets the window ID assigned to this VideoControl (not to be confused with the ID of the window containing the control).

Events
virtual EventHandler	PlaybackTimeChanged
	Event that is fired when the playback time changed. The new playback time can be accessed through the PlaybackTime property.

EventHandler	SelectedCameraChanged
	Event that is fired when the selected camera is changed. The new selected camera can be accessed through the SelectedCamera property.

Detailed Description

VideoControl is an easy to use UI component for showing a camera view in MIP plugin UI. The control creates a view of cameras having the same functionality as a normal view in the Smart Client. This means that features like live mode, playback mode, playback synchronization, camera selection, camera maximization, PTZ, independent playback, camera toolbar, timeline etc. is handled automatically by the control.

Constructor & Destructor Documentation

◆ VideoControl()

VideoOS.Platform.Client.VideoControl.VideoControl ( )

inlineprotected

Member Function Documentation

◆ ClearOverlay()

virtual void VideoOS.Platform.Client.VideoControl.ClearOverlay	(	int	cameraIndex,
		int	id )

inlinevirtual

Clear a specific overlay placed earlier. The id used during the SetOverlay() call is used in this method for clearing that overlay again.

Parameters

cameraIndex	The index of the camera in Cameras that the overlay should be applied on
id

◆ Close()

void VideoOS.Platform.Client.VideoControl.Close ( )

abstract

Closes the VideoControl. Call this method when it is removed from the UI.

◆ GetPaintSize()

virtual Size VideoOS.Platform.Client.VideoControl.GetPaintSize ( int cameraIndex )

inlinevirtual

Get the paint size of the image viewer control at the specified index. Use this for generating overlay of the correct dimensions.

Parameters

cameraIndex The index of the camera in Cameras

Returns

◆ OnPlaybackTimeChanged()

virtual void VideoOS.Platform.Client.VideoControl.OnPlaybackTimeChanged ( )

inlineprotectedvirtual

Internally used to call on event PlaybackTimeChanged.

◆ SetOverlay()

virtual void VideoOS.Platform.Client.VideoControl.SetOverlay	(	int	cameraIndex,
		Bitmap	bitmap,
		int	id,
		bool	keepAspectRatio,
		bool	scaleWithDigitalZoom,
		bool	scaleOverlay,
		double	scaleFactor,
		DockStyle	verticalDock,
		DockStyle	horizontalDock,
		double	absolutePosX,
		double	absolutePosY )

inlinevirtual

Set an overlay on top of the video being displayed.

Parameters

cameraIndex	The index of the camera in Cameras that the overlay should be applied on
bitmap
id
keepAspectRatio
scaleWithDigitalZoom
scaleOverlay
scaleFactor
verticalDock
horizontalDock
absolutePosX
absolutePosY

◆ SetTimelineSelection()

virtual void VideoOS.Platform.Client.VideoControl.SetTimelineSelection	(	DateTime	from,
		DateTime	to )

inlinevirtual

Enables time selection mode and applies the provided selection times.

Parameters

from	The beginning of the selection.
to	The end of the selection.

◆ ShapesOverlayAdd()

virtual Guid VideoOS.Platform.Client.VideoControl.ShapesOverlayAdd	(	int	cameraIndex,
		List< Shape >	overlayShapes,
		ShapesOverlayRenderParameters	renderParameters )

inlinevirtual

Set an overlay on top of the video being displayed. The returned id is used for updating and removing the overlay. If the specified cameraIndex is invalid, Guid.Empty will be retuned.

Parameters

cameraIndex	The index of the camera in Cameras that the overlay should be applied on
overlayShapes
renderParameters

Returns

◆ ShapesOverlayRemove()

virtual void VideoOS.Platform.Client.VideoControl.ShapesOverlayRemove	(	int	cameraIndex,
		Guid	id )

inlinevirtual

Clear a specific overlay placed earlier. The id used during the ShapesOverlayAdd() call is used in this method for clearing that overlay again.

Parameters

cameraIndex	The index of the camera in Cameras that the overlay should be applied on
id	Id of the overlay to remove

◆ ShapesOverlayUpdate()

virtual bool VideoOS.Platform.Client.VideoControl.ShapesOverlayUpdate	(	int	cameraIndex,
		Guid	id,
		List< Shape >	overlayShapes,
		ShapesOverlayRenderParameters	renderParameters )

inlinevirtual

Update a specific overlay placed earlier. The id used during the ShapesOverlayAdd() call is used in this method for updating that overlay.

Parameters

cameraIndex	The index of the camera in Cameras that the overlay should be applied on
id	Id of the overlay to update
overlayShapes
renderParameters

Returns

Property Documentation

◆ AutoSelectFirstCamera

bool VideoOS.Platform.Client.VideoControl.AutoSelectFirstCamera

getsetabstract

Gets or sets whether the first camera should be auto selected by the control when the camera view is loaded.

◆ Cameras

List<FQID> VideoOS.Platform.Client.VideoControl.Cameras

getsetabstract

Gets or sets the list of cameras shown by the control. When set a layout matching the numbers of cameras will automatically be created.

◆ Live

bool VideoOS.Platform.Client.VideoControl.Live

getsetabstract

Gets or sets whether the control is in live mode or not. If set to false then the control is in playback mode.

◆ PlaybackTime

DateTime VideoOS.Platform.Client.VideoControl.PlaybackTime

getsetabstract

Gets or sets the current playback time.

◆ SelectedCamera

FQID VideoOS.Platform.Client.VideoControl.SelectedCamera

getsetabstract

Gets or sets the current selected camera.

◆ TimelineMode

virtual TimelineMode VideoOS.Platform.Client.VideoControl.TimelineMode

getset

Gets or sets the timeline mode shown by the control.

◆ TimelineSpan

virtual TimeSpan VideoOS.Platform.Client.VideoControl.TimelineSpan

getset

Gets or sets the timeline span.

◆ WindowId

Guid VideoOS.Platform.Client.VideoControl.WindowId

getprotected set

Gets the window ID assigned to this VideoControl (not to be confused with the ID of the window containing the control).

Event Documentation

◆ PlaybackTimeChanged

virtual EventHandler VideoOS.Platform.Client.VideoControl.PlaybackTimeChanged

Event that is fired when the playback time changed. The new playback time can be accessed through the PlaybackTime property.

◆ SelectedCameraChanged

EventHandler VideoOS.Platform.Client.VideoControl.SelectedCameraChanged

abstract

Event that is fired when the selected camera is changed. The new selected camera can be accessed through the SelectedCamera property.

Public Member Functions

Protected Member Functions

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ VideoControl()

Member Function Documentation

◆ ClearOverlay()

◆ Close()

◆ GetPaintSize()

◆ OnPlaybackTimeChanged()

◆ SetOverlay()

◆ SetTimelineSelection()

◆ ShapesOverlayAdd()

◆ ShapesOverlayRemove()

◆ ShapesOverlayUpdate()

Property Documentation

◆ AutoSelectFirstCamera

◆ Cameras

◆ Live

◆ PlaybackTime

◆ SelectedCamera

◆ TimelineMode

◆ TimelineSpan

◆ WindowId

Event Documentation

◆ PlaybackTimeChanged

◆ SelectedCameraChanged