User Tutorial

Last updated: 2021-03-26 15:49:48

    This document helps you get started with Game Multimedia Engine (GME).

    1. Basic GME Knowledge

    2. GME Billing Modes

    GME currently provides multiple services, such as voice chat, voice messaging, and speech-to-text features. For billing details, see Daily Pay-as-You-Go Billing Mode.

    3. Free Demo

    You can scan the QR code in Free Demo to download the mobile application or download the executable program for the Windows platform to experience the 3D sound effect.

    4. Getting Started

    4.1 Activate the service

    Before using GME, you need to sign up for a Tencent Cloud account and activate the GME service. For more information, please see Voice Service Activation Guide.

    4.2 Obtaining the access parameter

    After activating the GME service, you can find the AppID and permission key in the details page of the created application.

    • The AppID and permission key are required in the Demo as parameters.
    • During the usage of SDK, the initialization API “Init” needs to use AppID as a parameter. The authentication APIs “QAVAuthBuffer.GenAuthBuffer” (voice chat) and “ApplyPTTAuthbuffer” (speech-to-text) all require permission key as parameters.

    4.3 Downloading SDK

    You can download the GME SDKs for different platforms. For details, see SDK Download Guide. Currently, GME supports Windows, Mac, Android, and iOS, and GSE supports UnrealEngine4, Unity3D, and Cocos2DX.

    GME also supports the real-time audio call on H5 and listening to the voice chat in the room on the mini program.

    4.4 Accessing SDK

    To access the SDK of each platform, you can refer to the project configuration document of each platform to configure the project, and then check the API Documentation of the corresponding platform to call the APIs to use GME services. The calling sequence of voice chat APIs is Init API (for initialization) > Poll API (for callback trigger) > EnterRoom API (for entering a voice chat room) > EnableMic API (for enabling the mic) > EnableSpeaker API (for enabling the speaker) > ExitRoom API (for exiting the room) > Unit API (for uninitialize).

    The room entry process of voice chat is shown as follows:

    5. Console Operation Guide

    For the background data of voice chat, voice message and voice analysis, see Operation Guide.

    6. Document Description

    Desired Operation Reference Document
    Download SDK files. SDK Download Guide
    Scan the QR code to download the application and try out GME. Free Demo
    Access the SDK to the project and check the configuration required when the SDK is exported from the project. (Take Unity platform as an example) Unity Project Configuration
    Access the SDK to the project, check all APIs, and realize voice chat and speech-to-text service. (Take Unity platform as an example) Unity API Documentation
    Access the SDK to the project and quickly access voice chat service. (Take Unity platform as an example) Unity Quick Start
    Realize the range voice effect in voice chat (similar to "Team Only" and "Everyone" audio modes in PUBG) Range Voice
    Realize the 3D real-time sound effect in the game. 3D Sound Effect
    Play back the accompaniment in the voice chat room by using GME. Accompaniment in Voice Chat
    Learn about the difference between different room types in voice chat service. Sound Quality selection
    Learn more about the details of authentication and the backend deployment scheme. Authentication Key
    Analyze the error codes generated in the usage of SDK and query the solutions. Error Codes
    Learn about the product FAQs of GME. General FAQ
    Check the billing rules before purchasing the service. FAQs About Billing
    Check the FAQs about the voice chat room. FAQs About Voice Chat Room
    Check the FAQs about audio during the usage of SDK. FAQs About Voice Chat Audio

    7. FAQs

    Consultation

    What is the traffic consumption when using the voice chat of GME?
    What features does GME have?

    Demo

    Does GME allow using only one OpenId across multiple devices?
    How do I use a downloaded demo?
    How do I get logs?
    What should I do if the screen goes black when I try to open an application after integrating the GME SDK and exporting an APK file?
    What should I do if an error occurs during compilation when I try to export an executable file from Xcode after adding the GMESDK.framework library?

    Voice Chat

    When should the Poll function in the GME SDK be invoked?
    Is there a limit on the number of voice chat rooms or members in GME?
    Why room entry fails even if 0 is returned when the EnterRoom API is called?
    How do I troubleshoot network problems?
    What should I do if a client is disconnected from a voice chat room?
    I can normally use the range voice but there is no attenuation. I set the 3D sound effect file but the return value is still 0. Why did this happen?
    What should I do if the mobile phone volume level becomes very low after room entry but becomes very high after the mic turns on?
    What should I do if the sound comes out of the receiver instead of the speaker after the microphone is enabled on Android?

    8. Feedback and Suggestion

    If you have any doubts or suggestions when using Tencent Cloud GME products and services, you can submit your feedback through the following channels. Dedicated personnel will contact you to solve your problems.

    • If you find product documentation problems, such as links, content, or API errors, you can click Send Feedback at the bottom of the document to select the content that has problems.
    • If you encounter product-related problems, please submit a ticket.

    Note:

    Please provide the information of SDK version and the used platform when you submit a ticket.