This document describes how to integrate with and debug GME client APIs for the voice chat feature for Unity.
Key Considerations for Using GME
GME provides the real-time voice chat service, voice messaging and speech-to-text services, which all depend on core APIs such as Init and Poll.
Notes
You have created a GME application and obtained the SDK AppID and key. For more information, see Activating Services. You have activated GME voice chat, voice messaging, and speech-to-text services. For more information, see Activating Services. Configure your project before using GME; otherwise, the SDK will not take effect.
After a GME API is called successfully, QAVError.OK will be returned with the value being 0.
GME APIs should be called in the same thread.
The Poll API should be called periodically for GME to trigger event callbacks.
GME only supports simple voice chat features on Unity WebGL. For more information, see Project Configuration. Integrating the SDK
Directions
Key processes involved in SDK integration are as follows:
2. Call Poll periodically to trigger callbacks C# classes
|
| |
| |
| |
| |
| Sound effect and accompaniment APIs |
Core APIs
|
| |
| Triggers an event callback. |
| |
| |
| |
Importing header files
Getting an instance
Get the Context instance by using the ITMGContext method instead of QAVContext.GetInstance().
Initializing the SDK
You need to initialize the SDK through the Init API before you can use the real-time voice chat, voice message, and speech-to-text services. The Init API must be called in the same thread as other APIs. We recommend you call all APIs in the main thread.
API prototype
//class ITMGContext
public abstract int Init(string sdkAppID, string openID);
|
| | |
| | openID can only be in Int64 type, which is passed in after being converted to a string. You can customize its rules, and it must be unique in the application. To pass in openID as a string, submit a ticket for application. |
Returned values
|
| The SDK was initialized successfully. |
AV_ERR_SDK_NOT_FULL_UPDATE=7015 | Checks whether the SDK file is complete. We recommend that you delete it and then import it again. |
Notes on 7015 error code
The error code 7015 is identified based on the MD5 value. If this error is reported during integration, check the integrity and version of the SDK file as prompted.
The returned value AV_ERR_SDK_NOT_FULL_UPDATE is only a reminder but will not cause an initialization failure.
Due to the third-party enhancement, the Unity packaging mechanism, and other factors, the library file MD5 will be affected, resulting in misjudgment. Therefore, ignore this error in the logic for official releases, and avoid displaying it on the UI.
Sample code
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;
}
Triggering event callback
Event callbacks can be triggered by periodically calling the Poll API in update. The Poll API is GME's message pump and should be called periodically for GME to trigger event callbacks; otherwise, the entire SDK service will run abnormally. For more information, see the EnginePollHelper file in SDK Download Guide. Call the Poll API periodically
The Poll API must be called periodically and in the main thread to avoid abnormal API callbacks.
API prototype
ITMGContext public abstract int Poll();
Sample code
public void Update()
{
ITMGContext.GetInstance().Poll();
}
Pausing the system
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.
API prototype
ITMGContext public abstract int Pause()
Resuming the system
When a Resume event occurs in the system, the engine should also be notified for resumption. The Resume API only supports resuming voice chat.
API prototype
ITMGContext public abstract int Resume()
Uninitializing SDK
This API is used to uninitialize the SDK. If the game account is bound to openid, switching game account requires uninitializing GME and then using the new openid to initialize again.
API prototype
ITMGContext public abstract int Uninit()
Voice Chat Room APIs
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, see Sound and Audio. |
| Calculates the local authentication key. |
| |
| |
| Determines whether room entry is successful. |
| |
Local authentication key calculation
Generate AuthBuffer for encryption and authentication of relevant features. For release in the production environment, use the backend deployment key as detailed in Authentication Key. API prototype
QAVAuthBuffer GenAuthBuffer(int appId, string roomId, string openId, string key)
|
| | AppID from the Tencent Cloud console
|
| | Room ID, which can contain up to 127 characters. |
| | User ID, which is the same as openID during initialization. |
| | Permission key from the Tencent Cloud console. |
Sample code
public static byte[] GetAuthBuffer(string AppID, string RoomID,string OpenId, string AuthKey){
return QAVAuthBuffer.GenAuthBuffer(int.Parse(AppID), RoomID, OpenId, AuthKey);
}
WebGL adaptation
On WebGL, after the local authentication function is called, the authentication key is saved in the JS code, and authBuffer is not returned to the C# layer. After a user calls the GetAuthBuffer API for local authentication, the user can enter "" or a random value in the called room entry API.
If the authentication key is calculated on the backend, GetAuthBuffer doesn't need to be called.
Entering a room
This API is used to enter a room with the generated authentication information. The mic and speaker are not enabled by default after room entry.
Notes
If the room entry callback result is 0, the room entry is successful. If 0 is returned from the EnterRoom API, it doesn't necessarily mean that the room entry is successful.
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.
API prototype
ITMGContext EnterRoom(string roomId, int roomType, byte[] authBuffer)
|
| | Room ID, which can contain up to 127 characters. |
| | Room type. We recommend that you select ITMG_ROOM_TYPE_FLUENCY for games. For more information on room audio types, see Sound Quality. |
| | |
Sample code
ITMGContext.GetInstance().EnterRoom(strRoomId, ITMGRoomType.ITMG_ROOM_TYPE_FLUENCY, byteAuthbuffer);
Callback for room entry
After the user enters the room, the room entry result will be called back, which can be listened on for processing. A successful callback means that the room entry is successful, and the billing starts.
API prototype
public delegate void QAVEnterRoomComplete(int result, string error_info);
public abstract event QAVEnterRoomComplete OnEnterRoomCompleteEvent;
Sample code
// 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 successfully
}
}
Data details
|
ITMG_MAIN_EVENT_TYPE_ENTER_ROOM | | {"error_info":"","result":0} |
ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT | | {"error_info":"waiting timeout, please check your network","result":0} |
If the network is disconnected, there will be a disconnection callback notification 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 codes
|
| Authentication failed. Causes: AppID doesn't exist or is incorrect.
An error occurred while authenticating authbuff. Authentication expired. OpenId is invalid.
|
| The user was already in another room. |
| The user was already in the process of entering a room but repeated this operation. We recommend that you not call the room entry API until the room entry callback is returned. |
| The user was already in the room and called the room entry API again. |
| 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. |
Exiting a room
This API is used to exit the current room. It is an async API. The returned value AV_OK indicates a successful async delivery. 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 the ExitRoom API; instead, you can directly call the EnterRoom API.
API prototype
Sample code
ITMGContext.GetInstance().ExitRoom();
Callback for room exit
A callback will be executed through a delegate function to pass a message after room exit.
API prototype
public delegate void QAVExitRoomComplete();
public abstract event QAVExitRoomComplete OnExitRoomCompleteEvent;
Sample code
Listen on an event:
ITMGContext.GetInstance().OnExitRoomCompleteEvent += new QAVExitRoomComplete(OnExitRoomComplete);
Process the event listened on:
void OnExitRoomComplete(){
// Send a callback after room exit
}
Determining whether user has entered room
This API is used to determine whether the user has entered a room. A value in bool type will be returned. Do not call this API during room entry.
API prototype
ITMGContext abstract bool IsRoomEntered()
Sample code
ITMGContext.GetInstance().IsRoomEntered();
Switching room
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.
API prototype
public abstract int SwitchRoom(string targetRoomID, byte[] authBuffer);
Type description
|
| | |
| | Generates a new authentication key with the ID of the room to enter |
Room Status Maintenance
APIs in this section are used to display speaking members and members entering or exiting the room and mute a member in the room at the business layer.
|
ITMG_MAIN_EVNET_TYPE_USER_UPDATE | The member status changed. |
| Mutes a member in the room. |
| |
Notification events of the member room entry and speaking status
This event is used to get the user speaking in the room and display the user on the UI, and to send a notification when someone enters or exits the room.
A notification for this event will be sent only when the status changes. To get the member status in real time, cache the notification when it is received at the business layer. The event message ITMG_MAIN_EVNET_TYPE_USER_UPDATE containing event_id, count, and openIdList will be returned, which will be identified in the OnEvent notification.
Notifications of the EVENT_ID_ENDPOINT_NO_AUDIO audio event will be sent only when the threshold is exceeded; that is, other members in the room can receive the notification that the local user stops speaking only after the local client captures no voice for two seconds.
The audio event returns only the member speaking status but not the specific volume level. If you need the specific volume levels of members in the room, you can use the GetRecvStreamLevel API.
|
| Return the openid of the member entering the room. | |
| Return the openid of the member exiting the room. | |
EVENT_ID_ENDPOINT_HAS_AUDIO | Return the openid of the member sending audio packets in the room. This event can be used to determine whether a user is speaking and display the voiceprint effect. | |
EVENT_ID_ENDPOINT_NO_AUDIO | Return the openid of the member stopping sending audio packets in the room. | |
Sample code
public delegate void QAVEndpointsUpdateInfo(int eventID, int count, [MarshalAs(UnmanagedType.LPArray, SizeParamIndex = 1)]string[] openIdList);
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;
}
Muting a member in the room
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 without affecting other devices. The returned value 0 indicates that the call is successful. Assume that users A, B, and C are all speaking using their mic in a room:
If A blocks C, A can only hear B.
If B blocks neither A nor C, B can hear both of them.
If C blocks neither A nor B, C can hear both of them.
This API is suitable for scenarios where a user is muted in a room.
API prototype
ITMGContext ITMGAudioCtrl AddAudioBlackList(String openId)
|
| | openid of the user to be blocked
|
Sample code
ITMGContext.GetInstance().GetAudioCtrl ().AddAudioBlackList (openId);
Unmuting
This API is used to remove an ID from the audio data blacklist. A returned value of 0 indicates the call is successful.
API prototype
ITMGContext ITMGAudioCtrl RemoveAudioBlackList(string openId)
|
| | User openid to be unblocked |
Sample code
ITMGContext.GetInstance().GetAudioCtrl ().RemoveAudioBlackList (openId);
Voice Chat Capturing APIs
The voice chat APIs can only be called after SDK initialization and room entry.
When the user clicks the button of enabling/disabling the mic or speaker on the UI, we recommend that you call the EnableMic or EnableSpeaker API.
To enable the user to press the mic button on the UI to speak and release it to stop speaking, we recommend that you call EnableAudioCaptureDevice once during room entry and call EnableAudioSend to enable the user to speak while pressing the button.
|
| |
| The mic status was obtained. |
| Enables/Disables the capturing device. |
IsAudioCaptureDeviceEnabled | Gets the capturing device status. |
| Enables/Disables audio upstreaming. |
| Gets the audio upstreaming status. |
| Gets the real-time mic volume level. |
| Gets the real-time audio upstreaming volume level. |
| Sets the mic volume level. |
| Gets the mic volume level. |
Enabling or disabling mic
This API is used to enable/disable the mic. The mic and speaker are not enabled by default after room entry. EnableMic = EnableAudioCaptureDevice + EnableAudioSend
API prototype
ITMGAudioCtrl EnableMic(bool isEnabled)
|
| | To enable the mic, set this parameter to true; otherwise, set it to false. |
Sample code
// Turn on mic
ITMGContext.GetInstance().GetAudioCtrl().EnableMic(true);
Getting the mic status
This API is used to get the mic status. The returned value 0 indicates that the mic is off, while 1 is on.
API prototype
ITMGAudioCtrl GetMicState()
Sample code
micToggle.isOn = ITMGContext.GetInstance().GetAudioCtrl().GetMicState();
Enabling or disabling capturing device
This API is used to enable/disable a capturing device. The device is not enabled by default after room entry.
This API can only be called after room entry. The device will be disabled automatically after room exit.
Operations such as permission application and volume type adjustment will generally be performed when a capturing device is enabled on a mobile device.
API prototype
ITMGAudioCtrl int EnableAudioCaptureDevice(bool isEnabled)
|
| | To enable the capturing device, set this parameter to true, otherwise, set it to false. |
Sample code
// Enable capturing device
ITMGContext.GetInstance().GetAudioCtrl().EnableAudioCaptureDevice(true);
Getting the capturing device status
This API is used to get the status of a capturing device.
API prototype
ITMGAudioCtrl bool IsAudioCaptureDeviceEnabled()
Sample code
bool IsAudioCaptureDevice = ITMGContext.GetInstance().GetAudioCtrl().IsAudioCaptureDeviceEnabled();
Enabling or disabling audio stream sending
This API is used to enable/disable audio stream sending. 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, see the EnableAudioCaptureDevice API.
API prototype
ITMGAudioCtrl int EnableAudioSend(bool isEnabled)
|
| | To enable audio upstreaming, set this parameter to true; otherwise, set it to false. |
Sample code
ITMGContext.GetInstance().GetAudioCtrl().EnableAudioSend(true);
Getting the audio stream sending status
This API is used to get the status of audio stream sending.
API prototype
ITMGAudioCtrl bool IsAudioSendEnabled()
Sample code
bool IsAudioSend = ITMGContext.GetInstance().GetAudioCtrl().IsAudioSendEnabled();
Getting the real-time mic volume
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.
API prototype
ITMGAudioCtrl int GetMicLevel
Sample code
ITMGContext.GetInstance().GetAudioCtrl().GetMicLevel();
Getting the real-time audio stream sending volume
This API is used to get the local real-time audio stream sending volume. An int-type value in the range of 0–100 will be returned.
API prototype
ITMGAudioCtrl int GetSendStreamLevel()
Sample code
int Level = ITMGContext.GetInstance().GetAudioCtrl().GetSendStreamLevel();
Setting the mic volume
This API is used to set the mic volume level. The corresponding parameter is volume, which is equivalent to attenuating or gaining the captured sound.
API prototype
ITMGAudioCtrl SetMicVolume(int volume)
|
| | Value range: 0-200. Default value: 100. 0 indicates that the audio is muted, while 100 indicates that the volume level remains unchanged. |
Sample code
int micVol = (int)(value * 100);
ITMGContext.GetInstance().GetAudioCtrl().SetMicVolume (micVol);
Getting the mic volume
This API is used to obtain the microphone volume. An "int" value is returned. Value 101 represents API SetMicVolume has not been called.
API prototype
ITMGAudioCtrl GetMicVolume()
Sample code
ITMGContext.GetInstance().GetAudioCtrl().GetMicVolume();
Voice Chat Playback APIs
|
| Enables/Disables the speaker. |
| The speaker status was obtained. |
| Enables/Disables the playback device. |
| Gets the playback device status. |
| Enables/Disables audio downstreaming. |
| Gets the audio downstreaming status. |
| Gets the real-time speaker volume level. |
| Gets the real-time downstreaming audio levels of other members in the room. |
| Sets the speaker volume level. |
| Gets the speaker volume level. |
Enabling or disabling speaker
This API is used to enable/disable the speaker. EnableSpeaker = EnableAudioPlayDevice + EnableAudioRecv
API prototype
ITMGAudioCtrl EnableSpeaker(bool isEnabled)
|
| | To disable the speaker, set this parameter to false; otherwise, set it to true. |
Sample code
// Turn on the speaker
ITMGContext.GetInstance().GetAudioCtrl().EnableSpeaker(true);
Getting the speaker status
This API is used to get the speaker status. 0 indicates that the speaker is off, and 1 is on.
API prototype
ITMGAudioCtrl GetSpeakerState()
Sample code
speakerToggle.isOn = ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerState();
Enabling or disabling playback device
This API is used to enable/disable a playback device.
API prototype
ITMGAudioCtrl EnableAudioPlayDevice(bool isEnabled)
|
| | To disable the playback device, set this parameter to false; otherwise, set it to true. |
Sample code
ITMGContext.GetInstance().GetAudioCtrl().EnableAudioPlayDevice(true);
Getting the playback device status
This API is used to get the status of a playback device.
API prototype
ITMGAudioCtrl bool IsAudioPlayDeviceEnabled()
Sample code
bool IsAudioPlayDevice = ITMGContext.GetInstance().GetAudioCtrl().IsAudioPlayDeviceEnabled();
Enabling or disabling audio stream receiving
This API is used to enable/disable audio stream receiving. If a playback device is already enabled, it will play back audio data from other members in the room; otherwise, it will remain muted. For more information on how to enable/disable the playback device, see the EnableAudioPlayDevice API.
API prototype
ITMGAudioCtrl int EnableAudioRecv(bool isEnabled)
|
| | To enable audio downstreaming, set this parameter to true; otherwise, set it to false. |
Sample code
ITMGContext.GetInstance().GetAudioCtrl().EnableAudioRecv(true);
Getting the audio stream receiving status
This API is used to get the status of audio stream receiving.
API prototype
ITMGAudioCtrl bool IsAudioRecvEnabled()
Sample code
bool IsAudioRecv = ITMGContext.GetInstance().GetAudioCtrl().IsAudioRecvEnabled();
Getting the real-time speaker volume
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.
API prototype
ITMGAudioCtrl GetSpeakerLevel()
Sample code
ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerLevel();
Getting the audio stream volume levels of other members in the room
This API is used to get the real-time audio stream volume levels of other members in the room. An int-type value will be returned. Value range: 0–200.
API prototype
ITMGAudioCtrl int GetRecvStreamLevel(string openId)
|
| | openId of another member in the room
|
Sample code
int Level = ITMGContext.GetInstance().GetAudioCtrl().GetRecvStreamLevel(openId);
Dynamically setting the volume of a member of the room
This API is used to set the volume of a member in the room. It takes effect only on the local side.
API prototype
public abstract int SetSpeakerVolumeByOpenID(string openid, int volume);
|
openId | String | OpenID of the target user
|
volume | int | Percentage. Recommended value range: 0-200. Default value: 100. |
Setting the speaker volume
This API is used to set the speaker volume.
API prototype
ITMGAudioCtrl SetSpeakerVolume(int volume)
|
| | Volume level. Value range: 0-200. Default value: 100. 0 indicates that the audio is muted, while 100 indicates that the volume level remains unchanged. |
Sample code
int speVol = (int)(value * 100);
ITMGContext.GetInstance().GetAudioCtrl().SetSpeakerVolume(speVol);
Getting the speaker volume
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".
API prototype
ITMGAudioCtrl GetSpeakerVolume()
Sample code
ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerVolume();
Device Selection APIs
Device selection APIs can be used only on PC.
|
| |
| |
| Gets the number of speakers. |
| |
| |
| |
Getting the number of mics
This API is used to get the number of mics.
Function prototype
public abstract int GetMicListCount()
Sample code
ITMGContext.GetInstance().GetAudioCtrl().GetMicListCount();
Enumerating mics
This API is used together with the GetMicListCount API to enumerate mics.
Function prototype
public abstract int GetMicList(out List<TMGAudioDeviceInfo> devicesInfo, int count)
Sample code
ITMGContext.GetInstance().GetAudioCtrl().GetMicList(devicesInfo,count);
Selecting mic
This API is used to select a mic. If this API is not called or DEVICEID_DEFAULT is passed in, the default mic will be selected.
The 0th device id returned in the GetMicList API is the default device of the call device. If there is a selected call device, it will be maintained by service. If it is unplugged, the call device will be changed back into the default device.
Function prototype
public abstract int SelectMic(string micID);
|
| | Mic ID, which is from the list returned by GetMicList. |
Sample code
string deviceID = DEVICE_ID_DEFAULT;
if (index != 0)
{
deviceID = listMicInfo[index - 1].m_strDeviceID;
}
ITMGContext.GetInstance().GetAudioCtrl().SelectMic(deviceID);
selectedMicID = deviceID;
This API is used to get the number of speakers.
Function prototype
public abstract int GetSpeakerListCount();
Sample code
ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerListCount();
Enumerating speakers
This API is used together with the GetSpeakerListCount API to enumerate speakers.
Function prototype
public abstract int GetSpeakerList(out List<TMGAudioDeviceInfo> devicesInfo, int count)
Sample code
int speakerCount = ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerListCount();
Debug.LogFormat("speakerCount = {0}", speakerCount);
if (speakerCount > 0)
{
int ret = ITMGContext.GetInstance().GetAudioCtrl().GetSpeakerList(out listSpeakerInfo, speakerCount);
Debug.LogFormat("GetSpeakerList ret = {0}", ret);
if (ret != 0)
{
listSpeakerInfo = null;
}
}
}
Selecting speaker
This API is used to select a playback device. If this API is not called or DEVICEID_DEFAULT is passed in, the default playback device will be selected.
Function prototype
public abstract int SelectSpeaker(string speaker);
|
| | Speaker ID, which is from the list returned by GetSpeakerList. |
Sample code
speakerDropdown = transform.Find("DevicePanel/SpeakerSelect").GetComponent<Dropdown>();
if (speakerDropdown != null)
{
speakerDropdown.onValueChanged.AddListener(delegate (int index)
{
string deviceID = DEVICE_ID_DEFAULT;
if (index != 0)
{
deviceID = listSpeakerInfo[index - 1].m_strDeviceID;
}
ITMGContext.GetInstance().GetAudioCtrl().SelectSpeaker(deviceID);
selectedSpeakerID = deviceID;
});
}
Special APIs
Enabling in-ear monitoring
This API is used to enable in-ear monitoring. You need to call EnableLoopBack+EnableSpeaker before you can hear your own voice.
API prototype
ITMGContext GetAudioCtrl EnableLoopBack(bool enable)
|
| | Specifies whether to enable the in-ear monitoring. |
Sample code
ITMGContext.GetInstance().GetAudioCtrl().EnableLoopBack(true);
Callback for device use and release
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.
public delegate void QAVOnDeviceStateChangedEvent(int deviceType, string deviceId, bool openOrClose);
public abstract event QAVOnDeviceStateChangedEvent OnDeviceStateChangedEvent;
|
| | 1 indicates capturing device.
2 indicates playback device.
|
| | Device GUID, which identifies a device and only applies to Windows and macOS. |
| | Whether the capturing/playback device is occupied or released |
Sample code
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
}
Getting user's room audio type
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, see the EnterRoom API.
API prototype
ITMGContext ITMGRoom public int GetRoomType()
Sample code
ITMGContext.GetInstance().GetRoom().GetRoomType();
Changing the room type
This API is used to modify a user's room audio type. For the result, see the callback event. The event type is ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE. 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.
API prototype
ITMGContext ITMGRoom public int ChangeRoomType(ITMGRoomType roomtype)
|
| | Room type to be switched to. For room audio types, see the EnterRoom API. |
Sample code
ITMGContext.GetInstance().GetRoom().ChangeRoomType(ITMG_ROOM_TYPE_FLUENCY);
Callback event
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.
public abstract event QAVCallback OnChangeRoomtypeCallback;
public abstract event QAVOnRoomTypeChangedEvent OnRoomTypeChangedEvent;
Sample code
// 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));
}
Notification of room type change
Once the room type is changed by you or another user in the room, this notification event will be used to notify the business layer of the room type change. The returned value will be the room type. For more information, see the EnterRoom API.
public delegate void QAVOnRoomTypeChangedEvent(int roomtype);
public abstract event QAVOnRoomTypeChangedEvent OnRoomTypeChangedEvent;
Sample code
// 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 monitoring event of room call quality
This is the quality monitoring event used to listen on the network quality. If your network conditions are poor, the business layer will ask you to switch the network through the UI. This event is triggered once every two seconds after room entry, and its message is ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY. The returned parameters include weight, loss, and delay, which are as detailed below:
|
| | 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, you can remind users that the network is poor and recommend them to switch the network. |
| | Upstream packet loss rate |
| | |
Getting version number
This API is used to get the SDK version number for analysis.
API prototype
ITMGContext abstract string GetSDKVersion()
Sample code
ITMGContext.GetInstance().GetSDKVersion();
Setting log printing level
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.
API prototype
ITMGContext SetLogLevel(ITMG_LOG_LEVEL levelWrite, ITMG_LOG_LEVEL levelPrint)
Parameter description
|
| | Sets the level of logs to be written. TMG_LOG_LEVEL_NONE indicates not to write. Default value: TMG_LOG_LEVEL_INFO. |
| | 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:
|
| |
| Prints error logs (default) |
| |
| |
| |
Sample code
ITMGContext.GetInstance().SetLogLevel(TMG_LOG_LEVEL_INFO,TMG_LOG_LEVEL_INFO);
Setting the log printing path
This API is used to set the log printing path. The default path is as follows. It needs to be called before initialization.
|
| %appdata%\\Tencent\\GME\\ProcessName |
| Application/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/Documents |
| /sdcard/Android/data/xxx.xxx.xxx/files |
| /Users/username/Library/Containers/xxx.xxx.xxx/Data/Documents |
API prototype
ITMGContext SetLogPath(string logDir)
Sample code
ITMGContext.GetInstance().SetLogPath(path);
Getting the diagnostic messages
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.
API prototype
ITMGRoom GetQualityTips()
Sample code
string tips = ITMGContext.GetInstance().GetRoom().GetQualityTips();
