SessionPlayer.PlayerResult
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(resultCode: Int, item: MediaItem?)Constructor that uses the current system clock as the completion time. |
Public functions |
|
|---|---|
Long |
Gets the completion time of the command. |
MediaItem? |
Gets the |
Int |
Gets the result code. |
Public constructors
PlayerResult(resultCode: Int, item: MediaItem?)
Constructor that uses the current system clock as the completion time.
Public functions
fun getCompletionTime(): Long
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 |
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.
| Returns | |
|---|---|
MediaItem? |
media item when the command completed. Can be |
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.
| Returns | |
|---|---|
Int |
result code |