This document describes how to access and debug the GME APIs for Unity voice chat.
Note:This document applies to GME SDK version 2.8.
GME provides two services: voice chat service and voice message and speech-to-text service, both of which rely on key APIs such as Init and Poll.
Note on Init APIIf you need to use voice chat and voice message services at the same time, you only need to call
Init
API once.
Billing will not start after initialization. After you call Entering a voice chat roomAPI: EnterRoom to enter the room successfully, the billing will start.
QAVError.OK
will be returned with the value being 0.Poll
API should be called periodically for GME to trigger event callbacks.Class | Description |
---|---|
ITMGContext | Key APIs |
ITMGRoom | Room APIs |
ITMGRoomManager | Room management APIs |
ITMGAudioCtrl | Audio APIs |
ITMGAudioEffectCtrl | Sound effect and accompaniment APIs |
Before the initialization, the SDK is in the uninitialized status, and you need to initialize it through the Init
API before you can use the voice chat and speech-to-text services.
You need to call the Init
API before calling any APIs of GME.
If you have any questions when using the service, please see General Issues.
API | Description |
---|---|
Init | Initializes GME |
Poll | Triggers event callback |
Pause | Pauses the system |
Resume | Resumes the system |
Uninit | Uninitializes GME |
Note:If you need to switch the account, please call
UnInit
to uninitialize the SDK. No fee is incurred for calling Init API.
using TencentMobileGaming;
Get the Context
instance by using the ITMGContext
method instead of QAVContext.GetInstance()
.
sdkAppID
parameter, please see Voice Service Activation Guide.Note:
- The SDK must be initialized before a user can enter a voice chat room.
- The Init API must be called in the same thread with other APIs. It is recommended to call all APIs in the main thread.
//class ITMGContext
public abstract int Init(string sdkAppID, string openID);
Parameter | Type | Description |
---|---|---|
sdkAppId | string | AppID provided by the GME service from the Tencent Cloud console |
openID | String | openID can only be in Int64 type, which is passed after being converted to a string. |
Returned Value | Description |
---|---|
QAVError.OK= 0 | Initialized SDK successfully |
AV_ERR_SDK_NOT_FULL_UPDATE=7015 | Checks whether the SDK file is complete. It is recommended to delete it and then import the SDK again. |
The returned value AV_ERR_SDK_NOT_FULL_UPDATE
is only a reminder but will not cause an initialization failure.
Notes on 7015 error code
- The 7015 error code is judged by md5. If this error is reported during integration, please check the integrity and version of the SDK file as prompted.
- Due to the third-party reinforcement, Unity packaging mechanism and other factors, the md5 of the library file will be affected, resulting in misjudgment. Please ignore this error in the logic for official release, and try to avoid displaying it in the UI.
int ret = ITMGContext.GetInstance().Init(sdkAppId, openID);
// Determine whether the initialization is successful by the returned value
if (ret != QAVError.OK)
{
Debug.Log("SDK initialization failed:"+ret);
return;
}
Event callbacks can be triggered by periodically calling the Poll
API in update
. The Poll
API should be called periodically for GME to trigger event callbacks; otherwise, the entire SDK service will run exceptionally.
Refer to the EnginePollHelper file in Demo.
Calling the `Poll` API periodicallyThe
Poll
API must be called periodically and in the main thread to avoid abnormal API callbacks.
ITMGContext public abstract int Poll();
public void Update()
{
ITMGContext.GetInstance().Poll();
}
When a Pause
event occurs in the system, the engine should also be notified for pause. For example, when the application switches to the background (OnApplicationPause, isPause=True), and you do not need the background to play back the audio in the room, please call Pause
API to pause the GME service.
ITMGContext public abstract int Pause()
When a Resume
event occurs in the system, the engine should also be notified for resumption. The Resume
API only supports resuming voice chat.
ITMGContext public abstract int Resume()
This API is used to uninitialize the SDK to make it uninitialized. Switching accounts requires uninitialization.
ITMGContext public abstract int Uninit()
Voice chat refers to the one-to-one or one-to-many real-time voice call feature.
You should initialize and call the SDK to enter a room before voice chat can start.
If you have any questions when using the service, please see FAQs About Voice Chat.
API | Description |
---|---|
GenAuthBuffer | Initializes authentication |
EnterRoom | Enters room |
IsRoomEntered | Indicates whether room entry is successful |
ExitRoom | Exits room |
ChangeRoomType | Modifies user's room audio type |
GetRoomType | Gets user's room audio type |
Generate AuthBuffer
for encryption and authentication of relevant features. For release in the production environment, please use the backend deployment key as detailed in Authentication Key.
QAVAuthBuffer GenAuthBuffer(int appId, string roomId, string openId, string key)
Parameter | Type | Description |
---|---|---|
appId | int | AppID from the Tencent Cloud console. |
roomId | string | Room ID, which can contain up to 127 characters. |
openId | string | User ID, which is the same as openID during initialization. |
key | string | Permission key from the Tencent Cloud console. |
public static byte[] GetAuthBuffer(string AppID, string RoomID,string OpenId, string AuthKey){
return QAVAuthBuffer.GenAuthBuffer(int.Parse(AppID), RoomID, OpenId, AuthKey);
}
When a user enters a room with the generated authentication information, the ITMG_MAIN_EVENT_TYPE_ENTER_ROOM
message will be received as a callback. Mic and speaker are not enabled by default after room entry. The returned value of AV_OK
indicates a success.
The audio type of the room is determined by the first user to enter the room. After that, if a member in the room changes the room type, it will take effect for all members there. For example, if the first user entering the room uses the smooth sound quality, and the second user entering the room uses the HD sound quality, the room audio type of the second user will become smooth sound quality. Only when a member in the room calls the ChangeRoomType
API, the audio type of the room will be changed.
For more information on how to choose a room audio type, please see Sound Quality Selection.
ITMGContext EnterRoom(string roomId, int roomType, byte[] authBuffer)
Parameter | Type | Description |
---|---|---|
roomId | string | Room ID, which can contain up to 127 characters |
roomType | ITMGRoomType | Room audio type |
authBuffer | Byte[] | Authentication code |
ITMGContext.GetInstance().EnterRoom(strRoomId, ITMGRoomType.ITMG_ROOM_TYPE_FLUENCY, byteAuthbuffer);
After the user enters the room, the message ITMG_MAIN_EVENT_TYPE_ENTER_ROOM
will be sent and identified in the OnEvent
function for callback and processing. A successful callback means that the room entry is successful, and the billing starts.
// Delegate function:
public delegate void QAVEnterRoomComplete(int result, string error_info);
// Event function:
public abstract event QAVEnterRoomComplete OnEnterRoomCompleteEvent;
// Listen on an event:
ITMGContext.GetInstance().OnEnterRoomCompleteEvent += new QAVEnterRoomComplete(OnEnterRoomComplete);
// Process the event listened on:
void OnEnterRoomComplete(int err, string errInfo)
{
if (err != 0) {
ShowLoginPanel("error code:" + err + " error message:" + errInfo);
return;
}else{
// Entered room
}
}
Message | Data | Sample |
---|---|---|
ITMG_MAIN_EVENT_TYPE_ENTER_ROOM | result; error_info | {"error_info":"","result":0} |
ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT | result; error_info | {"error_info":"waiting timeout, please check your network","result":0} |
If the network is disconnected, there will be a disconnected callback prompt ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT
. At this time, the SDK will automatically reconnect, and the callback is ITMG_MAIN_EVENT_TYPE_RECONNECT_START
. When the reconnection is successful, there will be a callback ITMG_MAIN_EVENT_TYPE_RECONNECT_SUCCESS
.
Error Code Value | Cause and Suggested Solution |
---|---|
7006 | Authentication failed AppID does not exist or is incorrect.authbuff .OpenId does not meet the specification. |
7007 | Already in another room. |
1001 | The user was already in the process of entering a room but repeated this operation. It is recommended not to call the room entering API until the room entry callback is returned. |
1003 | The user was already in the room and called the room entering API again. |
1101 | Make sure that the SDK is initialized, OpenId complies with the rules, the APIs are called in the same thread, and the Poll API is called normally. |
This API is called to exit the current room. It is an async API. The returned value of AV_OK
indicates a successful async delivery.
Note:If there is a scenario in the application where room entry is performed immediately after room exit, you don't need to wait for the
RoomExitComplete
callback notification from theExitRoom
API during API call; instead, you can directly call the API.
ITMGContext ExitRoom()
ITMGContext.GetInstance().ExitRoom();
A callback will be executed through a delegate function to pass a message after room exit.
Delegate function:
public delegate void QAVExitRoomComplete();
Event function:
public abstract event QAVExitRoomComplete OnExitRoomCompleteEvent;
Listen on an event:
ITMGContext.GetInstance().OnExitRoomCompleteEvent += new QAVExitRoomComplete(OnExitRoomComplete);
Process the event listened on:
void OnExitRoomComplete(){
// Send a callback after room exit
}
This API is used to determine whether the user has entered a room. A bool-type value will be returned. The call is invalid during the process of room entry.
ITMGContext abstract bool IsRoomEntered()
ITMGContext.GetInstance().IsRoomEntered();
User can call this API to quickly switch the voice chat room after entering the room. After the room is switched, the device is not reset, that is, if the microphone is already enabled in this room, the microphone will keep enabled after the room is switched.
The callback for quickly switching rooms is ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM
, and the fields are error_info
and result
.
public abstract int SwitchRoom(string roomID, byte[] authBuffer);
Parameter | Type | Description |
---|---|---|
targetRoomID | String | ID of the room to enter |
authBuffer | byte[] | Generates a new authentication with the ID of the room to enter |
Call this API to connect the microphones across rooms after the room entry. After the call, the local user can communicate with the target OpenID user in the target room.
/// <summary> Enable the room sharing, and connect the mic of the OpenID in another room.</summary>
public abstract int StartRoomSharing(string targetRoomID, string targetOpenID, byte[] authBuffer);
/// <summary> Stop the enabled room sharing.</summary>
public abstract int StopRoomSharing();
Parameter | Type | Description |
---|---|---|
targetRoomID | String | ID of the room to connect mic |
targetOpenID | String | The target OpenID to connect mic |
authBuffer | byte[] | Reserved flag. You just need to enter NULL. |
This API is used to obtain the user speaking in the room and display it in the UI, and to send a notification when someone entering or exiting the room.
A notification for this event will be sent only when the status changes. To get member status in real time, cache the notification when it is received at the upper layer. The event message ITMG_MAIN_EVNET_TYPE_USER_UPDATE
containing event_id
, count
, and openIdList
will be returned. The event message will be identified in the OnEvent
function.
Notifications for audio events are subject to a threshold, and a notification will be sent only when this threshold is exceeded. The notification "A member has stopped sending audio packets" will be sent if no audio packets are received in more than two seconds.
event_id | Description | Maintenance |
---|---|---|
EVENT_ID_ENDPOINT_ENTER | A member enters the room | Member list |
EVENT_ID_ENDPOINT_EXIT | A member exits the room | Member list |
EVENT_ID_ENDPOINT_HAS_AUDIO | A member sends audio packets | Chat member list |
EVENT_ID_ENDPOINT_NO_AUDIO | A member stops sending audio packets | Chat member list |
// Delegate function:
public delegate void QAVEndpointsUpdateInfo(int eventID, int count, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 1)]string[] openIdList);
// Event function:
public abstract event QAVEndpointsUpdateInfo OnEndpointsUpdateInfoEvent;
// Listen on an event:
ITMGContext.GetInstance().OnEndpointsUpdateInfoEvent += new QAVEndpointsUpdateInfo(OnEndpointsUpdateInfo);
// Process the event listened on:
void OnEndpointsUpdateInfo(int eventID, int count, string[] openIdList)
{
// Process
switch (eventID)
{
case EVENT_ID_ENDPOINT_ENTER:
// A member enters the room
break;
case EVENT_ID_ENDPOINT_EXIT:
// A member exits the room
break;
case EVENT_ID_ENDPOINT_HAS_AUDIO:
// A member sends audio packets
break;
case EVENT_ID_ENDPOINT_NO_AUDIO:
// A member stops sending audio packets
break;
default:
break;
}
break;
}
This API is used to add an ID to the audio data blocklist. This operation blocks audio from someone and only applies to the local device. A returned value of 0
indicates the call is successful. Assume that users A, B, and C are all speaking using their mic in a room:
This API is suitable for scenarios where a user is muted in a room.
ITMGContext ITMGAudioCtrl AddAudioBlackList(String openId)
Parameter | Type | Description |
---|---|---|
openId | String | ID to be blocked |
ITMGContext.GetInstance().GetAudioCtrl ().AddAudioBlackList (openId);
This API is used to remove an ID from the audio data blacklist. A returned value of 0 indicates the call is successful.
ITMGContext ITMGAudioCtrl RemoveAudioBlackList(string openId)
Parameter | Type | Description |
---|---|---|
openId | String | ID to be unblocked |
ITMGContext.GetInstance().GetAudioCtrl ().RemoveAudioBlackList (openId);
The voice chat APIs can only be called after SDK initialization and room entry.
When Enable/Disable Mic/Speaker is clicked on the UI, the following practices are recommended:
EnableMic
and EnableSpeaker
APIs, which is equivalent to calling the EnableAudioCaptureDevice/EnableAudioSend
and EnableAudioPlayDevice/EnableAudioRecv
APIs.EnableAudioCaptureDevice(true)
and EnableAudioPlayDevice(true)
once after room entry, and call EnableAudioSend/Recv
to send/receive audio streams when Enable/Disable Mic is clicked.EnableAudioCaptureDevice
and EnableAudioPlayDevice
.pause
API to pause the audio engine and call the resume
API to resume the audio engine.API | Description |
---|---|
EnableMic | Enables/disables mic |
GetMicState | Gets mic status |
EnableAudioCaptureDevice | Enables/disables capturing device |
IsAudioCaptureDeviceEnabled | Gets capturing device status |
EnableAudioSend | Enables/disables audio upstreaming |
IsAudioSendEnabled | Gets audio upstreaming status |
GetMicLevel | Gets real-time mic volume |
GetSendStreamLevel | Gets real-time audio upstreaming volume |
SetMicVolume | Sets mic volume |
GetMicVolume | Gets mic volume |
EnableSpeaker | Enables/disables speaker |
GetSpeakerState | Gets speaker status |
EnableAudioPlayDevice | Enables/disables playback device |
IsAudioPlayDeviceEnabled | Gets playback device status |
EnableAudioRecv | Enables/disables audio downstreaming |
IsAudioRecvEnabled | Gets audio downstreaming status |
GetSpeakerLevel | Gets real-time speaker volume |
GetRecvStreamLevel | Gets real-time downstreaming audio levels of other members in room |
SetSpeakerVolume | Sets speaker volume |
GetSpeakerVolume | Gets speaker volume |
EnableLoopBack | Enables/disables in-ear monitoring |
This API is used to enable/disable the mic. Mic and speaker are not enabled by default after room entry.
If accompaniment is used, please call this API as instructed in Accompaniment in Voice Chat.
EnableMic = EnableAudioCaptureDevice + EnableAudioSend
ITMGAudioCtrl EnableMic(bool isEnabled)
Parameter | Type | Description |
---|---|---|
isEnabled | boolean | To enable the mic, set this parameter to true ; otherwise, set it to false . |
// Enable mic
ITMGContext.GetInstance().GetAudioCtrl().EnableMic(true);
This API is used to get the mic status. The returned value 0 indicates that the mic is off, while 1 is on.
ITMGAudioCtrl GetMicState()
micToggle.isOn = ITMGContext.GetInstance().GetAudioCtrl().GetMicState();
This API is used to enable/disable a capturing device. The device is not enabled by default after room entry.
ITMGAudioCtrl int EnableAudioPlayDevice(bool isEnabled)
Parameter | Type | Description |
---|---|---|
isEnabled | bool | To enable a capturing device, set this parameter to true ; otherwise, set it to false . |
// Enable capturing device
ITMGContext.GetInstance().GetAudioCtrl().EnableAudioCaptureDevice(true);
This API is used to get the status of a capturing device.
ITMGAudioCtrl bool IsAudioCaptureDeviceEnabled()
bool IsAudioCaptureDevice = ITMGContext.GetInstance().GetAudioCtrl().IsAudioCaptureDeviceEnabled();
This API is used to enable/disable audio upstreaming. If a capturing device is already enabled, it will send captured audio data; otherwise, it will remain mute. For more information on how to enable/disable the capturing device, please see the EnableAudioCaptureDevice
API.
ITMGAudioCtrl int EnableAudioSend(bool isEnabled)
Parameter | Type | Description |
---|---|---|
isEnabled | bool | To enable audio upstreaming, set this parameter to true ; otherwise, set it to false . |
ITMGContext.GetInstance().GetAudioCtrl().EnableAudioSend(true);
This API is used to get the status of audio upstreaming.
ITMGAudioCtrl bool IsAudioSendEnabled()
bool IsAudioSend = ITMGContext.GetInstance().GetAudioCtrl().IsAudioSendEnabled();
This API is used to get the real-time mic volume. An int-type value in the range of 0-100 will be returned. It is recommended to call this API once every 20 ms.
This API is not applicable to the voice message service.
ITMGAudioCtrl int GetMicLevel
ITMGContext.GetInstance().GetAudioCtrl().GetMicLevel();
This API is used to get the local real-time audio upstreaming volume. An int-type value in the range of 0-100 will be returned.
This API is not applicable to the voice message service.
ITMGAudioCtrl int GetSendStreamLevel()
int Level = ITMGContext.GetInstance().GetAudioCtrl().GetSendStreamLevel();
This API is used to set the mic volume. The corresponding parameter is volume
, which is equivalent to attenuating or gaining the captured sound. 0 indicates that the audio is mute, while 100 indicates that the volume remains unchanged. The default value is 100.
This API is not applicable to the voice message service.
ITMGAudioCtrl SetMicVolume(int volume)
Parameter | Type | Description |
---|---|---|
volume | int | Sets volume. Value range: 0-200 |
int micVol = (int)(value * 100);
ITMGContext.GetInstance().GetAudioCtrl().SetMicVolume (micVol);
This API is used to obtain the microphone volume. An "int" value is returned. Value 101 represents API SetMicVolume has not been called.
This API is not applicable to the voice message service.
ITMGAudioCtrl GetMicVolume()
ITMGContext.GetInstance().GetAudioCtrl().GetMicVolume();
This API is used to enable/disable the speaker.
If accompaniment is used, please call this API as instructed in Accompaniment in Voice Chat.
EnableSpeaker = EnableAudioPlayDevice + EnableAudioRecv
ITMGAudioCtrl EnableSpeaker(bool isEnabled)
Parameter | Type | Description |
---|---|---|
isEnabled | bool | To disable the speaker, set this parameter to false ; otherwise, set it to true . |
// Enable the speaker
ITMGContext.GetInstance().GetAudioCtrl().EnableSpeaker(true);
This API is used to get the speaker status.
ITMGAudioCtrl GetSpeakerState()
speakerToggle.isOn = ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerState();
This API is used to enable/disable a playback device.
ITMGAudioCtrl EnableAudioPlayDevice(bool isEnabled)
Parameter | Type | Description |
---|---|---|
isEnabled | bool | To disable a playback device, set this parameter to false ; otherwise, set it to true . |
// Enable the playback device
ITMGContext.GetInstance().GetAudioCtrl().EnableAudioPlayDevice(true);
This API is used to get the status of a playback device.
ITMGAudioCtrl bool IsAudioPlayDeviceEnabled()
bool IsAudioPlayDevice = ITMGContext.GetInstance().GetAudioCtrl().IsAudioPlayDeviceEnabled();
This API is used to enable/disable audio downstreaming. If a playback device is already enabled, it will play back audio data from other members in the room; otherwise, it will remain mute. For more information on how to enable/disable the playback device, please see the EnableAudioPlayDevice
API.
ITMGAudioCtrl int EnableAudioRecv(bool isEnabled)
Parameter | Type | Description |
---|---|---|
isEnabled | bool | To enable audio downstreaming, set this parameter to true ; otherwise, set it to false . |
ITMGContext.GetInstance().GetAudioCtrl().EnableAudioRecv(true);
This API is used to get the status of audio downstreaming.
ITMGAudioCtrl bool IsAudioRecvEnabled()
bool IsAudioRecv = ITMGContext.GetInstance().GetAudioCtrl().IsAudioRecvEnabled();
This API is used to get the real-time speaker volume. An int-type value will be returned to indicate the volume. It is recommended to call this API once every 20 ms.
ITMGAudioCtrl GetSpeakerLevel()
ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerLevel();
This API is used to get the real-time audio downstreaming volume of other members in the room. An int-type value will be returned. Value range: 0-200.
ITMGAudioCtrl int GetRecvStreamLevel(string openId)
Parameter | Type | Description |
---|---|---|
openId | string | openId of another member in the room |
int Level = ITMGContext.GetInstance().GetAudioCtrl().GetRecvStreamLevel(openId);
This API is used to set the speaker volume.
The corresponding parameter is volume. 0 indicates that the audio is mute, while 100 indicates that the volume remains unchanged. The default value is 100.
ITMGAudioCtrl SetSpeakerVolume(int volume)
Parameter | Type | Description |
---|---|---|
volume | int | Sets volume. Value range: 0-200 |
int speVol = (int)(value * 100);
ITMGContext.GetInstance().GetAudioCtrl().SetSpeakerVolume(speVol);
This API is used to get the speaker volume. An int-type value will be returned to indicate the volume. 101 indicates that the SetSpeakerVolume
API has not been called.
"Level" indicates the real-time volume, and "Volume" the speaker volume. The final volume = Level * Volume%. For example, if the "Level" is 100 and "Volume" is 60, the final volume is "60".
ITMGAudioCtrl GetSpeakerVolume()
ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerVolume();
This API is used to enable in-ear monitoring. You need to call EnableLoopBack+EnableSpeaker
before you can hear your own voice.
ITMGContext GetAudioCtrl EnableLoopBack(bool enable)
Parameter | Type | Description |
---|---|---|
enable | bool | Specifies whether to enable |
ITMGContext.GetInstance().GetAudioCtrl().EnableLoopBack(true);
After a device is used or released in a room, a callback will be executed through a delegate function to pass a message of the event.
Delegate function:
public delegate void QAVOnDeviceStateChangedEvent(int deviceType, string deviceId, bool openOrClose);
Event function:
public abstract event QAVOnDeviceStateChangedEvent OnDeviceStateChangedEvent;
Parameter | Type | Description |
---|---|---|
deviceType | int | |
deviceId | string | Device GUID, which is used to identify a device and only applies to Windows and macOS. |
openOrClose | bool | Occupies or releases a capturing/playback device |
Listen on an event:
ITMGContext.GetInstance().GetAudioCtrl().OnDeviceStateChangedEvent += new QAVAudioDeviceStateCallback(OnAudioDeviceStateChange);
Process the event listened on:
void QAVAudioDeviceStateCallback(int deviceType, string deviceId, bool openOrClose){
// Callback for device occupancy and release
}
This API is used to get a user's room audio type. The returned value is the room audio type. Value 0 indicates that an error occurred while getting the user's room audio type. For room audio types, please see the EnterRoom
API.
ITMGContext ITMGRoom public int GetRoomType()
ITMGContext.GetInstance().GetRoom().GetRoomType();
ITMGContext ITMGRoom public int ChangeRoomType(ITMGRoomType roomtype)
Parameter | Type | Description |
---|---|---|
roomtype | ITMGRoomType | Room type to be switched to. For room audio types, please see the EnterRoom API. |
ITMGContext.GetInstance().GetRoom().ChangeRoomType(ITMG_ROOM_TYPE_FLUENCY);
Set the room type. After the room type is set, a callback will be executed through a delegate function to pass a message indicating that the modification has been completed.
Returned Parameter | Description |
---|---|
roomtype | Updated room type returned |
// Delegate function:
public abstract event QAVCallback OnChangeRoomtypeCallback;
// Event function:
public abstract event QAVOnRoomTypeChangedEvent OnRoomTypeChangedEvent;
// Listen on an event:
ITMGContext.GetInstance ().OnRoomTypeChangedEvent += new QAVOnRoomTypeChangedEvent (OnRoomTypeChangedEvent);
// Process the event listened on:
void OnRoomTypeChangedEvent(int roomtype)
{
ShowWarnning (string.Format ("RoomTypeChanged current:{0}",roomtype));
}
Once the room type is modified by you or another user in the room, this callback function will be called to notify the business layer of the room type change. The returned value will be the room type. For more information, please see the EnterRoom
API.
// Delegate function:
public delegate void QAVOnRoomTypeChangedEvent(int roomtype);
// Event function:
public abstract event QAVOnRoomTypeChangedEvent OnRoomTypeChangedEvent;
// Listen on an event:
ITMGContext.GetInstance().OnRoomTypeChangedEvent += new QAVOnRoomTypeChangedEvent(OnRoomTypeChangedEvent);
// Process the event listened on:
void OnRoomTypeChangedEvent(int roomtype){
// Send a callback after the room type is changed
}
The message for quality control event triggered once every two seconds after room entry is ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY
. The returned parameters include weight
, loss
, and delay
, which represent the following information. The event message will be identified in the OnEvent
function.
This API is used to monitor the network quality. If the user's network is poor, the business layer will remind the user to switch to a better network through the UI.
Parameter | Type | Description |
---|---|---|
weight | int | Value range: 1-50. 50 indicates excellent sound quality, 1 indicates very poor (barely usable) sound quality, and 0 represents an initial meaningless value. Generally, if the value is below 30, the business layer will remind users that the network is poor and recommend them to switch the network. |
loss | double | Upstream packet loss rate |
delay | int | Voice chat delay in ms |
This API is used to get the SDK version number for analysis.
ITMGContext abstract string GetSDKVersion()
ITMGContext.GetInstance().GetSDKVersion();
This API is used to set the level of logs to be printed, and needs to be called before the initialization. It is recommended to keep the default level.
ITMGContext SetLogLevel(ITMG_LOG_LEVEL levelWrite, ITMG_LOG_LEVEL levelPrint)
Parameter | Type | Description |
---|---|---|
levelWrite | ITMG_LOG_LEVEL | Sets the level of logs to be written. TMG_LOG_LEVEL_NONE indicates not to write. Default value: TMG_LOG_LEVEL_INFO |
levelPrint | ITMG_LOG_LEVEL | Sets the level of logs to be printed. TMG_LOG_LEVEL_NONE indicates not to print. Default value: TMG_LOG_LEVEL_ERROR |
ITMG_LOG_LEVEL | Description |
---|---|
TMG_LOG_LEVEL_NONE | Does not print logs |
TMG_LOG_LEVEL_ERROR | Prints error logs (default) |
TMG_LOG_LEVEL_INFO | Prints info logs |
TMG_LOG_LEVEL_DEBUG | Prints debug logs |
TMG_LOG_LEVEL_VERBOSE | Prints verbose logs |
ITMGContext.GetInstance().SetLogLevel(TMG_LOG_LEVEL_INFO,TMG_LOG_LEVEL_INFO);
This API is used to set the log printing path. The default path is as follows:
OS | Path |
---|---|
Windows | %appdata%\Tencent\GME\ProcessName |
iOS | Application/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Documents |
Android | /sdcard/Android/data/xxx.xxx.xxx/files |
Mac | /Users/username/Library/Containers/xxx.xxx.xxx/Data/Documents |
ITMGContext SetLogPath(string logDir)
Parameter | Type | Description |
---|---|---|
logDir | String | Path |
ITMGContext.GetInstance().SetLogPath(path);
This API is used to get information on the quality of real-time audio/video calls, which is mainly used to view real-time call quality and troubleshoot and can be ignored on the business side.
ITMGRoom GetQualityTips()
string tips = ITMGContext.GetInstance().GetRoom().GetQualityTips();
Was this page helpful?