# Source Blocks - VisioForge Media Blocks SDK .Net

Media Blocks SDK .Net

Source blocks provide data to the pipeline and are typically the first blocks in any media processing chain. VisioForge Media Blocks SDK .Net provides a comprehensive collection of source blocks for various inputs including hardware devices, files, networks, and virtual sources.

# Hardware Source Blocks

# System Video Source

SystemVideoSourceBlock is used to access webcams and other video capture devices.

# Block info

Name: SystemVideoSourceBlock.

Pin direction	Media type	Pins count
Output video	uncompressed video	1

# Enumerate available devices

Use the DeviceEnumerator.Shared.VideoSourcesAsync() method to get a list of available devices and their specifications: available resolutions, frame rates, and video formats. This method returns a list of VideoCaptureDeviceInfo objects. Each VideoCaptureDeviceInfo object provides detailed information about a capture device.

# The sample pipeline

graph LR;
    SystemVideoSourceBlock-->VideoRendererBlock;

# Sample code

// create pipeline
var pipeline = new MediaBlocksPipeline();

// create video source
VideoCaptureDeviceSourceSettings videoSourceSettings = null;

// select the first device
var device = (await DeviceEnumerator.Shared.VideoSourcesAsync())[0];
if (device != null)
{
    // select the first format (maybe not the best, but it is just a sample)
    var formatItem = device.VideoFormats[0];
    if (formatItem != null)
    {
        videoSourceSettings = new VideoCaptureDeviceSourceSettings(device)
        {
            Format = formatItem.ToFormat()
        };

        // select the first frame rate
        videoSourceSettings.Format.FrameRate = formatItem.FrameRateList[0];
    }
}

// create video source block using the selected device and format
var videoSource = new SystemVideoSourceBlock(videoSourceSettings);

// create video renderer block
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);

// connect blocks
pipeline.Connect(videoSource.Output, videoRenderer.Input);

// start pipeline
await pipeline.StartAsync();

# Sample applications

Simple Video Capture Demo (WPF)

# Remarks

You can specify an API to use during the device enumeration (refer to the VideoCaptureDeviceAPI enum description under SystemVideoSourceBlock for typical values). Android and iOS platforms have only one API, while Windows and Linux have multiple APIs.

# Platforms

Windows, macOS, Linux, iOS, Android.

# System Audio Source

SystemAudioSourceBlock is used to access mics and other audio capture devices.

# Block info

Name: SystemAudioSourceBlock.

Pin direction	Media type	Pins count
Output audio	uncompressed audio	1

# Enumerate available devices

Use the DeviceEnumerator.Shared.AudioSourcesAsync() method call to get a list of available devices and their specifications.

During device enumeration, you can get the list of available devices and their specifications. You can select the device and its format to create the source settings.

# The sample pipeline

graph LR;
    SystemAudioSourceBlock-->AudioRendererBlock;

# Sample code

// create pipeline
var pipeline = new MediaBlocksPipeline();

// create audio source block
IAudioCaptureDeviceSourceSettings audioSourceSettings = null;

// select first device
var device = (await DeviceEnumerator.Shared.AudioSourcesAsync())[0];
if (device != null)
{
    // select first format
    var formatItem = device.Formats[0];
    if (formatItem != null)
    {
        audioSourceSettings = device.CreateSourceSettings(formatItem.ToFormat());
    }    
}

// create audio source block using selected device and format
var audioSource = new SystemAudioSourceBlock(audioSourceSettings);

// create audio renderer block  
var audioRenderer = new AudioRendererBlock();

// connect blocks
pipeline.Connect(audioSource.Output, audioRenderer.Input);

// start pipeline
await pipeline.StartAsync();

# Capture audio from speakers (loopback)

Currently, loopback audio capture is supported only on Windows. Use the LoopbackAudioCaptureDeviceSourceSettings class to create the source settings for loopback audio capture.

WASAPI2 is used as the default API for loopback audio capture. You can specify the API to use during device enumeration.

// create pipeline
var pipeline = new MediaBlocksPipeline();

// create audio source block
var deviceItem = (await DeviceEnumerator.Shared.AudioOutputsAsync(AudioOutputDeviceAPI.WASAPI2))[0];
if (deviceItem == null)
{
    return;
}

var audioSourceSettings = new LoopbackAudioCaptureDeviceSourceSettings(deviceItem);
var audioSource = new SystemAudioSourceBlock(audioSourceSettings);

// create audio renderer block  
var audioRenderer = new AudioRendererBlock();

// connect blocks
pipeline.Connect(audioSource.Output, audioRenderer.Input);

// start pipeline
await pipeline.StartAsync();

# Sample applications

# Remarks

You can specify an API to use during the device enumeration. Android and iOS platforms have only one API, while Windows and Linux have multiple APIs.

# Platforms

Windows, macOS, Linux, iOS, Android.

# Basler Source Block

The Basler source block supports Basler USB3 Vision and GigE cameras. The Pylon SDK or Runtime should be installed to use the camera source.

# Block info

Name: BaslerSourceBlock.

Pin direction	Media type	Pins count
Output video	Uncompressed	1

# The sample pipeline

graph LR;
    BaslerSourceBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// get Basler source info by enumerating sources
var sources = await DeviceEnumerator.Shared.BaslerSourcesAsync();
var sourceInfo = sources[0];

// create Basler source    
var source = new BaslerSourceBlock(new BaslerSourceSettings(sourceInfo));

// create video renderer for VideoView
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);

// connect
pipeline.Connect(source.Output, videoRenderer.Input);

// start
await pipeline.StartAsync();

# Sample applications

Basler Source Demo (WPF)

# Platforms

Windows, Linux.

# Spinnaker/FLIR Source Block

The Spinnaker/FLIR source supports connection to FLIR cameras using Spinnaker SDK.

To use the SpinnakerSourceBlock, you first need to enumerate available Spinnaker cameras and then configure the source using SpinnakerSourceSettings.

# Enumerate Devices & `SpinnakerCameraInfo`

Use DeviceEnumerator.Shared.SpinnakerSourcesAsync() to get a list of SpinnakerCameraInfo objects. Each SpinnakerCameraInfo provides details about a detected camera:

Name (string): Unique identifier or name of the camera. Often a serial number or model-serial combination.
NetworkInterfaceName (string): Name of the network interface if it's a GigE camera.
Vendor (string): Camera vendor name.
Model (string): Camera model name.
SerialNumber (string): Camera's serial number.
FirmwareVersion (string): Camera's firmware version.
SensorSize (Size): Reports the sensor dimensions (Width, Height). You might need to call a method on SpinnakerCameraInfo like ReadInfo() (if available, or implied by enumeration) to populate this.
WidthMax (int): Maximum sensor width.
HeightMax (int): Maximum sensor height.

You select a SpinnakerCameraInfo object from the list to initialize SpinnakerSourceSettings.

# Settings

The SpinnakerSourceBlock is configured using SpinnakerSourceSettings. Key properties:

Name (string): The name of the camera (from SpinnakerCameraInfo.Name) to use.
Region (Rect): Defines the Region of Interest (ROI) to capture from the camera sensor. Set X, Y, Width, Height.
FrameRate (VideoFrameRate): The desired frame rate.
PixelFormat (SpinnakerPixelFormat enum): The desired pixel format (e.g., RGB, Mono8, BayerRG8). Default RGB.
OffsetX (int): X offset for the ROI on the sensor (default 0). Often implicitly part of Region.X.
OffsetY (int): Y offset for the ROI on the sensor (default 0). Often implicitly part of Region.Y.
ExposureMinimum (int): Minimum exposure time for auto-exposure algorithm (microseconds, e.g., 10-29999999). Default 0 (auto/camera default).
ExposureMaximum (int): Maximum exposure time for auto-exposure algorithm (microseconds). Default 0 (auto/camera default).
ShutterType (SpinnakerSourceShutterType enum): Type of shutter (e.g., Rolling, Global). Default Rolling.

