EOS_RTCAudio_SetAudioOutputSettingsOptions

EOS API reference page for EOS_RTCAudio_SetAudioOutputSettingsOptions

2 mins to read

Remarks

This struct is used to call EOS_RTCAudio_SetAudioOutputSettings.

Properties

EOS_RTCAudio_SetAudioOutputSettingsOptions

PropertyValue
int32_t ApiVersionAPI Version: Set this to EOS_RTCAUDIO_SETAUDIOOUTPUTSETTINGS_API_LATEST.
EOS_ProductUserId LocalUserIdThe Product User ID of the user who initiated this request.
const char* DeviceIdThe device Id to be used for this user. Pass NULL or empty string to use default output device. If the device ID is invalid, the default device will be used instead. Despite of this fact, that device ID will be stored and the library will try to move on it when a 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). Volume 50.0 means that the audio volume is not modified and stays in its source value.