Choose your implementation method:
This data structure is part of the RTC Interface.
This struct is used to call EOS_RTC_JoinRoom.
Properties
EOS_RTC_JoinRoomOptions
Property
|
Value
|
int32_t ApiVersion
|
API Version: Set this to EOS_RTC_JOINROOM_API_LATEST.
|
EOS_ProductUserId LocalUserId
|
The product user id of the user trying to request this operation.
|
const char* RoomName
|
The room the user would like to join.
|
const char* ClientBaseUrl
|
The room the user would like to join.
|
const char* ParticipantToken
|
Authorization credential token to join the room.
|
EOS_ProductUserId ParticipantId
|
The participant id used to join the room. If set to NULL the LocalUserId will be used instead.
|
uint32_t Flags
|
Join room flags, e.g. EOS_RTC_JOINROOMFLAGS_ENABLE_ECHO. This is a bitwise-or union of the defined flags.
|
EOS_Bool bManualAudioInputEnabled
|
Enable or disable 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.
|
EOS_Bool bManualAudioOutputEnabled
|
Enable or disable 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.
|
This data structure is part of the RTC Interface.
This struct is used to call {RTCInterface.JoinRoom}.
Properties
RTC.JoinRoomOptions
Property
|
Value
|
int ApiVersion
|
API Version: Set this to EOS_RTC_JOINROOM_API_LATEST.
|
ProductUserId LocalUserId
|
The product user id of the user trying to request this operation.
|
string RoomName
|
The room the user would like to join.
|
string ClientBaseUrl
|
The room the user would like to join.
|
string ParticipantToken
|
Authorization credential token to join the room.
|
ProductUserId ParticipantId
|
The participant id used to join the room. If set to NULL the LocalUserId will be used instead.
|
JoinRoomFlags Flags
|
Join room flags, e.g. EOS_RTC_JOINROOMFLAGS_ENABLE_ECHO. This is a bitwise-or union of the defined flags.
|
bool ManualAudioInputEnabled
|
Enable or disable 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.
|
bool ManualAudioOutputEnabled
|
Enable or disable 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.
|
Was this document useful?
Thank you for the response!
You’ve marked this document as useful:
yes
You’ve marked this document as not useful:
no