Class

RadWebCam

Initializes a new instance of the RadWebCam class.

Declaration

public RadWebCam()

Identifies the AutoStart dependency property.

Declaration

public static readonly DependencyProperty AutoStartProperty

Field Value

Identifies the CameraErrorContent dependency property.

Declaration

public static readonly DependencyProperty CameraErrorContentProperty

Field Value

Identifies the CameraErrorContentTemplate dependency property.

Declaration

public static readonly DependencyProperty CameraErrorContentTemplateProperty

Field Value

Registers the CameraError routed event.

Declaration

public static readonly RoutedEvent CameraErrorEvent

Field Value

Identifies the FlipHorizontally dependency property.

Declaration

public static readonly DependencyProperty FlipHorizontallyProperty

Field Value

Identifies the FlipVertically dependency property.

Declaration

public static readonly DependencyProperty FlipVerticallyProperty

Field Value

Identifies the HasError dependency property.

Declaration

public static readonly DependencyProperty HasErrorProperty

Field Value

Identifies the IsPreviewingSnapshot dependency property.

Declaration

public static readonly DependencyProperty IsPreviewingSnapshotProperty

Field Value

Identifies the IsRecording dependency property.

Declaration

public static readonly DependencyProperty IsRecordingProperty

Field Value

Identifies the PreviewSnapshots dependency property.

Declaration

public static readonly DependencyProperty PreviewSnapshotsProperty

Field Value

Identifies the RecordingButtonVisibility dependency property.

Declaration

public static readonly DependencyProperty RecordingButtonVisibilityProperty

Field Value

Registers the RecordingEnded routed event.

Declaration

public static readonly RoutedEvent RecordingEndedEvent

Field Value

Identifies the RecordingFilePath dependency property.

Declaration

public static readonly DependencyProperty RecordingFilePathProperty

Field Value

Identifies the RecordingLabelVisibility dependency property.

Declaration

public static readonly DependencyProperty RecordingLabelVisibilityProperty

Field Value

Registers the RecordingStarted routed event.

Declaration

public static readonly RoutedEvent RecordingStartedEvent

Field Value

Identifies the SettingsButtonVisibility dependency property.

Declaration

public static readonly DependencyProperty SettingsButtonVisibilityProperty

Field Value

Identifies the ShowAudioSettings dependency property.

Declaration

public static readonly DependencyProperty ShowAudioSettingsProperty

Field Value

Identifies the SnapshotButtonVisibility dependency property.

Declaration

public static readonly DependencyProperty SnapshotButtonVisibilityProperty

Field Value

Registers the SnapshotTaken routed event.

Declaration

public static readonly RoutedEvent SnapshotTakenEvent

Field Value

Identifies the ToolbarPanelVisibility dependency property.

Declaration

public static readonly DependencyProperty ToolbarPanelVisibilityProperty

Field Value

Identifies the VideoRecordingElapsedTimeFormat dependency property.

Declaration

public static readonly DependencyProperty VideoRecordingElapsedTimeFormatProperty

Field Value

Identifies the VideoRecordingElapsedTimeText dependency property.

Declaration

public static readonly DependencyProperty VideoRecordingElapsedTimeTextProperty

Field Value

Gets or sets whether the control will start the first webcam it finds upon starting the application.

Declaration

public bool AutoStart { get; set; }

Property Value

Gets a value indicating the content of the error message.

Declaration

public object CameraErrorContent { get; }

Property Value

Gets or sets the DataTemplate that defines the visual tree of the ContentPresenter instance that visualizes the property.

Declaration

public DataTemplate CameraErrorContentTemplate { get; set; }

Property Value

Gets or sets whether the control will flip the incoming video feed horizontally.

Declaration

public bool FlipHorizontally { get; set; }

Property Value

Gets or sets whether the control will flip the incoming video feed vertically.

Declaration

public bool FlipVertically { get; set; }

Property Value

Gets a value indicating whether the camera is in an error state.

Declaration

public bool HasError { get; }

Property Value

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

Declaration

public bool IsPreviewingSnapshot { get; }

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 visibility of the Toggle Recording button.

Declaration

public Visibility RecordingButtonVisibility { get; set; }

Property Value