Constructor: SpinnakerSourceSettings(string deviceName, Rect region, VideoFrameRate frameRate, SpinnakerPixelFormat pixelFormat = SpinnakerPixelFormat.RGB)

# Block info

Name: SpinnakerSourceBlock.

Pin direction	Media type	Pins count
Output video	various	one or more

# The sample pipeline

SpinnakerSourceBlock:Output → VideoRendererBlock

# Sample code

var pipeline = new MediaBlocksPipeline();

var sources = await DeviceEnumerator.Shared.SpinnakerSourcesAsync();
var sourceSettings = new SpinnakerSourceSettings(sources[0].Name, new VisioForge.Core.Types.Rect(0, 0, 1280, 720), new VideoFrameRate(10)); 

var source = new SpinnakerSourceBlock(sourceSettings);

var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
pipeline.Connect(source.Output, videoRenderer.Input);

await pipeline.StartAsync();

# Requirements

Spinnaker SDK installed.

# Platforms

Windows

# Allied Vision Source Block

The Allied Vision Source Block enables integration with Allied Vision cameras using the Vimba SDK. It allows capturing video streams from these industrial cameras.

# Block info

Name: AlliedVisionSourceBlock.

Pin direction	Media type	Pins count
Output video	Uncompressed video	1

# The sample pipeline

graph LR;
    AlliedVisionSourceBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Enumerate Allied Vision cameras
var alliedVisionCameras = await DeviceEnumerator.Shared.AlliedVisionSourcesAsync();
if (alliedVisionCameras.Count == 0)
{
    Console.WriteLine("No Allied Vision cameras found.");
    return;
}

var cameraInfo = alliedVisionCameras[0]; // Select the first camera

// Create Allied Vision source settings
// Width, height, x, y are optional and depend on whether you want to set a specific ROI
// If null, it might use default/full sensor resolution. Camera.ReadInfo() should be called.
cameraInfo.ReadInfo(); // Ensure camera info like Width/Height is read

var alliedVisionSettings = new AlliedVisionSourceSettings(
    cameraInfo,
    width: cameraInfo.Width, // Or a specific ROI width
    height: cameraInfo.Height // Or a specific ROI height
);

// Optionally configure other settings
alliedVisionSettings.ExposureAuto = VmbSrcExposureAutoModes.Continuous;
alliedVisionSettings.Gain = 10; // Example gain value

var alliedVisionSource = new AlliedVisionSourceBlock(alliedVisionSettings);

// Create video renderer
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1); // Assuming VideoView1 is your display control

// Connect blocks
pipeline.Connect(alliedVisionSource.Output, videoRenderer.Input);

// Start pipeline
await pipeline.StartAsync();

# Requirements

Allied Vision Vimba SDK must be installed.

# Sample applications

Refer to samples demonstrating industrial camera integration if available.

# Platforms

Windows, macOS, Linux.

# Blackmagic Decklink Source Block

For information about Decklink sources, see Decklink.

    
        #
        File Source Blocks

# Universal Source Block

A universal source that decodes video and audio files/network streams and provides uncompressed data to the connected blocks.

Block supports MP4, WebM, AVI, TS, MKV, MP3, AAC, M4A, and many other formats. If FFMPEG redist is available, all decoders available in FFMPEG will also be supported.

# Settings

The UniversalSourceBlock is configured through UniversalSourceSettings. It's recommended to create settings using the static factory method await UniversalSourceSettings.CreateAsync(...).

Key properties and parameters for UniversalSourceSettings:

