# Media Blocks SDK .Net - Developer Quick Start Guide

# Introduction

This developer guide provides a complete walkthrough for integrating the Media Blocks SDK .Net into your applications. Whether you're building video processing tools, streaming solutions, or multimedia applications, this guide will take you through all essential steps to get your project up and running quickly.

# SDK Installation Process

The SDK is distributed as a NuGet package for easy integration into your .Net projects. You can install it using the following command in your terminal or package manager console:

dotnet add package VisioForge.DotNet.MediaBlocks

For platform-specific requirements and additional installation details, please refer to the detailed installation guide for your operating system.

# SDK Initialization Steps

Before using any SDK functionality, proper initialization is required. This step prepares the necessary resources for the SDK to function correctly.

using VisioForge.Core;

// Initialize the SDK at application startup
VisioForgeX.InitSDK();

# Creating Your First Pipeline

The pipeline is the core component of the Media Blocks SDK architecture. It manages the flow of media data between different processing blocks.

using VisioForge.Core.MediaBlocks;

private MediaBlocksPipeline _pipeline;

// Create a new pipeline instance
_pipeline = new MediaBlocksPipeline();

When working with live media streams, it's important to set the live parameter to true to ensure proper real-time processing.

# Error Handling in Pipelines

Robust error handling is crucial for media applications. Subscribe to the pipeline's error events to catch and handle exceptions:

_pipeline.OnError += (sender, args) =>
{
    Console.WriteLine($"Pipeline error: {args.Message}");
    // Implement your error handling logic here
};

You can also monitor pipeline state changes by subscribing to the OnStart and OnStop events for implementing startup and shutdown procedures.

# Configuring Media Blocks

The power of the SDK comes from its modular block system. Here's how to add and configure essential blocks.

# Adding a Virtual Video Source

Virtual video sources are useful for testing or generating synthetic video content:

private VirtualVideoSourceBlock _virtualSource;

// Create a virtual video source with default settings
_virtualSource = new VirtualVideoSourceBlock(new VirtualVideoSourceSettings());

# Setting Up Video Rendering

To display video content on screen, add a renderer block connected to a UI control:

private VideoRendererBlock _videoRenderer;

// Connect the renderer to a VideoView control in your UI
_videoRenderer = new VideoRendererBlock(_pipeline, VideoView1);

The VideoView control should be added to your application window from the appropriate UI package for your platform (e.g., VisioForge.DotNet.Core.UI.MAUI for MAUI applications).

# Connecting Pipeline Components

Media blocks need to be connected to establish the flow of data through your pipeline:

// Connect the output of the source to the input of the renderer
_pipeline.Connect(_virtualSource.Output, _videoRenderer.Input);

Different block types may have multiple inputs and outputs, allowing you to create complex processing graphs. You can chain multiple blocks together to create sophisticated media processing workflows.

# Pipeline Operation Management

# Starting the Pipeline

To begin media processing, start the pipeline asynchronously:

// Start the pipeline and begin processing
await _pipeline.StartAsync();

Once started, you'll see the video from your configured source displayed through the renderer.

# Stopping the Pipeline

When you need to pause or stop processing, call the stop method:

// Stop all pipeline processing
await _pipeline.StopAsync();

# Pipeline Resource Cleanup

Always dispose of the pipeline when it's no longer needed to free system resources:

// Clean up all pipeline resources
_pipeline.Dispose();

# SDK Cleanup Process

When your application is shutting down, properly de-initialize the SDK:

// Release all SDK resources
VisioForgeX.DestroySDK();

This ensures all resources are properly released and prevents memory leaks.

# Advanced Examples and Sample Code

To further explore the capabilities of the Media Blocks SDK, check out these sample implementations:

For a comprehensive collection of code samples and demo applications, visit our GitHub repository.