# CuesState

Artifact: [androidx.media3:media3-ui-compose](https://developer.android.com/jetpack/androidx/releases/media3) [View Source](https://cs.android.com/search?q=file:androidx/media3/ui/compose/state/CuesState.kt+class:androidx.media3.ui.compose.state.CuesState)


```
@UnstableApi
class CuesState
```

<br />

*** ** * ** ***

State holder that converts `https://developer.android.com/reference/kotlin/androidx/media3/common/Player.Listener#onCues(java.util.List<androidx.media3.common.text.Cue>)` events into a State of List and tracks the availability of text commands.

## Summary

| ### Public constructors |
|---|
| `https://developer.android.com/reference/kotlin/androidx/media3/ui/compose/state/CuesState#CuesState(androidx.media3.common.Player)(player: https://developer.android.com/reference/kotlin/androidx/media3/common/Player?)` |

| ### Public functions |
|---|---|
| `suspend https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-nothing/index.html?` | `https://developer.android.com/reference/kotlin/androidx/media3/ui/compose/state/CuesState#observe()()` Subscribes to updates from `https://developer.android.com/reference/kotlin/androidx/media3/common/Player.Events` and listens to `https://developer.android.com/reference/kotlin/androidx/media3/common/Player#EVENT_CUES()` and `https://developer.android.com/reference/kotlin/androidx/media3/common/Player#EVENT_AVAILABLE_COMMANDS_CHANGED()` to update the `https://developer.android.com/reference/kotlin/androidx/media3/ui/compose/state/CuesState#cues()` state. |

| ### Public properties |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html<https://developer.android.com/reference/kotlin/androidx/media3/common/text/Cue>` | `https://developer.android.com/reference/kotlin/androidx/media3/ui/compose/state/CuesState#cues()` The current list of cues to be displayed. |

## Public constructors

### CuesState

```
CuesState(player: Player?)
```

| Parameters |
|---|---|
| `player: https://developer.android.com/reference/kotlin/androidx/media3/common/Player?` | The `https://developer.android.com/reference/kotlin/androidx/media3/common/Player` whose cues are observed. |

## Public functions

### observe

```
suspend fun observe(): Nothing?
```

Subscribes to updates from `https://developer.android.com/reference/kotlin/androidx/media3/common/Player.Events` and listens to `https://developer.android.com/reference/kotlin/androidx/media3/common/Player#EVENT_CUES()` and `https://developer.android.com/reference/kotlin/androidx/media3/common/Player#EVENT_AVAILABLE_COMMANDS_CHANGED()` to update the `https://developer.android.com/reference/kotlin/androidx/media3/ui/compose/state/CuesState#cues()` state.

## Public properties

### cues

```
val cues: List<Cue>
```

The current list of cues to be displayed. Defaults to an empty list and is also empty when `https://developer.android.com/reference/kotlin/androidx/media3/common/Player#COMMAND_GET_TEXT()` is not available.