state/settings-context
The one useStreamSettings instance, held above the layout and handed to
every settings panel, so a switch between layouts keeps every value and
every pending push.
Functions
SettingsProvider()
function SettingsProvider(__namedParameters): Element;Defined in: state/settings-context.tsx:19
Holds the one settings instance for every panel under it.
Parameters
| Parameter | Type |
|---|---|
__namedParameters | { children: ReactNode; } |
__namedParameters.children | ReactNode |
Returns
Element
useSettings()
function useSettings(): StreamSettings;Defined in: state/settings-context.tsx:25
The shared settings; throws outside the provider.
Returns
StreamSettings
useSettingsPanels()
function useSettingsPanels(): object;Defined in: state/settings-context.tsx:32
Which settings panels have anything to show, and which halves of the video panel do.
Returns
object
video
video: any;audio
audio: any = s.show.audioPanel;screen
screen: any = s.show.screenPanel;format
format: any;performance
performance: any;