SessionPlayer.PlayerResult

Added in 1.0.0
Deprecated in 1.3.0

public class 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
  • 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
  • Custom Info code: Positive integers equal to or greater than 1000. (i.e. code >+1000)

Summary

Public constructors

PlayerResult(int resultCode, @Nullable MediaItem item)

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

Public methods

long

Gets the completion time of the command.

@Nullable MediaItem

Gets the MediaItem for which the command was executed.

int

Gets the result code.

Public constructors

PlayerResult

Added in 1.0.0
Deprecated in 1.3.0
public PlayerResult(int resultCode, @Nullable MediaItem item)

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

Parameters
int resultCode

result code. Recommends to use the standard code defined here.

@Nullable MediaItem item

media item when the command completed

Public methods

getCompletionTime

Added in 1.0.0
Deprecated in 1.3.0
public long getCompletionTime()

Gets the completion time of the command. Being more specific, it's the same as elapsedRealtime when the command completed.

Returns
long

completion time of the command

getMediaItem

Added in 1.0.0
Deprecated in 1.3.0
public @Nullable MediaItem getMediaItem()

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.

Returns
@Nullable MediaItem

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

getResultCode

Added in 1.0.0
Deprecated in 1.3.0
public int getResultCode()

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.

Returns
int

result code