# PlaybackSeekUi.Client

Artifact: [androidx.leanback:leanback](https://developer.android.com/jetpack/androidx/releases/leanback) [View Source](https://cs.android.com/search?q=file:androidx/leanback/widget/PlaybackSeekUi.java+class:androidx.leanback.widget.PlaybackSeekUi.Client) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

*** ** * ** ***


```
public class PlaybackSeekUi.Client
```

<br />

*** ** * ** ***

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 `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#onSeekStarted()` event.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#Client()()` |

| ### Public methods |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekDataProvider` | `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#getPlaybackSeekDataProvider()()` Called by PlaybackSeekUi asking for PlaybackSeekDataProvider. |
| `boolean` | `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#isSeekEnabled()()` Called by PlaybackSeekUi to query client if seek is allowed. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#onSeekFinished(boolean)(boolean cancelled)` Called when cancelled or confirmed. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#onSeekPositionChanged(long)(long pos)` Called when user seeks to a different location. |
| `void` | `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#onSeekStarted()()` Event for start seeking. |

## Public constructors

### Client

Added in 1.1.0

```
public Client()
```

## Public methods

### getPlaybackSeekDataProvider

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public PlaybackSeekDataProvider getPlaybackSeekDataProvider()
```

Called by PlaybackSeekUi asking for PlaybackSeekDataProvider. This method will be called after `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#isSeekEnabled()` returns true. If client does not provide a `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekDataProvider`, client may directly seek media in `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#onSeekPositionChanged(long)`.

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekDataProvider` | PlaybackSeekDataProvider or null if no PlaybackSeekDataProvider is available. |

### isSeekEnabled

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public 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 [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public void onSeekFinished(boolean cancelled)
```

Called when cancelled or confirmed. When cancelled, client should restore playing from the position before `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#onSeekStarted()`. When confirmed, client should seek to last updated `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#onSeekPositionChanged(long)`.

| Parameters |
|---|---|
| `boolean cancelled` | True if cancelled false if confirmed. |

### onSeekPositionChanged

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public void onSeekPositionChanged(long pos)
```

Called when user seeks to a different location. This callback is called multiple times between `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#onSeekStarted()` and `https://developer.android.com/reference/androidx/leanback/widget/PlaybackSeekUi.Client#onSeekFinished(boolean)`.

| Parameters |
|---|---|
| `long pos` | Position that user seeks to. |

### onSeekStarted

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/leanback#1.1.0)

```
public void onSeekStarted()
```

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