tencent cloud

Feedback

Voice Chat

Last updated: 2023-04-04 15:01:38
    This document describes how to integrate with and debug GME client APIs for the voice chat feature for Android.

    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 AppID and Key of the SDK as instructed in Activating Services.
    You have activated the voice chat, voice messaging, and speech-to-text services of GME. 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.
    For detailed error codes, see Error Codes.

    Integrating the SDK

    Directions

    Key processes involved in SDK integration are as follows:
    
    2. Calling Poll periodically to trigger callbacks

    Voice chat for Android class

    Class
    Description
    ITMGContext
    Core APIs
    ITMGRoom
    Room APIs
    ITMGRoomManager
    Room management APIs
    ITMGAudioCtrl
    Audio APIs
    ITMGAudioEffectCtrl
    Sound effect and accompaniment APIs

    Core APIs

    API
    Description
    Init
    Initializes GME.
    Poll
    Triggers an 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.

    Getting singleton

    To use the voice feature, get the ITMGContext object first.

    Sample code

    import com.tencent.TMG.ITMGContext;
    ITMGContext.getInstance(this);

    Registering callback

    The API class uses the Delegate method to send callback notifications to the application. Register the callback function to the SDK for receiving callback messages.

    API prototype

    static public abstract class ITMGDelegate {
    public void OnEvent(ITMG_MAIN_EVENT_TYPE type, Intent data){}
    }
    Override this callback function in the constructor to process the parameters of the callback.
    Parameter
    Type
    Description
    type
    ITMGContext.ITMG_MAIN_EVENT_TYPE
    Event type in the callback response
    data
    Intent message type
    Callback message, i.e., event data

    Sample code

    private ITMGContext.ITMGDelegate itmgDelegate = null;
    itmgDelegate = new ITMGContext.ITMGDelegate() {
    @Override
    public void OnEvent(ITMGContext.ITMG_MAIN_EVENT_TYPE type, Intent data) {
    if (ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ENTER_ROOM == type)
    {
    // Analyze the returned data
    int nErrCode = data.getIntExtra("result" , -1);
    String strErrMsg = data.getStringExtra("error_info");
    }
    }
    }
    Register the callback function to the SDK before room entry.

    API prototype

    public abstract int SetTMGDelegate(ITMGDelegate delegate);
    Parameter
    Type
    Description
    delegate
    ITMGDelegate
    SDK callback function

    Sample code

    ITMGContext.GetInstance(this).SetTMGDelegate(itmgDelegate);

    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

    public abstract int Init(String sdkAppId, String openId);
    Parameter
    Type
    Description
    sdkAppId
    String
    AppID provided in the GME console, which can be obtained as instructed in Activating Services.
    openId
    String
    openID can only be in Int64 type, which is passed in after being converted to a const char*. 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

    Returned Value
    Description
    QAVError.OK= 0
    SDK was initialized successfully.
    AV_ERR_SDK_NOT_FULL_UPDATE=7015
    Check whether the SDK file is complete. We recommend that you delete it and then import the SDK 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

    String sdkAppID = "14000xxxxx";
    String openID = "100";
    int ret = 0;
    // After the user agrees to the application's privacy policy, initialize the SDK at an appropriate time based on the application features
    //ret = 0: The user agrees to the application's privacy policy
    //ret = 1: The user does not agree to the application's privacy policy
    // If the user does not agree to the privacy policy, change `ret` to a value other than 0
    if(ret != 0){
    Log.e(TAG,"The user does not agree to the application's privacy policy");
    }else{
    ITMGContext.GetInstance(this).Init(sdkAppId, openId);
    }

    Triggering event callback

    Event callbacks can be triggered by periodically calling the Poll API in update. Poll is the message pump of GME, and 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.java 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

    public abstract int Poll();

    Sample code

    private Handler mhandler = new Handler();private Runnable mRunnable = new Runnable() { @Override public void run() { if (s_pollEnabled) { if (ITMGContext.GetInstance(null) != null) ITMGContext.GetInstance(null).Poll(); } mhandler.postDelayed(mRunnable, 33); }};

    Pausing the system

    When a Pause event occurs in the system, the engine should also be notified for pause. If you do not need the audio played back in the background in the room, call Pause API to pause the GME service.

    API prototype

    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

    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.
    Note
    If the end user revokes the permission granted to the SDK to process the personal information, you can call the Uninit API to stop using the SDK features and stop collecting and close the user data used by the features.

    API prototype

    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.
    
    API
    Description
    GenAuthBuffer
    Calculates the local authentication key.
    EnterRoom
    Enters a room.
    ExitRoom
    Exits a room.
    IsRoomEntered
    Determines whether room entry is successful.
    SwitchRoom
    Switches the room quickly.
    StartRoomSharing
    Cross-room Co-anchoring

    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

    AuthBuffer public native byte[] genAuthBuffer(int sdkAppId, 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.

    Sample code

    import com.tencent.av.sig.AuthBuffer;// Header file
    byte[] authBuffer = AuthBuffer.getInstance().genAuthBuffer(Integer.parseInt(sdkAppId), strRoomID,openId, key);

    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

    public abstract int EnterRoom(String roomID, int roomType, byte[] authBuffer);
    Parameter
    Type
    Description
    roomId
    String
    Room ID, which can contain up to 127 characters.
    roomType
    int
    Room type. We recommend that you enter ITMG_ROOM_TYPE_FLUENCY. For more information on room audio types, see Sound Quality.
    authBuffer
    byte[]
    Authentication key

    Sample code

    ITMGContext.GetInstance(this).EnterRoom(roomId,roomType, authBuffer);

    Callback for room entry

    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.

    Function prototype

    private ITMGContext.ITMGDelegate itmgDelegate = null;
    itmgDelegate= new ITMGContext.ITMGDelegate() {
    @Override
    public void OnEvent(ITMGContext.ITMG_MAIN_EVENT_TYPE type, Intent data) {
    }
    };

    Sample code

    Sample code for processing the callback, including room entry and network disconnection events.
    public void OnEvent(ITMGContext.ITMG_MAIN_EVENT_TYPE type, Intent data) {
    if (ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ENTER_ROOM == type)
    {
    // Analyze the returned data
    int nErrCode = data.getIntExtra("result" , -1);
    String strErrMsg = data.getStringExtra("error_info");
    
    if (nErrCode == AVError.AV_OK)
    {
    //Entered room successfully, and you can proceed with your operation
    ScrollView_ShowLog("EnterRoom success");
    Log.i(TAG,"EnterRoom success!");
    }
    else
    {
    //If you fail to enter the room, you need to analyze the returned error message
    ScrollView_ShowLog("EnterRoom fail :" + strErrMsg);
    Log.i(TAG,"EnterRoom fail!");
    }
    }
    if (ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT == type)
    {
    //waiting timeout, please check your network
    }
    }

    Data details

    Message
    Data
    Example
    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 codes

    Error Code
    Cause and Suggested Solution
    7006
    Authentication failed. Causes:
    AppID doesn't exist or is incorrect.
    An error occurred while authenticating authbuff.
    Authentication expired.
    OpenId is invalid.
    7007
    The user was already in another room.
    1001
    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.
    1003
    The user was already in the room and called the room entry 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.

    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

    public abstract int ExitRoom();

    Sample code

    ITMGContext.GetInstance(this).ExitRoom();

    Callback for room exit

    After the user exits a room, a callback will be returned with the message being ITMG_MAIN_EVENT_TYPE_EXIT_ROOM.

    Sample code

    public void OnEvent(ITMGContext.ITMG_MAIN_EVENT_TYPE type, Intent data) {
    if (ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_EXIT_ROOM == type)
    {
    // Receive the event of successful room exit
    }
    }

    Data details

    Message
    Data
    Example
    ITMG_MAIN_EVENT_TYPE_EXIT_ROOM
    result; error_info
    {"error_info":"","result":0}

    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

    public abstract boolean IsRoomEntered();

    Sample code

    ITMGContext.GetInstance(this).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 descriptions

    Parameter
    Type
    Description
    targetRoomID
    String
    ID of the room to enter
    authBuffer
    byte[]
    Generates a new authentication key with the ID of the room to enter

    Callback sample code

    if(ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM == type) {
    int result = data.getIntExtra("result", 1);
    String errorInfo = data.getStringExtra("error_info");
    if (result == 0) {
    Toast.makeText(getActivity(), "switch room success.", Toast.LENGTH_SHORT).show();
    }
    else {
    Toast.makeText(getActivity(), "switch room failed.. error info=" + errorInfo, Toast.LENGTH_SHORT).show();
    }
    }

    Cross-room mic connection

    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. The target room should be of the same type as the local room.

    Example

    User a is in room A, user b is in room B, and user a can talk with b through the cross-room API. When user c in room A speaks, users b and d in room B cannot hear. User c in room A can hear only the voice in room A and the voice of user b in room B but not other users in room B.

    API prototype

    /// <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();

    Type descriptions

    Parameter
    Type
    Description
    targetRoomID
    String
    ID of the room to connect mic
    targetOpenID
    String
    Target OpenID to connect mic
    authBuffer
    byte[]
    Reserved flag. You just need to enter NULL.

    Sample code

    if (mSwtichRoomShareStart.isChecked())
    {
    String strRoomID = mEditRoomShareRoomID.getText().toString();
    String strOpenID = mEditRoomShareOpenID.getText().toString();
    int nRet = ITMGContext.GetInstance(getActivity()).GetRoom().StartRoomSharing(strRoomID, strOpenID, null);
    if (nRet != 0)
    {
    Toast.makeText(getActivity(), String.format("StartRoomSharing failed nRet=" + nRet), Toast.LENGTH_SHORT).show();
    }else
    {
    int nRet = ITMGContext.GetInstance(getActivity()).GetRoom().StopRoomSharing();
    if (nRet != 0)
    {
    Toast.makeText(getActivity(), String.format("StopRoomSharing failed nRet=" + nRet), Toast.LENGTH_SHORT).show();
    }
    }
    }

    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.
    
    API/Notification
    Description
    ITMG_MAIN_EVNET_TYPE_USER_UPDATE
    The member status changed.
    AddAudioBlackList
    Mutes a member in the room.
    RemoveAudioBlackList
    Unmutes a member.

    Notifications of member room entry and speaking status

    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. 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 a higher layer. The event message is ITMG_MAIN_EVNET_TYPE_USER_UPDATE, where the data contains event_id and user_list. 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
    ITMG_EVENT_ID_USER_ENTER
    Return the openid of the member entering the room.
    Member list
    ITMG_EVENT_ID_USER_EXIT
    Return the openid of the member exiting the room.
    Member list
    ITMG_EVENT_ID_USER_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.
    Chat member list
    ITMG_EVENT_ID_USER_NO_AUDIO
    Return the openid of the member stopping sending audio packets in the room.
    Chat member list

    Sample code

    public void OnEvent(ITMGContext.ITMG_MAIN_EVENT_TYPE type, Intent data) {
    if (ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVNET_TYPE_USER_UPDATE == type)
    {
    // Update member status
    int nEventID = data.getIntExtra("event_id", 0);
    String[] openIdList =data.getStringArrayExtra("user_list");
    switch (nEventID)
    {
    case ITMG_EVENT_ID_USER_ENTER:
    // A member enters the room
    break;
    case ITMG_EVENT_ID_USER_EXIT:
    // A member exits the room
    break;
    case ITMG_EVENT_ID_USER_HAS_AUDIO:
    // A member sends audio packets
    break;
    case ITMG_EVENT_ID_USER_NO_AUDIO:
    // A member stops sending audio packets
    break;
    default:
    break;
    }
    }
    }

    Data details

    Message
    Data
    Example
    ITMG_MAIN_EVNET_TYPE_USER_UPDATE
    event_id; user_list
    {"event_id":0,"user_list":""}

    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

    public abstract int AddAudioBlackList(String openId);
    Parameter
    Type
    Description
    openId
    String
    openid of the user to be blocked

    Sample code

    ITMGContext.GetInstance(this).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

    public abstract int RemoveAudioBlackList(String openId);
    Parameter
    Type
    Description
    openId
    String
    User openid to be unblocked

    Sample code

    ITMGContext.GetInstance(this).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.
    When the user enters a voice chat room, enabling/disabling a capturing device will restart both capturing and playback devices. If the application is playing back background music, it will also be interrupted. Playback won't be interrupted if the mic is enabled/disabled through control of upstreaming/downstreaming. Calling method: Call EnableAudioCaptureDevice(true) and EnableAudioPlayDevice(true) once after room entry, and call EnableAudioSend/Recv to send/receive audio streams when Enable/Disable Mic is clicked.
    API
    Description
    EnableMic
    Enables/Disables the mic.
    GetMicState
    Gets the mic status.
    EnableAudioCaptureDevice
    Enables/Disables the capturing device.
    IsAudioCaptureDeviceEnabled
    Gets the capturing device status.
    EnableAudioSend
    Enables/Disables audio upstreaming.
    IsAudioSendEnabled
    Gets the audio upstreaming status.
    GetMicLevel
    Gets the real-time mic volume level.
    GetSendStreamLevel
    Gets the real-time audio upstreaming volume level.
    SetMicVolume
    Sets the mic volume level.
    GetMicVolume
    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 is equivalent to using EnableAudioCaptureDevice and EnableAudioSend together. If accompaniment is used, call this API as instructed in Accompaniment in Voice Chat.

    API prototype

    public abstract int EnableMic(boolean isEnabled);
    Parameter
    Type
    Description
    isEnabled
    boolean
    To enable the mic, set this parameter to true; otherwise, set it to false.

    Sample code

    // Turn on mic
    ITMGContext.GetInstance(this).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

    public abstract int GetMicState();

    Sample code

    int micState = ITMGContext.GetInstance(this).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

    public abstract int EnableAudioCaptureDevice(boolean isEnabled);
    Parameter
    Type
    Description
    isEnabled
    boolean
    To enable the capturing device, set this parameter to true, otherwise, set it to false.

    Sample code

    // Enable capturing device
    ITMGContext.GetInstance(this).GetAudioCtrl().EnableAudioCaptureDevice(true);

    Getting the capturing device status

    This API is used to get the status of a capturing device.

    API prototype

    public abstract boolean IsAudioCaptureDeviceEnabled();

    Sample code

    bool IsAudioCaptureDevice = ITMGContext.GetInstance(this).GetAudioCtrl().IsAudioCaptureDeviceEnabled();

    Enabling or disabling audio upstreaming

    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, see the EnableAudioCaptureDevice API.

    API prototype

    public abstract int EnableAudioSend(boolean isEnabled);
    Parameter
    Type
    Description
    isEnabled
    boolean
    To enable audio upstreaming, set this parameter to true; otherwise, set it to false.

    Sample code

    ITMGContext.GetInstance(this).GetAudioCtrl().EnableAudioSend(true);

    Getting audio upstreaming status

    This API is used to get the status of audio upstreaming.

    API prototype

    public abstract boolean IsAudioSendEnabled();

    Sample code

    bool IsAudioSend = ITMGContext.GetInstance(this).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

    public abstract int GetMicLevel();

    Sample code

    int micLevel = ITMGContext.GetInstance(this).GetAudioCtrl().GetMicLevel();

    Getting the real-time audio upstreaming volume

    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.

    API prototype

    ITMGContext TMGAudioCtrl int GetSendStreamLevel()

    Sample code

    int Level = ITMGContext.GetInstance(this).GetAudioCtrl().GetSendStreamLevel();

    Setting the mic software 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

    public abstract int SetMicVolume(int volume);
    Parameter
    Type
    Description
    volume
    int
    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

    ITMGContext.GetInstance(this).GetAudioCtrl().SetMicVolume(volume);

    Getting the mic software 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

    public abstract int GetMicVolume();

    Sample code

    ITMGContext.GetInstance(this).GetAudioCtrl().GetMicVolume();

    Voice Chat Playback APIs

    API
    Description
    EnableSpeaker
    Enables/Disables the speaker.
    GetSpeakerState
    Gets the speaker status.
    EnableAudioPlayDevice
    Enables/Disables the playback device.
    IsAudioPlayDeviceEnabled
    Gets the playback device status.
    EnableAudioRecv
    Enables/Disables audio downstreaming.
    IsAudioRecvEnabled
    Gets the audio downstreaming status.
    GetSpeakerLevel
    Gets the real-time speaker volume level.
    GetRecvStreamLevel
    Gets the real-time downstreaming audio levels of other members in the room.
    SetSpeakerVolume
    Sets the speaker volume level.
    GetSpeakerVolume
    Gets the speaker volume level.

    Enabling or disabling speaker

    This API is used to enable/disable the speaker. EnableSpeaker is equivalent to using EnableAudioPlayDevice and EnableAudioRecv together. If accompaniment is used, call this API as instructed in Accompaniment in Voice Chat.

    API prototype

    public abstract int EnableSpeaker(boolean isEnabled);
    Parameter
    Type
    Description
    isEnabled
    boolean
    To disable the speaker, set this parameter to false; otherwise, set it to true.

    Sample code

    // Turn on the speaker
    ITMGContext.GetInstance(this).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

    public abstract int GetSpeakerState();

    Sample code

    int micState = ITMGContext.GetInstance(this).GetAudioCtrl().GetSpeakerState();

    Enabling or disabling playback device

    This API is used to enable/disable a playback device.

    API prototype

    public abstract int EnableAudioPlayDevice(boolean isEnabled);
    Parameter
    Type
    Description
    isEnabled
    boolean
    To disable the playback device, set this parameter to false; otherwise, set it to true.

    Sample code

    // Enable the playback device
    ITMGContext.GetInstance(this).GetAudioCtrl().EnableAudioPlayDevice(true);

    Getting the playback device status

    This API is used to get the status of a playback device.

    API prototype

    public abstract boolean IsAudioPlayDeviceEnabled();

    Sample code

    bool IsAudioPlayDevice = ITMGContext.GetInstance(this).GetAudioCtrl().IsAudioPlayDeviceEnabled();

    Enabling or disabling audio downstreaming

    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 muted. For more information on how to enable/disable the playback device, see the EnableAudioPlayDevice API.

    API prototype

    public abstract int EnableAudioRecv(boolean isEnabled);
    Parameter
    Type
    Description
    isEnabled
    boolean
    To enable audio downstreaming, set this parameter to true; otherwise, set it to false.

    Sample code

    ITMGContext.GetInstance(this).GetAudioCtrl().EnableAudioRecv(true);

    Getting audio downstreaming status

    This API is used to get the status of audio downstreaming.

    API prototype

    public abstract boolean IsAudioRecvEnabled();

    Sample code

    bool IsAudioRecv = ITMGContext.GetInstance(this).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

    public abstract int GetSpeakerLevel();

    Sample code

    int SpeakLevel = ITMGContext.GetInstance(this).GetAudioCtrl().GetSpeakerLevel();

    Getting the real-time downstreaming audio levels of other members in room

    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.

    API prototype

    public abstract int GetRecvStreamLevel(String openId);
    Parameter
    Type
    Description
    openId
    String
    openId of another member in the room

    Sample code

    int Level = ITMGContext.GetInstance(this).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.

    API prototype

    public abstract int SetSpeakerVolumeByOpenID(String openId, int volume);
    Parameter
    Type
    Description
    openId
    String
    OpenID of the target user
    volume
    int
    Percentage. Recommended value range: 0-200. Default value: 100.

    Sample code

    Executed statements
    // Lower the volume of 123333 to 80%
    String strOpenID = "1233333";
    int nOpenVolume = Integer.valueOf(80);
    int nRet = ITMGContext.GetInstance(getActivity()).GetAudioCtrl().SetSpeakerVolumeByOpenID(strOpenID, nOpenVolume);
    if (nRet != 0)
    {
    // Toast error occured
    }
    else
    {
    // Toast set successfully
    }

    Getting volume percentage

    Call this API to get the volume set by SetSpeakerVolumeByOpenID

    API prototype

    public abstract int GetSpeakerVolumeByOpenID(String openId);
    Parameter
    Type
    Description
    openId
    String
    OpenID of the target user

    Returned values

    API returns volume percentage set by OpenID, where 100 is by default.

    Setting the speaker volume

    This API is used to set the speaker volume.

    API prototype

    public abstract int SetSpeakerVolume(int volume);
    Parameter
    Type
    Description
    volume
    int
    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(this).GetAudioCtrl().SetSpeakerVolume(volume);

    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

    public abstract int GetSpeakerVolume();

    Sample code

    ITMGContext.GetInstance(this).GetAudioCtrl().GetSpeakerVolume();

    Advanced 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

    public abstract int EnableLoopBack(boolean enable);
    Parameter
    Type
    Description
    enable
    boolean
    Specifies whether to enable in-ear monitoring.

    Sample code

    ITMGContext.GetInstance(this).GetAudioCtrl().EnableLoopBack(true);

    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

    public abstract int GetRoomType();

    Sample code

    ITMGContext.GetInstance(this).GetRoom().GetRoomType();

    Getting the room ID

    This API is used to get the voice chat room ID and can be called only after a successful room entry. A string will be returned.

    API prototype

    public abstract String GetRoomID();

    Modifying user's room audio type

    This API is used to modify a user's room audio type. For the result, please 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

    public abstract int ChangeRoomType(int nRoomType);
    Parameter
    Type
    Description
    nRoomType
    int
    Room type to be switched to. For room audio types, see the EnterRoom API.

    Sample code

    ITMGContext.GetInstance(this).GetRoom().ChangeRoomType(nRoomType);

    Callback for modifying the room type

    After the room type is set, the event message ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE will be returned in the callback. The returned parameters include result, error_info, and new_room_type. The new_room_type represents the following information. The event message will be identified in the OnEvent function.
    Event Subtype
    Parameter
    Description
    ITMG_ROOM_CHANGE_EVENT_ENTERROOM
    1
    The existing audio type is inconsistent with and changed to that of the entered room.
    ITMG_ROOM_CHANGE_EVENT_START
    2
    A user is already in the room and the audio type starts changing (e.g., calling the ChangeRoomType API to change the audio type).
    ITMG_ROOM_CHANGE_EVENT_COMPLETE
    3
    A user is already in the room, and the audio type has been changed.
    ITMG_ROOM_CHANGE_EVENT_REQUEST
    4
    A room member calls the ChangeRoomType API to request a change of the room audio type.

    Sample code

    public void OnEvent(ITMGContext.ITMG_MAIN_EVENT_TYPE type, Intent data) { if (ITMGContext.ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE == type) { // Process the room type events }}

    Data details

    Message
    Data
    Example
    ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE
    result;error_info;new_room_type;subEventType
    {"error_info":"","new_room_type":0,"subEventType":0,"result":0}

    The monitoring event of room call quality

    This is the quality monitoring event, which 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:
    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, you can 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

    Getting version number

    This API is used to get the SDK version number for analysis.

    API prototype

    public abstract String GetSDKVersion();

    Sample code

    ITMGContext.GetInstance(this).GetSDKVersion();

    Checking mic permission

    This API is used to return the mic permission status.

    Function prototype

    public abstract ITMG_RECORD_PERMISSION CheckMicPermission();

    Parameter description

    Parameter
    Value
    Description
    ITMG_PERMISSION_GRANTED
    0
    The mic permission is granted.
    ITMG_PERMISSION_Denied
    1
    Microphone disabled.
    ITMG_PERMISSION_NotDetermined
    2
    No authorization box has been popped up to request the permission.
    ITMG_PERMISSION_ERROR
    3
    An error occurred while calling the API.

    Sample code

    ITMGContext.GetInstance(this).CheckMicPermission();

    Checking mic status

    Function prototype

    public abstract ITMG_CHECK_MIC_STATUS CheckMic();

    Returned value handling

    Returned Value
    Description
    Handling
    ITMG_CHECK_MIC_STATUS_AVAILABLE = 0
    Normally available
    No handling required
    ITMG_CHECK_MIC_STATUS_NO_GRANTED = 2
    Access not obtained/denied
    The access permission needs to be obtained before the mic is enabled.
    ITMG_CHECK_MIC_STATUS_INVALID_MIC = 3
    No device available
    Generally, this error will be reported on PCs when no mics are available. Prompt the user to insert a headset or mic.
    ITMG_CHECK_MIC_STATUS_NOT_INIT = 5
    Not initialized
    Call EnableMic after Init.

    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

    public abstract int SetLogLevel(int levelWrite, int levelPrint);

    Parameter description

    Parameter
    Type
    Description
    levelWrite
    ITMG_LOG_LEVEL
    Sets the level of logs to be written. TMG_LOG_LEVEL_NONE indicates not to log. 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:
    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

    Sample code

    ITMGContext.GetInstance(this).SetLogLevel(TMG_LOG_LEVEL_INFO,TMG_LOG_LEVEL_INFO);

    Setting the log printing path

    This API is used to set the log printing path, and needs to be called before initialization. The default path is /sdcard/Android/data/xxx.xxx.xxx/files.

    API prototype

    public abstract int SetLogPath(String logDir);
    Parameter
    Type
    Description
    logDir
    String
    Path

    Sample code

    ITMGContext.GetInstance(this).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

    public abstract String GetQualityTips();

    Sample code

    ITMGContext.GetInstance(this).GetRoom().GetQualityTips();

    Callback Messages

    Message
    Description
    Data
    Example
    ITMG_MAIN_EVENT_TYPE_ENTER_ROOM
    A member entered the audio room.
    result; error_info
    {"error_info":"","result":0}
    ITMG_MAIN_EVENT_TYPE_EXIT_ROOM
    A member exited the audio room.
    result; error_info
    {"error_info":"","result":0}
    ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT
    The room was disconnected due to a network or another issue.
    result; error_info
    {"error_info":"waiting timeout, please check your network","result":0}
    ITMG_MAIN_EVNET_TYPE_USER_UPDATE
    Room members were updated.
    user_list; event_id
    {"event_id":1,"user_list":["0"]}
    ITMG_MAIN_EVENT_TYPE_RECONNECT_START
    The reconnection to the room started.
    result; error_info
    {"error_info":"","result":0}
    ITMG_MAIN_EVENT_TYPE_RECONNECT_SUCCESS
    The reconnection to the room succeeded.
    result; error_info
    {"error_info":"","result":0}
    ITMG_MAIN_EVENT_TYPE_SWITCH_ROOM
    The room was quickly switched.
    result; error_info
    {"error_info":"","result":0}
    ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_TYPE
    The room status was changed.
    result; error_info; sub_event_type; new_room_type
    {"error_info":"","new_room_type":0,"result":0}
    ITMG_MAIN_EVENT_TYPE_ROOM_SHARING_START
    Cross-room mic connect started.
    result;
    {"result":0}
    ITMG_MAIN_EVENT_TYPE_ROOM_SHARING_STOP
    Cross-room mic connect stopped.
    result;
    {"result":0}
    ITMG_MAIN_EVENT_TYPE_SPEAKER_DEFAULT_DEVICE_CHANGED
    The default speaker was changed.
    result; error_info
    {"deviceID":"{0.0.0.00000000}.{a4f1e8be-49fa-43e2-b8cf-dd00542b47ae}","deviceName":"Speaker (Realtek High Definition Audio)","error_info":"","isNewDevice":true,"isUsedDevice":false,"result":0}
    ITMG_MAIN_EVENT_TYPE_SPEAKER_NEW_DEVICE
    A new speaker was added.
    result; error_info
    {"deviceID":"{0.0.0.00000000}.{a4f1e8be-49fa-43e2-b8cf-dd00542b47ae}","deviceName":"Speaker (Realtek High Definition Audio)","error_info":"","isNewDevice":true,"isUsedDevice":false,"result":0}
    ITMG_MAIN_EVENT_TYPE_SPEAKER_LOST_DEVICE
    A speaker was lost.
    result; error_info
    {"deviceID":"{0.0.0.00000000}.{a4f1e8be-49fa-43e2-b8cf-dd00542b47ae}","deviceName":"Speaker (Realtek High Definition Audio)","error_info":"","isNewDevice":false,"isUsedDevice":false,"result":0}
    ITMG_MAIN_EVENT_TYPE_MIC_NEW_DEVICE
    A new mic was added.
    result; error_info
    {"deviceID":"{0.0.1.00000000}.{5fdf1a5b-f42d-4ab2-890a-7e454093f229}","deviceName":"Mic (Realtek High Definition Audio)","error_info":"","isNewDevice":true,"isUsedDevice":true,"result":0}
    ITMG_MAIN_EVENT_TYPE_MIC_LOST_DEVICE
    A mic was lost.
    result; error_info
    {"deviceID":"{0.0.1.00000000}.{5fdf1a5b-f42d-4ab2-890a-7e454093f229}","deviceName":"Mic (Realtek High Definition Audio)","error_info":"","isNewDevice":false,"isUsedDevice":true,"result":0}
    ITMG_MAIN_EVENT_TYPE_MIC_DEFAULT_DEVICE_CHANGED
    The default mic was changed.
    result; error_info
    {"deviceID":"{0.0.1.00000000}.{5fdf1a5b-f42d-4ab2-890a-7e454093f229}","deviceName":"Mic (Realtek High Definition Audio)","error_info":"","isNewDevice":false,"isUsedDevice":true,"result":0}
    ITMG_MAIN_EVENT_TYPE_CHANGE_ROOM_QUALITY
    The room quality changed.
    weight; loss; delay
    {"weight":5,"loss":0.1,"delay":1}
    ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE
    Voice message recording was completed.
    result; file_path
    {"file_path":"","result":0}
    ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE
    Voice message upload was completed.
    result; file_path;file_id
    {"file_id":"","file_path":"","result":0}
    ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE
    Voice message download was completed.
    result; file_path;file_id
    {"file_id":"","file_path":"","result":0}
    ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE
    Voice message playback was completed.
    result; file_path
    {"file_path":"","result":0}
    ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE
    Fast speech-to-text conversion was completed.
    result; text;file_id
    {"file_id":"","text":"","result":0}
    ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE
    Streaming speech-to-text conversion was completed.
    result; file_path; text;file_id
    {"file_id":"","file_path":","text":"","result":0}
    ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING
    Streaming speech-to-text conversion is in progress.
    result; file_path; text;file_id
    {"file_id":"","file_path":","text":"","result":0}
    ITMG_MAIN_EVNET_TYPE_PTT_TEXT2SPEECH_COMPLETE
    Text-to-speech conversion was completed.
    result; text;file_id
    {"file_id":"","text":"","result":0}
    ITMG_MAIN_EVNET_TYPE_PTT_TRANSLATE_TEXT_COMPLETE
    Text translation was completed.
    result; text;file_id
    {"file_id":"","text":"","result":0}
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support