Table of Contents

Class WebRTCSinkSettings

Namespace
VisioForge.Core.Types.X.Sinks
Assembly
VisioForge.Core.dll

Settings of VisioForge.Core.MediaBlocks.Sinks.WebRTCSinkBlock: a WebRTC producer that runs its own signalling server and, optionally, a web server for the viewer page.

public class WebRTCSinkSettings : IMediaBlockSettings

Inheritance

Implements

Inherited Members

Properties

CongestionControl

Gets or sets the congestion control algorithm.

public WebRTCSinkCongestionControl CongestionControl { get; set; }

Property Value

WebRTCSinkCongestionControl

MaxBitrate

Gets or sets the highest bitrate congestion control may reach, in bits per second. Must not be below VisioForge.Core.Types.X.Sinks.WebRTCSinkSettings.StartBitrate, or the build fails.

public uint MaxBitrate { get; set; }

Property Value

uint

SignallingServerHost

Gets or sets the address the signalling (WebSocket) server listens on. The default accepts viewers on this machine only; 0.0.0.0 accepts viewers from other machines.

public string SignallingServerHost { get; set; }

Property Value

string

SignallingServerPort

Gets or sets the port of the signalling (WebSocket) server.

public int SignallingServerPort { get; set; }

Property Value

int

StartBitrate

Gets or sets the bitrate each viewer starts at, in bits per second. Must be within 1000..VisioForge.Core.Types.X.Sinks.WebRTCSinkSettings.MaxBitrate, or the build fails.

public uint StartBitrate { get; set; }

Property Value

uint

StunServer

Gets or sets the STUN server in the form stun://hostname:port. null keeps the element's default (stun://stun.l.google.com:19302).

public string StunServer { get; set; }

Property Value

string

TurnServers

Gets or sets the TURN servers in the form turn(s)://username:password@host:port.

public string[] TurnServers { get; set; }

Property Value

string[]

WebServerAddress

Gets or sets the address the web server listens on, for example http://0.0.0.0:8080/. Only http:// is supported; the build fails when the port is already in use.

public string WebServerAddress { get; set; }

Property Value

string

WebServerDirectory

Gets or sets the folder with the viewer page served over HTTP. null or empty runs no web server.

public string WebServerDirectory { get; set; }

Property Value

string

Methods

CreateBlock()

Creates the media block instance for WebRTC sink.

public MediaBlock CreateBlock()

Returns

MediaBlock

A new instance of VisioForge.Core.MediaBlocks.Sinks.WebRTCSinkBlock configured with these settings.