VTErrorCode

The VTErrorCode model gathers information about possible errors that can occur during SDK usage. This model includes the following errors:

• accessToken: Occurs when a client tries to use an invalid access token. For more information about the access token, see the Initializing the SDK or Enhanced Conference Access Control document.

• capacityLimit: Occurs when a client tries to join a conference that reached the capacity limit and no longer accepts new participants.

• closureCanceled: Occurs when a client simultaneously opens several sessions and then closes one of these sessions. This action closes the rest of the requested sessions and emits the closureCanceled error.

• conference: Occurs when a client tries to interact with an inactive conference, for example before the conference starts or after the end of the conference.

• credential: Occurs when a client tries to use an uninitialized SDK. Dolby.io Communications APIs requires initializing the SDK before usage. For more information, see the Initializing the SDK document.

• data: Occurs when a server returns invalid data.

• deviceIdentifier: Occurs when the SDK cannot successfully get the device identifier.

• dolbyVoice: Occurs when a client who is connected to the Dolby Voice conference tries to use methods that are not supported in Dolby Voice conferences.

• fileNotFound: Occurs when the SDK cannot find a file selected by a conference participant and, therefore, is not able to share this file during a conference.

• session: Occurs when the SDK cannot successfully perform the requested action due to a session issue.

• spatialAudio: Occurs in the following situations:

  • A participant tries to use spatial audio in a non-Dolby Voice conference.
  • A participant tries to use spatial audio when spatialAudio is not enabled in JoinOptions.
  • A participant calls setSpatialDirection, setSpatialEnvironment, or setSpatialPosition to set the spatial audio scene for listeners. Setting spatial audio scene for listeners requires using Set Spatial Listeners Audio REST API.

• uuid: Occurs when a client uses the conference ID, which is not recognized as a valid universally unique identifier (UUID).

• videoForwarding: Occurs when a client provides an incorrect value of the max parameter. The valid parameter's values are between 0 and 25. In the case of providing a value smaller than 0, SDK triggers the error.