LibraryResult

Artifact: androidx.media3:media3-session

Kotlin |Java

class LibraryResult<V>

A result to be used with ListenableFuture for asynchronous calls between and MediaBrowser.

Summary

Nested types
@Documented @Retention(value = RetentionPolicy.SOURCE) @Target(value = TYPE_USE) @IntDef(value = [SessionError.INFO_CANCELLED, SessionError.ERROR_UNKNOWN, SessionError.ERROR_INVALID_STATE, SessionError.ERROR_BAD_VALUE, SessionError.ERROR_PERMISSION_DENIED, SessionError.ERROR_IO, SessionError.ERROR_SESSION_DISCONNECTED, SessionError.ERROR_NOT_SUPPORTED, SessionError.ERROR_SESSION_AUTHENTICATION_EXPIRED, SessionError.ERROR_SESSION_PREMIUM_ACCOUNT_REQUIRED, SessionError.ERROR_SESSION_CONCURRENT_STREAM_LIMIT, SessionError.ERROR_SESSION_PARENTAL_CONTROL_RESTRICTED, SessionError.ERROR_SESSION_NOT_AVAILABLE_IN_REGION, SessionError.ERROR_SESSION_SKIP_LIMIT_REACHED, SessionError.ERROR_SESSION_SETUP_REQUIRED]) annotation LibraryResult.Code Result codes.

Nested types

@Documented
@Retention(value = RetentionPolicy.SOURCE)
@Target(value = TYPE_USE)
@IntDef(value = [SessionError.INFO_CANCELLED, SessionError.ERROR_UNKNOWN, SessionError.ERROR_INVALID_STATE, SessionError.ERROR_BAD_VALUE, SessionError.ERROR_PERMISSION_DENIED, SessionError.ERROR_IO, SessionError.ERROR_SESSION_DISCONNECTED, SessionError.ERROR_NOT_SUPPORTED, SessionError.ERROR_SESSION_AUTHENTICATION_EXPIRED, SessionError.ERROR_SESSION_PREMIUM_ACCOUNT_REQUIRED, SessionError.ERROR_SESSION_CONCURRENT_STREAM_LIMIT, SessionError.ERROR_SESSION_PARENTAL_CONTROL_RESTRICTED, SessionError.ERROR_SESSION_NOT_AVAILABLE_IN_REGION, SessionError.ERROR_SESSION_SKIP_LIMIT_REACHED, SessionError.ERROR_SESSION_SETUP_REQUIRED])
annotation LibraryResult.Code

Result codes.

Constants
`const Int`	`RESULT_ERROR_BAD_VALUE = -3` Result code representing that an argument is illegal.
`const Int`	`RESULT_ERROR_INVALID_STATE = -2` Result code representing that the command cannot be completed because the current state is not valid for the command.
`const Int`	`RESULT_ERROR_IO = -5` Result code representing that a file or network related error happened.
`const Int`	`RESULT_ERROR_NOT_SUPPORTED = -6` Result code representing that the command is not supported.
`const Int`	`RESULT_ERROR_PERMISSION_DENIED = -4` Result code representing that the command is not allowed.
`const Int`	`RESULT_ERROR_SESSION_AUTHENTICATION_EXPIRED = -102` Result code representing that the authentication has expired.
`const Int`	`RESULT_ERROR_SESSION_CONCURRENT_STREAM_LIMIT = -104` Result code representing that too many concurrent streams are detected.
`const Int`	`RESULT_ERROR_SESSION_DISCONNECTED = -100` Result code representing that the session and controller were disconnected.
`const Int`	`RESULT_ERROR_SESSION_NOT_AVAILABLE_IN_REGION = -106` Result code representing that the content is blocked due to being regionally unavailable.
`const Int`	`RESULT_ERROR_SESSION_PARENTAL_CONTROL_RESTRICTED = -105` Result code representing that the content is blocked due to parental controls.
`const Int`	`RESULT_ERROR_SESSION_PREMIUM_ACCOUNT_REQUIRED = -103` Result code representing that a premium account is required.
`const Int`	`RESULT_ERROR_SESSION_SETUP_REQUIRED = -108` Result code representing that the session needs user's manual intervention.
`const Int`	`RESULT_ERROR_SESSION_SKIP_LIMIT_REACHED = -107` Result code representing that the application cannot skip any more because the skip limit is reached.
`const Int`	`RESULT_ERROR_UNKNOWN = -1` Result code representing that the command is ended with an unknown error.
`const Int`	`RESULT_INFO_SKIPPED = 1` Result code representing that the command is skipped.
`const Int`	`RESULT_SUCCESS = 0` Result code representing that the command is successfully completed.

