Class LiveSourceSwitchBlockDynamic

Namespace

VisioForge.Core.LiveSourceSwitch

Assembly

VisioForge.Core.dll

Dynamic Live Source Switch block with proper support for runtime input add/remove. Unlike LiveSourceSwitchBlock, this version uses slot-based management where each slot has a fixed bridge name. When an input is removed, the slot becomes empty but the bridge remains ready for a new input.

public class LiveSourceSwitchBlockDynamic : MediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

object

MediaBlock

LiveSourceSwitchBlockDynamic

Implements

IMediaBlock

IDisposable

IMediaBlockInternals

Inherited Members

MediaBlock._isBuilt

MediaBlock._pipeline

MediaBlock._pipelineCtx

MediaBlock.GetPipelineContext()

MediaBlock.SetPipelineContext(BlockPipelineContext)

MediaBlock.SetPipeline(MediaBlocksPipeline)

MediaBlock.Context

MediaBlock.Name

MediaBlock.IsBuilt

MediaBlock.Owner

MediaBlock.Type

MediaBlock.ID

MediaBlock.Input

MediaBlock.Inputs

MediaBlock.Output

MediaBlock.Outputs

MediaBlock.HasInputs

MediaBlock.HasOutputs

MediaBlock.Build()

MediaBlock.CreateElements()

MediaBlock.AddElementsToPipeline()

MediaBlock.RemoveElementsFromPipeline()

MediaBlock.DeepCopy(string)

MediaBlock.Reset()

MediaBlock.ToYAMLBlock()

MediaBlock.ClearPads()

MediaBlock.Dispose(bool)

MediaBlock.Dispose()

object.Equals(object?)

object.Equals(object?, object?)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object?, object?)

object.ToString()

Extension Methods

MediaBlockExtensions.GetInputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockExtensions.GetOutputPadByType(IMediaBlock, MediaBlockPadMediaType)

MediaBlockHelper.SendEndOfStream(MediaBlock)

MediaBlockHelper.SendEvent(MediaBlock, Event)

MediaBlockHelper.SetState(MediaBlock, State)

Constructors

LiveSourceSwitchBlockDynamic(MediaBlocksPipeline, LiveSourceSwitchSettings)

Initializes a new instance of the VisioForge.Core.LiveSourceSwitch.LiveSourceSwitchBlockDynamic class.

public LiveSourceSwitchBlockDynamic(MediaBlocksPipeline pipeline, LiveSourceSwitchSettings settings)

Parameters

pipeline MediaBlocksPipeline

The parent MediaBlocks pipeline that will host this switch block.

settings LiveSourceSwitchSettings

The configuration settings including video/audio parameters and input limits.

Remarks

This constructor creates fixed bridge sources for each slot with predetermined names. When inputs are removed and re-added, they reuse the same bridge names to avoid conflicts.

Properties

AudioOutput

Gets the audio output pad.

public MediaBlockPad AudioOutput { get; }

Property Value

MediaBlockPad

CurrentAudioIndex

Gets the currently active audio slot index.

public int CurrentAudioIndex { get; }

Property Value

int

CurrentVideoIndex

Gets the currently active video slot index.

public int CurrentVideoIndex { get; }

Property Value

int

Input

Gets the input (not used - inputs are managed via slots).

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets the inputs array (empty - inputs are managed via slots).

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the primary output (video).

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets all outputs.

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets the settings.

public LiveSourceSwitchSettings Settings { get; }

Property Value

LiveSourceSwitchSettings

Type

Gets the block type.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

VideoOutput

Gets the video output pad.

public MediaBlockPad VideoOutput { get; }

Property Value

MediaBlockPad

Methods

Build()

Builds the internal pipeline structure by connecting bridge sources to switch inputs.

public override bool Build()

Returns

bool

true if the build was successful or was already built; false otherwise.

Remarks

This method connects all video and audio bridge sources to their respective switch inputs. Bridge sources remain connected even when slots are empty, outputting silence/black until an input is added.

CleanUp()

Cleans up resources.

public void CleanUp()

Dispose(bool)

Disposes resources.

protected override void Dispose(bool disposing)

Parameters

disposing bool

DurationAsync()

Gets the current playback duration/position of the main pipeline.

public Task<TimeSpan> DurationAsync()

Returns

Task<TimeSpan>

A Task<TResult> representing the current playback position.

GetContext()

Gets the execution context for this switch block.

public ContextX GetContext()

Returns

ContextX

The VisioForge.Core.GStreamer.ContextX instance used for logging and error handling.

GetCore()

