Table of Contents

Class AudioCaptureDeviceSourceSettings

Namespace
VisioForge.Core.Types.X.Sources
Assembly
VisioForge.Core.dll

Common audio capture device source settings.

public class AudioCaptureDeviceSourceSettings : IAudioCaptureDeviceSourceSettings, IVideoCaptureBaseAudioSourceSettings, IMediaBlockSettings, IAudioVolumeMute

Inheritance

Implements

Inherited Members

Constructors

AudioCaptureDeviceSourceSettings(AudioCaptureDeviceAPI, AudioCaptureDeviceInfo, AudioCaptureDeviceFormat)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.AudioCaptureDeviceSourceSettings class.

public AudioCaptureDeviceSourceSettings(AudioCaptureDeviceAPI api, AudioCaptureDeviceInfo device, AudioCaptureDeviceFormat format)

Parameters

api AudioCaptureDeviceAPI

The API.

device AudioCaptureDeviceInfo

The device.

format AudioCaptureDeviceFormat

The format.

AudioCaptureDeviceSourceSettings(AudioCaptureDeviceInfo)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.AudioCaptureDeviceSourceSettings class.

public AudioCaptureDeviceSourceSettings(AudioCaptureDeviceInfo device)

Parameters

device AudioCaptureDeviceInfo

The device.

AudioCaptureDeviceSourceSettings()

Initializes a new instance of the VisioForge.Core.Types.X.Sources.AudioCaptureDeviceSourceSettings class.

public AudioCaptureDeviceSourceSettings()

Properties

API

Gets or sets the API.

[JsonInclude]
public AudioCaptureDeviceAPI API { get; }

Property Value

AudioCaptureDeviceAPI

Device

Gets or sets the device.

public AudioCaptureDeviceInfo Device { get; set; }

Property Value

AudioCaptureDeviceInfo

Format

Gets or sets the format.

public AudioCaptureDeviceFormat Format { get; set; }

Property Value

AudioCaptureDeviceFormat

Methods

CreateBlock()

Creates the block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetMute()

Gets the mute.

public bool GetMute()

Returns

bool

true if successful, false otherwise.

GetVolume()

Gets the volume. Value should be in 0.0 - 1.0 range.

public double GetVolume()

Returns

double

System.Double.

IsSupported()

Determines whether this interface is supported.

public bool IsSupported()

Returns

bool

true if this interface is supported; otherwise, false.

Remarks

Forwarded to the block this settings object is attached to, so it answers for the capture element actually in use and only once that block has been built. Reporting merely that a block is attached said yes on every backend, including the ones that carry no volume or mute control at all.

SetInterface(IAudioVolumeMute)

Sets the interface.

public void SetInterface(IAudioVolumeMute intf)

Parameters

intf IAudioVolumeMute

The interface.

SetMute(bool)

Sets the mute.

public void SetMute(bool mute)

Parameters

mute bool

if set to true mute.

SetVolume(double)

Sets the volume. Value should be in 0.0 - 1.0 range.

public void SetVolume(double volume)

Parameters

volume double

The volume.

ToString()

Returns a String that represents this instance.

public override string ToString()

Returns

string

A String that represents this instance.