URI/Filename:
- UniversalSourceSettings.CreateAsync(string filename, bool renderVideo = true, bool renderAudio = true, bool renderSubtitle = false): Creates settings from a local file path.
- UniversalSourceSettings.CreateAsync(System.Uri uri, bool renderVideo = true, bool renderAudio = true, bool renderSubtitle = false): Creates settings from a System.Uri (can be a file URI or network URI like HTTP, RTSP - though dedicated blocks are often preferred for network streams). For iOS, an Foundation.NSUrl is used.
- The renderVideo, renderAudio, renderSubtitle booleans control which streams are processed. The CreateAsync method may update these based on actual stream availability in the media file/stream if ignoreMediaInfoReader is false (default).
StartPosition (TimeSpan?): Sets the starting position for playback.
StopPosition (TimeSpan?): Sets the stopping position for playback.
VideoCustomFrameRate (VideoFrameRate?): If set, video frames will be dropped or duplicated to match this custom frame rate.
UseAdvancedEngine (bool): If true (default, except Android where it's false), uses an advanced engine with stream selection support.
DisableHWDecoders (bool): If true (default false, except Android where it's true), hardware-accelerated decoders will be disabled, forcing software decoding.
MPEGTSProgramNumber (int): For MPEG-TS streams, specifies the program number to select (default -1, meaning automatic selection or first program).
ReadInfoAsync(): Asynchronously reads media file information (MediaFileInfo). This is called internally by CreateAsync unless ignoreMediaInfoReader is true.
GetInfo(): Gets the cached MediaFileInfo.

The UniversalSourceBlock itself is then instantiated with these settings: new UniversalSourceBlock(settings). The Filename property on UniversalSourceBlock instance (as seen in older examples) is a shortcut that internally creates basic UniversalSourceSettings. Using UniversalSourceSettings.CreateAsync provides more control.

# Block info

Name: UniversalSourceBlock.

Pin direction	Media type	Pins count
Output audio	depends from decoder	one or more
Output video	depends from decoder	one or more
Output subtitle	depends from decoder	one or more

# The sample pipeline

graph LR;
    UniversalSourceBlock-->VideoRendererBlock;
    UniversalSourceBlock-->AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

var fileSource = new UniversalSourceBlock();
fileSource.Filename = "test.mp4";

var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
pipeline.Connect(fileSource.VideoOutput, videoRenderer.Input);

var audioRenderer = new AudioRendererBlock();
pipeline.Connect(fileSource.AudioOutput, audioRenderer.Input);            

await pipeline.StartAsync();

# Sample applications

Simple Player Demo (WPF)

# Platforms

Windows, macOS, Linux, iOS, Android.

# Subtitle Source Block

The Subtitle Source Block loads subtitles from a file and outputs them as a subtitle stream, which can then be overlaid on video or rendered separately.

# Block info

Name: SubtitleSourceBlock.

Pin direction	Media type	Pins count
Output subtitle	Subtitle data	1

# Settings

The SubtitleSourceBlock is configured using SubtitleSourceSettings. Key properties include:

Filename (string): The path to the subtitle file (e.g., .srt, .ass).

# The sample pipeline

graph LR;
    UniversalSourceBlock --> SubtitleOverlayBlock;
    SubtitleSourceBlock --> SubtitleOverlayBlock;
    SubtitleOverlayBlock --> VideoRendererBlock;
    UniversalSourceBlock --> AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Create subtitle source settings
var subtitleSettings = new SubtitleSourceSettings("path/to/your/subtitles.srt");
var subtitleSource = new SubtitleSourceBlock(subtitleSettings);

// Example: Overlaying subtitles on a video from UniversalSourceBlock
var fileSource = await UniversalSourceSettings.CreateAsync("path/to/your/video.mp4");
var universalSource = new UniversalSourceBlock(fileSource);

var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
var audioRenderer = new AudioRendererBlock();

// This is a conceptual overlay. Actual implementation might need a specific subtitle overlay block.
// For simplicity, let's assume a downstream block can consume a subtitle stream,
// or you connect it to a block that renders subtitles on the video.
// Example with a hypothetical SubtitleOverlayBlock:
// var subtitleOverlay = new SubtitleOverlayBlock(); // Assuming such a block exists
// pipeline.Connect(universalSource.VideoOutput, subtitleOverlay.VideoInput);
// pipeline.Connect(subtitleSource.Output, subtitleOverlay.SubtitleInput);
// pipeline.Connect(subtitleOverlay.Output, videoRenderer.Input);
// pipeline.Connect(universalSource.AudioOutput, audioRenderer.Input);

// For a simple player without explicit overlay shown here:
pipeline.Connect(universalSource.VideoOutput, videoRenderer.Input);
pipeline.Connect(universalSource.AudioOutput, audioRenderer.Input);
// How subtitles from subtitleSource.Output are used would depend on the rest of the pipeline design.
// This block primarily provides the subtitle stream.

Console.WriteLine("Subtitle source created. Connect its output to a compatible block like a subtitle overlay or renderer.");

await pipeline.StartAsync();

# Platforms

Windows, macOS, Linux, iOS, Android (Depends on subtitle parsing capabilities).

# Stream Source Block

The Stream Source Block allows reading media data from a System.IO.Stream. This is useful for playing media from memory, embedded resources, or custom stream providers without needing a temporary file. The format of the data within the stream must be parsable by the underlying media framework (GStreamer).

# Block info

Name: StreamSourceBlock. (Pin information is dynamic, similar to UniversalSourceBlock, based on stream content. Typically, it would have an output that connects to a demuxer/decoder like DecodeBinBlock, or provide decoded audio/video pins if it includes demuxing/decoding capabilities.)

| Pin direction | Media type | Pins count | |---------------|:--------------------:|:----------:| | Output data | Varies (raw stream)| 1 | Alternatively, if it decodes: | Output video | Depends on stream | 0 or 1 | | Output audio | Depends on stream | 0 or 1+ |

# Settings

The StreamSourceBlock is typically instantiated directly with a System.IO.Stream. The StreamSourceSettings class serves as a wrapper to provide this stream.

Stream (System.IO.Stream): The input stream containing the media data. The stream must be readable and, if seeking is required by the pipeline, seekable.

# The sample pipeline

If StreamSourceBlock outputs raw data that needs decoding:

graph LR;
    StreamSourceBlock -- Stream Data --> DecodeBinBlock;
    DecodeBinBlock -- Video Output --> VideoRendererBlock;
    DecodeBinBlock -- Audio Output --> AudioRendererBlock;

If StreamSourceBlock handles decoding internally (less common for a generic stream source):

graph LR;
    StreamSourceBlock -- Video Output --> VideoRendererBlock;
    StreamSourceBlock -- Audio Output --> AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Example: Load a video file into a MemoryStream
byte[] fileBytes = File.ReadAllBytes("path/to/your/video.mp4");
var memoryStream = new MemoryStream(fileBytes);

// StreamSourceSettings is a container for the stream.
var streamSettings = new StreamSourceSettings(memoryStream);
// The CreateBlock method of StreamSourceSettings would typically return new StreamSourceBlock(streamSettings.Stream)
var streamSource = streamSettings.CreateBlock() as StreamSourceBlock; 
// Or, more directly: var streamSource = new StreamSourceBlock(memoryStream);

// Create video and audio renderers
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1); // Assuming VideoView1
var audioRenderer = new AudioRendererBlock();

// Connect outputs. Commonly, a StreamSourceBlock provides raw data to a DecodeBinBlock.
var decodeBin = new DecodeBinBlock();
pipeline.Connect(streamSource.Output, decodeBin.Input); // Assuming a single 'Output' pin on StreamSourceBlock
pipeline.Connect(decodeBin.VideoOutput, videoRenderer.Input);
pipeline.Connect(decodeBin.AudioOutput, audioRenderer.Input);

await pipeline.StartAsync();

// Important: Ensure the stream remains open and valid for the duration of playback.
// Dispose of the stream when the pipeline is stopped or disposed.
// Consider this in relation to pipeline.DisposeAsync() or similar cleanup.
// memoryStream.Dispose(); // Typically after pipeline.StopAsync() and pipeline.DisposeAsync()

# Remarks

The StreamSourceBlock itself will attempt to read from the provided stream. The success of playback depends on the format of the data in the stream and the availability of appropriate demuxers and decoders in the subsequent parts of the pipeline (often managed via DecodeBinBlock).

# Platforms

Windows, macOS, Linux, iOS, Android.

# CDG Source Block

The CDG Source Block is designed to play CD+G (Compact Disc + Graphics) files, commonly used for karaoke. It decodes both the audio track and the low-resolution graphics stream.

# Block info

Name: CDGSourceBlock.

Pin direction	Media type	Pins count
Output audio	Uncompressed audio	1
Output video	Uncompressed video	1

# The sample pipeline

graph LR;
    CDGSourceBlock -- Audio --> AudioRendererBlock;
    CDGSourceBlock -- Video --> VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Create CDG source settings
var cdgSettings = new CDGSourceSettings(
    "path/to/your/file.cdg",  // Path to the CDG graphics file
    "path/to/your/file.mp3"   // Path to the corresponding audio file (MP3, WAV, etc.)
);
// If audioFilename is null or empty, audio will be ignored.

var cdgSource = new CDGSourceBlock(cdgSettings);

// Create video renderer
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1); // Assuming VideoView1 is your display control
pipeline.Connect(cdgSource.VideoOutput, videoRenderer.Input);

// Create audio renderer (if audio is to be played)
if (!string.IsNullOrEmpty(cdgSettings.AudioFilename) && cdgSource.AudioOutput != null)
{
    var audioRenderer = new AudioRendererBlock();
    pipeline.Connect(cdgSource.AudioOutput, audioRenderer.Input);
}

// Start pipeline
await pipeline.StartAsync();

# Remarks

Requires both a .cdg file for graphics and a separate audio file (e.g., MP3, WAV) for the music.

# Platforms

Windows, macOS, Linux, iOS, Android.

# Network Source Blocks

# VNC Source Block

The VNC Source Block allows capturing video from a VNC (Virtual Network Computing) or RFB (Remote Framebuffer) server. This is useful for streaming the desktop of a remote machine.

# Block info

Name: VNCSourceBlock.

Pin direction	Media type	Pins count
Output video	Uncompressed video	1

# Settings

The VNCSourceBlock is configured using VNCSourceSettings. Key properties include:

Host (string): The hostname or IP address of the VNC server.
Port (int): The port number of the VNC server.
Password (string): The password for VNC server authentication, if required.
Uri (string): Alternatively, a full RFB URI (e.g., "rfb://host:port").
Width (int): Desired output width. The block may connect to a VNC server that provides specific dimensions.
Height (int): Desired output height.
Shared (bool): Whether to share the desktop with other clients (default true).
ViewOnly (bool): If true, no input (mouse/keyboard) is sent to the VNC server (default false).
Incremental (bool): Whether to use incremental updates (default true).
UseCopyrect (bool): Whether to use copyrect encoding (default false).
RFBVersion (string): RFB protocol version (default "3.3").
OffsetX (int): X offset for screen scraping.
OffsetY (int): Y offset for screen scraping.

# The sample pipeline

graph LR;
    VNCSourceBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Configure VNC source settings
var vncSettings = new VNCSourceSettings
{
    Host = "your-vnc-server-ip", // or use Uri
    Port = 5900, // Standard VNC port
    Password = "your-password", // if any
    // Width = 1920, // Optional: desired width
    // Height = 1080, // Optional: desired height
};

var vncSource = new VNCSourceBlock(vncSettings);

// Create video renderer
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1); // Assuming VideoView1 is your display control

// Connect blocks
pipeline.Connect(vncSource.Output, videoRenderer.Input);

// Start pipeline
await pipeline.StartAsync();