Public functions
`java-static LibraryResult<MediaItem!>!`	`@UnstableApi fromItemBundle(bundle: Bundle!)` Restores a `LibraryResult<MediaItem>` from a `Bundle`.
`java-static LibraryResult<ImmutableList<MediaItem!>!>!`	`@UnstableApi fromItemListBundle(bundle: Bundle!)` Restores a `LibraryResult<ImmutableList<MediaItem>` from a `Bundle`.
`java-static LibraryResult<Any!>!`	`@UnstableApi fromUnknownBundle(bundle: Bundle!)` Restores a `LibraryResult` with unknown value type from a `Bundle`.
`java-static LibraryResult<Void!>!`	`@UnstableApi fromVoidBundle(bundle: Bundle!)` Restores a `LibraryResult<Void>` from a `Bundle`.
`java-static LibraryResult<V!>!`	`<V> ofError(@LibraryResult.Code errorCode: Int)` Creates an instance with an unsuccessful `result code`.
`java-static LibraryResult<V!>!`	`@UnstableApi <V> ofError(sessionError: SessionError!)` Creates an instance with a `SessionError` to describe the error.
`java-static LibraryResult<V!>!`	`<V> ofError( @LibraryResult.Code errorCode: Int, params: MediaLibraryService.LibraryParams? )` Creates an instance with an unsuccessful `result code` and `LibraryParams` to describe the error.
`java-static LibraryResult<V!>!`	`@UnstableApi <V> ofError( sessionError: SessionError!, params: MediaLibraryService.LibraryParams! )` Creates an instance with a `SessionError` to describe the error, and the parameters sent by the browser.
`java-static LibraryResult<MediaItem!>!`	`ofItem(item: MediaItem!, params: MediaLibraryService.LibraryParams?)` Creates an instance with a media item and `resultCode==RESULT_SUCCESS`.
`java-static LibraryResult<ImmutableList<MediaItem!>!>!`	`ofItemList( items: (Mutable)List<MediaItem!>!, params: MediaLibraryService.LibraryParams? )` Creates an instance with a list of media items and `resultCode==RESULT_SUCCESS`.
`java-static LibraryResult<Void!>!`	`ofVoid()` Creates an instance with `resultCode==RESULT_SUCCESS`.
`java-static LibraryResult<Void!>!`	`ofVoid(params: MediaLibraryService.LibraryParams?)` Creates an instance with `resultCode==RESULT_SUCCESS` and optional `params`.
`Bundle!`	`@UnstableApi toBundle()`

Public properties
`Long`	`completionTimeMs` The completion time of the command in milliseconds.
`MediaLibraryService.LibraryParams?`	`params` The optional parameters.
`Int`	`@LibraryResult.Code resultCode` The `Code` of this result.
`SessionError?`	`@UnstableApi sessionError` The optional session error.
`V?`	`value` The value of this result.

Constants

RESULT_ERROR_BAD_VALUE

const val RESULT_ERROR_BAD_VALUE = -3: Int

Result code representing that an argument is illegal.

RESULT_ERROR_INVALID_STATE

const val RESULT_ERROR_INVALID_STATE = -2: Int

Result code representing that the command cannot be completed because the current state is not valid for the command.

RESULT_ERROR_IO

const val RESULT_ERROR_IO = -5: Int

Result code representing that a file or network related error happened.

RESULT_ERROR_NOT_SUPPORTED

const val RESULT_ERROR_NOT_SUPPORTED = -6: Int

Result code representing that the command is not supported.

RESULT_ERROR_PERMISSION_DENIED

const val RESULT_ERROR_PERMISSION_DENIED = -4: Int

Result code representing that the command is not allowed.

RESULT_ERROR_SESSION_AUTHENTICATION_EXPIRED

const val RESULT_ERROR_SESSION_AUTHENTICATION_EXPIRED = -102: Int

Result code representing that the authentication has expired.

RESULT_ERROR_SESSION_CONCURRENT_STREAM_LIMIT

const val RESULT_ERROR_SESSION_CONCURRENT_STREAM_LIMIT = -104: Int

Result code representing that too many concurrent streams are detected.

RESULT_ERROR_SESSION_DISCONNECTED

const val RESULT_ERROR_SESSION_DISCONNECTED = -100: Int

Result code representing that the session and controller were disconnected.

RESULT_ERROR_SESSION_NOT_AVAILABLE_IN_REGION

const val RESULT_ERROR_SESSION_NOT_AVAILABLE_IN_REGION = -106: Int

Result code representing that the content is blocked due to being regionally unavailable.

RESULT_ERROR_SESSION_PARENTAL_CONTROL_RESTRICTED

const val RESULT_ERROR_SESSION_PARENTAL_CONTROL_RESTRICTED = -105: Int

Result code representing that the content is blocked due to parental controls.

RESULT_ERROR_SESSION_PREMIUM_ACCOUNT_REQUIRED

const val RESULT_ERROR_SESSION_PREMIUM_ACCOUNT_REQUIRED = -103: Int

Result code representing that a premium account is required.

RESULT_ERROR_SESSION_SETUP_REQUIRED

const val RESULT_ERROR_SESSION_SETUP_REQUIRED = -108: Int

Result code representing that the session needs user's manual intervention.

RESULT_ERROR_SESSION_SKIP_LIMIT_REACHED

const val RESULT_ERROR_SESSION_SKIP_LIMIT_REACHED = -107: Int

