C# Class Accord.Controls.VideoSourcePlayer

Show file Open project: accord-net/framework Class Usage Examples

Private Properties

Property	Type	Description
CheckForCrossThreadAccess	void
InitializeComponent	void
UpdatePosition	void
VideoSourcePlayer_Paint	void
VideoSourcePlayer_ParentChanged	void
parent_SizeChanged	void
videoSource_NewFrame	void
videoSource_PlayingFinished	void
videoSource_VideoSourceError	void

Public Methods

Method	Description
GetCurrentVideoFrame ( ) : Bitmap	Get clone of current video frame displayed by the control.
SignalToStop ( ) : void	Signal video source to stop. Use WaitForStop method to wait until video source stops.
Start ( ) : void	Start video source and displaying its frames.
Stop ( ) : void	Stop video source. The method stops video source by calling its Accord.Video.IVideoSource.Stop method, which abourts internal video source's thread. Use SignalToStop and WaitForStop for more polite video source stopping, which gives a chance for video source to perform proper shut down and clean up.
VideoSourcePlayer ( ) : System	Initializes a new instance of the VideoSourcePlayer class.
WaitForStop ( ) : void	Wait for video source has stopped. Waits for video source stopping after it was signaled to stop using SignalToStop method. If SignalToStop was not called, then it will be called automatically.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.

Private Methods

Method	Description
CheckForCrossThreadAccess ( ) : void
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
UpdatePosition ( ) : void
VideoSourcePlayer_Paint ( object sender, PaintEventArgs e ) : void
VideoSourcePlayer_ParentChanged ( object sender, EventArgs e ) : void
parent_SizeChanged ( object sender, EventArgs e ) : void
videoSource_NewFrame ( object sender, NewFrameEventArgs eventArgs ) : void
videoSource_PlayingFinished ( object sender, ReasonToFinishPlaying reason ) : void
videoSource_VideoSourceError ( object sender, VideoSourceErrorEventArgs eventArgs ) : void

Method Details

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	true if managed resources should be disposed; otherwise, false.
return	void

GetCurrentVideoFrame() public method

Get clone of current video frame displayed by the control.

public GetCurrentVideoFrame ( ) : Bitmap
return	Bitmap

SignalToStop() public method

Signal video source to stop.

Use WaitForStop method to wait until video source stops.

public SignalToStop ( ) : void
return	void

Start() public method

Start video source and displaying its frames.

public Start ( ) : void
return	void

Stop() public method

Stop video source.

The method stops video source by calling its Accord.Video.IVideoSource.Stop method, which abourts internal video source's thread. Use SignalToStop and WaitForStop for more polite video source stopping, which gives a chance for video source to perform proper shut down and clean up.

public Stop ( ) : void
return	void

VideoSourcePlayer() public method

Initializes a new instance of the VideoSourcePlayer class.

public VideoSourcePlayer ( ) : System
return	System

WaitForStop() public method

Wait for video source has stopped.

Waits for video source stopping after it was signaled to stop using SignalToStop method. If SignalToStop was not called, then it will be called automatically.

public WaitForStop ( ) : void
return	void