EOS_RTCAudio_SetAudioInputSettingsOptions

EOS API reference page for EOS_RTCAudio_SetAudioInputSettingsOptions

2 min read

Remarks

This struct is used to call EOS_RTCAudio_SetAudioInputSettings.

Properties

EOS_RTCAudio_SetAudioInputSettingsOptions

PropertyValue
int32_t ApiVersionAPI Version: Set this to EOS_RTCAUDIO_SETAUDIOINPUTSETTINGS_API_LATEST.
EOS_ProductUserId LocalUserIdThe Product User ID of the user trying to request this operation.
const char* DeviceIdThe device Id to be used for this user. Pass NULL or empty string to use default input device. If the device ID is invalid, the default device will be used instead. Despite this fact, that device ID will be stored and the library will try to move on it when an audio device pool is being changed. The actual hardware audio device usage depends on the current payload and optimized not to use it when generated audio frames cannot be processed by someone else based on a scope of rules (For instance, when a client is alone in a room).
float VolumeThe volume to be used for all rooms of this user (range 0.0 to 100.0). At the moment, the only value that produce any effect is 0.0 (silence). Any other value is ignored and causes no change to the volume.
EOS_Bool bPlatformAECEnable or disable Platform AEC (Acoustic Echo Cancellation) if available.