PlaybackBaseControlGlue

public static final int ACTION_CUSTOM_LEFT_FIRST = 1

The adapter key for the first custom control on the left side of the predefined primary controls.

public static final int ACTION_CUSTOM_RIGHT_FIRST = 4096

The adapter key for the first custom control on the right side of the predefined primary controls.

public static final int ACTION_FAST_FORWARD = 128

The adapter key for the fast forward control.

public static final int ACTION_PLAY_PAUSE = 64

The adapter key for the play/pause control.

public static final int ACTION_REPEAT = 512

The adapter key for the repeat control.

public static final int ACTION_REWIND = 32

The adapter key for the rewind control.

public static final int ACTION_SHUFFLE = 1024

The adapter key for the shuffle control.

public static final int ACTION_SKIP_TO_NEXT = 256

The adapter key for the skip to next control.

public static final int ACTION_SKIP_TO_PREVIOUS = 16

The adapter key for the skip to previous control.

public PlaybackBaseControlGlue(@NonNull Context context, T impl)

Constructor for the glue.

public @Nullable PlaybackControlsRow getControlsRow()

Returns the playback controls row managed by the glue layer.

public @Nullable PlaybackRowPresenter getPlaybackRowPresenter()

Returns the playback controls row Presenter managed by the glue layer.

public @Nullable CharSequence getSubtitle()

Return The media subtitle.

public long getSupportedActions()

Returns a bitmask of actions supported by the media player.

public @Nullable CharSequence getTitle()

Returns the title of the media item.

public boolean isControlsOverlayAutoHideEnabled()

Returns true if the controls auto hides after a timeout when media is playing.

public final boolean isPlaying()

Returns true if media is currently playing.

public final boolean isPrepared()

Returns true when the media player is prepared to start media playback. When returning false, app may listen to onPreparedStateChanged event.

public void next()

Goes to the next media item. This method is optional.

public abstract void onActionClicked(@NonNull Action action)

Handles action clicks. A subclass may override this add support for additional actions.

public abstract boolean onKey(View v, int keyCode, KeyEvent event)

Handles key events and returns true if handled. A subclass may override this to provide additional support.

public void pause()

Pauses the media player.

public void play()

Starts the media player. Does nothing if isPrepared is false. To wait isPrepared to be true before playing, use playWhenPrepared.

public void previous()

Goes to the previous media item. This method is optional.

public final void seekTo(long position)

Seek media to a new position.

public void setArt(@Nullable Drawable cover)

Sets the drawable representing cover image. The drawable will be rendered by default description presenter in setDescriptionPresenter.

public void setControlsOverlayAutoHideEnabled(boolean enable)

Sets the controls to auto hide after a timeout when media is playing.

public void setControlsRow(@NonNull PlaybackControlsRow controlsRow)

Sets the controls row to be managed by the glue layer. If getPrimaryActionsAdapter is not provided, a default ArrayObjectAdapter will be created and initialized in onCreatePrimaryActions. If getSecondaryActionsAdapter is not provided, a default ArrayObjectAdapter will be created and initialized in onCreateSecondaryActions. The primary actions and playback state related aspects of the row are updated by the glue.

public void setPlaybackRowPresenter(@Nullable PlaybackRowPresenter presenter)

Sets the controls row Presenter to be managed by the glue layer.

public void setSubtitle(@Nullable CharSequence subtitle)

Sets the media subtitle. The subtitle will be rendered by default description presenter setDescriptionPresenter.

public void setTitle(@Nullable CharSequence title)

Sets the media title. The title will be rendered by default description presenter setDescriptionPresenter.

protected void onAttachedToHost(@NonNull PlaybackGlueHost host)

This method is called attached to associated PlaybackGlueHost. Subclass may override and call super.onAttachedToHost().

protected void onCreatePrimaryActions(
    @NonNull ArrayObjectAdapter primaryActionsAdapter
)

May be overridden to add primary actions to the adapter. Default implementation add PlaybackControlsRow.PlayPauseAction.

protected void onCreateSecondaryActions(
    @NonNull ArrayObjectAdapter secondaryActionsAdapter
)

May be overridden to add secondary actions to the adapter.

protected void onDetachedFromHost()

This method is called when current associated PlaybackGlueHost is attached to a different PlaybackGlue or PlaybackGlueHost is destroyed . Subclass may override and call super.onDetachedFromHost() at last. A typical PlaybackGlue will release resources (e.g. MediaPlayer or connection to playback service) in this method.

protected void onHostStart()

This method is called when PlaybackGlueHost is started. Subclass may override.

protected void onHostStop()

This method is called when PlaybackGlueHost is stopped. Subclass may override.

protected void onMetadataChanged()

Event when metadata changed

@CallSuper
protected void onPlayCompleted()

Event when play finishes, subclass may handling repeat mode here.

@CallSuper
protected void onPlayStateChanged()

Event when play state changed.

@CallSuper
protected void onPreparedStateChanged()

Event when ready state for play changes.