tencent cloud

Game Multimedia Engine

Product Introduction
Overview
Strengths
Features
Scenarios
Compliance
Console Guide
Usage Querying
Activating Services
Getting Started
Quick Integration of SDK
Quick Integration of Sample Project
Basic Feature Development Guide
Authentication Key
Voice Chat Role Configuration
Sound Quality
Client API
SDK for Unity
SDK for Unreal Engine
Cocos2D SDK
SDK for Windows
SDK for iOS
SDK for Android
SDK for macOS
H5 SDK
Electron SDK
SDK for Flutter
SDK Version Upgrade Guide
Error Codes
Toolchain
Server APIs
History
Introduction
API Category
Usage APIs
Recording APIs
Making API Requests
Voice Chat APIs
Application APIs
Data Types
Error Codes
FAQ
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 Agreement
Service Level Agreement
Política GME
Contrato de Privacidade e Segurança de Dados
Política de privacidade
DocumentaçãoGame Multimedia EngineServer APIs Recording APIsStartRecord

StartRecord

PDF
Modo Foco
Tamanho da Fonte
Última atualização: 2025-10-30 21:44:27

1. API Description

Domain name for API request: gme.intl.tencentcloudapi.com.

This API is used to start recording.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common Params. The value used for this API: StartRecord.
Version Yes String Common Params. The value used for this API: 2018-07-11.
Region No String Common Params. This parameter is not required.
BizId Yes Integer Application ID.
RoomId Yes String Room ID.
RecordMode Yes Integer Recording mode. Valid values: 1: single stream; 2: mixed streams; 3: single stream and mixed streams.
SubscribeRecordUserIds No SubscribeRecordUserIds Allowlist or blocklist for stream subscription. If you do not specify this parameter, the audio streams of all the users in the room are subscribed to by default.

3. Output Parameters

Parameter Name Type Description
TaskId Integer Task ID.
RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 Starting recording

This example shows you how to start recording.

Input Example

POST / HTTP/1.1
Host: gme.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartRecord
<Common request parameters>

{
    "RecordMode": 1,
    "SubscribeRecordUserIds": {
        "SubscribeUserIds": [
            1145
        ],
        "UnSubscribeUserIds": [
            1987
        ]
    },
    "RoomId": "1987",
    "BizId": 3400352518
}

Output Example

{
    "Response": {
        "TaskId": 446192236330927912,
        "RequestId": "h9167d24-a2c6-1125-a5bd-5c023ba721c2"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InternalError Internal error.
InvalidParameter Incorrect parameter.
InvalidParameterValue.InvalidBizId Invalid BizId.(SDKAppid)
InvalidParameterValue.InvalidRecordMode Invalid RecordMode.
InvalidParameterValue.InvalidRoomId Invalid RoomId.
InvalidParameterValue.InvalidSubscribeRecordUserIds Incorrect blocklist/allowlist format.
InvalidParameterValue.InvalidSubscribeUserIds The number of entries on the allowlist exceeds 20.
InvalidParameterValue.InvalidUNSubscribeUserIds The number of entries on the blocklist exceeds 20.
ResourceInUse.TaskInUse The task already exists.
ResourceNotFound.RoomNotFound The room does not exist.
ResourceNotFound.TaskNotFound The task ID does not exist.
UnauthorizedOperation Unauthorized operation.
UnsupportedOperation Operation unsupported.
UnsupportedOperation.ServiceNotOpened The recording service is not activated.
Anterior: StopRecordPróximo: Request Structure

Ajuda e Suporte

Esta página foi útil?

comentários