1. API Description
Domain name for API request: car.tencentcloudapi.com.
Initiate stream push. The codec for the stream push is automatically adjusted based on the client's (SDK) capabilities, with a default order of H265, H264, 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 understood by CAR. It will be used as the StreamId for pushing streams. For example, if the bound push domain is abc.livepush.myqcloud.com, the push address will be rtmp://abc.livepush.myqcloud.com/live/UserId?txSecret=xxx&txTime=xxx. |
| PublishStreamArgs | No | String | Push parameter, which is a custom parameter carried during stream pushing. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Starting stream push
This example shows you how to start stream push.
Input Example
POST / HTTP/1.1
Host: car.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.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for Node.js
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
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. |
Yes
No
Was this page helpful?