API Documentation

Release Notes

Overview

Strengths

Voice Chat

Voice Messaging

Speech-to-Text Conversion

Text Translation

Text-to-Speech Conversion

Audio and Video Recording        

Features

Game Interaction

Multilingual Communication

Metaverse Game

Scenarios

Compliance

Product Introduction

User Tutorial

Purchase Guide

SDK Download Guide

Basic Feature Demo

Scenario-Specific Demo

Product Feature Demo

Usage Querying

Activating Services

Console Guide

Quick Integration of Native SDK

Quick Integration of SDK for Unity

Quick Integration of SDK for Unreal Engine

Quick Integration of SDK

Quick Run of Unreal Engine Sample Project

Quick Integration of Sample Project

Getting Started

Authentication Key

Voice Chat Role Configuration

Sound Quality

Basic Feature Development Guide

Full Recording

Custom Recording

Recording Callback Description

Server-Side Recording

Range Voice

3D Sound Effect

Voice Changing

Accompaniment in Voice Chat

Real-Time Sound Equalizer

Sound Effect and Accompaniment

Network Audio Stream Forwarding Routing

Custom Message Channel

How to deal with the restrictions of corporate firewall

Language Parameter Reference List

Integrating GME Chat Room Management

Advanced Feature Development Guide

Integrating SDK

Speech-to-Text Service

Project Export

SDK for Unity

SDK for Unreal Engine

Project Configuration

Cocos2D SDK

SDK for Windows

iOS Project Upgrade Guide

SDK for iOS

SDK for Android

Voice Chat API

SDK for macOS

H5 SDK

Electron SDK

Real-time Voice

SDK for Flutter

SDK Version Upgrade Guide

Error Codes

Toolchain

 Client API 

History

Introduction

API Category

StartRecord

StopRecord

ModifyRecordInfo

DescribeTaskInfo

DescribeRecordInfo

Recording APIs

Request Structure

Common Params

Signature v3

Signature

Responses

Making API Requests

DeleteRoomMember

Voice Chat APIs

CreateApp

ModifyAppStatus

Application APIs

DescribeApplicationData

DescribeAppStatistics

Usage APIs

Data Types

Server APIs 

Product Features

Troubleshooting Guide

Billing

Sample Project Usage

General

Authentication

Voice Chat Room Entry Failure

Sound and Audio

Network

Speech-to-text Conversion

Program Export

Service Level Agreement

Service Agreement

Contact Us

Glossary

Data Privacy and Security Agreement

Privacy Policy

GME Policy

Game Multimedia Engine

Only some GME features are supported by the SDK for HTML5. Please refer to this document for the supported APIs and evaluate whether the SDK for HTML5 is appropriate for your business scenario.

 will be returned with the value being 0.

Authentication is required for room entry in GME. For more information, see the authentication section in relevant documentation.

Operation on devices should be performed after successful room entry.

 can only be used in an HTTPS environment; therefore, please use HTTPS.

You need to integrate JQ to use the demo.

Before initialization, the SDK is in the uninitialized state. A room can be entered only after the initialization authentication is performed and the SDK is initialized.

For more information on how to get parameters, see 

https://intl.cloud.tencent.com/document/product/607/10782

 uniquely identifies a user with the rules stipulated by the application developer and must be unique in the application (currently, only INT64 is supported).

The SDK must be initialized before a user can enter a room.

WebGMEAPI.fn.Init = function (document, SdkAppId, openId) {...}

const cSdkAppId = () => document.getElementById("input-SdkAppId").value;

const cOpenID = () => document.getElementById("input-OpenID").value;

gmeAPI.Init(document, cSdkAppId(), cOpenID());

 method to send callback notifications to the application. Register the callback function to the SDK to receive callback messages. The callback function should be registered to the SDK before room entry.

WebGMEAPI.fn.SetTMGDelegate = function (delegate){...}

You should initialize and call the SDK to enter a room before voice chat can start.

When a user enters a room with the generated authentication information, the 

 message will be received as a callback. Mic and speaker are not turned on by default after room entry.

WebGMEAPI.fn.EnterRoom = function (roomId, roomType, authBuffer) {...}

        $("#start_btn").click(function () {

            // Step 1: Get the `AuthBuffer`

            var FetchSigCgi = 'http://134.175.146.244:10005/';

                    sdkappid: cSdkAppId(),

                success: function (json) {

                    // Step 2: `AuthBuffer` is obtained successfully

                    if (json && json.errorCode === 0) {

                        let userSig = json.userSig;

                        gmeAPI.Init(document, cSdkAppId(), cOpenID());

                        gmeAPI.SetTMGDelegate(onEvent);

                        gmeAPI.EnterRoom(cRoomNum(), 1, userSig);

                        console.error(json);

After the user enters the room, the message 

 onEvent = function (eventType, result) {

         if (eventType === gmeAPI.event.ITMG_MAIN_EVENT_TYPE_ENTER_ROOM)

        else if (eventType === gmeAPI.event.ITMG_MAIN_EVENT_TYPE_USER_UPDATE)

            app._data.downStreamInfoList = result.PeerInfo;// Received peer information. For more information, see the table below

            app._data.brSend = result.UploadBRSend;// Bitrate of the uploaded audio data

            app._data.rtt = result.UploadRTT;// Upload RTT

        else if (eventType === gmeAPI.event.ITMG_MAIN_EVENT_TYPE_EXIT_ROOM)

        else if (eventType === gmeAPI.event.ITMG_MAIN_EVENT_TYPE_ROOM_DISCONNECT)

The received peer information is as follows (downStreamInfoList):

This API is called to exit the current room. It is an async API. There will be a callback after room exit. The returned value of 

This API is used to turn on/off the mic. Mic and speaker are not turned on by default after room entry.

WebGMEAPI.fn.EnableMic = function (bEnable) {...}

This API is used to set the mic volume. The corresponding parameter is 

. 0 indicates that the audio is mute, while 100 indicates that the volume remains unchanged. The default value is 100.

WebGMEAPI.fn.SetMicVolume = function (volume){...}

This API is used to turn on/off the speaker.

WebGMEAPI.fn.EnableSpeaker = function (bEnable){...}

tencent cloud