Table of Contents

Interface IVideoRenderer

Namespace
VAST.Media
Assembly
VAST.Common.dll

Defines the contract for a video renderer that displays video frames.

public interface IVideoRenderer : IDisposable
Inherited Members

Properties

DeviceOfflineImage

Gets or sets the image stream to display when the device is offline or no video is available.

Stream DeviceOfflineImage { get; set; }

Property Value

Stream

Fullscreen

Gets or sets a value indicating whether the renderer is in fullscreen mode.

bool Fullscreen { get; set; }

Property Value

bool

InputMediaType

Gets or sets the media type of the input video frames.

MediaType InputMediaType { get; set; }

Property Value

MediaType

InputRect

Gets or sets the input rectangle defining the source region to render.

Rect InputRect { get; set; }

Property Value

Rect

InstanceId

Gets or sets the unique identifier for this renderer instance.

Guid InstanceId { get; set; }

Property Value

Guid

PlatformContext

Gets or sets the platform-specific rendering context (e.g., a window handle or surface).

object PlatformContext { get; set; }

Property Value

object

RenderingFramerate

Gets or sets the target rendering framerate.

Rational RenderingFramerate { get; set; }

Property Value

Rational

RenderingStrategy

Gets or sets the rendering strategy that controls timing and synchronization behavior.

RenderingStrategy RenderingStrategy { get; set; }

Property Value

RenderingStrategy

State

Gets the current state of the renderer.

RendererState State { get; }

Property Value

RendererState

Stretch

Gets or sets the stretch mode used when rendering video to the output surface.

StretchType Stretch { get; set; }

Property Value

StretchType

Methods

Clear(string)

Clears the rendering surface.

void Clear(string color = null)

Parameters

color string

The color to fill the surface with, or null to use the default background color.

Present()

Presents the current frame to the display surface.

void Present()

Process(VersatileBuffer)

Processes a video frame for rendering.

void Process(VersatileBuffer packet)

Parameters

packet VersatileBuffer

The buffer containing the video frame data.

Start()

Starts the video renderer.

void Start()

Stop()

Stops the video renderer.

void Stop()