# Platforms

Windows, macOS, Linux (Depends on underlying GStreamer VNC plugin availability).

# RTSP Source Block

The RTSP source supports connection to IP cameras and other devices supporting the RTSP protocol.

Supported video codecs: H264, HEVC, MJPEG. Supported audio codecs: AAC, MP3, PCM, G726, G711, and some others if FFMPEG redist is installed.

# Block info

Name: RTSPSourceBlock.

Pin direction	Media type	Pins count
Output audio	depends from decoder	one or more
Output video	depends from decoder	one or more
Output subtitle	depends from decoder	one or more

# Settings

The RTSPSourceBlock is configured using RTSPSourceSettings. Key properties include:

Uri: The RTSP URL of the stream.
Login: Username for RTSP authentication, if required.
Password: Password for RTSP authentication, if required.
AudioEnabled: A boolean indicating whether to attempt to process the audio stream.
Latency: Specifies the buffering duration for the incoming stream (default is 1000ms).
AllowedProtocols: Defines the transport protocols to be used for receiving the stream. It's a flags enum RTSPSourceProtocol with values:
- UDP: Stream data over UDP.
- UDP_Multicast: Stream data over UDP multicast.
- TCP (Recommended): Stream data over TCP.
- HTTP: Stream data tunneled over HTTP.
- EnableTLS: Encrypt TCP and HTTP with TLS (use rtsps:// or httpsps:// in URI).
DoRTCP: Enables RTCP (RTP Control Protocol) for stream statistics and control (default is usually true).
RTPBlockSize: Specifies the size of RTP blocks.
UDPBufferSize: Buffer size for UDP transport.
CustomVideoDecoder: Allows specifying a custom GStreamer video decoder element name if the default is not suitable.
UseGPUDecoder: If set to true, the SDK will attempt to use a hardware-accelerated GPU decoder if available.
CompatibilityMode: If true, the SDK will not try to read camera information before attempting to play, which can be useful for problematic streams.
EnableRAWVideoAudioEvents: If true, enables events for raw (undecoded) video and audio sample data.

It's recommended to initialize RTSPSourceSettings using the static factory method RTSPSourceSettings.CreateAsync(Uri uri, string login, string password, bool audioEnabled, bool readInfo = true). This method can also handle ONVIF discovery if the URI points to an ONVIF device service. Setting readInfo to false enables CompatibilityMode.

# The sample pipeline

graph LR;
    RTSPSourceBlock-->VideoRendererBlock;
    RTSPSourceBlock-->AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// It's recommended to use CreateAsync to initialize settings
var rtspSettings = await RTSPSourceSettings.CreateAsync(
    new Uri("rtsp://login:pwd@192.168.1.64:554/Streaming/Channels/101?transportmode=unicast&profile=Profile_1"),
    "login", 
    "pwd",
    audioEnabled: true);

// Optionally, configure more settings
// rtspSettings.Latency = TimeSpan.FromMilliseconds(500);
// rtspSettings.AllowedProtocols = RTSPSourceProtocol.TCP; // Prefer TCP

var rtspSource = new RTSPSourceBlock(rtspSettings);

var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
pipeline.Connect(rtspSource.VideoOutput, videoRenderer.Input);

var audioRenderer = new AudioRendererBlock();
pipeline.Connect(rtspSource.AudioOutput, audioRenderer.Input);      

await pipeline.StartAsync();

# Sample applications

# Platforms

Windows, macOS, Linux, iOS, Android.

# HTTP Source Block

The HTTP source block allows data to be retrieved using HTTP/HTTPS protocols. It can be used to read data from MJPEG IP cameras, MP4 network files, or other sources.

# Block info

Name: HTTPSourceBlock.

Pin direction	Media type	Pins count
Output	Data	1

# The sample pipeline

The sample pipeline reads data from an MJPEG camera and displays it using VideoView.

graph LR;
    HTTPSourceBlock-->JPEGDecoderBlock;
    JPEGDecoderBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

var settings = new HTTPSourceSettings(new Uri("http://mjpegcamera:8080"))
{
    UserID = "username",
    UserPassword = "password"
};

var source = new HTTPSourceBlock(settings);
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
var jpegDecoder = new JPEGDecoderBlock();

pipeline.Connect(source.Output, jpegDecoder.Input);
pipeline.Connect(jpegDecoder.Output, videoRenderer.Input);

await pipeline.StartAsync();

# Platforms

Windows, macOS, Linux.

# HTTP MJPEG Source Block

The HTTP MJPEG Source Block is specifically designed to connect to and decode MJPEG (Motion JPEG) video streams over HTTP/HTTPS. This is common for many IP cameras.

# Block info

Name: HTTPMJPEGSourceBlock.

Pin direction	Media type	Pins count
Output video	Uncompressed video	1

# The sample pipeline

graph LR;
    HTTPMJPEGSourceBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Create settings for the HTTP MJPEG source
var mjpegSettings = await HTTPMJPEGSourceSettings.CreateAsync(
    new Uri("http://your-mjpeg-camera-url/stream"), // Replace with your camera's MJPEG stream URL
    "username", // Optional: username for camera authentication
    "password"  // Optional: password for camera authentication
);

if (mjpegSettings == null)
{
    Console.WriteLine("Failed to initialize HTTP MJPEG settings.");
    return;
}

mjpegSettings.CustomVideoFrameRate = new VideoFrameRate(25); // Optional: Set if camera doesn't report frame rate
mjpegSettings.Latency = TimeSpan.FromMilliseconds(200); // Optional: Adjust latency

var httpMjpegSource = new HTTPMJPEGSourceBlock(mjpegSettings);

// Create video renderer
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1); // Assuming VideoView1 is your display control

// Connect blocks
pipeline.Connect(httpMjpegSource.Output, videoRenderer.Input);

// Start pipeline
await pipeline.StartAsync();

# Sample applications

Similar to HTTP MJPEG Source Demo mentioned under the generic HTTP Source Block.

# Platforms

Windows, macOS, Linux.

# NDI Source Block

The NDI source block supports connection to NDI software sources and devices supporting the NDI protocol.

# Block info

Name: NDISourceBlock.

Pin direction	Media type	Pins count
Output audio	Uncompressed	1
Output video	Uncompressed	1

# The sample pipeline

graph LR;
    NDISourceBlock-->VideoRendererBlock;
    NDISourceBlock-->AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// get NDI source info by enumerating sources
var ndiSources = await DeviceEnumerator.Shared.NDISourcesAsync();
var ndiSourceInfo = ndiSources[0];

// create NDI source settings  
var ndiSettings = NDISourceSettings.CreateAsync(ndiSourceInfo);

var ndiSource = new NDISourceBlock(ndiSettings);

var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
pipeline.Connect(ndiSource.VideoOutput, videoRenderer.Input);

var audioRenderer = new AudioRendererBlock();
pipeline.Connect(ndiSource.AudioOutput, audioRenderer.Input);      

await pipeline.StartAsync();

# Sample applications

NDI Source Demo

# Platforms

Windows, macOS, Linux.

# GenICam Source Block

The GenICam source supports connection to GigE, and the USB3 Vision camera supports the GenICam protocol.

# Block info

Name: GenICamSourceBlock.

Pin direction	Media type	Pins count
Output video	various	one or more

# The sample pipeline

graph LR;
    GenICamSourceBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

var sourceSettings = new GenICamSourceSettings(cbCamera.Text, new VisioForge.Core.Types.Rect(0, 0, 512, 512), 15, GenICamPixelFormat.Mono8); 
var source = new GenICamSourceBlock(sourceSettings);

var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
pipeline.Connect(source.Output, videoRenderer.Input);

await pipeline.StartAsync();

# Sample applications

GenICam Source Demo

# Prerequisites

