Table of Contents

Class WHIPSinkSettings

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

WHIP (WebRTC-HTTP Ingestion Protocol) sink settings.

public class WHIPSinkSettings : IMediaBlockSettings

Inheritance

Implements

Inherited Members

Properties

AuthToken

Gets or sets the authentication token sent as Bearer token in HTTP header.

public string AuthToken { get; set; }

Property Value

string

IceTransportPolicy

Gets or sets the ICE transport policy.

public WHIPIceTransportPolicy IceTransportPolicy { get; set; }

Property Value

WHIPIceTransportPolicy

Location

Gets or sets the WHIP endpoint URL.

public string Location { get; set; }

Property Value

string

StunServer

Gets or sets the STUN server URL in format stun://hostname:port.

public string StunServer { get; set; }

Property Value

string

Timeout

Gets or sets the timeout in seconds for WHIP endpoint requests.

public TimeSpan Timeout { get; set; }

Property Value

TimeSpan

TurnServer

Gets or sets the TURN server URL in format turn(s)://username:password@host:port.

public string TurnServer { get; set; }

Property Value

string

UseLinkHeaders

Gets or sets a value indicating whether to use link headers from the WHIP server response to configure ICE servers.

public bool UseLinkHeaders { get; set; }

Property Value

bool

Methods

CreateBlock()

Creates the media block instance for WHIP sink.

public MediaBlock CreateBlock()

Returns

MediaBlock

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