useInputSettings

useInputSettings(params?) : Object

Convenience hook around getInputSettings() and updateInputSettings().

Params (optional)

ParameterRequiredTypeDescription
onErrorFunctionCallback for the 'input-settings-error' event
onInputSettingsUpdatedFunctionCallback for the input-settings-updated event

Return type

An object with the following properties:

NameTypeDescription
errorMsgstringDetails an input settings error. Defaults to null.
inputSettingsObjectThe settings for the participant. See daily-js instance method getInputSettings() for an overview of input settings
updateInputSettingsFunctionUpdates input settings, equivalent to calling the daily-js updateInputSettings() method

Any calls to updateInputSettings() before the meeting is joined will be silently ignored.

Sample code