Class AudioRendererBlock

Audio renderer block. Implements the MediaBlock. Implements the IMediaBlockInternals. Implements the IDisposable.

Inheritance
object
MediaBlock
AudioRendererBlock
Implements
Inherited Members
Namespace: VisioForge.Core.MediaBlocks.AudioRendering
Assembly: VisioForge.Core.dll
Syntax
public class AudioRendererBlock : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals, IMediaBlockRenderer

Constructors

AudioRendererBlock()

Initializes a new instance of the AudioRendererBlock class.

Declaration
public AudioRendererBlock()

AudioRendererBlock(IAudioRendererSettings)

Initializes a new instance of the AudioRendererBlock class.

Declaration
public AudioRendererBlock(IAudioRendererSettings settings)
Parameters
Type Name Description
IAudioRendererSettings settings

The settings.

AudioRendererBlock(AudioOutputDeviceInfo)

Initializes a new instance of the AudioRendererBlock class.

Declaration
public AudioRendererBlock(AudioOutputDeviceInfo device)
Parameters
Type Name Description
AudioOutputDeviceInfo device

The device.

Properties

Input

Gets the input.

Declaration
public override MediaBlockPad Input { get; }
Property Value
Type Description
MediaBlockPad

The input.
Overrides
MediaBlock.Input

Inputs

Gets the inputs.

Declaration
public override MediaBlockPad[] Inputs { get; }
Property Value
Type Description
MediaBlockPad[]

The inputs.
Overrides
MediaBlock.Inputs

IsSync

Gets or sets a value indicating whether to sync a stream/streams, for example audio and video. Usually it should be true for playback and capture application and false for transcoding.

Declaration
public bool IsSync { get; set; }
Property Value
Type Description
bool

true if sync enabled; otherwise, false.

Mute

Gets or sets a value indicating whether audio output device mute is enabled.

Declaration
public bool Mute { get; set; }
Property Value
Type Description
bool

true if mute; otherwise, false.

Output

Gets the output.

Declaration
public override MediaBlockPad Output { get; }
Property Value
Type Description
MediaBlockPad

The output.
Overrides
MediaBlock.Output

Outputs

Gets the outputs.

Declaration
public override MediaBlockPad[] Outputs { get; }
Property Value
Type Description
MediaBlockPad[]

The outputs.
Overrides
MediaBlock.Outputs

Settings

Gets the settings.

Declaration
public IAudioRendererSettings Settings { get; }
Property Value
Type Description
IAudioRendererSettings

The settings.

Type

Gets the type.

Declaration
public override MediaBlockType Type { get; }
Property Value
Type Description
MediaBlockType

The type.
Overrides
MediaBlock.Type

Volume

Gets or sets the audio output device volume. 1.0 is 100%.

Declaration
public double Volume { get; set; }
Property Value
Type Description
double

The volume.

Methods

Build()

Builds this instance.

Declaration
public override bool Build()
Returns
Type Description
bool

true if successfull, false otherwise.
Overrides
MediaBlock.Build()

CleanUp()

Cleans up.

Declaration
public void CleanUp()

Dispose(bool)

Releases unmanaged and - optionally - managed resources.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
bool disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides
MediaBlock.Dispose(bool)

GetCore()

Gets core.

Declaration
public BaseElement GetCore()
Returns
Type Description
BaseElement

VisioForge.Core.GStreamer.Base.BaseElement.

GetDevicesAsync(AudioOutputDeviceAPI?)

Gets the devices asynchronous.

Declaration
public static Task<AudioOutputDeviceInfo[]> GetDevicesAsync(AudioOutputDeviceAPI? api = null)
Parameters
Type Name Description
AudioOutputDeviceAPI? api

The API.
Returns
Type Description
Task<AudioOutputDeviceInfo[]>

Task<AudioOutputDeviceInfo[]>.

GetElement()

Gets the element.

Declaration
public Element GetElement()
Returns
Type Description
Element

Gst.Element.

IsAvailable(AudioOutputDeviceAPI)

Determines whether this media block is available. Correct NuGet SDK redist should be included into your project.

Declaration
public static bool IsAvailable(AudioOutputDeviceAPI api)
Parameters
Type Name Description
AudioOutputDeviceAPI api

The API.
Returns
Type Description
bool

true if this media block is available; otherwise, false.

Implements

IMediaBlock
IDisposable
IMediaBlockInternals
IMediaBlockRenderer

Extension Methods

MediaBlockHelper.SendEndOfStream(MediaBlock)
MediaBlockHelper.SendEvent(MediaBlock, Event)
MediaBlockHelper.SetState(MediaBlock, State)

See Also