EOS_Lobby_LocalRTCOptions

EOS API reference page for EOS_Lobby_LocalRTCOptions

Choose your implementation method:

C

C#

This data structure is part of the Lobby Interface.

Remarks

Input parameters to use with Lobby RTC Rooms.

Properties

EOS_Lobby_LocalRTCOptions

Property

Value

int32_t ApiVersion

API Version: Set this to EOS_LOBBY_LOCALRTCOPTIONS_API_LATEST.

uint32_t Flags

Flags for the local user in this room. The default is 0 if this struct is not specified. @see EOS_RTC_JoinRoomOptions::Flags

EOS_Bool bUseManualAudioInput

Set to EOS_TRUE to enable Manual Audio Input. If manual audio input is enabled, audio recording is not started and the audio buffers must be passed manually using EOS_RTCAudio_SendAudio. The default is EOS_FALSE if this struct is not specified.

EOS_Bool bUseManualAudioOutput

Set to EOS_TRUE to enable Manual Audio Output. If manual audio output is enabled, audio rendering is not started and the audio buffers must be received with EOS_RTCAudio_AddNotifyAudioBeforeRender and rendered manually. The default is EOS_FALSE if this struct is not specified.

EOS_Bool bLocalAudioDeviceInputStartsMuted

Set to EOS_TRUE to start the audio input device's stream as muted when first connecting to the RTC room. It must be manually unmuted with a call to EOS_RTCAudio_UpdateSending. If manual audio output is enabled, this value is ignored. The default value is EOS_FALSE if this struct is not specified.

This data structure is part of the Lobby Interface.

Remarks

Input parameters to use with Lobby RTC Rooms.

Properties

Lobby.LocalRTCOptions

Property

Value

int ApiVersion

API Version: Set this to EOS_LOBBY_LOCALRTCOPTIONS_API_LATEST.

uint Flags

Flags for the local user in this room. The default is 0 if this struct is not specified. @see EOS_RTC_JoinRoomOptions::Flags

bool UseManualAudioInput

Set to EOS_TRUE to enable Manual Audio Input. If manual audio input is enabled, audio recording is not started and the audio buffers must be passed manually using EOS_RTCAudio_SendAudio. The default is EOS_FALSE if this struct is not specified.

bool UseManualAudioOutput

Set to EOS_TRUE to enable Manual Audio Output. If manual audio output is enabled, audio rendering is not started and the audio buffers must be received with EOS_RTCAudio_AddNotifyAudioBeforeRender and rendered manually. The default is EOS_FALSE if this struct is not specified.

bool LocalAudioDeviceInputStartsMuted

Set to EOS_TRUE to start the audio input device's stream as muted when first connecting to the RTC room. It must be manually unmuted with a call to EOS_RTCAudio_UpdateSending. If manual audio output is enabled, this value is ignored. The default value is EOS_FALSE if this struct is not specified.

Tags