Field Detail

• DEFAULT_SEEK_TIMEOUT_MS

  public static final int DEFAULT_SEEK_TIMEOUT_MS

  Default timeout value for setSeekTimeoutMs(int).

  See Also:

  Constant Field Values

Constructor Detail

• SessionCallbackBuilder

  public SessionCallbackBuilder​(Context context,
                                SessionPlayerConnector sessionPlayerConnector)

  Creates a new builder.

  The builder uses the following default values:

  • SessionCallbackBuilder.AllowedCommandProvider: SessionCallbackBuilder.DefaultAllowedCommandProvider
  • Seek timeout: DEFAULT_SEEK_TIMEOUT_MS

  Unless stated above, null or 0 would be used to disallow relevant features.

  Parameters:

  context - A context.

  sessionPlayerConnector - A session player connector to handle incoming calls from the controller.

Method Detail

• setRatingCallback

  public SessionCallbackBuilder setRatingCallback​(@Nullable
                                                  SessionCallbackBuilder.RatingCallback ratingCallback)

  Sets the SessionCallbackBuilder.RatingCallback to handle user ratings.

  Parameters:

  ratingCallback - A rating callback.

  Returns:

  This builder.

  See Also:

  MediaSession.SessionCallback.onSetRating(MediaSession, ControllerInfo, String, Rating), MediaController.setRating(String, Rating)

• setCustomCommandProvider

  public SessionCallbackBuilder setCustomCommandProvider​(@Nullable
                                                         SessionCallbackBuilder.CustomCommandProvider customCommandProvider)

  Sets the SessionCallbackBuilder.CustomCommandProvider to handle incoming custom commands.

  Parameters:

  customCommandProvider - A custom command provider.

  Returns:

  This builder.

  See Also:

  MediaSession.SessionCallback.onCustomCommand(MediaSession, ControllerInfo, SessionCommand, Bundle), MediaController.sendCustomCommand(SessionCommand, Bundle)

• setMediaItemProvider

  public SessionCallbackBuilder setMediaItemProvider​(@Nullable
                                                     SessionCallbackBuilder.MediaItemProvider mediaItemProvider)

  Sets the SessionCallbackBuilder.MediaItemProvider that will convert media ids to MediaItems.

  Parameters:

  mediaItemProvider - The media item provider.

  Returns:

  This builder.

  See Also:

  MediaSession.SessionCallback.onCreateMediaItem(MediaSession, ControllerInfo, String), MediaController.addPlaylistItem(int, String), MediaController.replacePlaylistItem(int, String), MediaController.setMediaItem(String), MediaController.setPlaylist(List, MediaMetadata)

• setAllowedCommandProvider

  public SessionCallbackBuilder setAllowedCommandProvider​(@Nullable
                                                          SessionCallbackBuilder.AllowedCommandProvider allowedCommandProvider)

  Sets the SessionCallbackBuilder.AllowedCommandProvider to provide allowed commands for controllers.

  Parameters:

  allowedCommandProvider - A allowed command provider.

  Returns:

  This builder.

• setSkipCallback

  public SessionCallbackBuilder setSkipCallback​(@Nullable
                                                SessionCallbackBuilder.SkipCallback skipCallback)

  Sets the SessionCallbackBuilder.SkipCallback to handle skip backward and skip forward.

  Parameters:

  skipCallback - The skip callback.

  Returns:

  This builder.

  See Also:

  MediaSession.SessionCallback.onSkipBackward(MediaSession, ControllerInfo), MediaSession.SessionCallback.onSkipForward(MediaSession, ControllerInfo), MediaController.skipBackward(), MediaController.skipForward()

• setPostConnectCallback

  public SessionCallbackBuilder setPostConnectCallback​(@Nullable
                                                       SessionCallbackBuilder.PostConnectCallback postConnectCallback)

  Sets the SessionCallbackBuilder.PostConnectCallback to handle extra initialization after the connection.

  Parameters:

  postConnectCallback - The post connect callback.

  Returns:

  This builder.

  See Also:

  MediaSession.SessionCallback.onPostConnect(MediaSession, ControllerInfo)

• setDisconnectedCallback

  public SessionCallbackBuilder setDisconnectedCallback​(@Nullable
                                                        SessionCallbackBuilder.DisconnectedCallback disconnectedCallback)

  Sets the SessionCallbackBuilder.DisconnectedCallback to handle cleaning up controller.

  Parameters:

  disconnectedCallback - The disconnected callback.

  Returns:

  This builder.

  See Also:

  MediaSession.SessionCallback.onDisconnected(MediaSession, ControllerInfo)

• setRewindIncrementMs

  public SessionCallbackBuilder setRewindIncrementMs​(int rewindMs)

  Sets the rewind increment in milliseconds.

  Parameters:

  rewindMs - The rewind increment in milliseconds. A non-positive value will cause the rewind to be disabled.

  Returns:

  This builder.

  See Also:

  MediaSession.SessionCallback.onRewind(MediaSession, MediaSession.ControllerInfo), setSeekTimeoutMs(int)

• setFastForwardIncrementMs

  public SessionCallbackBuilder setFastForwardIncrementMs​(int fastForwardMs)

  Sets the fast forward increment in milliseconds.

  Parameters:

  fastForwardMs - The fast forward increment in milliseconds. A non-positive value will cause the fast forward to be disabled.

  Returns:

  This builder.

  See Also:

  MediaSession.SessionCallback.onFastForward(MediaSession, MediaSession.ControllerInfo), setSeekTimeoutMs(int)

• setSeekTimeoutMs

  public SessionCallbackBuilder setSeekTimeoutMs​(int seekTimeoutMs)

  Sets the timeout in milliseconds for fast forward and rewind operations, or 0 for no timeout. If a timeout is set, controllers will receive an error if the session's call to SessionPlayer.seekTo(long) takes longer than this amount of time.

  Parameters:

  seekTimeoutMs - A timeout for SessionPlayer.seekTo(long). A non-positive value will wait forever.

  Returns:

  This builder.

• build

  public androidx.media2.session.MediaSession.SessionCallback build()

  Builds MediaSession.SessionCallback.

  Returns:

  A new callback for a media session.