getInputSettings()
getInputSettings()
Returns the current input settings object, or an empty object if no settings are applied.
Example response object containing an active video and audio processor:
The input settings object represents the client's custom settings and may not match what is actually in effect for the input. For example, if the client calls updateInputSettings({ video: { settings: { frameRate: 30}}}), but the default device does not support 30fps, the actual frame rate will be that of the default device, but getInputSettings() will still return the preferred setting of 30. This allows the setting to remain and attempt to be applied if/when devices change.
Note, however, that if the constraints provided result in an error, the settings are cleared to avoid repeating errors and getInputSettings() will return an empty object. For instance, modifying the same example above but enforcing the invalid frame rate (updateInputSettings({ video: { settings: { frameRate: { exact: 30 }}}})) when there isn't a device that supports 30fps. This will result in an OverConstrainedError and the settings will be cleared.