usePlayWhenReady()

usePlayWhenReady(): boolean

Determines whether playback should begin automatically when the player is ready.

This hook provides a reactive way to observe and respond to changes in the player’s “play when ready” state — i.e., whether the player is configured to start playback automatically as soon as it is able to.

⚠️ Must be used within a PlayerProvider or AVPlayerViewControllerProvider component.

Returns

boolean

boolean true if playback should start automatically once ready, otherwise false.

Example

function PlaybackIndicator() {
  const playWhenReady = usePlayWhenReady();

  return <Text>{playWhenReady ? 'Auto-play enabled' : 'Auto-play disabled'}</Text>;
}