diff --git a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/NextButtonState.kt b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/NextButtonState.kt index a66436c22b..257dd34113 100644 --- a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/NextButtonState.kt +++ b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/NextButtonState.kt @@ -28,8 +28,8 @@ import androidx.media3.common.util.UnstableApi /** * Remembers the value of [NextButtonState] created based on the passed [Player] and launch a - * coroutine to listen to [Player]'s changes. If the [Player] instance changes between compositions, - * produce and remember a new value. + * coroutine to listen to [Player's][Player] changes. If the [Player] instance changes between + * compositions, produce and remember a new value. */ @UnstableApi @Composable diff --git a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PlayPauseButtonState.kt b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PlayPauseButtonState.kt index 5e7fedad45..b1c1232380 100644 --- a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PlayPauseButtonState.kt +++ b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PlayPauseButtonState.kt @@ -23,19 +23,16 @@ import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.runtime.setValue import androidx.media3.common.Player -import androidx.media3.common.Timeline import androidx.media3.common.listen import androidx.media3.common.util.UnstableApi -import androidx.media3.common.util.Util.handlePauseButtonAction -import androidx.media3.common.util.Util.handlePlayButtonAction import androidx.media3.common.util.Util.handlePlayPauseButtonAction import androidx.media3.common.util.Util.shouldEnablePlayPauseButton import androidx.media3.common.util.Util.shouldShowPlayButton /** * Remembers the value of [PlayPauseButtonState] created based on the passed [Player] and launch a - * coroutine to listen to [Player]'s changes. If the [Player] instance changes between compositions, - * produce and remember a new value. + * coroutine to listen to [Player's][Player] changes. If the [Player] instance changes between + * compositions, produce and remember a new value. */ @UnstableApi @Composable @@ -50,7 +47,7 @@ fun rememberPlayPauseButtonState(player: Player): PlayPauseButtonState { * component representing a PlayPause button. * * @property[isEnabled] determined by `isCommandAvailable(Player.COMMAND_PLAY_PAUSE)` and having - * something in the [Timeline] to play + * something in the [Timeline][androidx.media3.common.Timeline] to play * @property[showPlay] determined by [shouldShowPlayButton] */ @UnstableApi @@ -68,9 +65,9 @@ class PlayPauseButtonState(private val player: Player) { * The [Player] update that follows can take a form of [Player.play], [Player.pause], * [Player.prepare] or [Player.seekToDefaultPosition]. * - * @see [handlePlayButtonAction] - * @see [handlePauseButtonAction] - * @see [shouldShowPlayButton] + * @see [androidx.media3.common.util.Util.handlePlayButtonAction] + * @see [androidx.media3.common.util.Util.handlePauseButtonAction] + * @see [androidx.media3.common.util.Util.shouldShowPlayButton] */ fun onClick() { handlePlayPauseButtonAction(player) diff --git a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PresentationState.kt b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PresentationState.kt index c94f6d625d..51cceebc9e 100644 --- a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PresentationState.kt +++ b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PresentationState.kt @@ -24,8 +24,6 @@ import androidx.compose.runtime.mutableStateOf import androidx.compose.runtime.remember import androidx.compose.runtime.setValue import androidx.compose.ui.geometry.Size -import androidx.compose.ui.unit.Density -import androidx.compose.ui.unit.Dp import androidx.media3.common.C import androidx.media3.common.Player import androidx.media3.common.Timeline @@ -35,8 +33,8 @@ import androidx.media3.common.util.UnstableApi /** * Remembers the value of [PresentationState] created based on the passed [Player] and launches a - * coroutine to listen to [Player]'s changes. If the [Player] instance changes between compositions, - * produces and remembers a new value. + * coroutine to listen to [Player's][Player] changes. If the [Player] instance changes between + * compositions, produces and remembers a new value. */ @UnstableApi @Composable @@ -52,11 +50,11 @@ fun rememberPresentationState(player: Player): PresentationState { * * @property[videoSizeDp] wraps [Player.getVideoSize] in Compose's [Size], becomes `null` when * either height or width of the video is zero. Takes into account - * [VideoSize.pixelWidthHeightRatio] to return a Size in [Dp], i.e. device-independent pixel. To - * use this measurement in Compose's Drawing and Layout stages, convert it into pixels using - * [Density.toPx]. Note that for cases where `pixelWidthHeightRatio` is not equal to 1, the - * rescaling will be down, i.e. reducing the width or the height to achieve the same aspect ratio - * in square pixels. + * [VideoSize.pixelWidthHeightRatio] to return a Size in [Dp][androidx.compose.ui.unit.Dp], i.e. + * device-independent pixel. To use this measurement in Compose's Drawing and Layout stages, + * convert it into pixels using [Density.toPx][androidx.compose.ui.unit.Density.toPx]. Note that + * for cases where `pixelWidthHeightRatio` is not equal to 1, the rescaling will be down, i.e. + * reducing the width or the height to achieve the same aspect ratio in square pixels. * @property[coverSurface] set to false when the Player emits [Player.EVENT_RENDERED_FIRST_FRAME] * and reset back to true on [Player.EVENT_TRACKS_CHANGED] depending on the number and type of * tracks. diff --git a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PreviousButtonState.kt b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PreviousButtonState.kt index 9e50290b62..f32411f6aa 100644 --- a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PreviousButtonState.kt +++ b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/PreviousButtonState.kt @@ -28,8 +28,8 @@ import androidx.media3.common.util.UnstableApi /** * Remembers the value of [PreviousButtonState] created based on the passed [Player] and launch a - * coroutine to listen to [Player]'s changes. If the [Player] instance changes between compositions, - * produce and remember a new value. + * coroutine to listen to [Player's][Player] changes. If the [Player] instance changes between + * compositions, produce and remember a new value. */ @UnstableApi @Composable diff --git a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/RepeatButtonState.kt b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/RepeatButtonState.kt index 72f6e07700..1fb382d812 100644 --- a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/RepeatButtonState.kt +++ b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/RepeatButtonState.kt @@ -29,8 +29,8 @@ import androidx.media3.common.util.UnstableApi /** * Remember the value of [RepeatButtonState] created based on the passed [Player] and launch a - * coroutine to listen to [Player]'s changes. If the [Player] instance changes between compositions, - * produce and remember a new value. + * coroutine to listen to [Player's][Player] changes. If the [Player] instance changes between + * compositions, produce and remember a new value. */ @UnstableApi @Composable @@ -53,9 +53,9 @@ fun rememberRepeatButtonState( * button is clicked. Defaults to [Player.REPEAT_MODE_OFF], [Player.REPEAT_MODE_ONE], * [Player.REPEAT_MODE_ALL]. * @property[isEnabled] determined by `isCommandAvailable(Player.COMMAND_SET_REPEAT_MODE)` - * @property[repeatModeState] determined by [Player]'s `repeatMode`. Note that there is no guarantee - * for this state to be one from [toggleModeSequence]. A button click in such case will toggle the - * mode into the first one of [toggleModeSequence]. + * @property[repeatModeState] determined by [Player's][Player] `repeatMode`. Note that there is no + * guarantee for this state to be one from [toggleModeSequence]. A button click in such case will + * toggle the mode into the first one of [toggleModeSequence]. */ @UnstableApi class RepeatButtonState( diff --git a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/ShuffleButtonState.kt b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/ShuffleButtonState.kt index 2ff3ef3829..305e83a9e5 100644 --- a/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/ShuffleButtonState.kt +++ b/libraries/ui_compose/src/main/java/androidx/media3/ui/compose/state/ShuffleButtonState.kt @@ -28,8 +28,8 @@ import androidx.media3.common.util.UnstableApi /** * Remember the value of [ShuffleButtonState] created based on the passed [Player] and launch a - * coroutine to listen to [Player]'s changes. If the [Player] instance changes between compositions, - * produce and remember a new value. + * coroutine to listen to [Player's][Player] changes. If the [Player] instance changes between + * compositions, produce and remember a new value. */ @UnstableApi @Composable @@ -44,7 +44,7 @@ fun rememberShuffleButtonState(player: Player): ShuffleButtonState { * On/Off button. * * @property[isEnabled] determined by `isCommandAvailable(Player.COMMAND_SET_SHUFFLE_MODE)` - * @property[shuffleOn] determined by [Player]'s `shuffleModeEnabled` + * @property[shuffleOn] determined by [Player's][Player] `shuffleModeEnabled` */ @UnstableApi class ShuffleButtonState(private val player: Player) {