tencent cloud

Cloud Application Rendering

Release Notes
Product Introduction
Overview
Basic Concepts
Strengths
Use Cases
Purchase Guide
Billing Overview
Billing
Purchase Process
Overdue Payment
Refunds
Auto-Renewal Rules
Getting Started
Basic Technical Concepts
User Guides
Technical Integration
Integration Demo
Console Guide
Application Management
Project Management
Stream Push Service
Concurrency Management
Multiplayer Interaction
Session Status
Practical Tutorial
How to Implement Cloud-Native Recording
How to Implement Application Upload and Version Update via CAR-CLI
How to Implement Concurrency Sharing
How to Implement Mobile Chinese Input
How ‍to ‍Push ‍‍Cloud ‍Video Streams to CSS
How to Implement Multi-Person Interaction
How to Implement Live Room Interaction ‍with On-Screen Comments
Configuring and Using Cloud Browser
SDK Documentation
JavaScript SDK
SDK for Android
SDK for iOS
API Documentation
History
Introduction
API Category
Making API Requests
User APIs
Application Management APIs
Project Management APIs
Concurrency Management APIs
Stream Push Service APIs
Data Types
Error Codes
FAQs
CAR Basics
CAR Integration
Cloud Application
Service Level Agreement
CAR Policy
Privacy Policy
Data Processing And Security Agreement
Contact Us

StartPublishStream

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

1. API Description

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

This API is used to start pushing your cloud application's video streams in real time to CSS. The codec for the streaming is automatically selected based on the client's (SDK) capabilities, with a default order of H.265, H.264, VP8, and VP9.

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: StartPublishStream.
Version Yes String Common Params. The value used for this API: 2022-01-10.
Region No String Common Params. This parameter is not required for this API.
UserId Yes String Unique user ID, which is customized by you and is not parsed by CAR. It will be used as the StreamId for streaming. For example, if the bound streaming domain is abc.livepush.myqcloud.com, the streaming address will be rtmp://abc.livepush.myqcloud.com/live/UserId?txSecret=xxx&txTime=xxx.
PublishStreamArgs No String Streaming parameter, which is a custom parameter carried during streaming.

3. Output Parameters

Parameter Name Type Description
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 Pushing Streams

This example shows you how to start pushing streams.

Input Example

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



{
    "UserId": "abc123"
}

Output Example

{
    "Response": {
        "RequestId": "4eb17e58-68da-4e9a-b298-0894723c9022"
    }
}

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
FailedOperation Operation failed.
InternalError Internal error.
InvalidParameter Parameter error.
InvalidParameter.JsonParseError JSON parsing error.
OperationDenied Operation denied.
ResourceNotFound.SessionNotFound Unable to find the session.

Ajuda e Suporte

Esta página foi útil?

comentários