Class RTCConfiguration

Defines the parameters to configure how a new RTCPeerConnection is created.

Inheritance

System.Object

RTCConfiguration

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: SIPSorcery.Net

Assembly: SIPSorcery.dll

Syntax

public class RTCConfiguration

Remarks

As specified in https://www.w3.org/TR/webrtc/#rtcconfiguration-dictionary.

Fields

bundlePolicy

Declaration

public RTCBundlePolicy bundlePolicy

Field Value

Type	Description
RTCBundlePolicy

certificates

Declaration

public List<RTCCertificate> certificates

Field Value

Type	Description
System.Collections.Generic.List<RTCCertificate>

certificates2

Declaration

public List<RTCCertificate2> certificates2

Field Value

Type	Description
System.Collections.Generic.List<RTCCertificate2>

iceCandidatePoolSize

Size of the pre-fetched ICE pool. Defaults to 0.

Declaration

public int iceCandidatePoolSize

Field Value

Type	Description
System.Int32

iceServers

Declaration

public List<RTCIceServer> iceServers

Field Value

Type	Description
System.Collections.Generic.List<RTCIceServer>

iceTransportPolicy

Declaration

public RTCIceTransportPolicy iceTransportPolicy

Field Value

Type	Description
RTCIceTransportPolicy

rtcpMuxPolicy

Declaration

public RTCRtcpMuxPolicy rtcpMuxPolicy

Field Value

Type	Description
RTCRtcpMuxPolicy

X_BindAddress

Optional. If specified this address will be used as the bind address for any RTP and control sockets created. Generally this address does not need to be set. The default behaviour is to bind to [::] or 0.0.0.0, depending on system support, which minimises network routing causing connection issues.

Declaration

public IPAddress X_BindAddress

Field Value

Type	Description
System.Net.IPAddress

X_DisableExtendedMasterSecretKey

The Bouncy Castle DTLS logic enforces the use of Extended Master Secret Keys as per RFC7627. Some WebRTC implementations do not support Extended Master Secret Keys (for example Kurento in Mar 2021) and this configuration option is made available for cases where an application explicitly decides it's acceptable to disable them.

Declaration

public bool X_DisableExtendedMasterSecretKey

Field Value

Type	Description
System.Boolean

Remarks

From https://tools.ietf.org/html/rfc7627#section-4: "Clients and servers SHOULD NOT accept handshakes that do not use the extended master secret, especially if they rely on features like compound authentication that fall into the vulnerable cases described in Section 6.1."

X_ICEIncludeAllInterfaceAddresses

When gathering host ICE candidates for the local machine the default behaviour is to only use IP addresses on the interface that the OS routing table selects to connect to the destination, or the Internet facing interface if the destination is unknown. This default behaviour is to shield the leaking of all local IP addresses into ICE candidates. In some circumstances, and after weighing up the security concerns, it's very useful to include all interfaces in when generating the address list. Setting this parameter to true will cause all interfaces to be used irrespective of the destination address

Declaration

public bool X_ICEIncludeAllInterfaceAddresses

Field Value

Type	Description
System.Boolean

X_UseRsaForDtlsCertificate

Set to true to use the RSA key in the certificate for the DTLS handshake. The default is to use ECDSA. Chrome has defaulted to ECDSA since 2016 (see https://developer.chrome.com/blog/webrtc-ecdsa).

Declaration

public bool X_UseRsaForDtlsCertificate

Field Value

Type	Description
System.Boolean

X_UseRtpFeedbackProfile

Optional. If set to true the feedback profile set in the SDP offers and answers will be UDP/TLS/RTP/SAVPF instead of UDP/TLS/RTP/SAVP.

Declaration

public bool X_UseRtpFeedbackProfile

Field Value

Type	Description
System.Boolean

Extension Methods

JSONWriter.ToJson(Object)