Gets the core element (not applicable for composite blocks).

public BaseElement GetCore()

Returns

BaseElement

GetElement()

Gets the element (not applicable for composite blocks).

public Element GetElement()

Returns

Element

GetPipeline()

Gets the parent pipeline that hosts this switch block.

public MediaBlocksPipeline GetPipeline()

Returns

MediaBlocksPipeline

The VisioForge.Core.MediaBlocks.MediaBlocksPipeline instance managing this block.

Input_AddToSlotAsync(LVCVideoInput, int)

Adds a video-only input to a specific slot.

public Task<bool> Input_AddToSlotAsync(LVCVideoInput input, int slotIndex)

Parameters

input LVCVideoInput

The video input configuration to add.

slotIndex int

The zero-based slot index (0 to MaxVideoInputsCount-1).

Returns

Task<bool>

A Task<TResult> that completes with true if the input was added successfully; otherwise, false.

Remarks

Each slot has a fixed bridge name. When an input is added to a slot, it connects to that bridge. The slot must be empty before adding a new input - use VisioForge.Core.LiveSourceSwitch.LiveSourceSwitchBlockDynamic.Input_RemoveFromSlotAsync(System.Int32) first if needed.

Input_AddToSlotAsync(LVCVideoAudioInput, int)

Adds a combined video and audio input to a specific slot.

public Task<bool> Input_AddToSlotAsync(LVCVideoAudioInput input, int slotIndex)

Parameters

input LVCVideoAudioInput

The video/audio input configuration to add.

slotIndex int

The zero-based slot index.

Returns

Task<bool>

A Task<TResult> that completes with true if the input was added successfully; otherwise, false.

Remarks

Both video and audio streams are connected to their respective bridges for the same slot index. The slot must be empty before adding a new input.

Input_GetFromSlot(int)

Gets the input at a specific slot.

public LVCInput Input_GetFromSlot(int slotIndex)

Parameters

slotIndex int

The zero-based slot index.

Returns

LVCInput

The VisioForge.Core.LiveVideoCompositor.LVCInput at the specified slot, or null if the slot is empty or the index is invalid.

Input_RemoveFromSlotAsync(int)

Removes an input from a specific slot.

public Task<bool> Input_RemoveFromSlotAsync(int slotIndex)

Parameters

slotIndex int

The zero-based slot index to clear.

Returns

Task<bool>

A Task<TResult> that completes with true if the slot was cleared successfully; otherwise, false.

Remarks

The bridge source remains active after removal, outputting silence/black until a new input is added. The new input must use the same bridge name for this slot, which is handled automatically by VisioForge.Core.LiveSourceSwitch.LiveSourceSwitchBlockDynamic.Input_AddToSlotAsync(VisioForge.Core.LiveVideoCompositor.LVCVideoInput,System.Int32). Returns true if the slot is already empty.

StartAsync()

Starts the switch block and all configured input sources asynchronously.

public Task<bool> StartAsync()

Returns

Task<bool>

A Task<TResult> that completes with true if startup was successful; otherwise, false.

Remarks

This method builds the pipeline if not already built, preloads all inputs in occupied slots, then starts all input pipelines and the main pipeline in synchronized fashion.

StopAsync()

Stops the switch block and all active input sources asynchronously.

public Task StopAsync()

Returns

Task

A Task representing the asynchronous stop operation.

Remarks

This method stops all input pipelines in occupied slots, then stops the main pipeline. Empty slots are skipped during the stop process.

Switch(int)

Switches both video and audio to the specified slot.

public void Switch(int slotIndex)

Parameters

slotIndex int

The zero-based slot index to switch to.

Remarks

This method synchronously switches both video and audio streams to the same slot. Use VisioForge.Core.LiveSourceSwitch.LiveSourceSwitchBlockDynamic.SwitchVideo(System.Int32) and VisioForge.Core.LiveSourceSwitch.LiveSourceSwitchBlockDynamic.SwitchAudio(System.Int32) for independent control.

SwitchAudio(int)

Switches only audio to the specified slot, keeping video on its current slot.

public void SwitchAudio(int slotIndex)

Parameters

slotIndex int

The zero-based slot index to switch audio to.

SwitchVideo(int)

Switches only video to the specified slot, keeping audio on its current slot.

public void SwitchVideo(int slotIndex)

Parameters

slotIndex int

The zero-based slot index to switch video to.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Associates this MediaBlock with a pipeline and initializes its internal context. This method is called automatically when the block is added to a pipeline, providing access to shared resources and pipeline-wide configuration.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The MediaBlocksPipeline instance that will manage this block.