/**
 * 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 {@link PlayerProvider} or
 * [AVPlayerViewControllerProvider](../../ios-avplayerviewcontroller-plugin-api/variables/AVPlayerViewControllerProvider.md) component.
 *
 * @returns `boolean` **true** if playback should start automatically once ready, otherwise **false**.
 *
 * @example
 * ```tsx
 *
 * function PlaybackIndicator() {
 *   const playWhenReady = usePlayWhenReady();
 *
 *   return <Text>{playWhenReady ? 'Auto-play enabled' : 'Auto-play disabled'}</Text>;
 * }
 * ```
 *
 * @group Hooks
 */
export default function usePlayWhenReady(): boolean;