Domain name for API request: car.tencentcloudapi.com.
This API is used to start pushing your cloud application's video streams to a specified URL. 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. This streaming method will be billed separately. For details about the billing method, see Charging for Streaming to Specified URL.
A maximum of 20 requests can be initiated per second for this API.
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: StartPublishStreamWithURL. |
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. |
PublishStreamURL | Yes | String | Streaming address. Only RTMP is supported for streaming currently. |
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. |
This example shows you how to start pushing your cloud application's video streams to a specified URL
POST / HTTP/1.1
Host: car.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: StartPublishStreamWithURL
<Common request parameters>
{
"UserId": "abc",
"PublishStreamURL": "abc"
}
{
"Response": {
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
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. |
Was this page helpful?