2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

PeerError

The PeerError exception informs about problems that occur during the call negotiation phase. These errors cause the call setup failure. The PeerError exception includes a name property, which provides more information about the error. PeerError includes the following names:

  • RemoteDescriptionError: Occurs when there is a problem with providing the session description to the application during the call negotiation phase. The session description specifies the properties of the Dolby Interactivity API platform, including the media format. The specific errors for the RemoteDescriptionError exception can be retrieved by examining the e parameter of the exception. The e parameter represents underlyingError, which is the original error from WebRTC.
  • CreateAnswerError: Occurs when the client SDK creates an answer to the remote description from the Dolby Interactivity API platform and configures its local description. The answer includes information about media attached to the session, codecs, options supported by the browser, and gathered ICE candidates. The local description specifies the properties of the local end of the connection, including the media format. The specific errors for the CreateAnswerError exception can be retrieved by examining the e parameter of the exception. The e parameter represents underlyingError, which is the original error from WebRTC.
  • ConnectionFailedError: Usually caused by a network failure. It occurs when the peer connection state has one of the following values:

    • failed
    • connecting for more than 40 seconds

The valid PeerConnectionState values are defined in the MDN Web documentation.

Note: The Chrome browser does not support software H264 encoding and decoding on Android devices. Therefore, the Chrome usage may result in the LocalDescriptionError (present under the CreateAnswerError name) and RemoteDescriptionError exceptions on Android devices that do not support the H264 codec in their hardware. Due to a known Chrome issue, this problem may also appear on other Android devices when a participant joins a conference as a listener.

Constructors

constructor

+ new PeerError(name: any, message: any, peerId: any, e: any): PeerError

Parameters:

NameTypeDescription
nameanyThe name of the specific error, either RemoteDescriptionError, CreateAnswerError, or ConnectionFailedError
messageanyThe error message
peerIdanyThe peer ID
eanyThe original WebRTC error

Returns: PeerError

Properties

Static Error

Error: ErrorConstructor