RemoteCastPlayer.Builder


@UnstableApi
class RemoteCastPlayer.Builder


A builder for RemoteCastPlayer instances.

See Builder for the list of default values.

Summary

Public constructors

Builder(context: Context!)

Creates a builder.

Public functions

RemoteCastPlayer!

Builds and returns a RemoteCastPlayer instance.

RemoteCastPlayer.Builder!
@CanIgnoreReturnValue
setMaxSeekToPreviousPositionMs(
    maxSeekToPreviousPositionMs: @IntRange(from = 0) Long
)

Sets the maximum position for which seekToPrevious seeks to the previous MediaItem.

RemoteCastPlayer.Builder!

Sets the MediaItemConverter that will be used by the player to convert MediaItems.

RemoteCastPlayer.Builder!
@CanIgnoreReturnValue
setSeekBackIncrementMs(seekBackIncrementMs: @IntRange(from = 1) Long)

Sets the seekBack increment.

RemoteCastPlayer.Builder!
@CanIgnoreReturnValue
setSeekForwardIncrementMs(seekForwardIncrementMs: @IntRange(from = 1) Long)

Sets the seekForward increment.

RemoteCastPlayer.Builder!

Sets the CastTrackSelector that will be used by the player to handle TrackSelectionParameters.

Public constructors

Builder

Builder(context: Context!)

Creates a builder.

The builder uses the following default values:

Parameters
context: Context!

A Context.

Public functions

build

fun build(): RemoteCastPlayer!

Builds and returns a RemoteCastPlayer instance.

Throws
java.lang.IllegalStateException

If any of the following condition occurs:

  • This method has already been called.
  • The Cast has not been initialized via initialize before this method is called.

setMaxSeekToPreviousPositionMs

@CanIgnoreReturnValue
fun setMaxSeekToPreviousPositionMs(
    maxSeekToPreviousPositionMs: @IntRange(from = 0) Long
): RemoteCastPlayer.Builder!

Sets the maximum position for which seekToPrevious seeks to the previous MediaItem.

Parameters
maxSeekToPreviousPositionMs: @IntRange(from = 0) Long

The maximum position, in milliseconds.

Returns
RemoteCastPlayer.Builder!

This builder.

Throws
java.lang.IllegalArgumentException

If maxSeekToPreviousPositionMs is negative.

java.lang.IllegalStateException

If build has already been called.

setMediaItemConverter

@CanIgnoreReturnValue
fun setMediaItemConverter(mediaItemConverter: MediaItemConverter!): RemoteCastPlayer.Builder!

Sets the MediaItemConverter that will be used by the player to convert MediaItems.

Parameters
mediaItemConverter: MediaItemConverter!

A MediaItemConverter.

Returns
RemoteCastPlayer.Builder!

This builder.

Throws
java.lang.IllegalStateException

If build has already been called.

setSeekBackIncrementMs

@CanIgnoreReturnValue
fun setSeekBackIncrementMs(seekBackIncrementMs: @IntRange(from = 1) Long): RemoteCastPlayer.Builder!

Sets the seekBack increment.

Parameters
seekBackIncrementMs: @IntRange(from = 1) Long

The seek back increment, in milliseconds.

Returns
RemoteCastPlayer.Builder!

This builder.

Throws
java.lang.IllegalArgumentException

If seekBackIncrementMs is non-positive.

java.lang.IllegalStateException

If build has already been called.

setSeekForwardIncrementMs

@CanIgnoreReturnValue
fun setSeekForwardIncrementMs(seekForwardIncrementMs: @IntRange(from = 1) Long): RemoteCastPlayer.Builder!

Sets the seekForward increment.

Parameters
seekForwardIncrementMs: @IntRange(from = 1) Long

The seek forward increment, in milliseconds.

Returns
RemoteCastPlayer.Builder!

This builder.

Throws
java.lang.IllegalArgumentException

If seekForwardIncrementMs is non-positive.

java.lang.IllegalStateException

If build has already been called.

setTrackSelector

@CanIgnoreReturnValue
fun setTrackSelector(trackSelector: CastTrackSelector!): RemoteCastPlayer.Builder!

Sets the CastTrackSelector that will be used by the player to handle TrackSelectionParameters.

Calling this setter enables COMMAND_SET_TRACK_SELECTION_PARAMETERS for the created RemoteCastPlayer.

The provided CastTrackSelector must take care of all options in TrackSelectionParameters that the application uses.

Parameters
trackSelector: CastTrackSelector!

A CastTrackSelector.

Returns
RemoteCastPlayer.Builder!

This builder.

Throws
java.lang.IllegalStateException

If build has already been called.