Skip to main content
Version: 0.9.0 (next)

PrimarylessVideoSenderOptions class

Arguments of PrimarylessVideoSender: application-owned video, such as GUI panel content, under a library-generated StreamId. Unlike a render sender it answers no receiver request and may exist before any receiver connects.

Namespace: Quaternar.Qaros · Assembly: Quaternar.Qaros.dll

public sealed class PrimarylessVideoSenderOptions

Remarks​

The stream-parameter property matching PrimarylessVideoSenderOptions.GraphicsAPI must be set and the other two left null; creating the sender throws ArgumentException otherwise.

Constructors​

PrimarylessVideoSenderOptions(VideoFrameLayout)​

public PrimarylessVideoSenderOptions(VideoFrameLayout layout)

Parameters

NameTypeDescription
layoutVideoFrameLayout

Properties​

MemberDescription
LayoutRequired. The views and textures the application writes; change it later with PrimarylessVideoSender.ChangeLayout.
EnableReconnectsDefaults to true.
ReconnectTimeoutDefaults to 5 minutes. Must be positive and is sent in whole milliseconds; creating the sender throws ArgumentOutOfRangeException otherwise, even with PrimarylessVideoSenderOptions.EnableReconnects false.
GraphicsAPIDefaults to GraphicsAPI.Cpu.
StreamParamsD3D11Required when PrimarylessVideoSenderOptions.GraphicsAPI is GraphicsAPI.D3D11; must be null otherwise.
StreamParamsVulkanRequired when PrimarylessVideoSenderOptions.GraphicsAPI is GraphicsAPI.Vulkan; must be null otherwise.
StreamParamsOpenGlRequired when PrimarylessVideoSenderOptions.GraphicsAPI is GraphicsAPI.OpenGL; must be null otherwise.

Layout​

Required. The views and textures the application writes; change it later with PrimarylessVideoSender.ChangeLayout.

public VideoFrameLayout Layout { get; set; }

Value: VideoFrameLayout

EnableReconnects​

Defaults to true.

public bool EnableReconnects { get; set; }

Value: bool

ReconnectTimeout​

Defaults to 5 minutes. Must be positive and is sent in whole milliseconds; creating the sender throws ArgumentOutOfRangeException otherwise, even with PrimarylessVideoSenderOptions.EnableReconnects false.

public TimeSpan ReconnectTimeout { get; set; }

Value: TimeSpan

GraphicsAPI​

Defaults to GraphicsAPI.Cpu.

public GraphicsAPI GraphicsAPI { get; set; }

Value: GraphicsAPI

StreamParamsD3D11​

Required when PrimarylessVideoSenderOptions.GraphicsAPI is GraphicsAPI.D3D11; must be null otherwise.

public StreamParamsD3D11? StreamParamsD3D11 { get; set; }

Value: StreamParamsD3D11

StreamParamsVulkan​

Required when PrimarylessVideoSenderOptions.GraphicsAPI is GraphicsAPI.Vulkan; must be null otherwise.

public StreamParamsVulkan? StreamParamsVulkan { get; set; }

Value: StreamParamsVulkan

StreamParamsOpenGl​

Required when PrimarylessVideoSenderOptions.GraphicsAPI is GraphicsAPI.OpenGL; must be null otherwise.

public StreamParamsOpenGl? StreamParamsOpenGl { get; set; }

Value: StreamParamsOpenGl