Class PushVideoSourceBlock

Namespace

VisioForge.Core.MediaBlocks.Sources

Assembly

VisioForge.Core.dll

Push video source block for programmatic video frame injection into the pipeline. Provides real-time video streaming from application-generated or externally-sourced video frames for custom video sources, frame processing pipelines, video synthesis, and integration with external video APIs or capture devices. Implements the VisioForge.Core.MediaBlocks.Sources.SourceMediaBlock. Implements the VisioForge.Core.MediaBlocks.IMediaBlockInternals. Implements the IDisposable.

public class PushVideoSourceBlock : SourceMediaBlock, IMediaBlock, IDisposable, IMediaBlockInternals

Inheritance

object

MediaBlock

SourceMediaBlock

PushVideoSourceBlock

Implements

IMediaBlock

IDisposable

IMediaBlockInternals

Inherited Members

SourceMediaBlock.IsSubtitlesAvailable()

SourceMediaBlock.Stop()

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

PushVideoSourceBlock(PushVideoSourceSettings)

Initializes a new instance of the VisioForge.Core.MediaBlocks.Sources.PushVideoSourceBlock class with custom video settings. Configures the push video source for real-time frame injection with specified format parameters.

public PushVideoSourceBlock(PushVideoSourceSettings settings)

Parameters

settings PushVideoSourceSettings

The push video settings controlling resolution, pixel format, and buffering parameters.

Properties

Input

Gets the primary input pad (none for source blocks that receive pushed data).

public override MediaBlockPad Input { get; }

Property Value

MediaBlockPad

Inputs

Gets all input pads available on this block (none for source blocks).

public override MediaBlockPad[] Inputs { get; }

Property Value

MediaBlockPad[]

Output

Gets the primary video output pad for the pushed video stream.

public override MediaBlockPad Output { get; }

Property Value

MediaBlockPad

Outputs

Gets all output pads available on this block (single video output).

public override MediaBlockPad[] Outputs { get; }

Property Value

MediaBlockPad[]

Settings

Gets or sets the push video configuration settings that control video format and buffering.

public PushVideoSourceSettings Settings { get; set; }

Property Value

PushVideoSourceSettings

Type

Gets the media block type identifier for push video source operations.

public override MediaBlockType Type { get; }

Property Value

MediaBlockType

Methods

Build()

Builds and initializes the push video source within the pipeline context. Creates frame injection pipeline, configures format conversion, and prepares video output for downstream processing.

public override bool Build()

Returns

bool

true if the push video source was successfully built and configured; otherwise, false.

CleanUp()

Cleans up all resources associated with the push video operations, including frame buffers and video converters.

public void CleanUp()

ClearQueue()

Clears all pending video frames from the internal buffer queue.

public void ClearQueue()

Dispose(bool)

Releases unmanaged and managed resources used by the push video source. Properly stops frame injection and disposes of GStreamer elements and video buffers.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true to release both managed and unmanaged resources; false to release only unmanaged resources.

GetCore()

Gets the core GStreamer element wrapper for advanced configuration and monitoring.

public BaseElement GetCore()

Returns

BaseElement

Always null for composite source blocks with multiple internal elements.

GetElement()

Gets the native GStreamer element for direct GStreamer pipeline integration.

public Element GetElement()

Returns

Element

The push video source GStreamer element.

IsAvailable()

Determines whether push video support is available on the current system. Requires GStreamer appsrc plugin to be installed for video frame injection.

public static bool IsAvailable()

Returns

bool

true if push video support is available; otherwise, false.

PushFrame(VideoFrameX)

Pushes a video frame into the pipeline for real-time processing.

public void PushFrame(VideoFrameX frame)

Parameters

frame VideoFrameX

The VideoFrameX containing pixel data with format and timing information to inject into the pipeline.

IMediaBlockInternals.SetContext(MediaBlocksPipeline)

Sets the pipeline context for this push video source, providing access to the parent pipeline and logging context.

void IMediaBlockInternals.SetContext(MediaBlocksPipeline pipeline)

Parameters

pipeline MediaBlocksPipeline

The parent MediaBlocks pipeline containing this push video source.

See Also

SourceMediaBlock

IMediaBlockInternals

IDisposable