# PlaybackGlueHost

# PlaybackGlueHost

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

*** ** * ** ***

Kotlin\|[Java](https://developer.android.com/reference/androidx/leanback/media/PlaybackGlueHost "View this page in Java")

<br />

```
abstract class PlaybackGlueHost
```

<br />

Known direct subclasses  
[PlaybackFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/PlaybackFragmentGlueHost),[PlaybackSupportFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/PlaybackSupportFragmentGlueHost)  

|-----------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [PlaybackFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/PlaybackFragmentGlueHost)               | **This class is deprecated.** use[PlaybackSupportFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/PlaybackSupportFragmentGlueHost) <br />                                                                                                          |
| [PlaybackSupportFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/PlaybackSupportFragmentGlueHost) | [PlaybackGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost)implementation the interaction between this class and[PlaybackSupportFragment](https://developer.android.com/reference/kotlin/androidx/leanback/app/PlaybackSupportFragment). |

Known indirect subclasses  
[VideoFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/VideoFragmentGlueHost),[VideoSupportFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/VideoSupportFragmentGlueHost)  

|-----------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [VideoFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/VideoFragmentGlueHost)               | **This class is deprecated.** use[VideoSupportFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/VideoSupportFragmentGlueHost) <br />                                                                                                                                                                                                 |
| [VideoSupportFragmentGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/app/VideoSupportFragmentGlueHost) | [PlaybackGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost)implementation the interaction between[PlaybackGlue](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlue)and[VideoSupportFragment](https://developer.android.com/reference/kotlin/androidx/leanback/app/VideoSupportFragment). |

*** ** * ** ***

This class represents the UI (e.g. Fragment/Activity) hosting playback controls and defines the interaction between[PlaybackGlue](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlue)and the host. PlaybackGlueHost provides the following functions:

- Render UI of PlaybackGlue:[setPlaybackRow](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setPlaybackRow(androidx.leanback.widget.Row)),[setPlaybackRowPresenter](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setPlaybackRowPresenter(androidx.leanback.widget.PlaybackRowPresenter)).
- Client for fragment/activity onStart/onStop:[setHostCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setHostCallback(androidx.leanback.media.PlaybackGlueHost.HostCallback)).
- Auto fade out controls after a short period:[setFadingEnabled](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setFadingEnabled(boolean)).
- Key listener and ActionListener.[setOnKeyInterceptListener](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setOnKeyInterceptListener(android.view.View.OnKeyListener)),[setOnActionClickedListener](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setOnActionClickedListener(androidx.leanback.widget.OnActionClickedListener)).

Subclass of PlaybackGlueHost may implement optional interfaces:

<!-- -->

- [SurfaceHolderGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/media/SurfaceHolderGlueHost)to provide SurfaceView for video playback.
- [PlaybackSeekUi](https://developer.android.com/reference/kotlin/androidx/leanback/widget/PlaybackSeekUi)to provide seek UI to glue

These optional interfaces should be accessed by glue in[onAttachedToHost](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlue#onAttachedToHost(androidx.leanback.media.PlaybackGlueHost)).

## Summary

|                                                                                                             ### Nested types                                                                                                              |
|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `abstract class `[PlaybackGlueHost.HostCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost.HostCallback) Callbacks triggered by the host(e.g. fragment) hosting the video controls/surface. |
| `class `[PlaybackGlueHost.PlayerCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost.PlayerCallback) Optional Client that implemented by PlaybackGlueHost to respond to player event.        |

|                                                      ### Public constructors                                                       |
|------------------------------------------------------------------------------------------------------------------------------------|
| [PlaybackGlueHost](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#PlaybackGlueHost())`()` |

|                                                             ### Public functions                                                             |
|----------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | ~~[fadeOut](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#fadeOut())~~`()` **This function is deprecated.** Call[hideControlsOverlay](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#hideControlsOverlay(boolean)) <br />                                                                                                                                                                                   |
| [PlaybackGlueHost.PlayerCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost.PlayerCallback)`!` | [getPlayerCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#getPlayerCallback())`()` Implemented by PlaybackGlueHost for responding to player events.                                                                                                                                                                                                                                                                                          |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | [hideControlsOverlay](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#hideControlsOverlay(boolean))`(runAnimation: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` Hide controls overlay.                                                                                                                                                                                                                      |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                          | [isControlsOverlayAutoHideEnabled](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#isControlsOverlayAutoHideEnabled())`()` Returns true if auto hides controls overlay.                                                                                                                                                                                                                                                                                |
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)                                                          | [isControlsOverlayVisible](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#isControlsOverlayVisible())`()` Returns true if controls overlay is visible, false otherwise.                                                                                                                                                                                                                                                                               |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | [notifyPlaybackRowChanged](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#notifyPlaybackRowChanged())`()` Notifies host about a change so it can update the view.                                                                                                                                                                                                                                                                                     |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | [setControlsOverlayAutoHideEnabled](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setControlsOverlayAutoHideEnabled(boolean))`(enabled: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` Enables or disables controls overlay auto hidden.                                                                                                                                                                    |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | ~~[setFadingEnabled](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setFadingEnabled(boolean))~~`(enable: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` **This function is deprecated.** Use[setControlsOverlayAutoHideEnabled](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setControlsOverlayAutoHideEnabled(boolean)) <br />                                  |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | [setHostCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setHostCallback(androidx.leanback.media.PlaybackGlueHost.HostCallback))`(callback: `[PlaybackGlueHost.HostCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost.HostCallback)`!)` Sets the host[HostCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost.HostCallback)callback on the host. |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | [setOnActionClickedListener](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setOnActionClickedListener(androidx.leanback.widget.OnActionClickedListener))`(listener: `[OnActionClickedListener](https://developer.android.com/reference/kotlin/androidx/leanback/widget/OnActionClickedListener)`!)` Sets the[View.OnClickListener](https://developer.android.com/reference/android/view/View.OnClickListener.html)on this fragment.                  |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | [setOnKeyInterceptListener](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setOnKeyInterceptListener(android.view.View.OnKeyListener))`(onKeyListener: `[View.OnKeyListener](https://developer.android.com/reference/android/view/View.OnKeyListener.html)`!)` Sets the[android.view.View.OnKeyListener](https://developer.android.com/reference/android/view/View.OnKeyListener.html)on the host.                                                    |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | [setPlaybackRow](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setPlaybackRow(androidx.leanback.widget.Row))`(row: `[Row](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row)`!)` Sets the[Row](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row)that represents the information on control items that needs to be rendered.                                                                     |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | [setPlaybackRowPresenter](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setPlaybackRowPresenter(androidx.leanback.widget.PlaybackRowPresenter))`(presenter: `[PlaybackRowPresenter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/PlaybackRowPresenter)`!)` Sets[PlaybackRowPresenter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/PlaybackRowPresenter)for rendering the playback controls.   |
| [Unit](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)                                                                | [showControlsOverlay](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#showControlsOverlay(boolean))`(runAnimation: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html)`)` Show controls overlay.                                                                                                                                                                                                                      |

## Public constructors

### PlaybackGlueHost

Added in 1.1.0  

```
PlaybackGlueHost()
```  

## Public functions

### fadeOut

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

```
fun [fadeOut](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#fadeOut())(): Unit
```
| **This function is deprecated.**   
|
| Call[hideControlsOverlay](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#hideControlsOverlay(boolean))

Fades out the playback overlay immediately.  

### getPlayerCallback

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

```
fun getPlayerCallback(): PlaybackGlueHost.PlayerCallback!
```

Implemented by PlaybackGlueHost for responding to player events. Such as showing a spinning wheel progress bar when[onBufferingStateChanged](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost.PlayerCallback#onBufferingStateChanged(boolean)).  

|                                                                   Returns                                                                    |
|----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------|
| [PlaybackGlueHost.PlayerCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost.PlayerCallback)`!` | PlayerEventCallback that Host supports, null if not supported. |

### hideControlsOverlay

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

```
fun hideControlsOverlay(runAnimation: Boolean): Unit
```

Hide controls overlay.  

|                                             Parameters                                              |
|-----------------------------------------------------------------------------------------------------|-----------------------------------------|
| `runAnimation: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True to run animation, false otherwise. |

### isControlsOverlayAutoHideEnabled

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

```
fun isControlsOverlayAutoHideEnabled(): Boolean
```

Returns true if auto hides controls overlay.  

|                                       Returns                                       |
|-------------------------------------------------------------------------------------|---------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if auto hiding controls overlay. |

### isControlsOverlayVisible

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

```
fun isControlsOverlayVisible(): Boolean
```

Returns true if controls overlay is visible, false otherwise.  

|                                       Returns                                       |
|-------------------------------------------------------------------------------------|-------------------------------------------------------|
| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True if controls overlay is visible, false otherwise. |

|                                                                  See also                                                                   |
|---------------------------------------------------------------------------------------------------------------------------------------------|---|
| [showControlsOverlay](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#showControlsOverlay(boolean)) |   |
| [hideControlsOverlay](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#hideControlsOverlay(boolean)) |   |

### notifyPlaybackRowChanged

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

```
fun notifyPlaybackRowChanged(): Unit
```

Notifies host about a change so it can update the view.  

### setControlsOverlayAutoHideEnabled

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

```
fun setControlsOverlayAutoHideEnabled(enabled: Boolean): Unit
```

Enables or disables controls overlay auto hidden. If enabled, the view will be faded out after a time period.  

|                                           Parameters                                           |
|------------------------------------------------------------------------------------------------|-------------------------------------------------|
| `enabled: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True to enable auto hidden of controls overlay. |

### setFadingEnabled

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

```
fun [setFadingEnabled](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setFadingEnabled(boolean))(enable: Boolean): Unit
```
| **This function is deprecated.**   
|
| Use[setControlsOverlayAutoHideEnabled](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost#setControlsOverlayAutoHideEnabled(boolean))

Enables or disables view fading. If enabled, the view will be faded in when the fragment starts and will fade out after a time period.  

### setHostCallback

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

```
fun setHostCallback(callback: PlaybackGlueHost.HostCallback!): Unit
```

Sets the host[HostCallback](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlueHost.HostCallback)callback on the host. This method should only be called by[PlaybackGlue](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlue). App should not directly call this method, app should override[onHostStart](https://developer.android.com/reference/kotlin/androidx/leanback/media/PlaybackGlue#onHostStart())etc.  

### setOnActionClickedListener

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

```
fun setOnActionClickedListener(listener: OnActionClickedListener!): Unit
```

Sets the[View.OnClickListener](https://developer.android.com/reference/android/view/View.OnClickListener.html)on this fragment.  

### setOnKeyInterceptListener

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

```
fun setOnKeyInterceptListener(onKeyListener: View.OnKeyListener!): Unit
```

Sets the[android.view.View.OnKeyListener](https://developer.android.com/reference/android/view/View.OnKeyListener.html)on the host. This would trigger the listener when a[android.view.KeyEvent](https://developer.android.com/reference/android/view/KeyEvent.html)is unhandled by the host.  

### setPlaybackRow

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

```
fun setPlaybackRow(row: Row!): Unit
```

Sets the[Row](https://developer.android.com/reference/kotlin/androidx/leanback/widget/Row)that represents the information on control items that needs to be rendered.  

### setPlaybackRowPresenter

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

```
fun setPlaybackRowPresenter(presenter: PlaybackRowPresenter!): Unit
```

Sets[PlaybackRowPresenter](https://developer.android.com/reference/kotlin/androidx/leanback/widget/PlaybackRowPresenter)for rendering the playback controls.  

### showControlsOverlay

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

```
fun showControlsOverlay(runAnimation: Boolean): Unit
```

Show controls overlay.  

|                                             Parameters                                              |
|-----------------------------------------------------------------------------------------------------|-----------------------------------------|
| `runAnimation: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | True to run animation, false otherwise. |