# macOS

Install the Aravis package using Homebrew:

brew install aravis

# Linux

Install the Aravis package using the package manager:

sudo apt-get install libaravis-0.8-dev

# Windows

Install the VisioForge.CrossPlatform.GenICam.Windows.x64 package to your project using NuGet.

# Platforms

Windows, macOS, Linux

# SRT Source Block (with decoding)

The Secure Reliable Transport (SRT) is an open-source video streaming protocol designed for secure and low-latency delivery over unpredictable networks, like the public internet. Developed by Haivision, SRT optimizes streaming performance by dynamically adapting to varying bandwidths and minimizing the effects of packet loss. It incorporates AES encryption for secure content transmission. Primarily used in broadcasting and online streaming, SRT is crucial for delivering high-quality video feeds in real-time applications, enhancing viewer experiences even in challenging network conditions. It supports point-to-point and multicast streaming, making it versatile for diverse setups.

The SRT source block provides decoded video and audio streams from an SRT source.

# Block info

Name: SRTSourceBlock.

Pin direction	Media type	Pins count
Output video	Uncompressed	0+
Output audio	Uncompressed	0+

# Settings

The SRTSourceBlock is configured using SRTSourceSettings. This class provides comprehensive options for SRT connections:

Uri (string): The SRT URI (e.g., "srt://127.0.0.1:8888" or "srt://example.com:9000?mode=listener"). Default is "srt://127.0.0.1:8888".
Mode (SRTConnectionMode enum): Specifies the SRT connection mode. Default is Caller. See SRTConnectionMode enum details below.
Passphrase (string): The password for encrypted transmission.
PbKeyLen (SRTKeyLength enum): The crypto key length for AES encryption. Default is NoKey. See SRTKeyLength enum details below.
Latency (TimeSpan): The maximum accepted transmission latency (receiver side for caller/listener, or for both in rendezvous). Default is 125 milliseconds.
StreamId (string): The stream ID for SRT access control.
LocalAddress (string): The local address to bind to when in Listener or Rendezvous mode. Default null (any).
LocalPort (uint): The local port to bind to when in Listener or Rendezvous mode. Default 7001.
Authentication (bool): Whether to authenticate the connection. Default true.
AutoReconnect (bool): Whether the source should attempt to reconnect if the connection fails. Default true.
KeepListening (bool): If false (default), the element will signal end-of-stream when the remote client disconnects (in listener mode). If true, it keeps waiting for reconnection.
PollTimeout (TimeSpan): Polling timeout used when an SRT poll is started. Default 1000 milliseconds.
WaitForConnection (bool): If true (default), blocks the stream until a client connects (in listener mode).

The SRTSourceSettings can be initialized using await SRTSourceSettings.CreateAsync(string uri, bool ignoreMediaInfoReader = false). Setting ignoreMediaInfoReader to true can be useful if media info reading fails for a live stream.

# `SRTConnectionMode` Enum

Defines the operational mode for an SRT connection:

None (0): No connection mode specified (should not typically be used directly).
Caller (1): The source initiates the connection to a listener.
Listener (2): The source waits for an incoming connection from a caller.
Rendezvous (3): Both ends initiate connection to each other simultaneously, useful for traversing firewalls.

# `SRTKeyLength` Enum

Defines the key length for SRT's AES encryption:

NoKey (0) / Length0 (0): No encryption is used.
Length16 (16): 16-byte (128-bit) AES encryption key.
Length24 (24): 24-byte (192-bit) AES encryption key.
Length32 (32): 32-byte (256-bit) AES encryption key.

# The sample pipeline

graph LR;
    SRTSourceBlock-->VideoRendererBlock;
    SRTSourceBlock-->AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

var source = new SRTSourceBlock(new SRTSourceSettings() { Uri = edURL.Text });
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
var audioRenderer = new AudioRendererBlock();

pipeline.Connect(source.VideoOutput, videoRenderer.Input);
pipeline.Connect(source.AudioOutput, audioRenderer.Input);

await pipeline.StartAsync();

# Sample applications

SRT Source Demo

# Platforms

Windows, macOS, Linux, iOS, Android.

# SRT RAW Source Block

The Secure Reliable Transport (SRT) is a streaming protocol that optimizes video data delivery over unpredictable networks, like the Internet. It is open-source and designed to handle high-performance video and audio streaming. SRT provides security through end-to-end encryption, reliability by recovering lost packets, and low latency, which is suitable for live broadcasts. It adapts to varying network conditions by dynamically managing bandwidth, ensuring high-quality streams even under suboptimal conditions. Widely used in broadcasting and streaming applications, SRT supports interoperability and is ideal for remote production and content distribution.

The SRT source supports connection to SRT sources and provides a data stream. You can connect this block to DecodeBinBlock to decode the stream.

# Block info

Name: SRTRAWSourceBlock.

Pin direction	Media type	Pins count
Output data	Any	one

# Settings

The SRTRAWSourceBlock is configured using SRTSourceSettings. Refer to the detailed description of SRTSourceSettings and its related enums (SRTConnectionMode, SRTKeyLength) under the SRT Source Block (with decoding) section for all available properties and their explanations.

# The sample pipeline

graph LR;
    SRTRAWSourceBlock-->DecodeBinBlock;
    DecodeBinBlock-->VideoRendererBlock;
    DecodeBinBlock-->AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

var source = new SRTRAWSourceBlock(new SRTSourceSettings() { Uri = edURL.Text });
var decodeBin = new DecodeBinBlock();
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
var audioRenderer = new AudioRendererBlock();

pipeline.Connect(source.Output, decodeBin.Input);
pipeline.Connect(decodeBin.VideoOutput, videoRenderer.Input);
pipeline.Connect(decodeBin.AudioOutput, audioRenderer.Input);

await pipeline.StartAsync();

# Platforms

Windows, macOS, Linux, iOS, Android.

# Other Source Blocks

# Screen Source Block

Screen source supports recording video from the screen. You can select the display (if more than one), the part of the screen to be recorded, and optional mouse cursor recording.

# Settings

The ScreenSourceBlock uses platform-specific settings classes. The choice of settings class determines the underlying screen capture technology. The ScreenCaptureSourceType enum indicates the available technologies:

# Windows

ScreenCaptureDX9SourceSettings - Use DirectX 9 for screen recording. (ScreenCaptureSourceType.DX9)
ScreenCaptureD3D11SourceSettings - Use Direct3D 11 Desktop Duplication for screen recording. Allows specific window capture. (ScreenCaptureSourceType.D3D11DesktopDuplication)
ScreenCaptureGDISourceSettings - Use GDI for screen recording. (ScreenCaptureSourceType.GDI)

# macOS

ScreenCaptureMacOSSourceSettings - Use AVFoundation for screen recording. (ScreenCaptureSourceType.AVFoundation)

# Linux

ScreenCaptureXDisplaySourceSettings - Use X11 (XDisplay) for screen recording. (ScreenCaptureSourceType.XDisplay)

# iOS

IOSScreenSourceSettings - Use AVFoundation for current window/app recording. (ScreenCaptureSourceType.IOSScreen)

# Block info

Name: ScreenSourceBlock.

Pin direction	Media type	Pins count
Output video	uncompressed video	1

# The sample pipeline

graph LR;
    ScreenSourceBlock-->H264EncoderBlock;
    H264EncoderBlock-->MP4SinkBlock;

# Sample code

// create pipeline
var pipeline = new MediaBlocksPipeline();

// create source settings
var screenSourceSettings = new ScreenCaptureDX9SourceSettings() { FrameRate = 15 }

// create source block
var screenSourceBlock = new ScreenSourceBlock(screenSourceSettings);

