OpentokError.ErrorCode

public static final enum ErrorCode

Enclosing class: OpentokError

Defines error code values for OpentokError objects.

Enum constants

Name Description
UnknownError
AuthorizationFailure An invalid API key or token was provided.
InvalidSessionId Unable to connect: an invalid session ID was provided.
ConnectionFailed The session failed to connect.
NoMessagingServer There was an error connecting to the OpenTok messaging server.
ConnectionRefused A socket could not be opened to OpenTok the messaging server. Check that outbound ports 443 and 8080 are accessible.
SessionStateFailed The connection timed out while attempting to get the session's state. Check the network connection.
P2PSessionMaxParticipants A peer-to-peer enabled session can only have two participants.
SessionConnectionTimeout The connection timed out while attempting to connect to the session. Check the network connection.
SessionInternalError Internal error connecting to the session. Try connecting again.
SessionInvalidSignalType Invalid signal type.
SessionSignalDataTooLong Invalid signal -- the data string is too long (maximum length 8196).
SessionSignalTypeTooLong Invalid signal -- the type string is too long (maximum length 128).
SessionUnableToForceDisconnect Unable to force disconnect -- perhaps because the client's capabilities are limited.
SessionUnableToForceMute Unable to force mute -- perhaps because the client's capabilities are limited.
SessionUnableToSendSignal Unable to send signal -- perhaps because the client's capabilities are limited (e.g., a publisher-only token).
ConnectionDropped The connection to the OpenTok messaging server was dropped. Check the network connection.
SessionDisconnected Attempting to publish to a disconnected session.
PublisherInternalError Internal error when publishing. Try publishing again.
PublisherWebRTCError Subscriber WebRTC failure. Call the getMessage() method for more details.
PublisherUnableToPublish
PublisherUnexpectedPeerConnectionDisconnection
PublisherCannotAccessCamera
PublisherCameraAccessDenied
ConnectionTimedOut Subscriber timed out while attempting to connect to the stream. Try resubscribing to the stream.
SubscriberWebRTCError Subscriber WebRTC failure. Call the getMessage() method for more details.
SubscriberServerCannotFindStream The subscriber failed due to the stream being missing. This can happen if the subscriber is created at the same time the stream is removed from the session.
SubscriberStreamLimitExceeded The client tried to subscribe to a stream in a session that has exceeded the limit for simultaneous streams.
SubscriberInternalError Internal error when subscribing. Try subscribing again.
UnknownPublisherInstance Cannot unpublish: An unknown Publisher instance was passed into the Session.unpublish() method.
UnknownSubscriberInstance Cannot unsubscribe: An unknown Subscriber instance was passed into the Session.unsubscribe() method.
SessionNullOrInvalidParameter You passed an invalid parameter or the Session is null.
VideoCaptureFailed There was an error in the video capturer.
CameraFailed There was an error in acquiring video from the camera.
VideoRenderFailed There was an error in the video renderer.
SessionSubscriberNotFound The subscriber is unknown to this session. This is usually the result of calling Session#unsubscribe(SubscriberKit subscriber) with a subscriber that is not associated with the session.
SessionPublisherNotFound The publisher is unknown to this session. This is usually the result of calling Session#unpublish(PublisherKit publisher) with a publisher that is not publishing a stream to the session.
PublisherTimeout Timeout while attempting to publish.
SessionBlockedCountry Unable to connect to the session. Terms of service violation: export compliance.
SessionConnectionLimitExceeded The client tried to connect to a session that has exceeded the limit for simultaneous connections.
SessionUnexpectedGetSessionInfoResponse Unable to connect to the session. Try connecting again.
SessionIllegalState Unable to connect to a session that is already connected. Or unable to subscribe to a stream that is no longer in the session.
CaptionsChangeRateLimitError The server rejected a captions change request because too many were made in a short period of time. The operation can be retried after a few seconds. This error is reported through PublisherKit.PublisherListener#onError(PublisherKit, OpentokError) when the publisher requested the change, and through SubscriberKit.SubscriberListener#onError(SubscriberKit, OpentokError) when the subscriber did. Check OpentokError#getErrorDomain() to tell the two apart.
EncryptionSecretMissing Tried to join an end-to-end encrypted session without an encryption secret
EncryptionInternalError Internal error while encrypting a packet
DecryptionInternalError Internal error while decrypting a packet
EncryptionSecretMismatch Secret mismatch while decrypting a packet
InvalidEncryptionSecret Invalid encryption secret
EncryptionUnsupportedCodec Unsupported media codec for encryption
DecryptionUnsupportedCodec Unsupported media codec for decryption
EncryptionNotEnabled An encryption secret was set, but the session was not configured as end-to-end encrypted.
MediaTransformerInternalError
MediaTransformerInvalidType
MediaTransformerNameNotProvided
MediaTransformerCustomCallbackNotProvided
MediaTransformerPropertiesNotProvided
MediaTransformerModelNotFound
MediaTransformerOpenTokTransformersLibraryNotLoaded
MediaTransformerOpenTokTransformersSymbolNotFound
OpenTokTransformersInternalError
OpenTokTransformersInvalidParam
OpenTokTransformersNameNotProvided
OpenTokTransformersInvalidName
OpenTokTransformersPropertiesNotProvided
OpenTokTransformersInvalidPropertiesFormat
OpenTokTransformersModelFileNotFound
OpenTokTransformersRadiusPropertyNotProvided
OpenTokTransformersInvalidRadiusProperty
OpenTokTransformersCustomRadiusPropertyNotProvided
OpenTokTransformersInvalidCustomRadiusProperty
OpenTokTransformersImageFilePathPropertyNotProvided
OpenTokTransformersImageFilePathNotFound
OpenTokTransformersMlTransformerInitError

Methods

Name Description
(static) fromTypeCode(id) → {OpentokError.ErrorCode} Build Type from error code.
getErrorCode() → {int} Returns errorCode.
(static) valueOf(name) → {OpentokError.ErrorCode}
(static) values() → {OpentokError.ErrorCode[]}

(static) fromTypeCode(id) → {OpentokError.ErrorCode}

Build Type from error code.

Parameters:
Name Type Description
id int
Returns:

OpentokError.ErrorCode

getErrorCode() → {int}

Returns errorCode.

Returns:

errorCode

(static) valueOf(name) → {OpentokError.ErrorCode}

Parameters:
Name Type Description
name String
Returns:

OpentokError.ErrorCode

(static) values() → {OpentokError.ErrorCode[]}

Returns:

OpentokError.ErrorCode[]