tencent cloud

Feedback

Speech-to-Text Service

Last updated: 2024-01-18 15:15:48
    This document describes how to integrate with and debug GME client APIs for the voice messaging and speech-to-text services for Flutter.

    Key Considerations for Using GME

    GME provides the real-time voice service and 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 real-time voice and 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, GmeError.AV_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.
    Note: There is a default call rate limit for speech-to-text APIs. For more information on how calls are billed within the limit, see Purchase Guide. If you want to increase the limit or learn more about how excessive calls are billed, submit a ticket.
    Non-streaming speech-to-text API SpeechToText(): There can be up to 10 concurrent requests per account.
    Streaming speech-to-text API StartRecordingWithStreamingRecognition(): There can be up to 50 concurrent requests per account.

    Integrating the SDK

    Directions

    Key processes involved in SDK integration are as follows:
    
    
    

    .dart files

    gme.dart GME business implementation APIs
    gmeType.dart GME type definition file
    gmeError.dart GME error type definition file

    Core APIs

    API
    Description
    InitSDK
    Initializes GME.
    Poll
    Triggers the event callback.
    Uninit
    Uninitializes GME.

    Importing the GME module

    import 'package:gme/gme.dart';
    import 'package:gme/gmeType.dart';

    Getting an instance

    var m_context = await ITMGContext.GetInstance();

    Initializing the SDK

    You need to initialize the SDK through the Init API before you can use the real-time voice chat, voice messaging, 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

    Future<int> InitSDK(String appID, 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 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

    Returned Value
    Description
    GmeError.AV_OK= 0
    SDK initialized successfully.
    AV_ERR_SDK_NOT_FULL_UPDATE=7015
    Solution: Check whether the SDK file is complete. We recommend that you delete it and then import the SDK again.
    Note:
    Notes on 7015 error code
    The 7015 error code is identified by MD5. 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.

    Sample code

    int res = await ITMGContext.GetInstance().InitSDK(_editAppID.text,_editOpenID.text);
    // Determine whether the initialization is successful by the returned value
    if (ret != GmeError.AV_OK)
    {
    print("Failed to initialize the SDK:");
    return;
    }

    Triggering event callback

    Event callbacks can be triggered by calling the Poll API in the timer. 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.
    Note:
    The Poll API must be called periodically and in the main thread to avoid abnormal API callbacks.

    API prototype

    Future<void> Poll()

    Sample code

    Future<void> pollTimer() async {
    _pollTimer = Timer.periodic(Duration(milliseconds: 100), (Timer timer) {
    ITMGContext.GetInstance().Poll();
    });
    }

    Uninitializing SDK

    This API is used to uninitialize the SDK to make it uninitialized. If the game business account is bound to openid, switching game account requires uninitializing GME and then using the new openid to initialize again.

    API prototype

    Future<int> Uninit()

    Voice Messaging and Speech-to-Text Services

    Note:
    The speech-to-text service consists of fast recording-to-text conversion and streaming speech-to-text conversion.
    You do not need to enter a voice chat room when using the voice messaging service.
    The maximum recording duration of a voice message is 58 seconds by default, and the minimum recording duration cannot be less than 1 second. If you want to customize the recording duration, for example, to change the maximum recording duration to 10 seconds, call the SetMaxMessageLength API to set it after initialization.

    Flowchart for using the voice message service

    
    
    

    Flowchart for using the speech-to-text service

    
    
    
    API
    Description
    GenAuthBuffer
    Gets the authentication information.
    SetMaxMessageLength
    Specifies the maximum duration of a voice message.

    Generating the local authentication key

    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

    Future<Uint8List> GenAuthBuffer(String appID, String roomID, String openID, String key)
    Parameter
    Type
    Description
    appId
    string
    `AppId` from the Tencent Cloud console
    roomId
    string
    Enter `null` or an empty string.
    openId
    string
    User ID, which is the same as `OpenId` during initialization.
    key
    string
    Permission key from the Tencent Cloud console.

    Application authentication

    After the authentication information is generated, the authentication is assigned to the SDK.

    API prototype

    Future<int> ApplyPTTAuthbuffer(Uint8List authBuffer)

    Sample code

    Uint8List authBuffer = await ITMGContext.GetInstance().GenAuthBuffer(_editAppID.text, _editRoomID.text, _editOpenID.text, _editKey.text);
    m_context.ApplyPTTAuthbuffer(authBuffer);

    Specifying the maximum duration of voice message

    This API is used to specify the maximum duration of a voice message, which can be up to 58 seconds.

    API prototype

    Future<int> SetMaxMessageLength(int msTime)
    Parameter
    Type
    Description
    msTime
    number
    Voice message duration in ms. Value range: 1000 < `msTime` <= 58000

    Sample code

    ITMGContext.GetInstance().GetPTT().SetMaxMessageLength(fileLen);

    Streaming Speech Recognition

    Voice messaging and speech-to-text APIs

    API
    Description
    StartRecordingWithStreamingRecognition
    Starts streaming recording.
    StopRecording
    Stops recording.

    Starting streaming speech recognition

    This API is used to start streaming speech recognition. Text obtained from speech-to-text conversion will be returned in real time in its callback. It can specify a language for recognition or translate the text recognized in speech into a specified language and return the translation. To stop recording, call StopRecording.

    API prototype

    Future<int> StartRecordingWithStreamingRecognition(String filePath, String speechLanguage, String translateLanguage)
    Parameter
    Type
    Description
    filePath
    string
    Path of the stored audio file
    speechLanguage
    string
    The language in which the voice message file is to be converted to text. For parameters, see Language Parameter Reference List.
    translateLanguage
    string
    The language in which the voice message file is to be translated to text. For parameters, see Language Parameter Reference List.

    Sample code

    string filePath = "xx/xxx/xxx.silk"
    int res = await ITMGContext.GetInstance().GetPTT().StartRecordingWithStreamingRecognition(filePath, strCurLanguage, strCurLanguage);
    if (ret == 0) {
    this.currentStatus = "Start streaming recording";
    } else {
    this.currentStatus = "Failed to start streaming recording";
    }
    Note:
    Translation incurs additional fees. For more information, see Purchase Guide.

    Callback for streaming speech recognition

    After streaming speech recognition is started, you need to listen on callback messages in the OnEvent notification, which is as detailed below:
    ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE returns text after the recording is stopped and the recognition is completed, which is equivalent to returning the recognized text after a paragraph of speech. ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING returns the recognized text in real time during the recording, which is equivalent to returning the recognized text while speaking.
    The event message will be identified in the callback notification based on the actual needs. The passed parameters include the following four messages.
    Message
    Description
    result
    Return code indicating whether streaming speech recognition is successful
    text
    Text converted from speech
    file_path
    Local path of the stored recording file
    file_id
    Backend URL address of the recording file, which will be retained for 90 days
    Note:
    The file_id is empty when the 'ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING' message is listened for.

    Error codes

    Error Code
    Description
    Solution
    32775
    Streaming speech-to-text conversion failed, but recording succeeded.
    Call the `UploadRecordedFile` API to upload the recording file and then call the `SpeechToText` API to perform speech-to-text conversion.
    32777
    Streaming speech-to-text conversion failed, but recording and upload succeeded.
    The message returned contains a backend URL after successful upload. Call the `SpeechToText` API to perform speech-to-text conversion.
    32786
    Streaming speech-to-text conversion failed.
    During streaming recording, wait for the execution result of the streaming recording API to return.
    32787
    Speech-to-text conversion succeeded, but the text translation service was not activated.
    Activate the text translation service in the console.
    32788
    Speech-to-text conversion succeeded, but the language parameter of the text translation service was invalid.
    Check the parameter passed in.
    If the error code 4098 is reported, see Speech-to-text Conversion for solutions.

    Sample code

    void handleEventMsg(int eventType, String data){
    switch (eventType) {
    case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_COMPLETE:
    {
    HandleSTREAM2TEXTComplete(data,true);
    break;
    }
    ...
    case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVNET_TYPE_PTT_STREAMINGRECOGNITION_IS_RUNNING:
    {
    HandleSTREAM2TEXTComplete(data, false);
    break;
    }
    }
    }
    ITMGContext.GetInstance().SetEvent(handleEventMsg);

    Voice Message Recording

    The recording process is as follows: start recording > stop recording > return recording callback > start the next recording.

    Voice messaging and speech-to-text APIs

    API
    Description
    StartRecording
    Starts recording.
    PauseRecording
    Pauses recording.
    ResumeRecording
    Resumes recording.
    StopRecording
    Stops recording.
    CancelRecording
    Cancels recording.

    Starting recording

    This API is used to start recording.

    API prototype

    Future<int> StartRecording(String filePath)
    Parameter
    Type
    Description
    filePath
    string
    Path of the stored voice message file

    Sample code

    string filepath = "xxxx/xxx.silk";
    int res = await ITMGContext.GetInstance().GetPTT().StartRecording(filepath);

    Stopping recording

    This API is used to stop recording. It is async, and a callback for recording completion will be returned after recording stops. A recording file will be available only after recording succeeds.

    API prototype

    Future<int> StopRecording()

    Sample code

    ITMGContext.GetInstance().GetPTT().StopRecording();

    Callback for recording start

    A callback will be executed through a delegate function to pass a message when recording is completed.
    To stop recording, call StopRecording. The callback for recording start will be returned after the recording is stopped.
    Parameter
    Type
    Description
    code
    string
    `0`: Recording is completed.
    filepath
    string
    Path of the stored recording file, which must be accessible and cannot be the `fileid`.

    Error codes

    Error Code
    Cause
    Solution
    4097
    A parameter is empty.
    Check whether the API parameters in the code are correct.
    4098
    An initialization error occurred.
    Check whether the device is being used, whether the permissions are normal, and whether the initialization is normal.
    4099
    Recording is in progress.
    Make sure that the SDK recording feature is used at the right time.
    4100
    No audio data is captured.
    Check whether the mic is working properly.
    4101
    An error occurred while accessing the file during recording.
    Ensure the existence of the file and the validity of the file path.
    4102
    The mic is not authorized.
    The mic permission is required for using the SDK. To add the permission, see the SDK project configuration document for the corresponding engine or platform.
    4103
    The recording duration is too short.
    The recording duration should be in ms and longer than 1,000 ms.
    4104
    No recording operation is started.
    Check whether the recording starting API has been called.

    Sample code

    void handleEventMsg(int eventType, String data){
    switch (eventType) {
    case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
    {
    // Process
    break;
    }
    ...
    case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVNET_TYPE_PTT_RECORD_COMPLETE:
    {
    // Process
    break;
    }
    }
    }
    ITMGContext.GetInstance().SetEvent(handleEventMsg);

    Pausing recording

    This API is used to pause recording. If you want to resume recording, call the ResumeRecording API.

    API prototype

    Future<int> PauseRecording()

    Sample code

    ITMGContext.GetInstance().GetPTT().PauseRecording();

    Resuming recording

    This API is used to resume recording.

    API prototype

    Future<int> ResumeRecording()

    Sample code

    ITMGContext.GetInstance().GetPTT().ResumeRecording();

    Canceling recording

    This API is used to cancel recording. There is no callback after cancellation.

    API prototype

    Future<int> CancelRecording()

    Sample code

    ITMGContext.GetInstance().GetPTT().CancelRecording();

    Voice Message Upload, Download, and Playback

    API
    Description
    UploadRecordedFile
    Uploads an audio file.
    DownloadRecordedFile
    Downloads an audio file.
    PlayRecordedFile
    Plays back audio.
    StopPlayFile
    Stops playing back audio.
    GetFileSize
    Gets the audio file size.
    GetVoiceFileDuration
    Gets the audio file duration.

    Uploading an audio file

    This API is used to upload an audio file.

    API prototype

    Future<int> UploadRecordedFile(String filePath)
    Parameter
    Type
    Description
    filePath
    String
    Path of the uploaded audio file, which is a local path.

    Sample code

    ITMGContext.GetInstance().GetPTT().UploadRecordedFile(_filePath);

    Callback for audio file upload completion

    After the audio file is uploaded, the event message ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameters include result, file_path, and file_id.
    Parameter
    Type
    Description
    result
    number
    `0`: Recording is completed.
    filepath
    string
    Path of the stored recording file
    fileid
    string
    File URL

    Error codes

    Error Code
    Cause
    Solution
    8193
    An error occurred while accessing the file during upload.
    Ensure the existence of the file and the validity of the file path.
    8194
    Signature verification failed.
    Check whether the authentication key is correct and whether the voice messaging and speech-to-text feature is initialized.
    8195
    A network error occurred.
    Check whether the device can access the internet.
    8196
    The network failed while getting the upload parameters.
    Check whether the authentication is correct and whether the device network can normally access the internet.
    8197
    The packet returned during the process of getting the upload parameters is empty.
    Check whether the authentication is correct and whether the device network can normally access the internet.
    8198
    Failed to decode the packet returned during the process of getting the upload parameters.
    Check whether the authentication is correct and whether the device network can normally access the internet.
    8200
    No `appinfo` is set.
    Check whether the `apply` API is called or whether the input parameters are empty.

    Sample code

    void handleEventMsg(int eventType, String data){
    switch (eventType) {
    ...
    case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVNET_TYPE_PTT_UPLOAD_COMPLETE:
    {
    // Process
    break;
    }
    }
    }
    ITMGContext.GetInstance().SetEvent(handleEventMsg);

    Downloading the audio file

    This API is used to download an audio file.

    API prototype

    Future<int> DownloadRecordedFile(String fileId, String filePath)
    Parameter
    Type
    Description
    fileId
    string
    File URL
    filePath
    string
    Local path of the saved file, which must be accessible and cannot be the `fileid`.

    Sample code

    ITMGContext.GetInstance().GetPTT().DownloadRecordedFile(_fileId, _filePath);

    Callback for audio file download completion

    After the audio file is downloaded, the event message ITMG_MAIN_EVNET_TYPE_PTT_DOWNLOAD_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameters include result, file_path, and file_id.
    Parameter
    Type
    Description
    result
    number
    `0`: Download is completed.
    filepath
    string
    Path of the stored recording file
    fileid
    string
    URL of the recording file, which will be retained on the server for 90 days.

    Error codes

    Error Code
    Cause
    Solution
    12289
    An error occurred while accessing the file during download.
    Check whether the file path is valid.
    12290
    Signature verification failed.
    Check whether the authentication key is correct and whether the voice messaging and speech-to-text feature is initialized.
    12291
    A network storage system exception occurred.
    The server failed to get the audio file. Check whether the API parameter `fileid` is correct, whether the network is normal, and whether the file exists in COS.
    12292
    A server file system error occurred.
    Check whether the device can access the internet and whether the file exists on the server.
    12293
    The HTTP network failed while getting the download parameters.
    Check whether the device can access the internet.
    12294
    The packet returned during the process of getting the download parameters is empty.
    Check whether the device can access the internet.
    12295
    Failed to decode the packet returned during the process of getting the download parameters.
    Check whether the device can access the internet.
    12297
    No `appinfo` is set.
    Check whether the authentication key is correct and whether the voice messaging and speech-to-text feature is initialized.

    Sample code

    void handleEventMsg(int eventType, String data){
    switch (eventType) {
    ...
    case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
    {
    // Process
    break;
    }
    }
    }
    ITMGContext.GetInstance().SetEvent(handleEventMsg);

    Playing back audio

    This API is used to play back audio.

    API prototype

    Future<int> PlayRecordedFile(String filePath, int voiceType)
    Parameter
    Type
    Description
    filePath
    string
    Local audio file path
    voicetype
    ITMG_VOICE_TYPE
    Voice changing type. For more information, see Voice Changing.

    Error codes

    Error Code
    Cause
    Solution
    20485
    Playback is not started.
    Ensure the existence of the file and the validity of the file path.

    Sample code

    int res = await ITMGContext.GetInstance().GetPTT().PlayRecordedFile(_filePath, _nVoiceType);

    Callback for audio playback

    After the audio is played back, the event message ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameter includes result and file_path.
    Parameter
    Type
    Description
    code
    number
    `0`: Playback is completed.
    filepath
    string
    Path of the stored recording file

    Error codes

    Error Code
    Cause
    Solution
    20481
    An initialization error occurred.
    Check whether the device is being used, whether the permissions are normal, and whether the initialization is normal.
    20482
    During playback, the client tried to interrupt and play back the next one but failed (which should succeed normally).
    Check whether the code logic is correct.
    20483
    A parameter is empty.
    Check whether the API parameters in the code are correct.
    20484
    An internal error occurred.
    An error occurred while initializing the player. This error code is generally caused by failure in decoding, and the error should be located with the aid of logs.

    Sample code

    void handleEventMsg(int eventType, String data){
    switch (eventType) {
    case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVNET_TYPE_PTT_PLAY_COMPLETE:
    {
    // Process
    break;
    }
    }
    }

    Stopping audio playback

    This API is used to stop audio playback. There will be a callback for playback completion when the playback stops.

    API prototype

    Future<int> StopPlayFile()

    Sample code

    ITMGContext.GetInstance().GetPTT().StopPlayFile();

    Getting audio file size

    This API is used to get the size of an audio file.

    API prototype

    Future<int> GetFileSize(String filePath)
    Parameter
    Type
    Description
    filePath
    string
    Path of the audio file, which is a local path

    Sample code

    final int res = await ITMGContext.GetInstance().GetPTT().GetFileSize(_filePath);

    Getting audio file duration

    This API is used to get the duration of an audio file in milliseconds.

    API prototype

    Future<int> GetVoiceFileDuration(String filePath)
    Parameter
    Type
    Description
    filePath
    string
    Path of the audio file, which is a local path

    Sample code

    final int res = await ITMGContext.GetInstance().GetPTT().GetVoiceFileDuration(_filePath);

    Fast Recording-to-Text Conversion

    Translating audio file into text in specified language

    This API can specify a language for recognition or translate the text recognized in speech into a specified language and return the translation.
    Note:
    Translation incurs additional fees. For more information, see Purchase Guide.

    API prototype

    Future<int> SpeechToText(String fileId, String speechLanguage, String translateLanguage)
    Parameter
    Type
    Description
    fileID
    string
    URL of the audio file, which will be retained on the server for 90 days.
    speechLanguage
    string
    The language in which the audio file is to be converted to text. For parameters, see Language Parameter Reference List.
    translatelanguage
    string
    The language in which the audio file is to be translated to text. For parameters, see Language Parameter Reference List.

    Sample code

    ITMGContext.GetInstance().GetPTT().SpeechToText(_fileId, "cmn-Hans-CN", "cmn-Hans-CN");

    Callback for recognition

    After the specified audio file is converted to text, the event message ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE will be returned, which will be identified in the OnEvent function. The passed parameters include result, file_path and text (recognized text).
    Parameter
    Type
    Description
    result
    number
    `0`: Recording is completed.
    fileid
    string
    URL of the audio file, which will be retained on the server for 90 days.
    text
    string
    Converted text

    Error codes

    Error Code
    Cause
    Solution
    32769
    An internal error occurred.
    Analyze logs, get the actual error code returned from the backend to the client, and ask backend personnel for assistance.
    32770
    A network error occurred.
    Check whether the device can access the internet.
    32772
    Failed to decode the returned packet.
    Analyze logs, get the actual error code returned from the backend to the client, and ask backend personnel for assistance.
    32774
    No `appinfo` is set.
    Check whether the authentication key is correct and whether the voice messaging and speech-to-text feature is initialized.
    32776
    `authbuffer` check failed.
    Check whether `authbuffer` is correct.
    32784
    The speech-to-text conversion parameter is incorrect.
    Check whether the API parameter `fileid` in the code is empty.
    32785
    Speech-to-text translation returned an error.
    An error occurred in the voice messaging and speech-to-text feature on the backend. Analyze logs, get the actual error code returned from the backend to the client, and ask backend personnel for assistance.
    32787
    Speech-to-text conversion succeeded, but the text translation service was not activated.
    Activate the text translation service in the console.
    32788
    Speech-to-text conversion succeeded, but the language parameter of the text translation service was invalid.
    Check the parameter passed in.

    Sample code

    void handleEventMsg(int eventType, String data){
    switch (eventType) {
    case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVENT_TYPE_ENTER_ROOM:
    {
    // Process
    break;
    }
    ...
    case ITMG_MAIN_EVENT_TYPE.ITMG_MAIN_EVNET_TYPE_PTT_SPEECH2TEXT_COMPLETE:
    {
    // Process
    break;
    }
    }
    }

    Voice Message Volume Level APIs

    API
    Description
    GetMicLevel
    Gets the real-time mic volume level.
    SetMicVolume
    Sets the recording volume level.
    GetMicVolume
    Gets the recording volume level.
    GetSpeakerLevel
    Gets the real-time speaker volume level.
    SetSpeakerVolume
    Sets the playback volume level.
    GetSpeakerVolume
    Gets the playback volume level.

    Getting the real-time mic volume of voice message

    This API is used to get the real-time mic volume. A number-type value will be returned. Value range: 0-200.

    API prototype

    Future<int> GetMicLevel()

    Sample code

    final int res = await ITMGContext.GetInstance().GetPTT().GetMicLevel();

    Setting the recording volume of voice message

    This API is used to set the recording volume of voice message. Value range: 0-200.

    API prototype

    Future<int> SetMicVolume(int volume)
    Parameter
    Type
    Description
    vol
    number
    Value range: 0-200. Default value: `100`. `0` indicates that the audio is mute, while `100` indicates that the volume level remains unchanged.

    Sample code

    final int res = await ITMGContext.GetInstance().GetPTT().SetMicVolume(100);

    Getting the recording volume of voice message

    This API is used to get the recording volume of a voice message. A number-type value will be returned. Value range: 0-200.

    API prototype

    Future<int> GetMicVolume()

    Sample code

    final int res = await ITMGContext.GetInstance().GetPTT().GetMicVolume();

    Getting the real-time speaker volume of voice message

    This API is used to get the real-time speaker volume. A number-type value will be returned. Value range: 0-200.

    API prototype

    Future<int> GetSpeakerLevel()

    Sample code

    final int res = await ITMGContext.GetInstance().GetPTT().GetSpeakerLevel();

    Setting the playback volume of voice message

    This API is used to set the playback volume of voice message. Value range: 0-200.

    API prototype

    Future<int> SetSpeakerVolume(int volume)

    Sample code

    final int res = await ITMGContext.GetInstance().GetPTT().SetSpeakerVolume(100);

    Getting the playback volume of voice message

    This API is used to get the playback volume of a voice message. A number-type value will be returned. Value range: 0-200.

    API prototype

    Future<int> GetSpeakerVolume()

    Sample code

    final int res = await ITMGContext.GetInstance().GetPTT().GetSpeakerVolume();

    Advanced APIs

    Getting version number

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

    API prototype

    Future<String> GetSDKVersion()

    Sample code

    _sdkVersions = await 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

    Future<int> SetLogLevel(int levelWrite, int levelPrint)

    Parameter description

    Parameter
    Type
    Description
    level
    ITMG_LOG_LEVEL
    Sets the log level. `TMG_LOG_LEVEL_NONE` indicates not to log. Default value: `TMG_LOG_LEVEL_INFO`.
    level description:
    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().SetLogLevel(ITMG_LOG_LEVEL.TMG_LOG_LEVEL_ERROR,ITMG_LOG_LEVEL.TMG_LOG_LEVEL_ERROR);

    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 Init.

    API prototype

    Future<int> SetLogPath(String logDir)
    Parameter
    Type
    Description
    logPath
    string
    Path

    Sample code

    String logDir = ""// Set a path by yourself
    ITMGContext.GetInstance().SetLogPath(curPath);
    
    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