The Broadcast.Root
component is the React Context wrapper for Broadcast.
Player.Root
component is a React Context wrapper which passes the player
state store down to all of the child components. It is responsible for creating
the Zustand state store which is consumed
by the children, and listens for media/browser events and keeps state in sync.
ingestUrl
Broadcast
component. You can
create the ingestUrl
by passing
getIngest
a string (interpreted as a
Livepeer Studio stream key or URL), Livepeer Studio stream data, or Cloudflare
stream data. Broadcast
is compatible with all WHIP playback endpoints.
aspectRatio
16 / 9
.
Set to null
to disable the aspect ratio container (see Container
).
forceEnabled
false
, which previews
the video first, then streams media to the server upon activation.
audio
true
. Set to false
to start the broadcast without requesting an audio track.
This can be an object that adheres to the structure of
MediaTrackConstraints
, which will
constrain the audio track used in the broadcast.
video
true
. Set to false
to start the broadcast without requesting a video track.
This can be an object that adheres to the structure of
MediaTrackConstraints
, which will
constrain the video track used in the broadcast. This is usually used to limit the resolution of the video
and improve bandwidth usage.
hotkeys
true
). It’s recommended to follow ARIA guidelines by keeping this enabled
unless you’re implementing custom hotkeys or there’s a conflict with existing
ones.
creatorId
onError
null
when the previous error is resolved. The callback receives the parameter:
timeout
storage
localStorage
in the browser. Set to null
to disable
storage.