Gets or sets the location where video files are stored when capturing.

Declaration

public string RecordingFilePath { get; set; }

Property Value

Gets or sets the visibility of the label displaying the elapsed time while recording.

Declaration

public Visibility RecordingLabelVisibility { get; set; }

Property Value

Gets or sets the visibility of the Settings button.

Declaration

public Visibility SettingsButtonVisibility { get; set; }

Property Value

Gets or sets whether the settings dialog will include an Audio tab for controlling mic settings.

Declaration

public bool ShowAudioSettings { get; set; }

Property Value

Gets or sets the visibility of the Take Snapshot button.

Declaration

public Visibility SnapshotButtonVisibility { get; set; }

Property Value

Gets or sets the visibility of the Toolbar panel that hosts all the camera built-in controls.

Declaration

public Visibility ToolbarPanelVisibility { get; set; }

Property Value

Gets or sets the format of the elapsed time displayed during recording.

Declaration

public string VideoRecordingElapsedTimeFormat { get; set; }

Property Value

Gets or sets a value indicating for how long a video recording has been running.

Declaration

public string VideoRecordingElapsedTimeText { get; }

Property Value

Discards the snapshot that is currently being previewed. PreviewSnapshots must be set to true and the control must be previewing a snapshot triggered by calling TakeSnapshot().

Declaration

public void DiscardSnapshot()

Called when the control is destroyed.

Declaration

public void Dispose()

Implements IDisposable.Dispose()

Called when the control is destroyed.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Releases unmanaged resources and performs other cleanup operations before the RadWebCam is reclaimed by garbage collection.

Declaration

[SuppressMessage("Design", "CA1063:Implement IDisposable Correctly", Justification = "<Pending>")]
protected override void Finalize()

Gets a list with all the available audio capture devices.

Declaration

public static ReadOnlyCollection<MediaFoundationDeviceInfo> GetAudioCaptureDevices()

Returns

Gets a list with all the available video capture devices.

Declaration

public static ReadOnlyCollection<MediaFoundationDeviceInfo> GetVideoCaptureDevices()

Returns

Gets a list with all the available video file formats for the provided 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 void Initialize(MediaFoundationDeviceInfo videoDevice, MediaFoundationVideoFormatInfo videoFormat)

Parameters

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

Declaration

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

Parameters

When overridden in a derived class, is invoked whenever application code or internal processes call .

Declaration

public override void OnApplyTemplate()

Fires the CameraError event.

Declaration

protected virtual void OnCameraError(CameraErrorEventArgs e)

Parameters

Returns class-specific AutomationPeer.

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Raises the event. This method is invoked whenever is set to true internally.

Declaration

protected override void OnInitialized(EventArgs e)

Parameters

Fires the RecordingEnded event.

Declaration

protected virtual void OnRecordingEnded(RadRoutedEventArgs e)

Parameters

Fires the RecordingStarted event.

Declaration

protected virtual void OnRecordingStarted(RadRoutedEventArgs 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 void Pause()

Resets the theme.

Declaration

public void ResetTheme()

Saves the snapshot that is currently being previewed. PreviewSnapshots must be set to true and the control must be previewing a snapshot triggered by calling TakeSnapshot().

Declaration

public void SaveSnapshot()

Shuts down the media session and the recording.

Declaration

public void ShutDown()

Starts the video pipeline and starts displaying the video feed.

Declaration

public void Start()

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

Declaration

public void StartRecording()

Stops the video pipeline and stops displaying the video feed.

Declaration

public void Stop()

Stops the file capture.

Declaration

public void StopRecording()

Takes a snapshot from the currently displayed video feed. To get the snapshot subscribe to the SnapshotTaken event.

Declaration

public void TakeSnapshot()

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

Declaration

public event CameraErrorEventHandler CameraError

Event Value

Occurs when video recording has ended.

Declaration

public event RoutedEventHandler RecordingEnded

Event Value

Occurs when video recording is started.

Declaration

public event RecordingStartedEventHandler RecordingStarted

Event Value

Occurs when a snapshot is taken. If PreviewSnapshots is set to true the event is fired only if the SaveSnapshot command is executed.

Declaration

public event SnapshotTakenEventHandler SnapshotTaken

Event Value