Result code representing that the application cannot skip any more because the skip limit is reached.

RESULT_ERROR_UNKNOWN

const val RESULT_ERROR_UNKNOWN = -1: Int

Result code representing that the command is ended with an unknown error.

RESULT_INFO_SKIPPED

const val RESULT_INFO_SKIPPED = 1: Int

Result code representing that the command is skipped.

RESULT_SUCCESS

const val RESULT_SUCCESS = 0: Int

Result code representing that the command is successfully completed.

Interoperability: This code is also used to tell that the command was successfully sent, but the result is unknown when connected with android.support.v4.media.session.MediaSessionCompat or android.support.v4.media.session.MediaControllerCompat.

Public functions

fromItemBundle

@UnstableApi
java-static fun fromItemBundle(bundle: Bundle!): LibraryResult<MediaItem!>!

Restores a LibraryResult<MediaItem> from a Bundle.

fromItemListBundle

@UnstableApi
java-static fun fromItemListBundle(bundle: Bundle!): LibraryResult<ImmutableList<MediaItem!>!>!

Restores a LibraryResult<ImmutableList<MediaItem> from a Bundle.

fromUnknownBundle

@UnstableApi
java-static fun fromUnknownBundle(bundle: Bundle!): LibraryResult<Any!>!

Restores a LibraryResult with unknown value type from a Bundle.

fromVoidBundle

@UnstableApi
java-static fun fromVoidBundle(bundle: Bundle!): LibraryResult<Void!>!

Restores a LibraryResult<Void> from a Bundle.

ofError

java-static fun <V> ofError(@LibraryResult.Code errorCode: Int): LibraryResult<V!>!

Creates an instance with an unsuccessful result code.

errorCode must not be RESULT_SUCCESS.

Note: This method will be deprecated when ofError is promoted to stable API status.

Parameters
`@LibraryResult.Code errorCode: Int`	The error code.

ofError

@UnstableApi
java-static fun <V> ofError(sessionError: SessionError!): LibraryResult<V!>!

Creates an instance with a SessionError to describe the error. The resultCode is taken from code.

Parameters
`sessionError: SessionError!`	The `SessionError`.

ofError

java-static fun <V> ofError(
    @LibraryResult.Code errorCode: Int,
    params: MediaLibraryService.LibraryParams?
): LibraryResult<V!>!

Creates an instance with an unsuccessful result code and LibraryParams to describe the error.

errorCode must not be RESULT_SUCCESS.

Note: This method will be deprecated when ofError is promoted to stable API status.

Parameters
`@LibraryResult.Code errorCode: Int`	The error code.
`params: MediaLibraryService.LibraryParams?`	The optional parameters to describe the error.

ofError

@UnstableApi
java-static fun <V> ofError(
    sessionError: SessionError!,
    params: MediaLibraryService.LibraryParams!
): LibraryResult<V!>!

Creates an instance with a SessionError to describe the error, and the parameters sent by the browser. The resultCode is taken from code.

Parameters
`sessionError: SessionError!`	The `SessionError`.
`params: MediaLibraryService.LibraryParams!`	The `LibraryParams` sent by the browser.

ofItem

java-static fun ofItem(item: MediaItem!, params: MediaLibraryService.LibraryParams?): LibraryResult<MediaItem!>!

Creates an instance with a media item and resultCode==RESULT_SUCCESS.

The mediaMetadata must specify isBrowsable and isPlayable fields.

Parameters
`item: MediaItem!`	The media item.
`params: MediaLibraryService.LibraryParams?`	The optional parameters to describe the media item.

ofItemList

java-static fun ofItemList(
    items: (Mutable)List<MediaItem!>!,
    params: MediaLibraryService.LibraryParams?
): LibraryResult<ImmutableList<MediaItem!>!>!

Creates an instance with a list of media items and resultCode==RESULT_SUCCESS.

The mediaMetadata of each item in the list must specify isBrowsable and isPlayable fields.

Parameters
`items: (Mutable)List<MediaItem!>!`	The list of media items.
`params: MediaLibraryService.LibraryParams?`	The optional parameters to describe the list of media items.

ofVoid

java-static fun ofVoid(): LibraryResult<Void!>!

Creates an instance with resultCode==RESULT_SUCCESS.

ofVoid

java-static fun ofVoid(params: MediaLibraryService.LibraryParams?): LibraryResult<Void!>!

Creates an instance with resultCode==RESULT_SUCCESS and optional params.

toBundle

@UnstableApi
fun toBundle(): Bundle!

Public properties

completionTimeMs

val completionTimeMs: Long

The completion time of the command in milliseconds. It's the same as elapsedRealtime when the command is completed.

params

val params: MediaLibraryService.LibraryParams?

The optional parameters.

resultCode

@LibraryResult.Code
val resultCode: Int

The Code of this result.

sessionError

@UnstableApi
val sessionError: SessionError?

The optional session error.

value

val value: V?

The value of this result. Will be null if resultCode is not RESULT_SUCCESS.