java.lang.Enum<OpentokError.ErrorCode>
com.opentok.android.OpentokError.ErrorCode
All Implemented Interfaces:
: Serializable, Comparable<OpentokError.ErrorCode>, Constable
Enclosing class:
: OpentokError
public static enum OpentokError.ErrorCode extends Enum<OpentokError.ErrorCode>
Defines error code values for OpentokError objects.
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
Enum Constant Summary
Enum Constants
Enum Constant
Description
AuthorizationFailure
An invalid API key or token was provided.
CameraFailed
There was an error in acquiring video from the camera.
ConnectionDropped
The connection to the OpenTok messaging server was dropped.
ConnectionFailed
The session failed to connect.
ConnectionRefused
A socket could not be opened to OpenTok the messaging server.
ConnectionTimedOut
Subscriber timed out while attempting to connect to the stream.
DecryptionInternalError
Internal error while decrypting a packet
DecryptionUnsupportedCodec
Unsupported media codec for decryption
EncryptionInternalError
Internal error while encrypting a packet
EncryptionSecretMismatch
Secret mismatch while decrypting a packet
EncryptionSecretMissing
Tried to join an end-to-end encrypted session without an encryption secret
EncryptionUnsupportedCodec
Unsupported media codec for encryption
InvalidEncryptionSecret
Invalid encryption secret
InvalidSessionId
Unable to connect: an invalid session ID was provided.
MediaTransformerCustomCallbackNotProvided
MediaTransformerInternalError
MediaTransformerInvalidType
MediaTransformerModelNotFound
MediaTransformerNameNotProvided
MediaTransformerOpenTokTransformersLibraryNotLoaded
MediaTransformerOpenTokTransformersSymbolNotFound
MediaTransformerPropertiesNotProvided
NoMessagingServer
There was an error connecting to the OpenTok messaging server.
OpenTokTransformersCustomRadiusPropertyNotProvided
OpenTokTransformersImageFilePathNotFound
OpenTokTransformersImageFilePathPropertyNotProvided
OpenTokTransformersInternalError
OpenTokTransformersInvalidCustomRadiusProperty
OpenTokTransformersInvalidName
OpenTokTransformersInvalidParam
OpenTokTransformersInvalidPropertiesFormat
OpenTokTransformersInvalidRadiusProperty
OpenTokTransformersMlTransformerInitError
OpenTokTransformersModelFileNotFound
OpenTokTransformersNameNotProvided
OpenTokTransformersPropertiesNotProvided
OpenTokTransformersRadiusPropertyNotProvided
P2PSessionMaxParticipants
A peer-to-peer enabled session can only have two participants.
PublisherCameraAccessDenied
PublisherCannotAccessCamera
PublisherInternalError
Internal error when publishing.
PublisherTimeout
Timeout while attempting to publish.
PublisherUnableToPublish
PublisherUnexpectedPeerConnectionDisconnection
PublisherWebRTCError
Subscriber WebRTC failure.
SessionBlockedCountry
Unable to connect to the session.
SessionConnectionLimitExceeded
The client tried to connect to a session that has exceeded the limit for simultaneous connections.
SessionConnectionTimeout
The connection timed out while attempting to connect to the session.
SessionDisconnected
Attempting to publish to a disconnected session.
SessionIllegalState
Unable to connect to a session that is already connected.
SessionInternalError
Internal error connecting to the session.
SessionInvalidSignalType
Invalid signal type.
SessionNullOrInvalidParameter
You passed an invalid parameter or the Session is null.
SessionPublisherNotFound
The publisher is unknown to this session.
SessionSignalDataTooLong
Invalid signal -- the data string is too long (maximum length 8196).
SessionSignalTypeTooLong
Invalid signal -- the type string is too long (maximum length 128).
SessionStateFailed
The connection timed out while attempting to get the session's state.
SessionSubscriberNotFound
The subscriber is unknown to this session.
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).
SessionUnexpectedGetSessionInfoResponse
Unable to connect to the session.
SubscriberInternalError
Internal error when subscribing.
SubscriberServerCannotFindStream
The subscriber failed due to the stream being missing.
SubscriberStreamLimitExceeded
The client tried to subscribe to a stream in a session that has exceeded the limit for simultaneous streams.
SubscriberWebRTCError
Subscriber WebRTC failure.
UnknownError
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.
VideoCaptureFailed
There was an error in the video capturer.
VideoRenderFailed
There was an error in the video renderer.
Method Summary
All MethodsStatic MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
static OpentokError.ErrorCode
fromTypeCode(int id)
Build Type from error code.
int
getErrorCode()
Returns errorCode.
static OpentokError.ErrorCode
valueOf(String name)
Returns the enum constant of this class with the specified name.
static OpentokError.ErrorCode[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
Methods inherited from class java.lang.Enum
clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
Enum Constant Details
UnknownError
public static final OpentokError.ErrorCode UnknownError
AuthorizationFailure
public static final OpentokError.ErrorCode AuthorizationFailure
An invalid API key or token was provided.
InvalidSessionId
public static final OpentokError.ErrorCode InvalidSessionId
Unable to connect: an invalid session ID was provided.
ConnectionFailed
public static final OpentokError.ErrorCode ConnectionFailed
The session failed to connect.
NoMessagingServer
public static final OpentokError.ErrorCode NoMessagingServer
There was an error connecting to the OpenTok messaging server.
ConnectionRefused
public static final OpentokError.ErrorCode ConnectionRefused
A socket could not be opened to OpenTok the messaging server. Check that outbound ports 443 and 8080 are accessible.
SessionStateFailed
public static final OpentokError.ErrorCode SessionStateFailed
The connection timed out while attempting to get the session's state. Check the network connection.
P2PSessionMaxParticipants
public static final OpentokError.ErrorCode P2PSessionMaxParticipants
A peer-to-peer enabled session can only have two participants.
SessionConnectionTimeout
public static final OpentokError.ErrorCode SessionConnectionTimeout
The connection timed out while attempting to connect to the session. Check the network connection.
SessionInternalError
public static final OpentokError.ErrorCode SessionInternalError
Internal error connecting to the session. Try connecting again.
SessionInvalidSignalType
public static final OpentokError.ErrorCode SessionInvalidSignalType
Invalid signal type.
SessionSignalDataTooLong
public static final OpentokError.ErrorCode SessionSignalDataTooLong
Invalid signal -- the data string is too long (maximum length 8196).
SessionSignalTypeTooLong
public static final OpentokError.ErrorCode SessionSignalTypeTooLong
Invalid signal -- the type string is too long (maximum length 128).
SessionUnableToForceDisconnect
public static final OpentokError.ErrorCode SessionUnableToForceDisconnect
Unable to force disconnect -- perhaps because the client's capabilities are limited.
SessionUnableToForceMute
public static final OpentokError.ErrorCode SessionUnableToForceMute
Unable to force mute -- perhaps because the client's capabilities are limited.
SessionUnableToSendSignal
public static final OpentokError.ErrorCode SessionUnableToSendSignal
Unable to send signal -- perhaps because the client's capabilities are limited (e.g., a publisher-only token).
ConnectionDropped
public static final OpentokError.ErrorCode ConnectionDropped
The connection to the OpenTok messaging server was dropped. Check the network connection.
SessionDisconnected
public static final OpentokError.ErrorCode SessionDisconnected
Attempting to publish to a disconnected session.
PublisherInternalError
public static final OpentokError.ErrorCode PublisherInternalError
Internal error when publishing. Try publishing again.
PublisherWebRTCError
public static final OpentokError.ErrorCode PublisherWebRTCError
Subscriber WebRTC failure. Call the getMessage() method for
more details.
PublisherUnableToPublish
public static final OpentokError.ErrorCode PublisherUnableToPublish
PublisherUnexpectedPeerConnectionDisconnection
public static final OpentokError.ErrorCode PublisherUnexpectedPeerConnectionDisconnection
PublisherCannotAccessCamera
public static final OpentokError.ErrorCode PublisherCannotAccessCamera
PublisherCameraAccessDenied
public static final OpentokError.ErrorCode PublisherCameraAccessDenied
ConnectionTimedOut
public static final OpentokError.ErrorCode ConnectionTimedOut
Subscriber timed out while attempting to connect to the stream. Try resubscribing to the stream.
SubscriberWebRTCError
public static final OpentokError.ErrorCode SubscriberWebRTCError
Subscriber WebRTC failure. Call the getMessage() method for
more details.
SubscriberServerCannotFindStream
public static final OpentokError.ErrorCode 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
public static final OpentokError.ErrorCode SubscriberStreamLimitExceeded
The client tried to subscribe to a stream in a session that has exceeded the limit for simultaneous streams.
SubscriberInternalError
public static final OpentokError.ErrorCode SubscriberInternalError
Internal error when subscribing. Try subscribing again.
UnknownPublisherInstance
public static final OpentokError.ErrorCode UnknownPublisherInstance
Cannot unpublish: An unknown Publisher instance was passed into the Session.unpublish() method.
UnknownSubscriberInstance
public static final OpentokError.ErrorCode UnknownSubscriberInstance
Cannot unsubscribe: An unknown Subscriber instance was passed into the Session.unsubscribe() method.
SessionNullOrInvalidParameter
public static final OpentokError.ErrorCode SessionNullOrInvalidParameter
You passed an invalid parameter or the Session is null.
VideoCaptureFailed
public static final OpentokError.ErrorCode VideoCaptureFailed
There was an error in the video capturer.
CameraFailed
public static final OpentokError.ErrorCode CameraFailed
There was an error in acquiring video from the camera.
VideoRenderFailed
public static final OpentokError.ErrorCode VideoRenderFailed
There was an error in the video renderer.
SessionSubscriberNotFound
public static final OpentokError.ErrorCode 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
public static final OpentokError.ErrorCode 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
public static final OpentokError.ErrorCode PublisherTimeout
Timeout while attempting to publish.
SessionBlockedCountry
public static final OpentokError.ErrorCode SessionBlockedCountry
Unable to connect to the session. Terms of service violation: export compliance.
SessionConnectionLimitExceeded
public static final OpentokError.ErrorCode SessionConnectionLimitExceeded
The client tried to connect to a session that has exceeded the limit for simultaneous connections.
SessionUnexpectedGetSessionInfoResponse
public static final OpentokError.ErrorCode SessionUnexpectedGetSessionInfoResponse
Unable to connect to the session. Try connecting again.
SessionIllegalState
public static final OpentokError.ErrorCode 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.
EncryptionSecretMissing
public static final OpentokError.ErrorCode EncryptionSecretMissing
Tried to join an end-to-end encrypted session without an encryption secret
EncryptionInternalError
public static final OpentokError.ErrorCode EncryptionInternalError
Internal error while encrypting a packet
DecryptionInternalError
public static final OpentokError.ErrorCode DecryptionInternalError
Internal error while decrypting a packet
EncryptionSecretMismatch
public static final OpentokError.ErrorCode EncryptionSecretMismatch
Secret mismatch while decrypting a packet
InvalidEncryptionSecret
public static final OpentokError.ErrorCode InvalidEncryptionSecret
Invalid encryption secret
EncryptionUnsupportedCodec
public static final OpentokError.ErrorCode EncryptionUnsupportedCodec
Unsupported media codec for encryption
DecryptionUnsupportedCodec
public static final OpentokError.ErrorCode DecryptionUnsupportedCodec
Unsupported media codec for decryption
MediaTransformerInternalError
public static final OpentokError.ErrorCode MediaTransformerInternalError
MediaTransformerInvalidType
public static final OpentokError.ErrorCode MediaTransformerInvalidType
MediaTransformerNameNotProvided
public static final OpentokError.ErrorCode MediaTransformerNameNotProvided
MediaTransformerCustomCallbackNotProvided
public static final OpentokError.ErrorCode MediaTransformerCustomCallbackNotProvided
MediaTransformerPropertiesNotProvided
public static final OpentokError.ErrorCode MediaTransformerPropertiesNotProvided
MediaTransformerModelNotFound
public static final OpentokError.ErrorCode MediaTransformerModelNotFound
MediaTransformerOpenTokTransformersLibraryNotLoaded
public static final OpentokError.ErrorCode MediaTransformerOpenTokTransformersLibraryNotLoaded
MediaTransformerOpenTokTransformersSymbolNotFound
public static final OpentokError.ErrorCode MediaTransformerOpenTokTransformersSymbolNotFound
OpenTokTransformersInternalError
public static final OpentokError.ErrorCode OpenTokTransformersInternalError
OpenTokTransformersInvalidParam
public static final OpentokError.ErrorCode OpenTokTransformersInvalidParam
OpenTokTransformersNameNotProvided
public static final OpentokError.ErrorCode OpenTokTransformersNameNotProvided
OpenTokTransformersInvalidName
public static final OpentokError.ErrorCode OpenTokTransformersInvalidName
OpenTokTransformersPropertiesNotProvided
public static final OpentokError.ErrorCode OpenTokTransformersPropertiesNotProvided
OpenTokTransformersInvalidPropertiesFormat
public static final OpentokError.ErrorCode OpenTokTransformersInvalidPropertiesFormat
OpenTokTransformersModelFileNotFound
public static final OpentokError.ErrorCode OpenTokTransformersModelFileNotFound
OpenTokTransformersRadiusPropertyNotProvided
public static final OpentokError.ErrorCode OpenTokTransformersRadiusPropertyNotProvided
OpenTokTransformersInvalidRadiusProperty
public static final OpentokError.ErrorCode OpenTokTransformersInvalidRadiusProperty
OpenTokTransformersCustomRadiusPropertyNotProvided
public static final OpentokError.ErrorCode OpenTokTransformersCustomRadiusPropertyNotProvided
OpenTokTransformersInvalidCustomRadiusProperty
public static final OpentokError.ErrorCode OpenTokTransformersInvalidCustomRadiusProperty
OpenTokTransformersImageFilePathPropertyNotProvided
public static final OpentokError.ErrorCode OpenTokTransformersImageFilePathPropertyNotProvided
OpenTokTransformersImageFilePathNotFound
public static final OpentokError.ErrorCode OpenTokTransformersImageFilePathNotFound
OpenTokTransformersMlTransformerInitError
public static final OpentokError.ErrorCode OpenTokTransformersMlTransformerInitError
Method Details
values
public static OpentokError.ErrorCode[] values()
Returns an array containing the constants of this enum class, in the order they are declared.
Returns: : an array containing the constants of this enum class, in the order they are declared
valueOf
public static OpentokError.ErrorCode valueOf(String name)
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
Parameters:
: name - the name of the enum constant to be returned.
Returns: : the enum constant with the specified name
Throws:
: IllegalArgumentException - if this enum class has no constant with the specified name
: NullPointerException - if the argument is null
getErrorCode
public int getErrorCode()
Returns errorCode.
Returns: : errorCode
fromTypeCode
public static OpentokError.ErrorCode fromTypeCode(int id)
Build Type from error code.