Source
The SourceSelect
component provides gateways with a dropdown interface to choose between different media source devices like cameras and microphones.
All of the SourceSelect
components extend from
@radix-ui/react-select
,
and inherits all of the documentation for those components.
Features
- Synchronizes state with the user media and the broadcast
- Adheres to WAI-ARIA design patterns
- Persists to
localStorage
by default (with storage overrides customizable inRoot
)
Anatomy
Import the components and piece the parts together.
Props
SourceSelect
Takes all props of the Radix Select Root component.
forceMount
A boolean that, when set to true, ensures the component is always mounted. If this is not specified, it will only be shown when sources are detected.
type
A string indicating the type of media devices to list in the dropdown, either
"audioinput"
for microphones or "videoinput"
for cameras.
children
A function that takes the available media devices as input and returns the React nodes (options) to be rendered inside the dropdown. This enables dynamic population of the dropdown based on the available devices. ™
SelectItem
value.Data Attributes
data-livepeer-source-select
Serves to identify the component’s role within the broadcast interface.
data-type
Indicates the type of media source device the dropdown is currently displaying,
either "audioinput"
for microphones or "videoinput"
for cameras.
data-visible
Reflects the visibility status of the dropdown, with "true"
meaning it’s
currently visible (i.e., device support is available) and "false"
denoting
it’s not visible.
Was this page helpful?