PlayerException (player API)

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

com.amazonaws.ivs.player.PlayerException

All Implemented Interfaces:: Serializable

public class PlayerException extends RuntimeException

Represents an error that occurred during media playback. The exception has additional properties that can uniquely identify the exception.

Some valuable errors to handle:

source: MasterPlaylist type: ErrorType.ERROR_AUTHORIZATION code: 403 - This is a private stream and viewer authorization is missing or invalid.
source: MasterPlaylist type: ErrorType.ERROR_NOT_AVAILABLE code: 429 - The concurrent-viewers limit has been reached. See Amazon IVS Service Quotas.
source: MasterPlaylist type: ErrorType.ERROR_NOT_AVAILABLE code: 404 - The stream is invalid (e.g., the playback URL is incorrect) or not online.

See Also:

Serialized Form

Method Summary

Modifier and Type

Method

Description

int

getCode()

String

getErrorMessage()

ErrorType

getErrorType()

String

getSource()

Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details
- getCode
  
  public int getCode()
  
  Returns:
  
  A code representing the specific error condition. The code values depend on the source and result types. For example, if getSource() is "Segment", the result is ErrorType.ERROR_NETWORK, and the code value is 400, this indicates that an HTTP 400 error occurred while trying to download a video segment.
- getSource
  
  @NonNull public String getSource()
  
  Returns:
  
  The source component within the player that generated the error.
- getErrorType
  
  @NonNull public ErrorType getErrorType()
  
  Returns:
  
  The result code for the error.
- getErrorMessage
  
  @NonNull public String getErrorMessage()
  
  Returns:
  
  A message describing the error. This differs from Throwable.getMessage() in that this contains only the error text and not any source or code value.