// create video encoder block and connect it to the source block
var h264EncoderBlock = new H264EncoderBlock(new OpenH264EncoderSettings());
pipeline.Connect(screenSourceBlock.Output, h264EncoderBlock.Input);

// create MP4 sink block and connect it to the encoder block
var mp4SinkBlock = new MP4SinkBlock(new MP4SinkSettings(@"output.mp4"));
pipeline.Connect(h264EncoderBlock.Output, mp4SinkBlock.CreateNewInput(MediaBlockPadMediaType.Video));

// run pipeline
await pipeline.StartAsync();

# [Windows] Window capture

You can capture a specific window by using the ScreenCaptureD3D11SourceSettings class.

// create Direct3D11 source
var source = new ScreenCaptureD3D11SourceSettings();

// set frame rate
source.FrameRate = new VideoFrameRate(30);

// get handle of the window
var wih = new System.Windows.Interop.WindowInteropHelper(this);
source.WindowHandle = wih.Handle;

// create source block
var screenSourceBlock = new ScreenSourceBlock(new ScreenCaptureDX9SourceSettings() { FrameRate = 15 });

// other code is the same as above

# Sample applications

# Platforms

Windows, macOS, Linux, iOS.

# Virtual Video Source Block

VirtualVideoSourceBlock is used to produce test video data in a wide variety of video formats. The type of test data is controlled by the settings.

# Settings

The VirtualVideoSourceBlock is configured using VirtualVideoSourceSettings. Key properties:

Pattern (VirtualVideoSourcePattern enum): Specifies the type of test pattern to generate. See VirtualVideoSourcePattern enum below for available patterns. Default is SMPTE.
Width (int): Width of the output video (default 1280).
Height (int): Height of the output video (default 720).
FrameRate (VideoFrameRate): Frame rate of the output video (default 30fps).
Format (VideoFormatX enum): Pixel format of the video (default RGB).
ForegroundColor (SKColor): For patterns that use a foreground color (e.g., SolidColor), this property defines it (default SKColors.White).

Constructors:

VirtualVideoSourceSettings(): Default constructor.
VirtualVideoSourceSettings(int width, int height, VideoFrameRate frameRate): Initializes with specified dimensions and frame rate.

# `VirtualVideoSourcePattern` Enum

Defines the test pattern generated by VirtualVideoSourceBlock:

SMPTE (0): SMPTE 100% color bars.
Snow (1): Random (television snow).
Black (2): 100% Black.
White (3): 100% White.
Red (4), Green (5), Blue (6): Solid colors.
Checkers1 (7) to Checkers8 (10): Checkerboard patterns with 1, 2, 4, or 8 pixel squares.
Circular (11): Circular pattern.
Blink (12): Blinking pattern.
SMPTE75 (13): SMPTE 75% color bars.
ZonePlate (14): Zone plate.
Gamut (15): Gamut checkers.
ChromaZonePlate (16): Chroma zone plate.
SolidColor (17): A solid color, defined by ForegroundColor.
Ball (18): Moving ball.
SMPTE100 (19): Alias for SMPTE 100% color bars.
Bar (20): Bar pattern.
Pinwheel (21): Pinwheel pattern.
Spokes (22): Spokes pattern.
Gradient (23): Gradient pattern.
Colors (24): Various colors pattern.
SMPTERP219 (25): SMPTE test pattern, RP 219 conformant.

# Block info

Name: VirtualVideoSourceBlock.

Pin direction	Media type	Pins count
Output video	uncompressed video	1

# The sample pipeline

graph LR;
    VirtualVideoSourceBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

var audioSourceBlock = new VirtualAudioSourceBlock(new VirtualAudioSourceSettings());
var videoSourceBlock = new VirtualVideoSourceBlock(new VirtualVideoSourceSettings());
                      
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
pipeline.Connect(videoSourceBlock.Output, videoRenderer.Input);

var audioRenderer = new AudioRendererBlock();
pipeline.Connect(audioSourceBlock.Output, audioRenderer.Input);

await pipeline.StartAsync();

# Platforms

Windows, macOS, Linux, iOS, Android.

# Virtual Audio Source Block

VirtualAudioSourceBlock is used to produce test audio data in a wide variety of audio formats. The type of test data is controlled by the settings.

# Settings

The VirtualAudioSourceBlock is configured using VirtualAudioSourceSettings. Key properties:

Wave (VirtualAudioSourceSettingsWave enum): Specifies the type of audio waveform to generate. See VirtualAudioSourceSettingsWave enum below. Default Sine.
Format (AudioFormatX enum): Audio sample format (default S16LE).
SampleRate (int): Sample rate in Hz (default 48000).
Channels (int): Number of audio channels (default 2).
Volume (double): Volume of the test signal (0.0 to 1.0, default 0.8).
Frequency (double): Frequency of the test signal in Hz (e.g., for Sine wave, default 440).
IsLive (bool): Indicates if the source is live (default true).
ApplyTickRamp (bool): Apply ramp to tick samples (default false).
CanActivatePull (bool): Can activate in pull mode (default false).
CanActivatePush (bool): Can activate in push mode (default true).
MarkerTickPeriod (uint): Make every Nth tick a marker tick (for Ticks wave, 0 = no marker, default 0).
MarkerTickVolume (double): Volume of marker ticks (default 1.0).
SamplesPerBuffer (int): Number of samples in each outgoing buffer (default 1024).
SinePeriodsPerTick (uint): Number of sine wave periods in one tick (for Ticks wave, default 10).
TickInterval (TimeSpan): Distance between start of current and start of next tick (default 1 second).
TimestampOffset (TimeSpan): An offset added to timestamps (default TimeSpan.Zero).

Constructor:

VirtualAudioSourceSettings(VirtualAudioSourceSettingsWave wave = VirtualAudioSourceSettingsWave.Ticks, int sampleRate = 48000, int channels = 2, AudioFormatX format = AudioFormatX.S16LE)

# `VirtualAudioSourceSettingsWave` Enum

Defines the waveform for VirtualAudioSourceBlock:

Sine (0): Sine wave.
Square (1): Square wave.
Saw (2): Sawtooth wave.
Triangle (3): Triangle wave.
Silence (4): Silence.
WhiteNoise (5): White uniform noise.
PinkNoise (6): Pink noise.
SineTable (7): Sine table.
Ticks (8): Periodic Ticks.
GaussianNoise (9): White Gaussian noise.
RedNoise (10): Red (Brownian) noise.
BlueNoise (11): Blue noise.
VioletNoise (12): Violet noise.

# Block info

Name: VirtualAudioSourceBlock.

Pin direction	Media type	Pins count
Output audio	uncompressed audio	1

# The sample pipeline

graph LR;
    VirtualAudioSourceBlock-->AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

var audioSourceBlock = new VirtualAudioSourceBlock(new VirtualAudioSourceSettings());
var videoSourceBlock = new VirtualVideoSourceBlock(new VirtualVideoSourceSettings());
                      
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
pipeline.Connect(videoSourceBlock.Output, videoRenderer.Input);

var audioRenderer = new AudioRendererBlock();
pipeline.Connect(audioSourceBlock.Output, audioRenderer.Input);

await pipeline.StartAsync();

# Platforms

Windows, macOS, Linux, iOS, Android.

# Demuxer Source Block

The Demuxer Source Block is used to demultiplex local media files into their constituent elementary streams (video, audio, subtitles). It allows for selective rendering of these streams.

# Block info

Name: DemuxerSourceBlock.

Pin direction	Media type	Pins count
Output video	Depends on file	0 or 1
Output audio	Depends on file	0 or 1+
Output subtitle	Depends on file	0 or 1+

# The sample pipeline

graph LR;
    DemuxerSourceBlock -- Video Stream --> VideoRendererBlock;
    DemuxerSourceBlock -- Audio Stream --> AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Create settings, ensure to await CreateAsync
