Table of Contents

Class PulseAudioSourceSettings

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

PulseAudio source settings for capturing audio using pulsesrc GStreamer element. PulseAudio is the default sound server on many Linux distributions. Implements the VisioForge.Core.Types.X.Sources.IAudioCaptureDeviceSourceSettings Implements the VisioForge.Core.Types.X.VideoCapture.IVideoCaptureBaseAudioSourceSettings

public class PulseAudioSourceSettings : IAudioCaptureDeviceSourceSettings, IVideoCaptureBaseAudioSourceSettings, IMediaBlockSettings, IAudioVolumeMute

Inheritance

Implements

Inherited Members

Constructors

PulseAudioSourceSettings()

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

public PulseAudioSourceSettings()

PulseAudioSourceSettings(AudioCaptureDeviceInfo, AudioCaptureDeviceFormat)

Initializes a new instance of the VisioForge.Core.Types.X.Sources.PulseAudioSourceSettings class with device information.

public PulseAudioSourceSettings(AudioCaptureDeviceInfo device, AudioCaptureDeviceFormat format)

Parameters

device AudioCaptureDeviceInfo

The device.

format AudioCaptureDeviceFormat

The format.

Properties

API

Gets the API type.

public AudioCaptureDeviceAPI API { get; }

Property Value

AudioCaptureDeviceAPI

ClientName

Gets or sets the client name that will be visible in PulseAudio volume control applications.

public string ClientName { get; set; }

Property Value

string

Device

Gets or sets the device information.

public AudioCaptureDeviceInfo Device { get; set; }

Property Value

AudioCaptureDeviceInfo

DeviceName

Gets or sets the PulseAudio device name. If null or empty, the default device will be used.

public string DeviceName { get; set; }

Property Value

string

Format

Gets or sets the audio format.

public AudioCaptureDeviceFormat Format { get; set; }

Property Value

AudioCaptureDeviceFormat

ProvideClock

Gets or sets a value indicating whether to provide a clock for the pipeline.

public bool ProvideClock { get; set; }

Property Value

bool

Methods

CreateBlock()

Creates the media block.

public MediaBlock CreateBlock()

Returns

MediaBlock

MediaBlock.

GetMute()

Gets the mute state.

public bool GetMute()

Returns

bool

true if muted, false otherwise.

GetVolume()

Gets the volume.

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.

SetInterface(IAudioVolumeMute)

Sets the interface.

public void SetInterface(IAudioVolumeMute intf)

Parameters

intf IAudioVolumeMute

The interface.

SetMute(bool)

Sets the mute state.

public void SetMute(bool mute)

Parameters

mute bool

if set to true mute.

SetVolume(double)

Sets the volume.

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.

See Also