- Introduction
- Purchase Guide
- Console Guide
- Feature Guide
- API Documentation
- StreamLive Policy
- Introduction
- Purchase Guide
- Console Guide
- Feature Guide
- API Documentation
- StreamLive Policy
1. API Description
Domain name for API request: mdl.tencentcloudapi.com.
This API is used to create a StreamLive channel.
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: CreateStreamLiveChannel. |
| Version | Yes | String | Common Params. The value used for this API: 2020-03-26. |
| Region | No | String | Common Params. This parameter is not required for this API. |
| Name | Yes | String | Channel name, which can contain 1-32 case-sensitive letters, digits, and underscores and must be unique at the region level |
| AttachedInputs.N | Yes | Array of AttachedInput | Inputs to attach. You can attach 1 to 5 inputs. |
| OutputGroups.N | Yes | Array of StreamLiveOutputGroupsInfo | Configuration information of the channel’s output groups. Quantity: [1, 10] |
| AudioTemplates.N | No | Array of AudioTemplateInfo | Audio transcoding templates. Quantity: [1, 20] |
| VideoTemplates.N | No | Array of VideoTemplateInfo | Video transcoding templates. Quantity: [1, 10] |
| AVTemplates.N | No | Array of AVTemplate | Audio/Video transcoding templates. Quantity: [1, 10] |
| PlanSettings | No | PlanSettings | Event settings |
| EventNotifySettings | No | EventNotifySetting | The callback settings. |
| InputLossBehavior | No | InputLossBehaviorInfo | Complement the last video frame settings. |
| PipelineInputSettings | No | PipelineInputSettingsInfo | Pipeline configuration. |
3. Output Parameters
| Parameter Name | Type | Description |
|---|---|---|
| Id | String | Channel ID |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
4. Example
Example1 Sample request
Input Example
POST / HTTP/1.1
Host: mdl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateStreamLiveChannel
<Common request parameters>
{
"AudioTemplates": [
{
"AudioBitrate": "112000",
"AudioSelectorName": "eng",
"LanguageCode": "eng",
"Name": "test1",
"Acodec": "AAC"
}
],
"OutputGroups": [
{
"Name": "outputGroup",
"Outputs": [
{
"Scte35Settings": {
"Behavior": "PASSTHROUGH"
},
"Name": "output"
}
],
"DrmSettings": {
"ContentId": "12312dsde2",
"State": "OPEN"
},
"DashRemuxSettings": {
"SegmentNumber": "3",
"PeriodTriggers": "OPEN",
"SegmentDuration": "2000"
},
"Type": "HLS",
"HlsRemuxSettings": {
"SegmentNumber": "3",
"PdtInsertion": "OPEN",
"SegmentDuration": "2000",
"PdtDuration": "600"
},
"Destinations": [
{
"AuthKey": "aaaa",
"Username": "bbbb",
"OutputUrl": "http://domain/live/1233",
"Password": "cccc"
}
]
}
],
"VideoTemplates": [
{
"Name": "test2",
"VideoBitrate": "1000000",
"Vcodec": "H264",
"Height": "1080",
"Width": "1920",
"Fps": "60"
}
],
"Name": "channel",
"AttachedInputs": [
{
"AudioSelectors": [
{
"AudioPidSelection": {
"Pid": "256"
},
"Name": "eng"
}
],
"Id": "EEEEE"
}
]
}
Output Example
{
"Response": {
"Id": "sda",
"RequestId": "11-222-222"
}
}
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 |
|---|---|
| InternalError | Internal error. |
| InvalidParameter.AVTemplates | Audio/Video transcoding template error |
| InvalidParameter.AlreadyAssociatedChannel | Channel already associated. |
| InvalidParameter.AttachedInputs | Invalid AttachedInputs. |
| InvalidParameter.AudioTemplates | Incorrect audio transcoding template. |
| InvalidParameter.ExceededQuantityLimit | The quantity exceeds the limit. |
| InvalidParameter.Id | Invalid Id. |
| InvalidParameter.Name | Invalid Name. |
| InvalidParameter.NotFound | Not found. |
| InvalidParameter.NotifyKey | Callback key format error. |
| InvalidParameter.NotifyUrl | Callback URL format error. |
| InvalidParameter.OutputGroups | Invalid OutputGroups. |
| InvalidParameter.VideoTemplates | Incorrect video transcoding template. |
Yes
No
Was this page helpful?