org.digitalmediaserver.cast

Enum StandardResponse.ErrorReason

java.lang.Object

java.lang.Enum<StandardResponse.ErrorReason>

org.digitalmediaserver.cast.StandardResponse.ErrorReason

All Implemented Interfaces:

Serializable, Comparable<StandardResponse.ErrorReason>

Enclosing class:

StandardResponse

public static enum StandardResponse.ErrorReason
extends Enum<StandardResponse.ErrorReason>

Represents media error message reasons.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APP_ERROR Returned when the application state is invalid to fulfill the request
AUTHENTICATION_EXPIRED Returned when a request cannot be performed because authentication has expired, e.g. user changed password or the token was revoked
CONCURRENT_STREAM_LIMIT Returned when too many concurrent streams are detected
CONTENT_ALREADY_PLAYING Returned when the requested content is already playing
CONTENT_FILTERED Returned when the content is blocked due to filter
DUPLICATE_REQUEST_ID Returned when the request ID is not unique (the receiver is processing a request with the same ID)
END_OF_QUEUE Returned when skip is not possible due to going back beyond the first item or forward beyond the last item in the queue
GENERIC_LOAD_ERROR Returned when the load request encounter intermittent issue
INVALID_COMMAND Returned when the command is not valid or not implemented
INVALID_MEDIA_SESSION_ID Returned when the media session does not exist
INVALID_PARAMS Returned when the params are not valid or a non optional param is missing
INVALID_REQUEST Returned when the request is not valid
LANGUAGE_NOT_SUPPORTED Returned when the requested language is not supported
NOT_AVAILABLE_IN_REGION Returned when the content is blocked due to being regionally unavailable
NOT_SUPPORTED Returned when the request is not supported by the application
PARENTAL_CONTROL_RESTRICTED Returned when the content is blocked due to parental controls
PREMIUM_ACCOUNT_REQUIRED Returned when premium account is required for the request to succeed
SKIP_LIMIT_REACHED Returned when cannot skip more items due to reaching skip limit
VIDEO_DEVICE_REQUIRED Returned when the request cannot be completed because a video-capable device is required

Method Summary

Modifier and Type	Method and Description
static StandardResponse.ErrorReason	typeOf(String errorReason) Parses the specified string and returns the corresponding StandardResponse.ErrorReason, or null if no match could be found.
static StandardResponse.ErrorReason	valueOf(String name) Returns the enum constant of this type with the specified name.
static StandardResponse.ErrorReason[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INVALID_COMMAND

public static final StandardResponse.ErrorReason INVALID_COMMAND

Returned when the command is not valid or not implemented

INVALID_PARAMS

public static final StandardResponse.ErrorReason INVALID_PARAMS

Returned when the params are not valid or a non optional param is missing

INVALID_MEDIA_SESSION_ID

public static final StandardResponse.ErrorReason INVALID_MEDIA_SESSION_ID

Returned when the media session does not exist

SKIP_LIMIT_REACHED

public static final StandardResponse.ErrorReason SKIP_LIMIT_REACHED

Returned when cannot skip more items due to reaching skip limit

NOT_SUPPORTED

public static final StandardResponse.ErrorReason NOT_SUPPORTED

Returned when the request is not supported by the application

LANGUAGE_NOT_SUPPORTED

public static final StandardResponse.ErrorReason LANGUAGE_NOT_SUPPORTED

Returned when the requested language is not supported

END_OF_QUEUE

public static final StandardResponse.ErrorReason END_OF_QUEUE

Returned when skip is not possible due to going back beyond the first item or forward beyond the last item in the queue

DUPLICATE_REQUEST_ID

public static final StandardResponse.ErrorReason DUPLICATE_REQUEST_ID

Returned when the request ID is not unique (the receiver is processing a request with the same ID)

VIDEO_DEVICE_REQUIRED

public static final StandardResponse.ErrorReason VIDEO_DEVICE_REQUIRED

Returned when the request cannot be completed because a video-capable device is required

PREMIUM_ACCOUNT_REQUIRED

public static final StandardResponse.ErrorReason PREMIUM_ACCOUNT_REQUIRED

Returned when premium account is required for the request to succeed

APP_ERROR

public static final StandardResponse.ErrorReason APP_ERROR

Returned when the application state is invalid to fulfill the request

AUTHENTICATION_EXPIRED

public static final StandardResponse.ErrorReason AUTHENTICATION_EXPIRED

Returned when a request cannot be performed because authentication has expired, e.g. user changed password or the token was revoked

CONCURRENT_STREAM_LIMIT

public static final StandardResponse.ErrorReason CONCURRENT_STREAM_LIMIT

Returned when too many concurrent streams are detected

PARENTAL_CONTROL_RESTRICTED

public static final StandardResponse.ErrorReason PARENTAL_CONTROL_RESTRICTED

Returned when the content is blocked due to parental controls

CONTENT_FILTERED

public static final StandardResponse.ErrorReason CONTENT_FILTERED

Returned when the content is blocked due to filter

NOT_AVAILABLE_IN_REGION

public static final StandardResponse.ErrorReason NOT_AVAILABLE_IN_REGION

Returned when the content is blocked due to being regionally unavailable

CONTENT_ALREADY_PLAYING

public static final StandardResponse.ErrorReason CONTENT_ALREADY_PLAYING

Returned when the requested content is already playing

INVALID_REQUEST

public static final StandardResponse.ErrorReason INVALID_REQUEST

Returned when the request is not valid

GENERIC_LOAD_ERROR

public static final StandardResponse.ErrorReason GENERIC_LOAD_ERROR

Returned when the load request encounter intermittent issue

Method Detail

values

public static StandardResponse.ErrorReason[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StandardResponse.ErrorReason c : StandardResponse.ErrorReason.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StandardResponse.ErrorReason valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

typeOf

@Nullable
public static StandardResponse.ErrorReason typeOf(String errorReason)

Parses the specified string and returns the corresponding StandardResponse.ErrorReason, or null if no match could be found.

Parameters:

errorReason - the string to parse.

Returns:

The resulting StandardResponse.ErrorReason or null.