Media input associated with media channel.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Id | String | Yes | Media input ID. |
| AudioSelectors | Array of AudioSelectorInfo | No | Audio selector for media input. Quantity limit: [0,20] Note: this field may return null, indicating that no valid values can be obtained. |
Audio Pid selection.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Pid | Integer | No | Audio Pid. Default value: 0. |
Pipeline input audio statistics.
Used by actions: DescribeMediaLiveChannelInputStatistics.
| Name | Type | Description |
|---|---|---|
| Fps | Integer | Audio FPS. |
| Rate | Integer | Audio bitrate in bps. |
| Pid | Integer | Audio Pid, which is available only if the input is rtp/udp. |
Audio selector.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Audio name, which can contain 1-32 letters, digits, and underscores. |
| AudioPidSelection | AudioPidSelectionInfo | No | Audio Pid selection. |
Audio transcoding template.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| AudioSelectorName | String | Yes | Only AttachedInputs.AudioSelectors.Name can be selected. This parameter is required for RTP_PUSH and UDP_PUSH. |
| Name | String | Yes | Audio transcoding template name, which can contain 1-20 letters and digits. |
| Acodec | String | No | Audio codec. Valid value: AAC. Default value: AAC. |
| AudioBitrate | Integer | No | Audio bitrate. If this parameter is left empty, the original value will be used. Valid values: 6000, 7000, 8000, 10000, 12000, 14000, 16000, 20000, 24000, 28000, 32000, 40000, 48000, 56000, 64000, 80000, 96000, 112000, 128000, 160000, 192000, 224000, 256000, 288000, 320000, 384000, 448000, 512000, 576000, 640000, 768000, 896000, 1024000 |
| LanguageCode | String | No | Audio language code, whose length is always 3 characters. |
Channel alarm information.
Used by actions: DescribeMediaLiveChannelAlerts.
| Name | Type | Description |
|---|---|---|
| Pipeline0 | Array of ChannelPipelineAlerts | Alarm details of pipeline 0 under this channel. |
| Pipeline1 | Array of ChannelPipelineAlerts | Alarm details of pipeline 1 under this channel. |
Channel information.
Used by actions: DescribeMediaLiveChannel, DescribeMediaLiveChannels.
| Name | Type | Description |
|---|---|---|
| Id | String | Channel ID. |
| State | String | Channel status. |
| AttachedInputs | Array of AttachedInputInfo | Information of associated input. |
| OutputGroups | Array of OutputGroupsInfo | Information of output group. |
| Name | String | Channel name. |
| AudioTemplates | Array of AudioTemplateInfo | Audio transcoding template array. Note: this field may return null, indicating that no valid values can be obtained. |
| VideoTemplates | Array of VideoTemplateInfo | Video transcoding template array. Note: this field may return null, indicating that no valid values can be obtained. |
Channel output statistics.
Used by actions: DescribeMediaLiveChannelInputStatistics.
| Name | Type | Description |
|---|---|---|
| InputId | String | Input ID. |
| Statistics | InputStatistics | Input statistics. |
Channel output information.
Used by actions: DescribeMediaLiveChannelOutputStatistics.
| Name | Type | Description |
|---|---|---|
| OutputGroupName | String | Output group name. |
| Statistics | OutputsStatistics | Output group statistics. |
Channel alarm details.
Used by actions: DescribeMediaLiveChannelAlerts.
| Name | Type | Description |
|---|---|---|
| SetTime | String | Alarm start time in UTC time. |
| ClearTime | String | Alarm end time in UTC time. This time is available only after the alarm ends. |
| Type | String | Alarm type. |
| Message | String | Alarm details. |
DASH configuration information.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| SegmentDuration | Integer | No | Segment duration in ms. Value range: [1000,30000]. Default value: 4000. The value can only be a multiple of 1,000. |
| SegmentNumber | Integer | No | Number of segments. Value range: [1,30]. Default value: 5. |
| PeriodTriggers | String | No | Whether to enable multi-period. Valid values: CLOSE/OPEN. Default value: CLOSE. |
Relay destination address.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| OutputUrl | String | Yes | Relay destination address. Length limit: [1,512]. |
| AuthKey | String | No | Authentication key. Length limit: [1,128]. Note: this field may return null, indicating that no valid values can be obtained. |
| Username | String | No | Authentication username. Length limit: [1,128]. Note: this field may return null, indicating that no valid values can be obtained. |
| Password | String | No | Authentication password. Length limit: [1,128]. Note: this field may return null, indicating that no valid values can be obtained. |
Custom DRM key.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | Yes | DRM key, which is a 32-bit hexadecimal string. Note: uppercase letters in the string will be automatically converted to lowercase ones. |
| Track | String | No | Required for Widevine encryption. Valid values: SD, HD, UHD1, UHD2, AUDIO, ALL. ALL refers to all tracks. If this parameter is set to ALL, no other tracks can be added. Note: this field may return null, indicating that no valid values can be obtained. |
| KeyId | String | No | Required for Widevine encryption. It is a 32-bit hexadecimal string. Note: uppercase letters in the string will be automatically converted to lowercase ones. Note: this field may return null, indicating that no valid values can be obtained. |
| Iv | String | No | Required when FairPlay uses the AES encryption method. It is a 32-bit hexadecimal string. For more information about this parameter, please see: https://tools.ietf.org/html/rfc3826 Note: uppercase letters in the string will be automatically converted to lowercase ones. Note: this field may return null, indicating that no valid values can be obtained. |
DRM configuration information, which takes effect only for HLS and DASH.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| State | String | No | Whether to enable DRM encryption. Valid value: CLOSE/OPEN. Default value: CLOSE. Currently, this is supported only for HLS/DASH/HLS_ARCHIVE/DASH_ARCHIVE. |
| ContentId | String | No | When Scheme is set to TencentDRM, this parameter should be set to the ContentId of DRM encryption, and if this parameter is left empty, a ContentId will be automatically created. When Scheme is set to CustomDRMKeys, this parameter is required and should be specified by the user. |
| Scheme | String | No | Valid values: TencentDRM, CustomDRMKeys. If this parameter is left empty, TencentDRM will be used by default. TencentDRM refers to Tencent digital rights management (DRM) encryption. CustomDRMKeys refers to an encryption key customized by the user. |
| Keys | Array of DrmKey | No | The key customized by the content user, which is required when Scheme is set to CustomDRMKeys.Note: this field may return null, indicating that no valid values can be obtained. |
HLS protocol configuration.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| SegmentDuration | Integer | No | Segment duration in ms. Value range: [1000,30000]. Default value: 4000. The value can only be a multiple of 1,000. |
| SegmentNumber | Integer | No | Number of segments. Value range: [1,30]. Default value: 5. |
| PdtInsertion | String | No | Whether to enable PDT insertion. Valid values: CLOSE/OPEN. Default value: CLOSE. |
| PdtDuration | Integer | No | PDT duration in seconds. Value range: (0,3000]. Default value: 600. |
Input information.
Used by actions: DescribeMediaLiveInput, DescribeMediaLiveInputs.
| Name | Type | Description |
|---|---|---|
| Region | String | Input region. |
| Id | String | Input ID. |
| Name | String | Input name. |
| Type | String | Input type. |
| SecurityGroupIds | Array of String | Array of security groups associated with input. |
| AttachedChannels | Array of String | Array of channels associated with input. Note: this field may return null, indicating that no valid values can be obtained. |
| InputSettings | Array of InputSettingInfo | Input configuration array. |
Input security group information.
Used by actions: DescribeMediaLiveInputSecurityGroup, DescribeMediaLiveInputSecurityGroups.
| Name | Type | Description |
|---|---|---|
| Id | String | Input security group ID. |
| Name | String | Input security group name. |
| Whitelist | Array of String | List of allowlist entries. |
| OccupiedInputs | Array of String | List of bound input streams. Note: this field may return null, indicating that no valid values can be obtained. |
| Region | String | Input security group address. |
Input settings information.
Used by actions: CreateMediaLiveInput, DescribeMediaLiveInput, DescribeMediaLiveInputs, ModifyMediaLiveInput.
| Name | Type | Required | Description |
|---|---|---|---|
| AppName | String | No | Application name, which is used for RTMP_PUSH and can contain 1-32 letters and digits. Note: this field may return null, indicating that no valid values can be obtained. |
| StreamName | String | No | Stream name, which is used for RTMP_PUSH and can contain 1-32 letters and digits. Note: this field may return null, indicating that no valid values can be obtained. |
| SourceUrl | String | No | Origin-pull URL, which is used for RTMP_PULL/HLS_PULL/MP4_PULL. Length limit: [1,512]. Note: this field may return null, indicating that no valid values can be obtained. |
| InputAddress | String | No | RTP/UDP input address, which does not need to be entered for the input parameter. Note: this field may return null, indicating that no valid values can be obtained. |
Input statistics.
Used by actions: DescribeMediaLiveChannelInputStatistics.
| Name | Type | Description |
|---|---|---|
| Pipeline0 | Array of PipelineInputStatistics | Input statistics of pipeline 0. |
| Pipeline1 | Array of PipelineInputStatistics | Input statistics of pipeline 1. |
Log information.
Used by actions: DescribeMediaLiveChannelLogs.
| Name | Type | Description |
|---|---|---|
| Type | String | Log type. It contains the value of StreamStart which refers to the push information. |
| Time | String | Time when the log is printed. |
| Message | LogMessageInfo | Log details. |
Log details.
Used by actions: DescribeMediaLiveChannelLogs.
| Name | Type | Description |
|---|---|---|
| StreamInfo | StreamInfo | Push information. Note: this field may return null, indicating that no valid values can be obtained. |
Configuration information related to associating with the media packaging service.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Id | String | Yes | Media packaging ID. |
Channel output group information.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Channel output group name, which can contain 1–32 letters, digits, and underscores and must be unique at the channel level. |
| Type | String | Yes | Output protocol type. Valid values: HLS, DASH, HLS_ARCHIVE, HLS_MEDIA_PACKAGE, DASH_MEDIA_PACKAGE. |
| Outputs | Array of OutputInfo | Yes | Output information. Quantity limit: [1,1] for RTMP/RTP; [1,10] for HLS/DASH. |
| Destinations | Array of DestinationInfo | Yes | Relay destination address. Quantity limit: [1,2]. |
| HlsRemuxSettings | HlsRemuxSettingsInfo | No | HLS protocol configuration information, which takes effect only for HLS/HLS_ARCHIVE. |
| DashRemuxSettings | DashRemuxSettingsInfo | No | DASH protocol configuration information, which takes effect only for DASH/DSAH_ARCHIVE. |
| DrmSettings | DrmSettingsInfo | No | DRM configuration information. |
| MediaPackageSettings | MediaPackageSettingsInfo | No | Configuration information of media packaging, which is required when Type is set to MediaPackage.Note: this field may return null, indicating that no valid values can be obtained. |
Output information.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Output name. |
| AudioTemplateNames | Array of String | No | Audio transcoding template name array. Quantity limit: [0,1] for RTMP; [0,20] for others. Note: this field may return null, indicating that no valid values can be obtained. |
| VideoTemplateNames | Array of String | No | Video transcoding template name array. Quantity limit: [0,1]. Note: this field may return null, indicating that no valid values can be obtained. |
| Scte35Settings | Scte35SettingsInfo | No | SCTE-35 information configuration. |
Channel output statistics.
Used by actions: DescribeMediaLiveChannelOutputStatistics.
| Name | Type | Description |
|---|---|---|
| Pipeline0 | Array of PipelineOutputStatistics | Output information of pipeline 0. |
| Pipeline1 | Array of PipelineOutputStatistics | Output information of pipeline 1. |
Pipeline input statistics.
Used by actions: DescribeMediaLiveChannelInputStatistics.
| Name | Type | Description |
|---|---|---|
| Timestamp | Integer | Data timestamp in seconds. |
| NetworkIn | Integer | Input bandwidth in bps. |
| Video | Array of VideoPipelineInputStatistics | Video information array. For rtp/udp input, the quantity is the number of Pid of the input video.For other inputs, the quantity is 1. |
| Audio | Array of AudioPipelineInputStatistics | Audio information array. For rtp/udp input, the quantity is the number of Pid of the input audio.For other inputs, the quantity is 1. |
Pipeline log information.
Used by actions: DescribeMediaLiveChannelLogs.
| Name | Type | Description |
|---|---|---|
| Pipeline0 | Array of LogInfo | Log information of pipeline 0. Note: this field may return null, indicating that no valid values can be obtained. |
| Pipeline1 | Array of LogInfo | Log information of pipeline 1. Note: this field may return null, indicating that no valid values can be obtained. |
Channel output statistics.
Used by actions: DescribeMediaLiveChannelOutputStatistics.
| Name | Type | Description |
|---|---|---|
| Timestamp | Integer | Timestamp. In seconds, indicating data time. |
| NetworkOut | Integer | Output bandwidth in bps. |
SCTE-35 configuration information.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Behavior | String | No | Whether to pass through SCTE-35 information. Valid values: NO_PASSTHROUGH/PASSTHROUGH. Default value: NO_PASSTHROUGH. |
Audio information.
Used by actions: DescribeMediaLiveChannelLogs.
| Name | Type | Description |
|---|---|---|
| Pid | Integer | Audio Pid.Note: this field may return null, indicating that no valid values can be obtained. |
| Codec | String | Audio codec. Note: this field may return null, indicating that no valid values can be obtained. |
| Fps | Integer | Audio frame rate. Note: this field may return null, indicating that no valid values can be obtained. |
| Rate | Integer | Audio bitrate. Note: this field may return null, indicating that no valid values can be obtained. |
| SampleRate | Integer | Audio sample rate. Note: this field may return null, indicating that no valid values can be obtained. |
Push information.
Used by actions: DescribeMediaLiveChannelLogs.
| Name | Type | Description |
|---|---|---|
| ClientIp | String | Client IP. |
| Video | Array of StreamVideoInfo | Video information of pushed streams. |
| Audio | Array of StreamAudioInfo | Audio information of pushed streams. |
| Scte35 | Array of StreamScte35Info | SCTE-35 information of pushed streams. |
SCTE-35 information.
Used by actions: DescribeMediaLiveChannelLogs.
| Name | Type | Description |
|---|---|---|
| Pid | Integer | SCTE-35 Pid.Note: this field may return null, indicating that no valid values can be obtained. |
Video information of pushed streams.
Used by actions: DescribeMediaLiveChannelLogs.
| Name | Type | Description |
|---|---|---|
| Pid | Integer | Video Pid.Note: this field may return null, indicating that no valid values can be obtained. |
| Codec | String | Video codec. Note: this field may return null, indicating that no valid values can be obtained. |
| Fps | Integer | Video frame rate. Note: this field may return null, indicating that no valid values can be obtained. |
| Rate | Integer | Video bitrate. Note: this field may return null, indicating that no valid values can be obtained. |
| Width | Integer | Video width. Note: this field may return null, indicating that no valid values can be obtained. |
| Height | Integer | Video height. Note: this field may return null, indicating that no valid values can be obtained. |
Pipeline input video statistics.
Used by actions: DescribeMediaLiveChannelInputStatistics.
| Name | Type | Description |
|---|---|---|
| Fps | Integer | Video FPS. |
| Rate | Integer | Video bitrate in bps. |
| Pid | Integer | Video Pid, which is available only if the input is rtp/udp. |
Video transcoding template.
Used by actions: CreateMediaLiveChannel, DescribeMediaLiveChannel, DescribeMediaLiveChannels, ModifyMediaLiveChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | Yes | Video transcoding template name, which can contain 1-20 letters and digits. |
| Vcodec | String | No | Video codec. Valid values: H264/H265. If this parameter is left empty, the original value will be used. |
| VideoBitrate | Integer | No | Video bitrate. Value range: [50000,40000000]. The value can only be a multiple of 1,000. If this parameter is left empty, the original value will be used. |
| Width | Integer | No | Video width. Value range: (0,3000]. The value can only be a multiple of 4. If this parameter is left empty, the original value will be used. |
| Height | Integer | No | Video height. Value range: (0,3000]. The value can only be a multiple of 4. If this parameter is left empty, the original value will be used. |
| Fps | Integer | No | Video frame rate. Value range: [1,240]. If this parameter is left empty, the original value will be used. |
| TopSpeed | String | No | Whether to enable top speed codec. Valid value: CLOSE/OPEN. Default value: CLOSE. |
| BitrateCompressionRatio | Integer | No | Top speed codec compression ratio. Value range: [0,50]. The lower the compression ratio, the higher the image quality. |
Was this page helpful?