SessionCallbackBuilder (ExoPlayer library)

java.lang.Object
- com.google.android.exoplayer2.ext.media2.SessionCallbackBuilder

```
public final class SessionCallbackBuilder
extends Object
```
Builds a MediaSession.SessionCallback with various collaborators.

See Also:

MediaSession.SessionCallback

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`SessionCallbackBuilder.AllowedCommandProvider`	Provides allowed commands for `MediaController`.
`static interface`	`SessionCallbackBuilder.CustomCommandProvider`	Callbacks for querying what custom commands are supported, and for handling a custom command when a controller sends it.
`static class`	`SessionCallbackBuilder.DefaultAllowedCommandProvider`	Default implementation of `SessionCallbackBuilder.AllowedCommandProvider` that behaves as follows: Accepts connection requests from controller if any of the following conditions are met: Controller is in the same package as the session.
`static interface`	`SessionCallbackBuilder.DisconnectedCallback`	Callback for handling controller disconnection.
`static class`	`SessionCallbackBuilder.MediaIdMediaItemProvider`	A `SessionCallbackBuilder.MediaItemProvider` that creates media items containing only a media ID.
`static interface`	`SessionCallbackBuilder.MediaItemProvider`	Provides the `MediaItem`.
`static interface`	`SessionCallbackBuilder.PostConnectCallback`	Callback for handling extra initialization after the connection.
`static interface`	`SessionCallbackBuilder.RatingCallback`	Callback receiving a user rating for a specified media id.
`static interface`	`SessionCallbackBuilder.SkipCallback`	Callback receiving skip backward and skip forward.

Field Summary

Fields
Modifier and Type Field Description

static int DEFAULT_SEEK_TIMEOUT_MS
Default timeout value for setSeekTimeoutMs(int).

Fields
Modifier and Type	Field	Description
`static int`	`DEFAULT_SEEK_TIMEOUT_MS`	Default timeout value for `setSeekTimeoutMs(int)`.

Constructor Summary

Constructors
Constructor Description

SessionCallbackBuilder(Context context, SessionPlayerConnector sessionPlayerConnector)
Creates a new builder.

Constructors
Constructor	Description
`SessionCallbackBuilder(Context context, SessionPlayerConnector sessionPlayerConnector)`	Creates a new builder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`androidx.media2.session.MediaSession.SessionCallback`	`build()`	Builds `MediaSession.SessionCallback`.
`SessionCallbackBuilder`	`setAllowedCommandProvider(SessionCallbackBuilder.AllowedCommandProvider allowedCommandProvider)`	Sets the `SessionCallbackBuilder.AllowedCommandProvider` to provide allowed commands for controllers.
`SessionCallbackBuilder`	`setCustomCommandProvider(SessionCallbackBuilder.CustomCommandProvider customCommandProvider)`	Sets the `SessionCallbackBuilder.CustomCommandProvider` to handle incoming custom commands.
`SessionCallbackBuilder`	`setDisconnectedCallback(SessionCallbackBuilder.DisconnectedCallback disconnectedCallback)`	Sets the `SessionCallbackBuilder.DisconnectedCallback` to handle cleaning up controller.
`SessionCallbackBuilder`	`setFastForwardIncrementMs(int fastForwardMs)`	Sets the fast forward increment in milliseconds.
`SessionCallbackBuilder`	`setMediaItemProvider(SessionCallbackBuilder.MediaItemProvider mediaItemProvider)`	Sets the `SessionCallbackBuilder.MediaItemProvider` that will convert media ids to `MediaItems`.
`SessionCallbackBuilder`	`setPostConnectCallback(SessionCallbackBuilder.PostConnectCallback postConnectCallback)`	Sets the `SessionCallbackBuilder.PostConnectCallback` to handle extra initialization after the connection.
`SessionCallbackBuilder`	`setRatingCallback(SessionCallbackBuilder.RatingCallback ratingCallback)`	Sets the `SessionCallbackBuilder.RatingCallback` to handle user ratings.
`SessionCallbackBuilder`	`setRewindIncrementMs(int rewindMs)`	Sets the rewind increment in milliseconds.
`SessionCallbackBuilder`	`setSeekTimeoutMs(int seekTimeoutMs)`	Sets the timeout in milliseconds for fast forward and rewind operations, or `0` for no timeout.
`SessionCallbackBuilder`	`setSkipCallback(SessionCallbackBuilder.SkipCallback skipCallback)`	Sets the `SessionCallbackBuilder.SkipCallback` to handle skip backward and skip forward.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 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:
    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.

Class SessionCallbackBuilder

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SEEK_TIMEOUT_MS

Constructor Detail

SessionCallbackBuilder

Method Detail

setRatingCallback

setCustomCommandProvider

setMediaItemProvider

setAllowedCommandProvider

setSkipCallback

setPostConnectCallback

setDisconnectedCallback

setRewindIncrementMs

setFastForwardIncrementMs

setSeekTimeoutMs

build