added in version 26.1.0
belongs to Maven artifact com.android.support:leanback-v17:28.0.0-alpha1

PlaybackSeekUi.Client

public static class PlaybackSeekUi.Client
extends Object

java.lang.Object
   ↳ android.support.v17.leanback.widget.PlaybackSeekUi.Client


Client (e.g. PlaybackGlue) to register on PlaybackSeekUi so that it can interact with Seeking UI. For example client(PlaybackGlue) will pause media when PlaybackSeekUi emits onSeekStarted() event.

Summary

Public constructors

PlaybackSeekUi.Client()

Public methods

PlaybackSeekDataProvider getPlaybackSeekDataProvider()

Called by PlaybackSeekUi asking for PlaybackSeekDataProvider.

boolean isSeekEnabled()

Called by PlaybackSeekUi to query client if seek is allowed.

void onSeekFinished(boolean cancelled)

Called when cancelled or confirmed.

void onSeekPositionChanged(long pos)

Called when user seeks to a different location.

void onSeekStarted()

Event for start seeking.

Inherited methods

From class java.lang.Object

Public constructors

PlaybackSeekUi.Client

added in version 26.1.0
PlaybackSeekUi.Client ()

Public methods

getPlaybackSeekDataProvider

added in version 26.1.0
PlaybackSeekDataProvider getPlaybackSeekDataProvider ()

Called by PlaybackSeekUi asking for PlaybackSeekDataProvider. This method will be called after isSeekEnabled() returns true. If client does not provide a PlaybackSeekDataProvider, client may directly seek media in onSeekPositionChanged(long).

Returns
PlaybackSeekDataProvider PlaybackSeekDataProvider or null if no PlaybackSeekDataProvider is available.

isSeekEnabled

added in version 26.1.0
boolean isSeekEnabled ()

Called by PlaybackSeekUi to query client if seek is allowed.

Returns
boolean True if allow PlaybackSeekUi to start seek, false otherwise.

onSeekFinished

added in version 26.1.0
void onSeekFinished (boolean cancelled)

Called when cancelled or confirmed. When cancelled, client should restore playing from the position before onSeekStarted(). When confirmed, client should seek to last updated onSeekPositionChanged(long).

Parameters
cancelled boolean: True if cancelled false if confirmed.

onSeekPositionChanged

added in version 26.1.0
void onSeekPositionChanged (long pos)

Called when user seeks to a different location. This callback is called multiple times between onSeekStarted() and onSeekFinished(boolean).

Parameters
pos long: Position that user seeks to.

onSeekStarted

added in version 26.1.0
void onSeekStarted ()

Event for start seeking. Client will typically pause media and save the current position in the callback.