Class VideoCaptureCoreX
Class VideoCaptureCoreX. Implements the IDisposable Implements the IAsyncDisposable
Inherited Members
Namespace: VisioForge.Core.VideoCaptureX
Assembly: VisioForge.Core.dll
Syntax
public class VideoCaptureCoreX : IDisposable, IAsyncDisposable
Constructors
VideoCaptureCoreX()
Initializes a new instance of the VideoCaptureCoreX class.
Declaration
public VideoCaptureCoreX()
VideoCaptureCoreX(IVideoView)
Initializes a new instance of the VideoCaptureCoreX class.
Declaration
public VideoCaptureCoreX(IVideoView videoView)
Parameters
| Type | Name | Description |
|---|---|---|
| IVideoView | videoView | The video view. |
Properties
Audio_OutputDevice
Gets or sets the audio output.
Declaration
public IAudioRendererSettings Audio_OutputDevice { get; set; }
Property Value
| Type | Description |
|---|---|
| IAudioRendererSettings | The audio output. |
Audio_OutputDevice_Mute
Gets or sets a value indicating whether audio output device mute is enabled.
Declaration
public bool Audio_OutputDevice_Mute { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Audio_OutputDevice_Volume
Gets or sets the audio output device volume [0.0-1.0].
Declaration
public double Audio_OutputDevice_Volume { get; set; }
Property Value
| Type | Description |
|---|---|
| double |
Audio_Play
Gets or sets a value indicating whether audio playback is enabled.
Declaration
public bool Audio_Play { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Audio_Record
Gets or sets a value indicating whether audio recording is enabled.
Declaration
public bool Audio_Record { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Audio_Source
Gets or sets the audio source.
Declaration
public IVideoCaptureBaseAudioSourceSettings Audio_Source { get; set; }
Property Value
| Type | Description |
|---|---|
| IVideoCaptureBaseAudioSourceSettings |
Audio_VU_Meter_Enabled
Gets or sets a value indicating whether audio VU meter is enabled].
Declaration
public bool Audio_VU_Meter_Enabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Barcode_Reader_Enabled
Gets or sets a value indicating whether barcode detection is enabled.
Declaration
public bool Barcode_Reader_Enabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Debug_Dir
Gets or sets debug directory.
Declaration
public string Debug_Dir { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Debug_DisableMessageDialogs
Gets or sets a value indicating whether message dialog will be shown in case of error if OnError event is not implemented.
Declaration
public bool Debug_DisableMessageDialogs { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Debug_Mode
Gets or sets a value indicating whether debug mode enabled.
Declaration
public bool Debug_Mode { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Debug_Telemetry
Gets or sets a value indicating whether sending telemetry enabled (only during debugging in Visual Studio).
Declaration
public bool Debug_Telemetry { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Remarks
Only anonymous data will be send.
Face_Tracking
Gets or sets face tracking settings.
Declaration
public FaceTrackingSettings Face_Tracking { get; set; }
Property Value
| Type | Description |
|---|---|
| FaceTrackingSettings |
Fonts
Gets the fonts names.
Declaration
public ObservableCollection<FontDescriptionX> Fonts { get; }
Property Value
| Type | Description |
|---|---|
| ObservableCollection<FontDescriptionX> | The fonts names. |
Motion_Detection
Gets or sets object detection settings.
Declaration
public MotionDetectionExSettings Motion_Detection { get; set; }
Property Value
| Type | Description |
|---|---|
| MotionDetectionExSettings |
SDK_BuildDate
Gets SDK build date.
Declaration
public static DateTime SDK_BuildDate { get; }
Property Value
| Type | Description |
|---|---|
| DateTime |
SDK_Version
Gets SDK version.
Declaration
public static Version SDK_Version { get; }
Property Value
| Type | Description |
|---|---|
| Version |
Snapshot_Grabber_Enabled
Gets or sets a value indicating whether the snapshot grabber is enabled. It should be enabled before calling Start/StartAsync method.
Declaration
public bool Snapshot_Grabber_Enabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
State
Gets or sets the state.
Declaration
public PlaybackState State { get; set; }
Property Value
| Type | Description |
|---|---|
| PlaybackState | The state. |
Subtitles_Enabled
Gets or sets a value indicating whether subtitles is enabled.
Declaration
public bool Subtitles_Enabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Subtitles_ExternalFile
Gets or sets the subtitles external file.
Declaration
public Uri Subtitles_ExternalFile { get; set; }
Property Value
| Type | Description |
|---|---|
| Uri |
Subtitles_Settings
Gets or sets the subtitles settings.
Declaration
public SubtitleOverlaySettings Subtitles_Settings { get; set; }
Property Value
| Type | Description |
|---|---|
| SubtitleOverlaySettings |
Video_Composition_Enabled
Gets or sets a value indicating whether video composition is enabled.
Declaration
public bool Video_Composition_Enabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Video_Overlay_Enabled
Gets or sets a value indicating whether video overlay manager enabled. You should enable it before the Start/StartAsync methods call.
Declaration
public bool Video_Overlay_Enabled { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
|
Video_Play
Gets or sets a value indicating whether video playback is enabled.
Declaration
public bool Video_Play { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
Video_Source
Gets or sets the video source.
Declaration
public IVideoCaptureBaseVideoSourceSettings Video_Source { get; set; }
Property Value
| Type | Description |
|---|---|
| IVideoCaptureBaseVideoSourceSettings |
Methods
AudioOutputMuteSet(bool)
Mutes the audio output.
Declaration
public void AudioOutputMuteSet(bool value)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | value | if set to |
Audio_Effects_AddOrUpdate(BaseAudioEffect)
Adds/updates the audio effect.
Declaration
public void Audio_Effects_AddOrUpdate(BaseAudioEffect effect)
Parameters
| Type | Name | Description |
|---|---|---|
| BaseAudioEffect | effect | The effect. |
Audio_Effects_Clear()
Clear audio effects.
Declaration
public void Audio_Effects_Clear()
Audio_Effects_Get(string)
Gets the audio effect.
Declaration
public BaseAudioEffect Audio_Effects_Get(string effectName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | effectName | Name of the effect. |
Returns
| Type | Description |
|---|---|
| BaseAudioEffect | BaseAudioEffect. |
Audio_Effects_Remove(string)
Removes the audio effect.
Declaration
public void Audio_Effects_Remove(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name. |
Audio_Effects_Remove(BaseAudioEffect)
Removes an audio effect.
Declaration
public void Audio_Effects_Remove(BaseAudioEffect effect)
Parameters
| Type | Name | Description |
|---|---|---|
| BaseAudioEffect | effect | The effect. |
Audio_OutputsAsync(AudioOutputDeviceAPI?)
Gets the audio outputs.
Declaration
public Task<AudioOutputDeviceInfo[]> Audio_OutputsAsync(AudioOutputDeviceAPI? api = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AudioOutputDeviceAPI? | api | The API. |
Returns
| Type | Description |
|---|---|
| Task<AudioOutputDeviceInfo[]> | System.Threading.Tasks.Task<AudioOutputDeviceInfo[]>. |
Audio_Source_GetInfo(out int, out int, out AudioFormatX)
Gets information about the audio source.
Declaration
public bool Audio_Source_GetInfo(out int sampleRate, out int channels, out AudioFormatX format)
Parameters
| Type | Name | Description |
|---|---|---|
| int | sampleRate | The sample rate. |
| int | channels | The channels. |
| AudioFormatX | format | The format. |
Returns
| Type | Description |
|---|---|
| bool |
|
Audio_SourcesAsync(AudioCaptureDeviceAPI?)
Gets the audio sources.
Declaration
public Task<AudioCaptureDeviceInfo[]> Audio_SourcesAsync(AudioCaptureDeviceAPI? api = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AudioCaptureDeviceAPI? | api | The API. |
Returns
| Type | Description |
|---|---|
| Task<AudioCaptureDeviceInfo[]> | System.Threading.Tasks.Task<AudioCaptureDeviceInfo[]>. |
Debug_SavePipeline(string)
Saves the pipeline.
Declaration
public void Debug_SavePipeline(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name. |
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()
Dispose(bool)
Releases unmanaged and - optionally - managed resources.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | disposing |
|
DisposeAsync()
Dispose as an asynchronous operation.
Declaration
public ValueTask DisposeAsync()
Returns
| Type | Description |
|---|---|
| ValueTask | A Task<ValueTask> representing the asynchronous operation. |
Duration()
Gets duration.
Declaration
public TimeSpan Duration()
Returns
| Type | Description |
|---|---|
| TimeSpan | TimeSpan. |
DurationAsync()
Gets duration (async).
Declaration
public Task<TimeSpan> DurationAsync()
Returns
| Type | Description |
|---|---|
| Task<TimeSpan> | Task<TimeSpan>. |
~VideoCaptureCoreX()
Finalizes an instance of the VideoCaptureCoreX class.
Declaration
protected ~VideoCaptureCoreX()
GetContext()
Gets the context.
Declaration
public ContextX GetContext()
Returns
| Type | Description |
|---|---|
| ContextX | GSTContext. |
GetLogger()
Gets the logger.
Declaration
public ILogger GetLogger()
Returns
| Type | Description |
|---|---|
| ILogger | ILogger. |
GetMediaBlocksPipeline()
Gets the Media Blocks pipeline.
Declaration
public MediaBlocksPipeline GetMediaBlocksPipeline()
Returns
| Type | Description |
|---|---|
| MediaBlocksPipeline | MediaBlocksPipeline. |
GetSourceMixerControl()
Gets the source mixer control if Video_Source is VideoMixerSourceSettings.
Declaration
public IVideoMixerControl GetSourceMixerControl()
Returns
| Type | Description |
|---|---|
| IVideoMixerControl | IVideoMixerControl. |
IsCapturePaused(int)
Checks if the capture paused.
Declaration
public bool IsCapturePaused(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The output index. |
Returns
| Type | Description |
|---|---|
| bool | bool. |
IsCaptureStarted(int)
Checks if the capture started.
Declaration
public bool IsCaptureStarted(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The output index. |
Returns
| Type | Description |
|---|---|
| bool | bool. |
Outputs_Add(IVideoCaptureXBaseOutput, bool)
Adds output.
Declaration
public void Outputs_Add(IVideoCaptureXBaseOutput output, bool autostart = true)
Parameters
| Type | Name | Description |
|---|---|---|
| IVideoCaptureXBaseOutput | output | The output. |
| bool | autostart | if set to |
Outputs_Clear()
Clears output.
Declaration
public void Outputs_Clear()
Outputs_Count()
Gets the output count.
Declaration
public int Outputs_Count()
Returns
| Type | Description |
|---|---|
| int | int. |
Outputs_Get(int)
Gets an output.
Declaration
public IVideoCaptureXBaseOutput Outputs_Get(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Returns
| Type | Description |
|---|---|
| IVideoCaptureXBaseOutput | IVideoCaptureXBaseOutput. |
Outputs_Remove(IVideoCaptureXBaseOutput)
Removes output.
Declaration
public void Outputs_Remove(IVideoCaptureXBaseOutput output)
Parameters
| Type | Name | Description |
|---|---|---|
| IVideoCaptureXBaseOutput | output | The output. |
Outputs_RemoveAt(int)
Removes output.
Declaration
public void Outputs_RemoveAt(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Pause()
Pauses playback.
Declaration
public bool Pause()
Returns
| Type | Description |
|---|---|
| bool |
|
PauseAsync()
Pauses playback (async).
Declaration
public Task<bool> PauseAsync()
Returns
| Type | Description |
|---|---|
| Task<bool> | The Task. |
PauseCapture(int)
Pauses the capture.
Declaration
public bool PauseCapture(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Returns
| Type | Description |
|---|---|
| bool |
|
PauseCaptureAsync(int)
Pauses the capture (async.).
Declaration
public Task<bool> PauseCaptureAsync(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Returns
| Type | Description |
|---|---|
| Task<bool> | Task<System.Boolean>. |
Resume()
Resumes playback.
Declaration
public bool Resume()
Returns
| Type | Description |
|---|---|
| bool |
|
ResumeAsync()
Resumes playback (async).
Declaration
public Task<bool> ResumeAsync()
Returns
| Type | Description |
|---|---|
| Task<bool> | The Task. |
ResumeCapture(int)
Resumes the capture.
Declaration
public bool ResumeCapture(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Returns
| Type | Description |
|---|---|
| bool |
|
ResumeCaptureAsync(int)
Resumes the capture (async.).
Declaration
public Task<bool> ResumeCaptureAsync(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Returns
| Type | Description |
|---|---|
| Task<bool> | Task<System.Boolean>. |
SetCustomErrorHandler(IMediaBlocksPipelineCustomErrorHandler)
Sets the custom error handler.
Declaration
public void SetCustomErrorHandler(IMediaBlocksPipelineCustomErrorHandler errorHandler)
Parameters
| Type | Name | Description |
|---|---|---|
| IMediaBlocksPipelineCustomErrorHandler | errorHandler | The error handler. |
SetLicenseKey(string, string, string)
After buying a license of Video Capture SDK, you will receive the serial number. To get rid of nag screen during the run time, you will need to activate control via this method.
Declaration
public void SetLicenseKey(string licenseKey, string username, string email)
Parameters
| Type | Name | Description |
|---|---|---|
| string | licenseKey | License key. |
| string | username | User name used during purchase. |
| string | E-mail used during purchase. |
Examples
VideoCaptureX1.SetLicenseKey(�your_license_key�, "username", "email").
Settings_Load(string)
Loads SDK settings from JSON file.
Declaration
public bool Settings_Load(string jsonFilename)
Parameters
| Type | Name | Description |
|---|---|---|
| string | jsonFilename | JSON settings file. |
Returns
| Type | Description |
|---|---|
| bool | Returns bool. |
Settings_Save(string, string)
Saves current SDK control settings to file (JSON).
Declaration
public bool Settings_Save(string jsonFilename, string infoFilename)
Parameters
| Type | Name | Description |
|---|---|---|
| string | jsonFilename | JSON file name. |
| string | infoFilename | SDK info fil ename. |
Returns
| Type | Description |
|---|---|
| bool | Returns true if the operation has been successful. |
Snapshot_Get()
Gets the snapshot as VideoFrameX.
Declaration
public VideoFrameX Snapshot_Get()
Returns
| Type | Description |
|---|---|
| VideoFrameX | Bitmap. |
Snapshot_GetAsync()
Gets the snapshot as Bitmap (async).
Declaration
public Task<VideoFrameX> Snapshot_GetAsync()
Returns
| Type | Description |
|---|---|
| Task<VideoFrameX> | Task<Bitmap>. |
Snapshot_GetSK()
Gets the snapshot as SKBitmap.
Declaration
public SKBitmap Snapshot_GetSK()
Returns
| Type | Description |
|---|---|
| SKBitmap | SKBitmap. |
Snapshot_GetSKAsync()
Gets the snapshot as SKBitmap (async).
Declaration
public Task<SKBitmap> Snapshot_GetSKAsync()
Returns
| Type | Description |
|---|---|
| Task<SKBitmap> | Task<SKBitmap>. |
Snapshot_Save(string, SKEncodedImageFormat, int)
Saves snapshot to a file.
Declaration
public bool Snapshot_Save(string filename, SKEncodedImageFormat format, int quality = 85)
Parameters
| Type | Name | Description |
|---|---|---|
| string | filename | File name. |
| SKEncodedImageFormat | format | Format. |
| int | quality | The quality [0..100]. |
Returns
| Type | Description |
|---|---|
| bool |
|
Snapshot_SaveAsync(string, SKEncodedImageFormat, int)
Saves snapshot to a file (async).
Declaration
public Task<bool> Snapshot_SaveAsync(string filename, SKEncodedImageFormat format, int quality = 85)
Parameters
| Type | Name | Description |
|---|---|---|
| string | filename | File name. |
| SKEncodedImageFormat | format | Format. |
| int | quality | The quality [0..100]. |
Returns
| Type | Description |
|---|---|
| Task<bool> |
|
Start()
Starts.
Declaration
public bool Start()
Returns
| Type | Description |
|---|---|
| bool |
|
StartAsync()
Start (async).
Declaration
public Task<bool> StartAsync()
Returns
| Type | Description |
|---|---|
| Task<bool> | The Task. |
StartCapture(int, string)
Starts the capture.
Declaration
public bool StartCapture(int index, string filename)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
| string | filename | The filename. |
Returns
| Type | Description |
|---|---|
| bool |
|
StartCaptureAsync(int, string)
Starts the capture (async.).
Declaration
public Task<bool> StartCaptureAsync(int index, string filename)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
| string | filename | The filename. |
Returns
| Type | Description |
|---|---|
| Task<bool> | Task<System.Boolean>. |
Stop()
Stops the playback.
Declaration
public void Stop()
StopAsync()
Stops the playback (async).
Declaration
public Task StopAsync()
Returns
| Type | Description |
|---|---|
| Task | Task. |
StopCapture(int)
Stops the capture.
Declaration
public bool StopCapture(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Returns
| Type | Description |
|---|---|
| bool |
|
StopCaptureAsync(int)
Stops the capture (async.).
Declaration
public Task<bool> StopCaptureAsync(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Returns
| Type | Description |
|---|---|
| Task<bool> | Task<System.Boolean>. |
Subtitles_Settings_Update()
Updates the subtitle settings.
Declaration
public void Subtitles_Settings_Update()
VideoRenderer_GetVideoInfo()
Get video stream information for video renderer.
Declaration
public VideoStreamInfo VideoRenderer_GetVideoInfo()
Returns
| Type | Description |
|---|---|
| VideoStreamInfo | VideoStreamInfo. |
Video_Composition_Add(VideoCompositionElement)
Adds the composition element.
Declaration
public void Video_Composition_Add(VideoCompositionElement element)
Parameters
| Type | Name | Description |
|---|---|---|
| VideoCompositionElement | element | The element. |
Video_Composition_Clear()
Clears video composition elements.
Declaration
public void Video_Composition_Clear()
Video_Composition_Remove(VideoCompositionElement)
Removes the composition element.
Declaration
public void Video_Composition_Remove(VideoCompositionElement element)
Parameters
| Type | Name | Description |
|---|---|---|
| VideoCompositionElement | element | The element. |
Video_Effects_AddOrUpdateAsync(BaseVideoEffect)
Adds/updates the video effect.
Declaration
public Task Video_Effects_AddOrUpdateAsync(BaseVideoEffect effect)
Parameters
| Type | Name | Description |
|---|---|---|
| BaseVideoEffect | effect | The effect. |
Returns
| Type | Description |
|---|---|
| Task | A Task representing the asynchronous operation. |
Video_Effects_Clear()
Clears the video effects.
Declaration
public void Video_Effects_Clear()
Video_Effects_Get(string)
Gets the video effect.
Declaration
public BaseVideoEffect Video_Effects_Get(string effectName)
Parameters
| Type | Name | Description |
|---|---|---|
| string | effectName | Name of the effect. |
Returns
| Type | Description |
|---|---|
| BaseVideoEffect | BaseVideoEffect. |
Video_Effects_Remove(string)
Removes the video effect.
Declaration
public void Video_Effects_Remove(string name)
Parameters
| Type | Name | Description |
|---|---|---|
| string | name | The name. |
Video_Effects_Remove(BaseVideoEffect)
Removes the video effect.
Declaration
public void Video_Effects_Remove(BaseVideoEffect effect)
Parameters
| Type | Name | Description |
|---|---|---|
| BaseVideoEffect | effect | The effect. |
Video_Overlay_Add(IOverlayManagerElement)
Adds overlay.
Declaration
public void Video_Overlay_Add(IOverlayManagerElement overlay)
Parameters
| Type | Name | Description |
|---|---|---|
| IOverlayManagerElement | overlay | The overlay. |
Video_Overlay_Clear()
Clears all overlays.
Declaration
public void Video_Overlay_Clear()
Video_Overlay_Remove(IOverlayManagerElement)
Removes overlay.
Declaration
public void Video_Overlay_Remove(IOverlayManagerElement overlay)
Parameters
| Type | Name | Description |
|---|---|---|
| IOverlayManagerElement | overlay | The overlay. |
Video_Overlay_RemoveAt(int)
Removes overlay at specified index.
Declaration
public void Video_Overlay_RemoveAt(int index)
Parameters
| Type | Name | Description |
|---|---|---|
| int | index | The index. |
Video_Overlay_Update(IOverlayManagerElement)
Updates overlay.
Declaration
public void Video_Overlay_Update(IOverlayManagerElement overlay)
Parameters
| Type | Name | Description |
|---|---|---|
| IOverlayManagerElement | overlay | The overlay. |
Video_Source_GetResolutionAndFrameRate(out VideoFrameRate)
Gets resolution of the video source.
Declaration
public Size Video_Source_GetResolutionAndFrameRate(out VideoFrameRate frameRate)
Parameters
| Type | Name | Description |
|---|---|---|
| VideoFrameRate | frameRate | The frame rate. |
Returns
| Type | Description |
|---|---|
| Size | Size. |
Video_SourcesAsync()
Gets the video sources.
Declaration
public Task<VideoCaptureDeviceInfo[]> Video_SourcesAsync()
Returns
| Type | Description |
|---|---|
| Task<VideoCaptureDeviceInfo[]> | System.Threading.Tasks.Task<VisioForge.Core.Types.X.Sources.VideoCaptureDeviceInfo[]>. |
WaitForStartAsync()
Waits for start asynchronous.
Declaration
public Task WaitForStartAsync()
Returns
| Type | Description |
|---|---|
| Task | Task. |
Events
OnAudioFrameBuffer
This event occurs whenever each new audio frame is received.
Declaration
public event EventHandler<AudioFrameBufferEventArgs> OnAudioFrameBuffer
Event Type
| Type | Description |
|---|---|
| EventHandler<AudioFrameBufferEventArgs> |
OnAudioVUMeter
This event occurs whenever each new video VU meter data is received.
Declaration
public event EventHandler<VUMeterXEventArgs> OnAudioVUMeter
Event Type
| Type | Description |
|---|---|
| EventHandler<VUMeterXEventArgs> |
OnBarcodeDetected
This event occurs whenever each new barcode detected. Event args contain barcode data.
Declaration
public event EventHandler<BarcodeDetectorEventArgs> OnBarcodeDetected
Event Type
| Type | Description |
|---|---|
| EventHandler<BarcodeDetectorEventArgs> |
OnError
This event occurs whenever error is happened,.
Declaration
public event EventHandler<ErrorsEventArgs> OnError
Event Type
| Type | Description |
|---|---|
| EventHandler<ErrorsEventArgs> |
OnFaceDetected
This event occurs whenever each new video frame is received and a face(s) detected.
Declaration
public event EventHandler<AFFaceDetectionEventArgs> OnFaceDetected
Event Type
| Type | Description |
|---|---|
| EventHandler<AFFaceDetectionEventArgs> |
OnLicenseRequired
This event occurs in a case of an license required.
Declaration
public event EventHandler<LicenseEventArgs> OnLicenseRequired
Event Type
| Type | Description |
|---|---|
| EventHandler<LicenseEventArgs> |
OnMotionDetection
This event occurs whenever each new video frame is received. Event args contain motion data.
Declaration
public event EventHandler<MotionDetectionExEventArgs> OnMotionDetection
Event Type
| Type | Description |
|---|---|
| EventHandler<MotionDetectionExEventArgs> |
OnOutputPaused
Occurs when on output paused.
Declaration
public event EventHandler<int> OnOutputPaused
Event Type
| Type | Description |
|---|---|
| EventHandler<int> |
OnOutputResumed
Occurs when on output resumed.
Declaration
public event EventHandler<int> OnOutputResumed
Event Type
| Type | Description |
|---|---|
| EventHandler<int> |
OnOutputStarted
Occurs when on output started.
Declaration
public event EventHandler<int> OnOutputStarted
Event Type
| Type | Description |
|---|---|
| EventHandler<int> |
OnOutputStopped
Occurs when on output stopped.
Declaration
public event EventHandler<int> OnOutputStopped
Event Type
| Type | Description |
|---|---|
| EventHandler<int> |
OnPause
This event occurs whenever the playback pauses.
Declaration
public event EventHandler<EventArgs> OnPause
Event Type
| Type | Description |
|---|---|
| EventHandler<EventArgs> |
OnResume
This event occurs whenever the playback resumes.
Declaration
public event EventHandler<EventArgs> OnResume
Event Type
| Type | Description |
|---|---|
| EventHandler<EventArgs> |
OnStart
This event occurs whenever the playback starts.
Declaration
public event EventHandler<EventArgs> OnStart
Event Type
| Type | Description |
|---|---|
| EventHandler<EventArgs> |
OnStop
This event occurs whenever playback is stopped.
Declaration
public event EventHandler<StopEventArgs> OnStop
Event Type
| Type | Description |
|---|---|
| EventHandler<StopEventArgs> |
OnVideoFrameBitmap
This event occurs whenever each new video frame is received.
Declaration
public event EventHandler<VideoFrameBitmapEventArgs> OnVideoFrameBitmap
Event Type
| Type | Description |
|---|---|
| EventHandler<VideoFrameBitmapEventArgs> |
OnVideoFrameBuffer
This event occurs whenever each new video frame is received (RGB).
Declaration
public event EventHandler<VideoFrameXBufferEventArgs> OnVideoFrameBuffer
Event Type
| Type | Description |
|---|---|
| EventHandler<VideoFrameXBufferEventArgs> |
OnVideoFrameSKBitmap
This event occurs whenever each new video frame is received (SKBitmap).
Declaration
public event EventHandler<VideoFrameSKBitmapEventArgs> OnVideoFrameSKBitmap
Event Type
| Type | Description |
|---|---|
| EventHandler<VideoFrameSKBitmapEventArgs> |