Class

RadWebCam

Initializes a new instance of the RadWebCam class with default settings. The control will automatically start the first detected webcam when loaded.

Declaration

public RadWebCam()

Gets or sets whether the control will automatically start the first webcam it finds when the control is loaded.

Declaration

public bool AutoStart { get; set; }

Property Value

Gets the element representing the border of the camera.

Declaration

public LightVisualElement CameraBorderElement { get; }

Property Value

Gets or sets the height of the panel with the camera controls.

Declaration

public int ControlPanelHeight { get; set; }

Property Value

Gets the default size of the control.

Declaration

protected override Size DefaultSize { get; }

Property Value

Overrides Control.DefaultSize

Gets a value indicating whether the camera is in a state where something is preventing normal operation.

Declaration

public bool HasError { get; protected set; }

Property Value

Gets or sets a value indicating whether the control is in snapshot preview mode.

Declaration

public bool IsPreviewingSnapshot { get; set; }

Property Value

Gets or sets a value indicating whether the source content is being recorded to a file.

Declaration

public bool IsRecording { get; set; }

Property Value

Gets or sets whether the control will go into preview mode when a snapshot is taken.

Declaration

public bool PreviewSnapshots { get; set; }

Property Value

Gets or sets the file path where video files are saved when recording from the webcam. Must be set before calling StartRecording() method.

Declaration

public string RecordingFilePath { get; set; }

Property Value

Gets the element used to display snapshot previews or error messages.

Declaration

public LightVisualElement SnapshotPreviewElement { get; }

Property Value

Gets or sets the format string for displaying elapsed time during video recording. Uses standard DateTime format strings.

Declaration

public string VideoRecordingElapsedTimeFormat { get; set; }

Property Value

Gets the main web cam control element.

Declaration

public RadWebCamElement WebCamElement { get; }

Property Value

Creates the camera border element.

Declaration

protected virtual LightVisualElement CreateCameraBorderElement()

Returns

Creates and initializes the child elements of the RadWebCam control.

Declaration

protected override void CreateChildItems(RadElement parent)

Parameters

Overrides RadControl.CreateChildItems(RadElement)

Creates the root RadElement of the control.

Declaration

protected override RootRadElement CreateRootElement()

Returns

Overrides RadControl.CreateRootElement()

Creates the snapshot preview element.

Declaration

protected virtual LightVisualElement CreateSnapshotPreviewElement()

Returns

Creates the main RadWebCam element.

Declaration

protected virtual RadWebCamElement CreateWebCamElement()

Returns

Creates the root element of RadWebCam.

Declaration

protected virtual WebCamRootRadElement CreateWebCamRootElement()

Returns

Discards the taken snapshot when the control is in preview snapshot mode.

Declaration

public virtual void DiscardSnapshot()

Releases the unmanaged resources used by the RadWebCam control and its child controls and optionally releases the managed resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides RadControl.Dispose(bool)

Gets a list with all the available audio capture devices on the system.

Declaration

public static ReadOnlyCollection<MediaFoundationDeviceInfo> GetAudioCaptureDevices()

Returns

Gets a list with all the available video capture devices (webcams) on the system.

Declaration

public static ReadOnlyCollection<MediaFoundationDeviceInfo> GetVideoCaptureDevices()

Returns

Gets a list with all the available video file formats for the provided capture device.

Declaration

public static ReadOnlyCollection<MediaFoundationVideoFormatInfo> GetVideoFormats(MediaFoundationDeviceInfo device, bool recordingFormatsOnly = false)

Parameters

Returns

Starts up the video pipeline and displays the video from the source inside of the control.

Declaration

public virtual void Initialize(MediaFoundationDeviceInfo videoDevice, MediaFoundationVideoFormatInfo videoFormat)

Parameters

Starts up the video pipeline and displays the video from the source inside of the control with audio support.

Declaration

public virtual void Initialize(MediaFoundationDeviceInfo videoDevice, MediaFoundationVideoFormatInfo videoFormat, MediaFoundationDeviceInfo audioDevice)

Parameters

Exceptions

Fires the CameraError event.

Declaration

protected virtual void OnCameraError(CameraErrorEventArgs e)

Parameters

Raises the System.Windows.Forms.Control.HandleCreated event and initializes the default webcam if available.

Declaration

protected override void OnHandleCreated(EventArgs e)

Parameters

Overrides Control.OnHandleCreated(EventArgs)

Notifies that the control is about to be visualized and initializes the webcam position.

Declaration

protected override void OnLoad(Size desiredSize)

Parameters

Overrides RadControl.OnLoad(Size)

Fires the RecordingEnded event.

Declaration

protected virtual void OnRecordingEnded(EventArgs e)

Parameters

Fires the RecordingStarted event.

Declaration

protected virtual void OnRecordingStarted(CancelEventArgs e)

Parameters

Fires the SettingsDialogShowing event.

Declaration

protected virtual void OnSettingsDialogShowing(CameraSettingsDialogShowingEventArgs e)

Parameters

Fires the SnapshotTaken event.

Declaration

protected virtual void OnSnapshotTaken(SnapshotTakenEventArgs e)

Parameters

Pauses the video pipeline and pauses displaying the video feed.

Declaration

public virtual void Pause()

Triggers the SnapshotTaken event when the control is in preview snapshot mode.

Declaration

public virtual void SaveSnapshot()

Performs the work of setting the specified bounds of this control and updates the webcam stream position.

Declaration

protected override void SetBoundsCore(int x, int y, int width, int height, BoundsSpecified specified)

Parameters

Overrides RadControl.SetBoundsCore(int, int, int, int, BoundsSpecified)

Shows the camera settings dialog which allows configuring camera properties. The SettingsDialogShowing event can be used to customize or cancel the dialog.

Declaration

public virtual void ShowSettingsDialog()

Shuts down the video pipeline.

Declaration

public virtual void ShutDown()

Starts the video pipeline and starts displaying the video feed.

Declaration

public virtual void Start()

Starts capturing the media source(s) to a file. The RecordingFilePath property must be set before calling this method.

Declaration

public virtual void StartRecording()

Stops the video pipeline and stops displaying the video feed.

Declaration

public virtual void Stop()

Stops the file capture.

Declaration

public virtual void StopRecording()

Takes a snapshot from the currently displayed webcam video feed. If PreviewSnapshots is true, the snapshot will be displayed for preview before firing the SnapshotTaken event. Otherwise, the SnapshotTaken event will be fired immediately.

Declaration

public virtual void TakeSnapshot()

Occurs when an error is preventing the camera from operating normally.

Declaration

public event EventHandler<CameraErrorEventArgs> CameraError

Event Value

Occurs when video recording has ended.

Declaration

public event EventHandler RecordingEnded

Event Value

Occurs when video recording is started.

Declaration

public event EventHandler<CancelEventArgs> RecordingStarted

Event Value

Occurs when the settings dialog is about to be shown.

Declaration

public event EventHandler<CameraSettingsDialogShowingEventArgs> SettingsDialogShowing

Event Value

Occurs when a snapshot is taken from the webcam. If PreviewSnapshots is set to true, the event is fired only when the SaveSnapshot() method is called.

Declaration

public event EventHandler<SnapshotTakenEventArgs> SnapshotTaken

Event Value