Class VideoView

VideoView control for WinForms.

Inheritance
object
MarshalByRefObject
Component
Control
ScrollableControl
Panel
VideoView
Implements
Inherited Members
Namespace: VisioForge.Core.UI.WinForms
Assembly: VisioForge.Core.dll
Syntax
public class VideoView : Panel, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, IVideoView

Constructors

VideoView()

Initializes a new instance of the VideoView class.

Declaration
public VideoView()

Properties

StatusOverlay

Gets or sets status overlay that is active after Start/StartAsync call but before actual video streaming. The overlay can be used for IP cameras connection progress. Use TextStatusOverlay to configure text overlay.

Declaration
public IStatusOverlay StatusOverlay { get; set; }
Property Value
Type Description
IStatusOverlay

Methods

Attach(IMPVCVECore)

Attaches parent.

Declaration
public void Attach(IMPVCVECore parent)
Parameters
Type Name Description
IMPVCVECore parent

Parent.

CallInvoke(Delegate, params object[])

Calls the Invoke.

Declaration
public void CallInvoke(Delegate method, params object[] args)
Parameters
Type Name Description
Delegate method

The method.
object[] args

The arguments.

CallRefresh()

Calls the refresh.

Declaration
public void CallRefresh()

ClearUI()

Clears the UI.

Declaration
public void ClearUI()

Detach(IMPVCVECore)

Detaches parent.

Declaration
public void Detach(IMPVCVECore parent)
Parameters
Type Name Description
IMPVCVECore parent

Parent.

Dispose(bool)

Dispose.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

Disposing parameter.
Overrides
Control.Dispose(bool)

GetBackgroundColor()

Gets the color of the background.

Declaration
public SKColor GetBackgroundColor()
Returns
Type Description
SKColor

SKColor.

GetHandle()

Gets window handle.

Declaration
public nint GetHandle()
Returns
Type Description
nint

Returns nint.

GetInvokeRequired()

Gets the invoke required.

Declaration
public bool GetInvokeRequired()
Returns
Type Description
bool

true if the invoke is required, false otherwise.

GetIsHandleCreated()

Gets the is handle created.

Declaration
public bool GetIsHandleCreated()
Returns
Type Description
bool

true if the handle is created, false otherwise.

GetSize()

Gets size.

Declaration
public Size GetSize()
Returns
Type Description
Size

Return Size.

GetUIEngine()

Gets UI engine.

Declaration
public VideoViewUIEngine GetUIEngine()
Returns
Type Description
VideoViewUIEngine

Returns VideoViewUIEngine.

InvokeStart()

Invokes Start().

Declaration
public void InvokeStart()

InvokeStartComplete()

Invokes Start(), complete.

Declaration
public void InvokeStartComplete()

InvokeStop()

Invokes Stop().

Declaration
public void InvokeStop()

InvokeVideoRendererUpdate()

Invokes VideoRendererUpdate().

Declaration
public void InvokeVideoRendererUpdate()

LogDialogClear()

Clears logs dialog.

Declaration
public void LogDialogClear()

LogDialogClose()

Closes logs dialog.

Declaration
public void LogDialogClose()

LogDialogError(string)

Logs the error in a custom dialog.

Declaration
public void LogDialogError(string msg)
Parameters
Type Name Description
string msg

The message.

OnPaint(PaintEventArgs)

OnPaint override.

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
PaintEventArgs e

Event args.
Overrides
Control.OnPaint(PaintEventArgs)

OnPropertyChanged(string)

OnPropertyChanged API.

Declaration
protected virtual void OnPropertyChanged(string propertyName = null)
Parameters
Type Name Description
string propertyName

Property name.

PictureBoxCreate(int, int)

Create the PictureBox.

Declaration
public void PictureBoxCreate(int width, int height)
Parameters
Type Name Description
int width

The width.
int height

The height.

PictureBoxDestroy()

Destroys the PictureBox.

Declaration
public void PictureBoxDestroy()

PictureBoxExists()

Is the PictureBox exists.

Declaration
public bool PictureBoxExists()
Returns
Type Description
bool

true if exists, false otherwise.

PictureBoxGetImage()

Gets the PictureBox image.

Declaration
public Bitmap PictureBoxGetImage()
Returns
Type Description
Bitmap

Bitmap.

PictureBoxSetImage(Bitmap)

Set the image on PictureBox.

Declaration
public void PictureBoxSetImage(Bitmap image)
Parameters
Type Name Description
Bitmap image

The image.

PushMouseButtonDown(int, int, MouseButton)

Pushes the mouse button down.

Declaration
public void PushMouseButtonDown(int x, int y, MouseButton button)
Parameters
Type Name Description
int x

The x.
int y

The y.
MouseButton button

The button.

PushMouseButtonUp(int, int, MouseButton)

Pushes the mouse button up.

Declaration
public void PushMouseButtonUp(int x, int y, MouseButton button)
Parameters
Type Name Description
int x

The x.
int y

The y.
MouseButton button

The button.

PushMouseMove(int, int)

Pushes the mouse move.

Declaration
public void PushMouseMove(int x, int y)
Parameters
Type Name Description
int x

The x.
int y

The y.

ResizeRoundTo(int)

Resizes the VideoView round to value.

Declaration
public void ResizeRoundTo(int round)
Parameters
Type Name Description
int round

The value.

SetHandle(nint)

Sets the handle. Not implemented.

Declaration
public void SetHandle(nint handle)
Parameters
Type Name Description
nint handle

The handle.
Exceptions
Type Condition
NotImplementedException

Not implemented.

ShowMessage(string)

Shows the message.

Declaration
public MessageBoxResult ShowMessage(string message)
Parameters
Type Name Description
string message

The message.
Returns
Type Description
MessageBoxResult

MessageBoxResult.

Events

OnMouseButtonDown

Occurs when mouse button down.

Declaration
public event EventHandler<MouseButtonEventArgs> OnMouseButtonDown
Event Type
Type Description
EventHandler<MouseButtonEventArgs>

OnMouseButtonUp

Occurs when mouse button up.

Declaration
public event EventHandler<MouseButtonEventArgs> OnMouseButtonUp
Event Type
Type Description
EventHandler<MouseButtonEventArgs>

OnMouseMoved

Occurs when mouse moved.

Declaration
public event EventHandler<MouseMoveEventArgs> OnMouseMoved
Event Type
Type Description
EventHandler<MouseMoveEventArgs>

PropertyChanged

Property changed event.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
PropertyChangedEventHandler

Implements

IDropTarget
ISynchronizeInvoke
IWin32Window
IBindableComponent
IComponent
IDisposable
INotifyPropertyChanged
IVideoView