Package com.castlabs.android.player.exceptions

Class CastlabsPlayerException

    • Field Detail

      • TYPE_UNKNOWN

        public static final int TYPE_UNKNOWN
        Error raised with an unknown type
        See Also:
        Constant Field Values

      • TYPE_AUDIO_TRACK_INITIALIZATION

        public static final int TYPE_AUDIO_TRACK_INITIALIZATION
        Error raised when the track can not be initialized. The cause of this error is a AudioSink.InitializationException that contains the audio track state reported by AudioTrack.getState().

        This is reported as SEVERITY_ERROR since this means that no audio playback will be possible.
        See Also:
        Constant Field Values

      • TYPE_AUDIO_DECODER_INITIALIZATION

        public static final int TYPE_AUDIO_DECODER_INITIALIZATION
        Error raised when the audio decoder can not be initialized. The cause of this error is a MediaCodecRenderer.DecoderInitializationException.

        This is reported as SEVERITY_ERROR since this means that no audio playback will be possible.
        See Also:
        Constant Field Values

      • TYPE_AUDIO_WRITE_ERROR

        public static final int TYPE_AUDIO_WRITE_ERROR
        Raised when an error occurs while writing to the audio track. The cause of this error is a AudioSink.WriteException that exposes the AudioSink.WriteException.errorCode that is returned from AudioTrack.write(byte[], int, int)

        This is reported as SEVERITY_WARNING since it might be possible that audio playback will recover.
        See Also:
        Constant Field Values

      • TYPE_VIDEO_DECODER_INITIALIZATION

        public static final int TYPE_VIDEO_DECODER_INITIALIZATION
        Raised when the video decoder can not be initialized. The cause of this error is a MediaCodecRenderer.DecoderInitializationException.

        This is reported as SEVERITY_ERROR since this means that no video playback will be possible.
        See Also:
        Constant Field Values

      • TYPE_MANIFEST_LOADING_FAILED

        public static final int TYPE_MANIFEST_LOADING_FAILED
        This error type is raised when loading the player manifest (i.e. the DASH mpd, or the HLS playlist) failed. The cause of this error is an IOException.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_SDK_INIT_ERROR

        public static final int TYPE_SDK_INIT_ERROR
        Error raised when the SDK could not be initialised successfully. The cause of the error is a Throwable.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_NO_RENDERER_FOUND

        public static final int TYPE_NO_RENDERER_FOUND
        Error raised when no plugin was found that can be used to create a renderer to playback a given DRM and content combination. An error of this type will be raised for example if you are trying to playback a DASH stream using OMA-DRM but the OMA-Plugin was not loaded. It is possible also that this Exception is thrown if a Renderer has been temporarily disabled. A few use cases, such as performing background playback ,can disable a number of Renderers. This error has no cause attached to it.

        This is reported as SEVERITY_WARNING.
        See Also:
        Constant Field Values

      • TYPE_NO_PLAYABLE_CONTENT

        public static final int TYPE_NO_PLAYABLE_CONTENT
        Error raised when the applied filters were not able to find any viable content that can be displayed on the current device. This can happen for example when you are trying to playback 4K video on a device that does not support it and 4K is the only representation found in the Manifest.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_PLAYBACK_ERROR

        public static final int TYPE_PLAYBACK_ERROR
        Error raised when the ExoPlayer reports a general playback error. The cause of this error is a ExoPlaybackException.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_API_MISMATCH

        public static final int TYPE_API_MISMATCH
        This error is raised if a method is called that is not supported on the current API level. This will for example be triggered if you try to use Widevine DRM on devices that do not support it.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_UNSUPPORTED_DRM

        public static final int TYPE_UNSUPPORTED_DRM
        This error is raised if you are trying to use a DRM system that is not supported by the device. The cause if this error is a UnsupportedDrmException.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_DRMTODAY_EXCEPTION

        public static final int TYPE_DRMTODAY_EXCEPTION
        This error is raised if an exception occurred while the player was communicating with DRMToday to fetch a license. The cause of this error is a DrmTodayException.

        Note that this error usually occurs during license acquisition and before any decryption errors are reported by the decoder.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_DOWNLOAD_ERROR

        public static final int TYPE_DOWNLOAD_ERROR
        This error is raised if an exception occurred while downloading playback data. The cause of this error is a DownloadException that you can use to identify the root cause and the id of the track that caused the error.

        This is reported as SEVERITY_WARNING since it depends on where and when this exception is raised.
        See Also:
        Constant Field Values

      • TYPE_SECONDARY_DISPLAY

        public static final int TYPE_SECONDARY_DISPLAY
        This error is raised if a secondary display is detected and the current configuration does not permit playback on that display.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_KEY_EXPIRED

        public static final int TYPE_KEY_EXPIRED
        This error is raised if a DRM key expires during playback.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_DRM_KEY_DOWNLOAD_ERROR

        public static final int TYPE_DRM_KEY_DOWNLOAD_ERROR
        This error is raised if a DRM key could not be fetched successfully. This is usually caused when offline lincenses are loaded.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_CONNECTIVITY_LOST_ERROR

        public static final int TYPE_CONNECTIVITY_LOST_ERROR
        This error is raised if an exception occurred while downloading playback and no network connectivity is available.

        This is reported as SEVERITY_WARNING and the player will automatically try to recover once connectivity is re-gained. This can be treated as in informative warning.
        See Also:
        Constant Field Values

      • TYPE_CONNECTIVITY_GAINED_INFO

        public static final int TYPE_CONNECTIVITY_GAINED_INFO
        This exception is raised after the player lost connectivity (TYPE_CONNECTIVITY_LOST_ERROR), once connectivity was re-gained.

        This is reported as SEVERITY_INFO and can be treated as in informative message.
        See Also:
        Constant Field Values

      • TYPE_BEHIND_LIVE_WINDOW

        public static final int TYPE_BEHIND_LIVE_WINDOW
        Error raised when the current playback position is behind the live edge in a live stream. The cause of this error is a BehindLiveWindowException.

        When this error is raised, the player is in a fatal state and you will need to restart/reopen the stream to continue playback at the live edge.

        Typically, this error is caused by loss of connectivity where the player is not able to keep updating the manifests to stay at the live edge or within the live window.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_INVALID_PLAYER_LICENSE

        public static final int TYPE_INVALID_PLAYER_LICENSE
        Error raised when the castLabs player license is invalid or expired. Please contact support if you see this error unexpectedly. Note that if this error occurs, playback is prevented and the player will stop working.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_DATA_DOWLOAD_ERROR

        public static final int TYPE_DATA_DOWLOAD_ERROR
        This error is raised if an exception occurred while downloading data. The cause can be used to identify the root cause. In contrast to TYPE_DOWNLOAD_ERROR this type is raised for any download issues around non track specific data.

        This is reported as SEVERITY_WARNING since it depends on where and when this exception is raised. This type might contain the URL key in the errorData bundle.
        See Also:
        Constant Field Values

      • TYPE_DRM_EXCEPTION

        public static final int TYPE_DRM_EXCEPTION
        This error is raised if an exception occurred while the player was communicating with DRM server to fetch a license. The cause of this error is a DrmSession.DrmSessionException.

        Note that this error usually occurs during license acquisition and before any decryption errors are reported by the decoder.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_AUDIO_UNSUPPORTED

        public static final int TYPE_AUDIO_UNSUPPORTED
        This error is raised if all audio tracks are filtered out as unsupported. It is reported as SEVERITY_WARNING
        See Also:
        Constant Field Values

      • TYPE_VIDEO_UNSUPPORTED

        public static final int TYPE_VIDEO_UNSUPPORTED
        This error is raised if all video tracks are filtered out as unsupported. It is reported as SEVERITY_WARNING
        See Also:
        Constant Field Values

      • TYPE_TEXT_UNSUPPORTED

        public static final int TYPE_TEXT_UNSUPPORTED
        This error is raised if all text tracks are filtered out as unsupported. It is reported as SEVERITY_WARNING
        See Also:
        Constant Field Values

      • TYPE_USER_ID_NOT_PROVIDED

        public static final int TYPE_USER_ID_NOT_PROVIDED
        Error raised when the userID is mandatory and has not been provided.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_MANIFEST_PARSING_FAILED

        public static final int TYPE_MANIFEST_PARSING_FAILED
        This error type is raised when parsing the player manifest (i.e. the DASH mpd, or the HLS playlist) failed. The cause of this error is an ParserException.

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_DRM_PROVISION_ERROR

        public static final int TYPE_DRM_PROVISION_ERROR
        Error raised during device provisioning

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_CSL_LIMIT_REACHED

        public static final int TYPE_CSL_LIMIT_REACHED
        Error raised when concurrent stream limiting reaches maximum clients

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_CSL_NETWORK_ERROR

        public static final int TYPE_CSL_NETWORK_ERROR
        Error raised when there's a network error with the concurrent stream limiting service

        This is reported as SEVERITY_ERROR.
        See Also:
        Constant Field Values

      • TYPE_HDCP_CONNECTION_WARNING

        public static final int TYPE_HDCP_CONNECTION_WARNING
        This exception is raised after the player sees changes in HDCP connectivity.

        This is reported as SEVERITY_INFO and can be treated as in informative message.
        See Also:
        Constant Field Values

      • TYPE_AD_ERROR

        public static final int TYPE_AD_ERROR
        This error is raised when a general error occurs at initializing or during an Ad.
        See Also:
        Constant Field Values

      • TYPE_DNS_SERVER_ERROR

        public static final int TYPE_DNS_SERVER_ERROR
        This error is raised when a DNS server error occurs.
        See Also:
        Constant Field Values

      • TYPE_TIME_OUT_ERROR

        public static final int TYPE_TIME_OUT_ERROR
        This error is raised when a timeout error occurs.
        See Also:
        Constant Field Values

      • TYPE_MANIFEST_INVALID

        public static final int TYPE_MANIFEST_INVALID
        This error happens when the player found a semantic issue with a Manifest. This could be due to a change in between manifest updates deemed as illegal by the corresponding spec.
        See Also:
        Constant Field Values

    • Constructor Detail

      • CastlabsPlayerException

        public CastlabsPlayerException​(int severity,
                               int type,
                               @Nullable
                               String message)

      • CastlabsPlayerException

        public CastlabsPlayerException​(int severity,
                               int type,
                               @Nullable
                               String message,
                               @Nullable
                               Throwable cause)

      • CastlabsPlayerException

        public CastlabsPlayerException​(int severity,
                               int type,
                               @Nullable
                               String message,
                               @Nullable
                               Throwable cause,
                               @Nullable
                               String explicitCauseMessage)

    • Method Detail

      • getType

        public int getType()
        Returns:
        the type of this error.

      • getCauseMessage

        public String getCauseMessage()
        Returns:
        message An explicitly set cause message if not null or the message of the lowest exception in the cause chain otherwise. May not be used in app UI elements.

      • getErrorData

        @NonNull
