tencent cloud


Full Recording

Last updated: 2024-01-18 14:10:27
    This document describes how to quickly integrate the GME server-side recording feature through full recording.

    Use Cases

    GME provides server-side recording capabilities for voice chat audio streams to help you implement various scenarios, including content retention, management, and reproduction. In full recording mode, you can record all voice chat rooms in the application. In custom recording mode, you can record the specified room. In both recording modes, you can record the mixed stream by room or single stream by user. Recording files will be stored in COS under your account.
    This document describes how to integrate full recording. To enable custom recording for your application, see Custom Recording.
    Using GME's server-side recording feature will incur recording service fees. Billing for this feature at Tencent Cloud International will officially start on April 1, 2023. Billing details will be announced in advance in Purchase Guide.
    Recording files will be stored in COS under your account, and COS bills will be generated based on your specific usage information such as storage volume, duration, and access frequency. For billing details, see Billing Overview.


    You have activated the voice chat service as instructed in Activating Services.
    You have activated the server-side recording service. Currently, this feature is only available to allowed users. To try it out, contact us to add you to the allowlist.
    You have integrated the GME SDK, including core APIs and voice chat APIs. For more information, see Quick Integration of Native SDK, Quick Integration of SDK for Unity, and Quick Integration of SDK for Unreal Engine.

    Service Architecture


    Feature Overview

    1. Recording scope

    After full recording is enabled, all voice chat rooms will be recorded. You can specify only mixed-stream recording, only single-stream recording, or both.

    2. Recording mechanism

    Recording task start

    A recording task will start when the first user enters the room.

    Recording task ending

    The recording task will end when the last user exits the room.

    Recording task segmentation

    If a single audio file lasts two hours or longer, it will be segmented automatically.
    If a user turns off the mic, the user's single-stream recording will be segmented automatically. After a user turns on the mic, a new segment will be generated.
    If an ongoing recording task is interrupted due to an exception, a new segment will be generated after the task restarts automatically.

    Recording task event notification

    A recording task event will be notified to the configured callback URL through the callback mechanism. If such an event occurs, you will receive a callback notification such as Recording started, Recording stopped, or The recording file has been uploaded.
    For the specific callback information, see Recording Callback Description.

    3. Storage location

    With GME's server-side recording, recording files will be stored in the specified bucket in COS under your account. You need to specify the region of the bucket. For the available regions, see Regions and Access Endpoints.

    4. Recording file format


    5. Recording file naming convention

    User single-stream recording files: bizid_roomid_userid/${task start time}_${id}_audio.mp3
    Room mixed-stream recording file: bizid_roomid/${taskid} _${task start time} _${id}_audio.mp3
    bizid: GME application ID, which can be obtained in the GME console. roomid: Voice chat room ID, which is defined and passed in to the GME SDK when you use the voice chat service. userid: Player ID, which is defined and passed in to the GME SDK when you use the voice chat service. taskid: Recording task ID, which is generated by the GME recording service. Each recording task has a unique task ID. id: Serial number of a recording task segment, which starts from 0.

    Integration directions

    Step 1. Configure the recording service in the console

    Activating/Deactivating the recording service

    Log in to the GME console, click Service Management on the left sidebar, locate the target application, click Set to enter the Details page, and click Modify in the Voice Recording Service section.
    Select Enable.
    When you activate the recording service for the first time, GME will request access to your COS service. You need to grant the access in the pop-up window to activate the server-side recording service.

    Configuring the recording file storage location

    On the Details page, click Modify in the Voice Recording Service section and click Bind next to Recording File Bucket. In the Bind Bucket pop-up window, you can bind an existing COS bucket (created in the COS console in advance) or create a bucket.

    Configuring the recording event callback (optional)

    If you want to receive the event callbacks of the recording service, you can configure the callback URL. On the Details page, click Modify in the Voice Recording Service section and click Modify next to Callback URL. In the pop-up window, enter the URL for receiving callbacks. Currently, event callback messages are pushed only for the recording task completion status.

    Configuring the recording scope

    You can select Custom recording or Full recording for Recording Scope. Here, you need to select Full recording and specify whether to record single streams, mixed streams, or both.
    After setting the above configuration items, click Save, and the recording service will be activated. If you no longer need the service, select Disable for the recording service in the console to avoid incurring additional fees.

    Step 2. Receive the recording task callback (optional)

    If a callback URL is configured in step 1, you can receive recording task event callbacks.

    Step 3. View/Manage recording files

    An audio file can be generated in several minutes after a recording task ends. You need to log in to the COS console to view and manage recording files.
    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