useOptionalPlayer

Hook to access or select Player state when a Player is available

Import

import { useOptionalPlayer } from "@videojs/react";

Without a selector, the hook returns the player store or undefined outside Player.

const store = useOptionalPlayer();

With a selector, it subscribes while a player is available and returns the selected value. The selector is not called outside Player.

import { selectPlayback, useOptionalPlayer } from "@videojs/react";

const playback = useOptionalPlayer(selectPlayback);

Use usePlayer when the component requires a surrounding player.

Returns the player store when available, or undefined outside a Player.

UnknownStore | undefined

Selects a player value when available, or returns undefined outside a Player.

Parameter	Type	Default	Details
`selector*`	`function`	`—`
Description Derives a value from the player store state. Type `((state: UnknownState) => R)`

R | undefined