var demuxerSettings = await DemuxerSourceSettings.CreateAsync(
    "path/to/your/video.mp4", 
    renderVideo: true, 
    renderAudio: true, 
    renderSubtitle: false);

if (demuxerSettings == null)
{
    Console.WriteLine("Failed to initialize demuxer settings. Ensure the file exists and is readable.");
    return;
}

var demuxerSource = new DemuxerSourceBlock(demuxerSettings);

// Setup video rendering if video is available and rendered
if (demuxerSettings.RenderVideo && demuxerSource.VideoOutput != null)
{
    var videoRenderer = new VideoRendererBlock(pipeline, VideoView1); // Assuming VideoView1 is your display control
    pipeline.Connect(demuxerSource.VideoOutput, videoRenderer.Input);
}

// Setup audio rendering if audio is available and rendered
if (demuxerSettings.RenderAudio && demuxerSource.AudioOutput != null)
{
    var audioRenderer = new AudioRendererBlock();
    pipeline.Connect(demuxerSource.AudioOutput, audioRenderer.Input);
}

// Start pipeline
await pipeline.StartAsync();

# Sample applications

No specific sample application link, but can be used in player-like scenarios.

# Platforms

Windows, macOS, Linux, iOS, Android.

# Image Video Source Block

The Image Video Source Block generates a video stream from a static image file (e.g., JPG, PNG). It repeatedly outputs the image as video frames according to the specified frame rate.

# Block info

Name: ImageVideoSourceBlock.

Pin direction	Media type	Pins count
Output video	Uncompressed video	1

# The sample pipeline

graph LR;
    ImageVideoSourceBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Create image video source settings
var imageSourceSettings = new ImageVideoSourceSettings("path/to/your/image.jpg"); // Replace with your image path
imageSourceSettings.FrameRate = new VideoFrameRate(10); // Output 10 frames per second
imageSourceSettings.IsLive = true; // Treat as a live source (optional)
// imageSourceSettings.NumBuffers = 100; // Optional: output only 100 frames then stop

var imageSource = new ImageVideoSourceBlock(imageSourceSettings);

// Create video renderer
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1); // Assuming VideoView1 is your display control

// Connect blocks
pipeline.Connect(imageSource.Output, videoRenderer.Input);

// Start pipeline
await pipeline.StartAsync();

# Remarks

This block uses SkiaSharp for image decoding, so ensure necessary dependencies are met if not using a standard VisioForge package that includes it.

# Platforms

Windows, macOS, Linux, iOS, Android.

# Push Source Blocks

Push Source blocks allow you to feed media data (video, audio, JPEG images, or generic data) directly into the Media Blocks pipeline from your application code. This is useful when your media originates from a custom source, such as a proprietary capture device, a network stream not supported by built-in blocks, or procedurally generated content.

The behavior of push sources is generally controlled by common settings available through the IPushSourceSettings interface, implemented by specific push source settings classes:

IsLive (bool): Indicates if the source is live. Defaults vary by type (e.g., true for audio/video).
DoTimestamp (bool): If true, the block will attempt to generate timestamps for the pushed data.
StreamType (PushSourceStreamType enum: Stream or SeekableStream): Defines the stream characteristics.
PushFormat (PushSourceFormat enum: Bytes, Time, Default, Automatic): Controls how data is pushed (e.g., based on byte count or time).
BlockPushData (bool): If true, the push operation will block until the data is consumed by the pipeline.

The specific type of push source is determined by the PushSourceType enum: Video, Audio, Data, JPEG.

# Push Video Source Block

Allows pushing raw video frames into the pipeline.

# Block info

Name: PushSourceBlock (configured for video).

Pin direction	Media type	Pins count
Output video	Uncompressed video	1

# Settings

Configured using PushVideoSourceSettings:

Width (int): Width of the video frames.
Height (int): Height of the video frames.
FrameRate (VideoFrameRate): Frame rate of the video.
Format (VideoFormatX enum): Pixel format of the video frames (e.g., RGB, NV12, I420).
Inherits common push settings like IsLive (defaults to true), DoTimestamp, StreamType, PushFormat, BlockPushData.

Constructor: PushVideoSourceSettings(int width, int height, VideoFrameRate frameRate, VideoFormatX format = VideoFormatX.RGB)

# The sample pipeline

graph LR;
    PushVideoSourceBlock-->VideoEncoderBlock-->MP4SinkBlock;
    PushVideoSourceBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Configure push video source
var videoPushSettings = new PushVideoSourceSettings(
    width: 640, 
    height: 480, 
    frameRate: new VideoFrameRate(30), 
    format: VideoFormatX.RGB);
// videoPushSettings.IsLive = true; // Default

var videoPushSource = new PushSourceBlock(videoPushSettings);

// Example: Render the pushed video
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
pipeline.Connect(videoPushSource.Output, videoRenderer.Input);

// Start pipeline
await pipeline.StartAsync();

// In a separate thread or task, push video frames:
// byte[] frameData = ... ; // Your raw RGB frame data (640 * 480 * 3 bytes)
// videoPushSource.PushFrame(frameData); 
// Call PushFrame repeatedly for each new video frame.

# Platforms

Windows, macOS, Linux, iOS, Android.

# Push Audio Source Block

Allows pushing raw audio samples into the pipeline.

# Block info

Name: PushSourceBlock (configured for audio).

Pin direction	Media type	Pins count
Output audio	Uncompressed audio	1

# Settings

Configured using PushAudioSourceSettings:

SampleRate (int): Sample rate of the audio (e.g., 44100, 48000).
Channels (int): Number of audio channels (e.g., 1 for mono, 2 for stereo).
Format (AudioFormatX enum): Format of the audio samples (e.g., S16LE for 16-bit signed little-endian PCM).
Inherits common push settings like IsLive (defaults to true), DoTimestamp, StreamType, PushFormat, BlockPushData.

Constructor: PushAudioSourceSettings(bool isLive = true, int sampleRate = 48000, int channels = 2, AudioFormatX format = AudioFormatX.S16LE)

# The sample pipeline

graph LR;
    PushAudioSourceBlock-->AudioEncoderBlock-->MP4SinkBlock;
    PushAudioSourceBlock-->AudioRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Configure push audio source
var audioPushSettings = new PushAudioSourceSettings(
    isLive: true, 
    sampleRate: 44100, 
    channels: 2, 
    format: AudioFormatX.S16LE);

var audioPushSource = new PushSourceBlock(audioPushSettings);

// Example: Render the pushed audio
var audioRenderer = new AudioRendererBlock();
pipeline.Connect(audioPushSource.Output, audioRenderer.Input);

// Start pipeline
await pipeline.StartAsync();

// In a separate thread or task, push audio samples:
// byte[] audioData = ... ; // Your raw PCM S16LE audio data
// audioPushSource.PushFrame(audioData); 
// Call PushFrame repeatedly for new audio data.

# Platforms

Windows, macOS, Linux, iOS, Android.

# Push Data Source Block

Allows pushing generic byte data into the pipeline. The interpretation of this data depends on the Caps (capabilities) specified.

# Block info

Name: PushSourceBlock (configured for data).

Pin direction	Media type	Pins count
Output data	Custom	1

# Settings

Configured using PushDataSourceSettings:

Caps (Gst.Caps): GStreamer capabilities string describing the data format (e.g., "video/x-h264, stream-format=byte-stream"). This is crucial for downstream blocks to understand the data.
PadMediaType (MediaBlockPadMediaType enum): Specifies the type of the output pad (e.g., Video, Audio, Data, Auto).
Inherits common push settings like IsLive, DoTimestamp, StreamType, PushFormat, BlockPushData.

# The sample pipeline

graph LR;
    PushDataSourceBlock-->ParserOrDecoder-->Renderer;

