Skip to main content

Function: usePlayer()

function usePlayer(options?: UsePlayerOptions): UsePlayerResult;

Defined in: packages/player/src/hooks/usePlayer.ts:42

Create a Player on mount and destroy it on unmount.

Parameters​

ParameterTypeDescription
optionsUsePlayerOptionsRead once, on mount. Later changes are ignored, because re-creating an mpv core mid-render would tear down playback.

Returns​

UsePlayerResult

{ player, error } — player is undefined until Player.create() resolves.

Example​

const { player, error } = usePlayer({
  volume: 0.8,
  setup: (p) => p.load('https://example.com/track.mp3'),
})