Register now for Android Dev Summit 2019!

PlayerResult

open class PlayerResult : BaseResult
kotlin.Any
   ↳ androidx.media2.common.SessionPlayer.PlayerResult

Result class of the asynchronous APIs.

Subclass may extend this class for providing more result and/or custom result code. For the custom result code, follow the convention below to avoid potential code duplication.

  • Predefined error code: Negative integers greater than -100. (i.e. -100 < code < 0)
  • Custom error code: Negative integers equal to or less than -1000. (i.e. code < -1000)
  • Predefined info code: Positive integers less than 100. (i.e. 0 < code < 100)
  • Custom Info code: Positive integers equal to or greater than 1000. (i.e. code > +1000)

Summary

Public constructors

<init>(resultCode: Int, @Nullable item: MediaItem?)

Constructor that uses the current system clock as the completion time.

Public methods

open Long

Gets the completion time of the command.

open MediaItem?

Gets the MediaItem for which the command was executed.

open Int

Gets the result code.

Public constructors

<init>

PlayerResult(resultCode: Int, @Nullable item: MediaItem?)

Constructor that uses the current system clock as the completion time.

Parameters
resultCode Int: result code. Recommends to use the standard code defined here.
item Int: media item when the command completed

Public methods

getCompletionTime

open fun getCompletionTime(): Long

Gets the completion time of the command. Being more specific, it's the same as android.os.SystemClock#elapsedRealtime() when the command completed.

Return
Long: completion time of the command

getMediaItem

@Nullable open fun getMediaItem(): MediaItem?

Gets the MediaItem for which the command was executed. In other words, this is the item sent as an argument of the command if any, otherwise the current media item when the command completed.

Return
MediaItem?: media item when the command completed. Can be null for an error, or the current media item was null.

getResultCode

open fun getResultCode(): Int

Gets the result code.

Subclass of the SessionPlayer may have defined customized extra code other than codes defined here. Check the documentation of the class that you're interested in.

Return
Int: result code.