Class VideoCaptureModeHelper

Namespace

VisioForge.Core.Types.VideoCapture

Assembly

VisioForge.Core.dll

Provides extension methods for working with VisioForge.Core.Types.VideoCapture.VideoCaptureMode enumeration values.

public static class VideoCaptureModeHelper

Inheritance

object

VideoCaptureModeHelper

Inherited Members

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Remarks

This static class contains helper methods to determine the characteristics of different capture modes, such as whether they are preview-only or capture modes, and whether they handle audio-only scenarios.

Methods

IsAudioOnly(VideoCaptureMode)

Determines whether the specified capture mode handles audio only (no video).

public static bool IsAudioOnly(this VideoCaptureMode mode)

Parameters

mode VideoCaptureMode

The VisioForge.Core.Types.VideoCapture.VideoCaptureMode to check.

Returns

bool

true if the mode is VisioForge.Core.Types.VideoCapture.VideoCaptureMode.AudioPreview or VisioForge.Core.Types.VideoCapture.VideoCaptureMode.AudioCapture; otherwise, false.

IsCapture(VideoCaptureMode)

Determines whether the specified capture mode is a capture (recording) mode.

public static bool IsCapture(this VideoCaptureMode mode)

Parameters

mode VideoCaptureMode

The VisioForge.Core.Types.VideoCapture.VideoCaptureMode to check.

Returns

bool

true if the mode saves data to file or stream; otherwise, false.

Remarks

This method simply returns the inverse of VisioForge.Core.Types.VideoCapture.VideoCaptureModeHelper.IsPreview(VisioForge.Core.Types.VideoCapture.VideoCaptureMode).

IsPreview(VideoCaptureMode)

Determines whether the specified capture mode is a preview mode.

public static bool IsPreview(this VideoCaptureMode mode)

Parameters

mode VideoCaptureMode

The VisioForge.Core.Types.VideoCapture.VideoCaptureMode to check.

Returns

bool

true if the mode is a preview mode (displays without saving); otherwise, false.

Exceptions

ArgumentOutOfRangeException

Thrown when an unrecognized capture mode value is provided.