useInputSettings
useInputSettings(params?) : Object
Convenience hook around getInputSettings()
and updateInputSettings()
.
Params (optional)
Parameter | Required | Type | Description |
---|---|---|---|
onError | Function | Callback for the 'input-settings-error' event | |
onInputSettingsUpdated | Function | Callback for the input-settings-updated event |
Return type
An object with the following properties:
Name | Type | Description |
---|---|---|
errorMsg | string | Details an input settings error. Defaults to null . |
inputSettings | Object | The settings for the participant. See daily-js instance method getInputSettings() for an overview of input settings |
updateInputSettings | Function | Updates input settings, equivalent to calling the daily-js updateInputSettings() method |
Any calls to updateInputSettings()
before the meeting is joined will be silently ignored.