public Bundle getErrorData()
        Returns a Bundle with error-specific error data. This data may be different for each error type.
        Returns:
        the Bundle with error data

      • getString

        @Nullable
public String getString​(String key)
        Returns the value for the given key out of the errorData Map. Note that this method will convert the requested data into String. Even if originally it was not.
        Parameters:
        key - the key for which to return the value.
        Returns:
        the value, or null if the key does not exist.

      • getInteger

        @Nullable
public Integer getInteger​(String key)
        Returns the value for the given key out of the errorData Map. Note that this method try to parse the requested data into an Integer. Even if originally it was not.
        Parameters:
        key - the key for which to return the value.
        Returns:
        the value, or null if the key does not exist.

      • createFatal

        public static CastlabsPlayerException createFatal​(com.google.android.exoplayer2.source.dash.DashPeriodNotFoundException exception)

      • createFatal

        public static CastlabsPlayerException createFatal​(@NonNull
                                                  com.google.android.exoplayer2.upstream.HttpDataSource.HttpDataSourceException exception,
                                                  int type)

      • createError

        public static CastlabsPlayerException createError​(int severity,
                                                  String message,
                                                  com.google.android.exoplayer2.upstream.HttpDataSource.InvalidResponseCodeException e)

      • createError

        public static CastlabsPlayerException createError​(int severity,
                                                  String message,
                                                  com.google.android.exoplayer2.upstream.HttpDataSource.HttpDataSourceException e)

      • log

        public void log()
        Logs this exception using its severity to choose the log level

      • typeString

        public static String typeString​(int type)
        Translates an error type to a human readable string
        Parameters:
        type - the error type
        Returns:
        The string representation of the error type