Inherits from NSError
Declared in OTError.h

Overview

The OTError class defines errors for the OpenTok iOS SDK. It extends the NSError class.

The OTPublisherErrorCode enum defines values for the code property of the OTError object for errors related to methods of the OTPublisher class:

  • OTNoMediaPublished — Attempting to publish a stream with no audio or video.
  • OTUserDeniedCameraAccess — The user denied access to the camera during publishing.
  • OTSessionDisconnected — Attempting to publish to a disconnected session.

The OTSessionErrorCode enum defines values for the code property of the OTError object for errors related to methods of the OTSession class:

  • OTAuthorizationFailure – An invalid API key or token was provided.
  • OTInvalidSessionId — An invalid session ID was provided.
  • OTConnectionFailed — There was an error connecting to OpenTok services.
  • OTNoMessagingServer — No messaging server is available for this session.
  • OTSDKUpdateRequired — A new version of the OpenTok SDK is available and required to connect to this session.
  • OTP2PSessionUnsupported — iOS does not currently support peer-to-peer OpenTok sessions.
  • OTUnknownServerError — The client was unable to communicate with the server, possibly due to a version incompatibility
  • OTP2PSessionRequired — A peer-to-peer enabled session is required to use this SDK
  • OTP2PSessionMaxParticipants — A peer-to-peer enabled session can only have two participants

The OTSubscriberErrorCode enum defines values for the code property of the OTError object for errors related to methods of the OTSubscriber class:

  • OTFailedToConnect — Subscriber failed to connect to stream. Can reattempt connection.
  • OTConnectionTimedOut — Subscriber timed out while attempting to connect to stream. Can reattempt connection.
  • OTNoStreamMedia — The stream has no audio or video to subscribe to.
  • OTInitializationFailure — Subscriber failed to initialize.
  • OTInvalidStreamType — The stream type is not currently supported by this version of the SDK.
  • OTSelfSubscribeFailure — This version of the SDK cannot subscribe to its own streams.