Example: Pushing H.264 Annex B byte stream

graph LR;
    PushDataSourceBlock-->H264ParserBlock-->H264DecoderBlock-->VideoRendererBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Configure push data source for H.264 byte stream
var dataPushSettings = new PushDataSourceSettings();
dataPushSettings.Caps = new Gst.Caps("video/x-h264, stream-format=(string)byte-stream");
dataPushSettings.PadMediaType = MediaBlockPadMediaType.Video;
// dataPushSettings.IsLive = true; // Set if live

var dataPushSource = new PushSourceBlock(dataPushSettings);

// Example: Decode and render H.264 stream
var h264Parser = new H264ParserBlock();
var h264Decoder = new H264DecoderBlock(); // Or OpenH264DecoderBlock, etc.
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);

pipeline.Connect(dataPushSource.Output, h264Parser.Input);
pipeline.Connect(h264Parser.Output, h264Decoder.Input);
pipeline.Connect(h264Decoder.Output, videoRenderer.Input);

// Start pipeline
await pipeline.StartAsync();

// In a separate thread or task, push H.264 NALUs:
// byte[] naluData = ... ; // Your H.264 NALU data
// dataPushSource.PushFrame(naluData);

# Platforms

Windows, macOS, Linux, iOS, Android.

# Push JPEG Source Block

Allows pushing individual JPEG images, which are then output as a video stream.

# Block info

Name: PushSourceBlock (configured for JPEG).

Pin direction	Media type	Pins count
Output video	Uncompressed video	1

# Settings

Configured using PushJPEGSourceSettings:

Width (int): Width of the decoded JPEG images.
Height (int): Height of the decoded JPEG images.
FrameRate (VideoFrameRate): The frame rate at which the JPEG images will be presented as a video stream.
Inherits common push settings like IsLive (defaults to true), DoTimestamp, StreamType, PushFormat, BlockPushData.

Constructor: PushJPEGSourceSettings(int width, int height, VideoFrameRate frameRate)

# The sample pipeline

graph LR;
    PushJPEGSourceBlock-->VideoRendererBlock;
    PushJPEGSourceBlock-->VideoEncoderBlock-->MP4SinkBlock;

# Sample code

var pipeline = new MediaBlocksPipeline();

// Configure push JPEG source
var jpegPushSettings = new PushJPEGSourceSettings(
    width: 1280, 
    height: 720, 
    frameRate: new VideoFrameRate(10)); // Present JPEGs as a 10 FPS video

var jpegPushSource = new PushSourceBlock(jpegPushSettings);

// Example: Render the video stream from JPEGs
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);
pipeline.Connect(jpegPushSource.Output, videoRenderer.Input);

// Start pipeline
await pipeline.StartAsync();

// In a separate thread or task, push JPEG image data:
// byte[] jpegImageData = File.ReadAllBytes("image.jpg");
// jpegPushSource.PushFrame(jpegImageData); 
// Call PushFrame for each new JPEG image.

# Platforms

Windows, macOS, Linux, iOS, Android.

# Apple Platform Source Blocks

# iOS Video Source Block

iOSVideoSourceBlock provides video capture from the device camera on iOS platforms. It is available only on iOS (not macOS Catalyst).

# Block info

Name: IOSVideoSourceBlock.

Pin direction	Media type	Pins count
Output video	Uncompressed video	1

# Enumerate available devices

Use DeviceEnumerator.Shared.VideoSourcesAsync() to get a list of available video devices on iOS. Each device is represented by a VideoCaptureDeviceInfo object.

# The sample pipeline

graph LR;
    IOSVideoSourceBlock-->VideoRendererBlock;

# Sample code

// create pipeline
var pipeline = new MediaBlocksPipeline();

// select the first available video device
var device = (await DeviceEnumerator.Shared.VideoSourcesAsync())[0];
VideoCaptureDeviceSourceSettings videoSourceSettings = null;
if (device != null)
{
    var formatItem = device.VideoFormats[0];
    if (formatItem != null)
    {
        videoSourceSettings = new VideoCaptureDeviceSourceSettings(device)
        {
            Format = formatItem.ToFormat()
        };
        videoSourceSettings.Format.FrameRate = formatItem.FrameRateList[0];
    }
}

// create iOS video source block
var videoSource = new IOSVideoSourceBlock(videoSourceSettings);

// create video renderer block
var videoRenderer = new VideoRendererBlock(pipeline, VideoView1);

// connect blocks
pipeline.Connect(videoSource.Output, videoRenderer.Input);

// start pipeline
await pipeline.StartAsync();

# Platforms

iOS (not available on macOS Catalyst)

# macOS Audio Source Block

OSXAudioSourceBlock provides audio capture from input devices on macOS platforms.

# Block info

Name: OSXAudioSourceBlock.

Pin direction	Media type	Pins count
Output audio	Uncompressed audio	1

# Enumerate available devices

Use DeviceEnumerator.Shared.AudioSourcesAsync() to get a list of available audio devices on macOS. Each device is represented by an AudioCaptureDeviceInfo object.

# The sample pipeline

graph LR;
    OSXAudioSourceBlock-->AudioRendererBlock;

# Sample code

// create pipeline
var pipeline = new MediaBlocksPipeline();

// select the first available audio device
var devices = await DeviceEnumerator.Shared.AudioSourcesAsync();
var device = devices.Length > 0 ? devices[0] : null;
OSXAudioSourceSettings audioSourceSettings = null;
if (device != null)
{
    var formatItem = device.Formats[0];
    if (formatItem != null)
    {
        audioSourceSettings = new OSXAudioSourceSettings(device.DeviceID, formatItem);
    }
}

// create macOS audio source block
var audioSource = new OSXAudioSourceBlock(audioSourceSettings);

// create audio renderer block
var audioRenderer = new AudioRendererBlock();

// connect blocks
pipeline.Connect(audioSource.Output, audioRenderer.Input);

// start pipeline
await pipeline.StartAsync();

# Platforms

macOS (not available on iOS)

# Source Blocks - VisioForge Media Blocks SDK .Net

# Hardware Source Blocks

# System Video Source

# Block info

# Enumerate available devices

# The sample pipeline

# Sample code

# Sample applications

# Remarks

# Platforms

# System Audio Source

# Block info

# Enumerate available devices

# The sample pipeline

# Sample code

# Capture audio from speakers (loopback)

# Sample applications

# Remarks

# Platforms

# Basler Source Block

# Block info

# The sample pipeline

# Sample code

# Sample applications

# Platforms

# Spinnaker/FLIR Source Block

# Enumerate Devices & SpinnakerCameraInfo

# Settings

# Block info

# The sample pipeline

# Sample code

# Requirements

# Platforms

# Allied Vision Source Block

# Block info

# The sample pipeline

# Sample code

# Requirements

# Sample applications

# Platforms

# Blackmagic Decklink Source Block

# File Source Blocks

# Universal Source Block

# Settings

# Block info

# The sample pipeline

# Sample code

# Sample applications

# Platforms

# Subtitle Source Block

# Block info

# Settings

# The sample pipeline

# Sample code

# Platforms

# Stream Source Block

# Block info

# Settings

# The sample pipeline

# Sample code

# Remarks

# Platforms

# CDG Source Block

# Block info

# The sample pipeline

# Sample code

# Remarks

# Platforms

# Network Source Blocks

# VNC Source Block

# Block info

# Settings

# The sample pipeline

# Sample code

# Platforms

# RTSP Source Block

# Block info

# Settings

# The sample pipeline

# Sample code

# Enumerate Devices & `SpinnakerCameraInfo`

# `SRTConnectionMode` Enum

# `SRTKeyLength` Enum

# `VirtualVideoSourcePattern` Enum

# `VirtualAudioSourceSettingsWave` Enum