Table of Contents

Class RTCError

Namespace
CSharpToJavaScript.APIs.JS
Assembly
CSharpToJavaScript.dll

The RTCError interface describes an error which has occurred while handling WebRTC operations. It's based upon the standard DOMException interface that describes general DOM errors.

[Value("RTCError")]
public class RTCError : DOMException
Inheritance
RTCError
Inherited Members

Remarks

Constructors

RTCError()

public RTCError()

RTCError(RTCErrorInit, string)

public RTCError(RTCErrorInit init, string message = null)

Parameters

init RTCErrorInit
message string

Properties

ErrorDetail

The RTCError interface's read-only
errorDetail property is a string indicating the WebRTC-specific error code that occurred.

[Value("errorDetail")]
public RTCErrorDetailType ErrorDetail { get; }

Property Value

RTCErrorDetailType

A read-only string whose value indicates the type of WebRTC-specific error that
occurred on an RTCPeerConnection. The possible values are:

Remarks

HttpRequestStatusCode

[Value("httpRequestStatusCode")]
public long? HttpRequestStatusCode { get; }

Property Value

long?

ReceivedAlert

The RTCError read-only property
receivedAlert specifies the fatal DTLS
error which resulted in an alert being received from the remote peer.

[Value("receivedAlert")]
public ulong? ReceivedAlert { get; }

Property Value

ulong?

An unsigned long integer value specifying the fatal DTLS error which
resulted in an alert being received from the remote peer.

NOTE
This property is null if the RTCError doesn't represent a
DTLS error (with ErrorDetail set to
dtls-failure).

Remarks

SctpCauseCode

The read-only sctpCauseCode property in an
RTCError object provides the {{Glossary("SCTP")}} cause code explaining
why the SCTP negotiation failed, if the RTCError represents an SCTP error.

[Value("sctpCauseCode")]
public long? SctpCauseCode { get; }

Property Value

long?

An unsigned long integer value specifying SCTP cause code explaining why the error
occurred. This property is null if the error isn't an SCTP error, with its
ErrorDetail property set to
sctp-failure.The standard SCTP error cause codes, numbered 1-13, are defined in the SCTP
specification: {{RFC(4960, "", "3.3.10")}}.

Remarks

SdpLineNumber

The RTCError interface's read-only property
sdpLineNumber specifies the line number within the
SDP at which a syntax error occurred while parsing it.

[Value("sdpLineNumber")]
public long? SdpLineNumber { get; }

Property Value

long?

An unsigned integer value indicating the line within the SDP at which the syntax error
described by the RTCError object occurred. The lines are numbered starting
with line 1.This property is null unless the value of
ErrorDetail is sdp-syntax-error.

Remarks

SentAlert

The read-only sentAlert property in an
RTCError object specifies the {{Glossary("DTLS")}} alert number occurred
while sending data to the remote peer, if the error represents an outbound DTLS error.

[Value("sentAlert")]
public ulong? SentAlert { get; }

Property Value

ulong?

An unsigned integer value providing the DTLS alert number corresponding to the DTLS
error which was sent to the remote peer, as represented by this RTCError
object. This property is null if ErrorDetail
isn't dtls-failure.

Remarks