Data Types
Last updated: 2020-01-13 15:27:26
Contents：
DelayInfo
Information of the delayed playback
Used by actions: DescribeLiveDelayInfoList.
| Name | Type | Description |
|---|---|---|
| DomainName | String | Push domain name. |
| AppName | String | Push path, which is the same as the AppName in push and playback addresses and is "live" by default. |
| StreamName | String | Stream name. |
| DelayInterval | Integer | Delay time in seconds. |
| CreateTime | String | Creation time in UTC format. Note: Beijing time is 8 hours ahead of UTC. Example: 2019-06-18T12:00:00Z (20:00:00, June 18, 2019, Beijing time). |
| ExpireTime | String | Expiration time in UTC format. Note: Beijing time is 8 hours ahead of UTC. Example: 2019-06-18T12:00:00Z (20:00:00, June 18, 2019, Beijing time). |
| Status | Integer | Current status, -1: Expired, 1: Effective. |
ForbidStreamInfo
List of forbidden streams
Used by actions: DescribeLiveForbidStreamList.
| Name | Type | Description |
|---|---|---|
| StreamName | String | Stream name. |
| CreateTime | String | Creation time. |
| ExpireTime | String | Forbidding expiration time. |
HlsSpecialParam
HLS-specific recording parameter
Used by actions: CreateLiveRecordTemplate、DescribeLiveRecordTemplate、DescribeLiveRecordTemplates、ModifyLiveRecordTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| FlowContinueDuration | Integer | No | HLS timeout period. |
PlayAuthKeyInfo
Playback authentication key information
Used by actions: DescribeLivePlayAuthKey.
| Name | Type | Description |
|---|---|---|
| DomainName | String | Domain name. |
| Enable | Integer | Whether to enable. 0: disabled; 1: enabled. |
| AuthKey | String | Authentication key. |
| AuthDelta | Integer | Validity period in seconds. |
| AuthBackKey | String | Authentication BackKey. |
PublishTime
Push time
Used by actions: DescribeLiveStreamOnlineList.
| Name | Type | Description |
|---|---|---|
| PublishTime | String | Push time In UTC format, for example: 2018-06-29T19:00:00Z. |
PushAuthKeyInfo
Push authentication key information
Used by actions: DescribeLivePushAuthKey.
| Name | Type | Description |
|---|---|---|
| DomainName | String | Domain name. |
| Enable | Integer | Whether to enable. 0: disabled; 1: enabled. |
| MasterAuthKey | String | Master authentication key. |
| BackupAuthKey | String | Backup authentication key. |
| AuthDelta | Integer | Validity period in seconds. |
RecordParam
Recording template parameter
Used by actions: CreateLiveRecordTemplate、DescribeLiveRecordTemplate、DescribeLiveRecordTemplates、ModifyLiveRecordTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| RecordInterval | Integer | No | Recording interval. In seconds. Default value: 1,800. Value range: 300–7,200. This parameter is not valid for HLS, and a file is generated from push start to push end when HLS is recorded. |
| StorageTime | Integer | No | Recording storage duration. In seconds. Value range: 0–93,312,000. 0 represents permanent storage. |
| Enable | Integer | No | Whether to enable recording in the current format. 0: no; 1: yes. Default value: 0. |
RecordTemplateInfo
Recording template information
Used by actions: DescribeLiveRecordTemplate、DescribeLiveRecordTemplates.
| Name | Type | Description |
|---|---|---|
| TemplateId | Integer | Template ID. |
| TemplateName | String | Template name. |
| Description | String | Message description |
| FlvParam | RecordParam | FLV recording parameter. |
| HlsParam | RecordParam | HLS recording parameter. |
| Mp4Param | RecordParam | Mp4 recording parameter. |
| AacParam | RecordParam | AAC recording parameter. |
| IsDelayLive | Integer | 0: LVB, 1: LCB. |
| HlsSpecialParam | HlsSpecialParam | Custom HLS recording parameter. |
| Mp3Param | RecordParam | Mp3 recording parameter. |
RuleInfo
Rule information
Used by actions: DescribeLiveRecordRules、DescribeLiveTranscodeRules.
| Name | Type | Description |
|---|---|---|
| CreateTime | String | Rule creation time. |
| UpdateTime | String | Rule update time. |
| TemplateId | Integer | Template ID. |
| DomainName | String | Push domain name. |
| AppName | String | Push path. |
| StreamName | String | Stream name. |
StreamEventInfo
Streaming event information.
Used by actions: DescribeLiveStreamEventList.
| Name | Type | Description |
|---|---|---|
| AppName | String | Application name. |
| DomainName | String | Push domain name. |
| StreamName | String | Stream name. |
| StreamStartTime | String | Push start time. In UTC format. Example: 2019-01-07T12:00:00Z. |
| StreamEndTime | String | Push end time. In UTC format. Example: 2019-01-07T15:00:00Z. |
| StopReason | String | Stop reason. |
| Duration | Integer | Push duration in seconds. |
| ClientIp | String | Host IP. |
| Resolution | String | Resolution. |
StreamName
List of stream names
Used by actions: DescribeLiveStreamPublishedList.
| Name | Type | Description |
|---|---|---|
| StreamName | String | Stream name. |
| AppName | String | Application name. |
| DomainName | String | Push domain name. |
| StreamStartTime | String | Push start time. In UTC format. Example: 2019-01-07T12:00:00Z. |
| StreamEndTime | String | Push end time. In UTC format. Example: 2019-01-07T15:00:00Z. |
| StopReason | String | Stop reason. |
| Duration | Integer | Push duration in seconds. |
| ClientIp | String | Host IP. |
| Resolution | String | Resolution. |
StreamOnlineInfo
Queries active push information
Used by actions: DescribeLiveStreamOnlineList.
| Name | Type | Description |
|---|---|---|
| StreamName | String | Stream name. |
| PublishTimeList | Array of PublishTime | Push time list |
| AppName | String | Application name. |
| DomainName | String | Push domain name. |
TemplateInfo
Transcoding template information
Used by actions: DescribeLiveTranscodeTemplate、DescribeLiveTranscodeTemplates.
| Name | Type | Description |
|---|---|---|
| Vcodec | String | Video encoding format: h264/h265. |
| VideoBitrate | Integer | Video bitrate in Kbps. Value range: 100–8,000 |
| Acodec | String | Audio encoding format: AAC/MP3 aac/mp3. |
| AudioBitrate | Integer | Audio bitrate. Value range: 0–500 |
| Width | Integer | Width. Value range: 0–3,000 |
| Height | Integer | Height. Value range: 0–3,000 |
| Fps | Integer | Frame rate. Value range: 0–200 |
| Gop | Integer | Keyframe interval in seconds. Value range: 1–50 |
| Rotate | Integer | Rotation angle. Valid values: 0, 90, 180, 270 |
| Profile | String | Encoding quality: baseline/main/high. |
| BitrateToOrig | Integer | Whether to not exceed the original bitrate. 0: no; 1: yes. |
| HeightToOrig | Integer | Whether to not exceed the original height. 0: no; 1: yes. |
| FpsToOrig | Integer | Whether to not exceed the original frame rate. 0: no; 1: yes. |
| NeedVideo | Integer | Whether to keep the video. 0: no; 1: yes. |
| NeedAudio | Integer | Whether to keep the audio. 0: no; 1: yes. |
| TemplateId | Integer | Template ID. |
| TemplateName | String | Template name |
| Description | String | Template description |
| AiTransCode | Integer | Whether it is a TESHD template. 0: no; 1: yes. Default value: 0. |
| AdaptBitratePercent | Float | VideoBitrate minus TESHD bitrate. Value range: 0.1–0.5. |
