Bandwidth information
Used by actions: DescribeDeliverBandwidthList.
| Name | Type | Description |
|---|---|---|
| Time | String | Format of return value: yyyy-mm-dd HH:MM:SS The time accuracy matches with the query granularity. |
| Bandwidth | Float | Bandwidth. |
Bandwidth and traffic information.
Used by actions: DescribeBillBandwidthAndFluxList.
| Name | Type | Description |
|---|---|---|
| Time | String | Time point in the format of yyyy-mm-dd HH:MM:SS. |
| Bandwidth | Float | Bandwidth in Mbps. |
| Flux | Float | Traffic in MB. |
| PeakTime | String | Time point of peak value in the format of yyyy-mm-dd HH:MM:SS. As raw data is at a 5-minute granularity, if data at a 1-hour or 1-day granularity is queried, the time point of peak bandwidth value at the corresponding granularity will be returned. |
Rule information
Used by actions: DescribeLiveCallbackRules.
| 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. |
Callback template information.
Used by actions: DescribeLiveCallbackTemplate, DescribeLiveCallbackTemplates.
| Name | Type | Description |
|---|---|---|
| TemplateId | Integer | Template ID. |
| TemplateName | String | Template name. |
| Description | String | Description. |
| StreamBeginNotifyUrl | String | Stream starting callback URL. |
| StreamEndNotifyUrl | String | Interruption callback URL. |
| StreamMixNotifyUrl | String | Stream mixing callback URL. |
| RecordNotifyUrl | String | Recording callback URL. |
| SnapshotNotifyUrl | String | Screencapturing callback URL. |
| PornCensorshipNotifyUrl | String | Porn detection callback URL. |
| CallbackKey | String | Callback authentication key. |
Downstream playback statistical metrics
Used by actions: DescribeGroupProIspPlayInfoList.
| Name | Type | Description |
|---|---|---|
| Time | String | Time point in the format of yyyy-mm-dd HH:MM:SS. |
| Bandwidth | Float | Bandwidth in Mbps. |
| Flux | Float | Traffic in MB. |
| Request | Integer | Number of new requests. |
| Online | Integer | Number of concurrent connections. |
Certificate information.
Used by actions: DescribeLiveCert, DescribeLiveCerts.
| Name | Type | Description |
|---|---|---|
| CertId | Integer | Certificate ID. |
| CertName | String | Certificate name. |
| Description | String | Description. |
| CreateTime | String | Creation time in UTC format. |
| HttpsCrt | String | Certificate content. |
| CertType | Integer | Certificate type: 0: Tencent Cloud-hosted certificate. 1: user-added certificate. |
| CertExpireTime | String | Certificate expiration time in UTC format. |
| DomainList | Array of String | List of domain names that use this certificate. |
Aggregated playback information of client IP.
Used by actions: DescribeTopClientIpSumInfoList.
| Name | Type | Description |
|---|---|---|
| ClientIp | String | Client IP in dotted-decimal notation. |
| Province | String | District where the client is located. |
| TotalFlux | Float | Total traffic. |
| TotalRequest | Integer | Total number of requests. |
| TotalFailedRequest | Integer | Total number of failed requests. |
| CountryArea | String | Country/region where the client is located. |
Used by actions: CreateCommonMixStream.
| Name | Type | Required | Description |
|---|---|---|---|
| UseMixCropCenter | Integer | No | |
| AllowCopy | Integer | No |
General stream mix input crop parameter.
Used by actions: CreateCommonMixStream.
| Name | Type | Required | Description |
|---|---|---|---|
| CropWidth | Float | No | Crop width. Value range: [0,2000]. |
| CropHeight | Float | No | Crop height. Value range: [0,2000]. |
| CropStartLocationX | Float | No | Starting crop X coordinate. Value range: [0,2000]. |
| CropStartLocationY | Float | No | Starting crop Y coordinate. Value range: [0,2000]. |
General stream mix input parameter.
Used by actions: CreateCommonMixStream.
| Name | Type | Required | Description |
|---|---|---|---|
| InputStreamName | String | Yes | Input stream name of up to 80 bytes, which is a string containing letters, digits, and underscores. |
| LayoutParams | CommonMixLayoutParams | Yes | Input stream layout parameter. |
| CropParams | CommonMixCropParams | No | Input stream crop parameter. |
General stream mix layout parameter.
Used by actions: CreateCommonMixStream.
| Name | Type | Required | Description |
|---|---|---|---|
| ImageLayer | Integer | Yes | Input layer. Value range: [1,16]. 1) For image_layer of background stream (i.e., main host video image or canvas), enter 1.2) For audio stream mix, this parameter is also required. |
| InputType | Integer | No | Input type. Value range: [0,5]. If this parameter is left empty, 0 will be used by default. 0: the input stream is audio/video. 2: the input stream is image. 3: the input stream is canvas. 4: the input stream is audio. 5: the input stream is pure video. |
| ImageWidth | Float | No | Output width of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream width will be used by default. If percentage is used, the expected output is (percentage * background width). |
| ImageHeight | Float | No | Output height of input video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, the input stream height will be used by default. If percentage is used, the expected output is (percentage * background height). |
| LocationX | Float | No | X-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Horizontal offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width). |
| LocationY | Float | No | Y-axis offset of input in output video image. Value range: Pixel: [0,2000] Percentage: [0.01,0.99] If this parameter is left empty, 0 will be used by default. Vertical offset from the top-left corner of main host background video image. If percentage is used, the expected output is (percentage * background width) |
| Color | String | No | When InputType is 3 (canvas), this value indicates the canvas color.Commonly used colors include: Red: 0xcc0033. Yellow: 0xcc9900. Green: 0xcccc33. Blue: 0x99CCFF. Black: 0x000000. White: 0xFFFFFF. Gray: 0x999999 |
| WatermarkId | Integer | No | When InputType is 2 (image), this value is the watermark ID. |
General stream mix output parameter.
Used by actions: CreateCommonMixStream.
| Name | Type | Required | Description |
|---|---|---|---|
| OutputStreamName | String | Yes | Output stream name. |
| OutputStreamType | Integer | No | Output stream type. Valid values: [0,1]. If this parameter is left empty, 0 will be used by default. If the output stream is a stream in the input stream list, enter 0. If you want the stream mix result to be a new stream, enter 1. If this value is 1, output_stream_id cannot appear in input_stram_list, and there cannot be a stream with the same ID on the LVB backend. |
| OutputStreamBitRate | Integer | No | Output stream bitrate. Value range: [1,50000]. If this parameter is left empty, the system will automatically determine. |
| OutputStreamGop | Integer | No | Output stream GOP size. Value range: [1,10]. If this parameter is left empty, the system will automatically determine. |
| OutputStreamFrameRate | Integer | No | Output stream frame rate. Value range: [1,60]. If this parameter is left empty, the system will automatically determine. |
| OutputAudioBitRate | Integer | No | Output stream audio bitrate. Value range: [1,500] If this parameter is left empty, the system will automatically determine. |
| OutputAudioSampleRate | Integer | No | Output stream audio sample rate. Valid values: [96000, 88200, 64000, 48000, 44100, 32000,24000, 22050, 16000, 12000, 11025, 8000]. If this parameter is left empty, the system will automatically determine. |
| OutputAudioChannels | Integer | No | Output stream audio sound channel. Valid values: [1,2]. If this parameter is left empty, the system will automatically determine. |
| MixSei | String | No | SEI information in output stream. If there are no special needs, leave it empty. |
Number of concurrent recording channels
Used by actions: DescribeConcurrentRecordStreamNum.
| Name | Type | Description |
|---|---|---|
| Time | String | Time point. |
| Num | Integer | Number of channels. |
Stream playback information
Used by actions: DescribeStreamPlayInfoList.
| Name | Type | Description |
|---|---|---|
| Time | String | Data point in time in the format of yyyy-mm-dd HH:MM:SS. |
| Bandwidth | Float | Bandwidth in Mbps. |
| Flux | Float | Traffic in MB. |
| Request | Integer | Number of requests. |
| Online | Integer | Number of online viewers. |
Delayed playback information.
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 time. Note: the difference between UTC time and Beijing time is 8 hours. Example: 2019-06-18T12:00:00Z (i.e., June 18, 2019 20:00:00 Beijing time). |
| ExpireTime | String | Expiration time in UTC time. Note: the difference between UTC time and Beijing time is 8 hours. Example: 2019-06-18T12:00:00Z (i.e., June 18, 2019 20:00:00 Beijing time). |
| Status | Integer | Current status: -1: expired. 1: in effect. |
Domain name certificate information
Used by actions: DescribeLiveDomainCert.
| Name | Type | Description |
|---|---|---|
| CertId | Integer | Certificate ID. |
| CertName | String | Certificate name. |
| Description | String | Description. |
| CreateTime | String | Creation time in UTC format. |
| HttpsCrt | String | Certificate content. |
| CertType | Integer | Certificate type. 0: user-added certificate 1: Tencent Cloud-hosted certificate. |
| CertExpireTime | String | Certificate expiration time in UTC format. |
| DomainName | String | Domain name that uses this certificate. |
| Status | Integer | Certificate status. |
Statistics of each domain name.
Used by actions: DescribeLiveDomainPlayInfoList.
| Name | Type | Description |
|---|---|---|
| MainlandOrOversea | String | In or outside Mainland China: Mainland: data in Mainland China. Oversea: data outside Mainland China. |
| Bandwidth | Float | Bandwidth in Mbps. |
| Flux | Float | Traffic in MB. |
| Online | Integer | Number of viewers. |
| Request | Integer | Number of requests. |
LVB domain name information
Used by actions: DescribeLiveDomain, DescribeLiveDomains.
| Name | Type | Description |
|---|---|---|
| Name | String | LVB domain name. |
| Type | Integer | Domain name type: 0: push. 1: playback. |
| Status | Integer | Domain name status: 0: deactivated. 1: activated. |
| CreateTime | String | Creation time. |
| BCName | Integer | Whether there is a CNAME record pointing to a fixed rule domain name: 0: no. 1: yes. |
| TargetDomain | String | Domain name corresponding to CNAME record. |
| PlayType | Integer | Playback region. This parameter is valid only if Type is 1.1: in Mainland China. 2: global. 3: outside Mainland China. |
| IsDelayLive | Integer | Whether it is LCB: 0: LVB. 1: LCB. |
| CurrentCName | String | Information of currently used CNAME record. |
| RentTag | Integer | Disused parameter, which can be ignored. |
| RentExpireTime | String | Disused parameter, which can be ignored. |
| IsMiniProgramLive | Integer | 0: LVB. 1: LVB on Mini Program. Note: this field may return null, indicating that no valid values can be obtained. |
Multi-domain name information list
Used by actions: DescribeLiveDomainPlayInfoList.
| Name | Type | Description |
|---|---|---|
| Domain | String | Domain name. |
| DetailInfoList | Array of DomainDetailInfo | Details. |
List of forbidden streams
Used by actions: DescribeLiveForbidStreamList.
| Name | Type | Description |
|---|---|---|
| StreamName | String | Stream name. |
| CreateTime | String | Creation time. |
| ExpireTime | String | Forbidding expiration time. |
Bandwidth, traffic, number of requests, and number of concurrent connections of an ISP in a district.
Used by actions: DescribeGroupProIspPlayInfoList.
| Name | Type | Description |
|---|---|---|
| ProvinceName | String | District. |
| IspName | String | ISP. |
| DetailInfoList | Array of CdnPlayStatData | Detailed data at the minute level. |
HLS-specific recording parameter
Used by actions: CreateLiveRecordTemplate, DescribeLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| FlowContinueDuration | Integer | No | HLS timeout period. |
HTTP return code and statistics
Used by actions: DescribePlayErrorCodeDetailInfoList.
| Name | Type | Description |
|---|---|---|
| HttpCode | String | HTTP return code. Example: "2xx", "3xx", "4xx", "5xx". |
| ValueList | Array of HttpCodeValue | Statistics. 0 will be added for points in time when there is no data. |
HTTP return code data
Used by actions: DescribePlayErrorCodeDetailInfoList.
| Name | Type | Description |
|---|---|---|
| Time | String | Time in the format of yyyy-mm-dd HH:MM:SS. |
| Numbers | Integer | Occurrences. |
| Percentage | Float | Proportion. |
Playback error code information
Used by actions: DescribeHttpStatusInfoList.
| Name | Type | Description |
|---|---|---|
| Time | String | Data point in time, In the format of yyyy-mm-dd HH:MM:SS. |
| HttpStatusInfoList | Array of HttpStatusInfo | Playback status code details. |
Playback error code information
Used by actions: DescribeHttpStatusInfoList.
| Name | Type | Description |
|---|---|---|
| HttpStatus | String | Playback HTTP status code. |
| Num | Integer | Quantity. |
Monitored playback data
Used by actions: DescribeAllStreamPlayInfoList.
| Name | Type | Description |
|---|---|---|
| PlayDomain | String | Playback domain name. |
| StreamName | String | Stream ID. |
| Rate | Integer | Playback bitrate. 0 indicates the original bitrate. |
| Protocol | String | Playback protocol. Valid values: Unknown, Flv, Hls, Rtmp, Huyap2p. |
| Bandwidth | Float | Bandwidth in Mbps. |
| Online | Integer | Number of online viewers. A data point is sampled per minute, and the number of TCP connections across the sample points is calculated. |
| Request | Integer | Number of requests. |
Playback authentication key information.
Used by actions: DescribeLivePlayAuthKey.
| Name | Type | Description |
|---|---|---|
| DomainName | String | Domain name. |
| Enable | Integer | Whether to enable: 0: disable. 1: enable. |
| AuthKey | String | Authentication key. |
| AuthDelta | Integer | Validity period in seconds. |
| AuthBackKey | String | Authentication BackKey. |
Total occurrences of each status code. Most HTTP return codes are supported.
Used by actions: DescribePlayErrorCodeSumInfoList.
| Name | Type | Description |
|---|---|---|
| Code | String | HTTP code. Valid values: 400, 403, 404, 500, 502, 503, 504. |
| Num | Integer | Total occurrences. |
Playback information at the stream level.
Used by actions: DescribeStreamDayPlayInfoList.
| Name | Type | Description |
|---|---|---|
| StreamName | String | Stream name. |
| TotalFlux | Float | Total traffic in MB. |
Queries the playback information by ISP and district.
Used by actions: DescribeProvinceIspPlayInfoList.
| Name | Type | Description |
|---|---|---|
| Time | String | Data point in time. |
| Value | Float | Value of bandwidth/traffic/number of requests/number of concurrent connections/download speed. If there is no data returned, the value is 0. Note: this field may return null, indicating that no valid values can be obtained. |
Aggregated playback statistics.
Used by actions: DescribeVisitTopSumInfoList.
| Name | Type | Description |
|---|---|---|
| Name | String | Domain name or stream ID. |
| AvgFluxPerSecond | Float | Average download speed, In MB/s. Calculation formula: average download speed per minute. |
| TotalFlux | Float | Total traffic in MB. |
| TotalRequest | Integer | Total number of requests. |
Playback error code information
Used by actions: DescribePlayErrorCodeSumInfoList.
| Name | Type | Description |
|---|---|---|
| CountryAreaName | String | Country or region. |
| ProvinceName | String | District. |
| IspName | String | ISP. |
| Code2xx | Integer | Occurrences of 2xx error codes. |
| Code3xx | Integer | Occurrences of 3xx error codes. |
| Code4xx | Integer | Occurrences of 4xx error codes. |
| Code5xx | Integer | Occurrences of 5xx error codes. |
Queries playback information by district/ISP.
Used by actions: DescribeProIspPlaySumInfoList.
| Name | Type | Description |
|---|---|---|
| Name | String | District/ISP/country/region. |
| TotalFlux | Float | Total traffic in MB. |
| TotalRequest | Integer | Total number of requests. |
| AvgFluxPerSecond | Float | Average download traffic in MB/s. |
Push time.
Used by actions: DescribeLiveStreamOnlineList.
| Name | Type | Description |
|---|---|---|
| PublishTime | String | Push time. In UTC format, such as 2018-06-29T19:00:00Z. |
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 | Standby authentication key. |
| AuthDelta | Integer | Validity period in seconds. |
Push information
Used by actions: DescribeLiveStreamPushInfoList.
| Name | Type | Description |
|---|---|---|
| StreamName | String | Stream name. |
| AppName | String | Push path. |
| ClientIp | String | Push client IP. |
| ServerIp | String | IP of the server that receives the stream. |
| VideoFps | Integer | Pushed video frame rate in Hz. |
| VideoSpeed | Integer | Pushed video bitrate in bps. |
| AudioFps | Integer | Pushed audio frame rate in Hz. |
| AudioSpeed | Integer | Pushed audio bitrate in bps. |
| PushDomain | String | Push domain name. |
| BeginPushTime | String | Push start time. |
| Acodec | String | Audio codec, Example: AAC. |
| Vcodec | String | Video codec, Example: H.264. |
| Resolution | String | Resolution. |
| AsampleRate | Integer | Sample rate. |
| MetaAudioSpeed | Integer | Audio bitrate in metadata in Kbps. |
| MetaVideoSpeed | Integer | Video bitrate in metadata in Kbps. |
| MetaFps | Integer | Frame rate in metadata. |
Push quality data of a stream.
Used by actions: DescribeStreamPushInfoList.
| Name | Type | Description |
|---|---|---|
| Time | String | Data time in the format of %Y-%m-%d %H:%M:%S.%ms and accurate down to the millisecond level. |
| PushDomain | String | Push domain name. |
| AppName | String | Push path. |
| ClientIp | String | Push client IP. |
| BeginPushTime | String | Push start time in the format of %Y-%m-%d %H:%M:%S.%ms and accurate down to the millisecond level. |
| Resolution | String | Resolution information. |
| VCodec | String | Video codec. |
| ACodec | String | Audio codec. |
| Sequence | String | Push serial number, which uniquely identifies a push. |
| VideoFps | Integer | Video frame rate. |
| VideoRate | Integer | Video bitrate in bps. |
| AudioFps | Integer | Audio frame rate. |
| AudioRate | Integer | Audio bitrate in bps. |
| LocalTs | Integer | Local elapsed time in milliseconds. The greater the difference between audio/video elapsed time and local elapsed time, the poorer the push quality and the more serious the upstream lag. |
| VideoTs | Integer | Video elapsed time in milliseconds. |
| AudioTs | Integer | Audio elapsed time in milliseconds. |
| MetaVideoRate | Integer | Video bitrate in metadata in Kbps. |
| MetaAudioRate | Integer | Audio bitrate in metadata in Kbps. |
| MateFps | Integer | Frame rate in metadata. |
Recording template parameter.
Used by actions: CreateLiveRecordTemplate, DescribeLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate.
| Name | Type | Required | Description |
|---|---|---|---|
| RecordInterval | Integer | No | Recording interval. In seconds. Default value: 1800. Value range: 300-7200. This parameter is not valid for HLS, and a file will be generated from push start to interruption during HLS recording. |
| StorageTime | Integer | No | Recording storage period. In seconds. Value range: 0-93312000. 0: permanent storage. |
| Enable | Integer | No | Whether to enable recording in the current format. Default value: 0. 0: no, 1: yes. |
| VodSubAppId | Integer | No | VOD subapplication ID. |
| VodFileName | String | No | Recording filename. Supported special placeholders include: {StreamID}: stream ID {StartYear}: start time - year {StartMonth}: start time - month {StartDay}: start time - day {StartHour}: start time - hour {StartMinute}: start time - minute {StartSecond}: start time - second {StartMillisecond}: start time - millisecond {EndYear}: end time - year {EndMonth}: end time - month {EndDay}: end time - day {EndHour}: end time - hour {EndMinute}: end time - minute {EndSecond}: end time - second {EndMillisecond}: end time - millisecond If this parameter is not set, the recording filename will be {StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond} by default |
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. |
Rule information.
Used by actions: DescribeLiveRecordRules, DescribeLiveSnapshotRules, DescribeLiveTranscodeRules, DescribeLiveWatermarkRules.
| 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. |
Screencapturing template information.
Used by actions: DescribeLiveSnapshotTemplate, DescribeLiveSnapshotTemplates.
| Name | Type | Description |
|---|---|---|
| TemplateId | Integer | Template ID. |
| TemplateName | String | Template name. |
| SnapshotInterval | Integer | Screencapturing interval. Value range: 5-300s. |
| Width | Integer | Screenshot width. Value range: 0-3000. 0: original width and fit to the original ratio. |
| Height | Integer | Screenshot height. Value range: 0-2000. 0: original height and fit to the original ratio. |
| PornFlag | Integer | Whether to enable porn detection. 0: no, 1: yes. |
| CosAppId | Integer | COS application ID. |
| CosBucket | String | COS bucket name. |
| CosRegion | String | COS region. |
| Description | String | Template description. |
| CosPrefix | String | COS bucket folder prefix. Note: this field may return null, indicating that no valid values can be obtained. |
| CosFileName | String | COS filename. Note: this field may return null, indicating that no valid values can be obtained. |
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, such as 2019-01-07T12:00:00Z. |
| StreamEndTime | String | Push end time. In UTC format, such as 2019-01-07T15:00:00Z. |
| StopReason | String | Stop reason. |
| Duration | Integer | Push duration in seconds. |
| ClientIp | String | Host IP. |
| Resolution | String | Resolution. |
Stream name list.
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, such as 2019-01-07T12:00:00Z. |
| StreamEndTime | String | Push end time. In UTC format, such as 2019-01-07T15:00:00Z. |
| StopReason | String | Stop reason. |
| Duration | Integer | Push duration in seconds. |
| ClientIp | String | Host IP. |
| Resolution | String | Resolution. |
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. |
Transcoding template information.
Used by actions: DescribeLiveTranscodeTemplate, DescribeLiveTranscodeTemplates.
| Name | Type | Description |
|---|---|---|
| Vcodec | String | Video encoding format: h264/h265. |
| VideoBitrate | Integer | Video bitrate. Value range: 100-8000 Kbps. |
| Acodec | String | Audio codec. Valid values: aac, mp3. |
| AudioBitrate | Integer | Audio bitrate. Value range: 0-500 Kbps. |
| Width | Integer | Width. Value range: 0-3000. |
| Height | Integer | Height. Value range: 0-3000. |
| Fps | Integer | Frame rate. Value range: 0-200 FPS. |
| Gop | Integer | Keyframe interval. Value range: 1-50s. |
| Rotate | Integer | Rotation angle. Valid values: 0, 90, 180, 270. |
| Profile | String | Encoding quality. Valid values: 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 top speed codec template. 0: no, 1: yes. Default value: 0. |
| AdaptBitratePercent | Float | VideoBitrate minus top speed codec bitrate. Value range: 0.1-0.5. |
Metric value at a specified point in time.
Used by actions: DescribeScreenShotSheetNumList.
| Name | Type | Description |
|---|---|---|
| Time | String | UTC time in the format of yyyy-mm-ddTHH:MM:SSZ. |
| Num | Integer | Value. |
Transcoding details.
Used by actions: DescribeLiveTranscodeDetailInfo.
| Name | Type | Description |
|---|---|---|
| StreamName | String | Stream name. |
| StartTime | String | Start time (Beijing time) in the format of yyyy-mm-dd HH:MM. |
| EndTime | String | End time (Beijing time) in the format of yyyy-mm-dd HH:MM. |
| Duration | Integer | Transcoding duration in minutes. Note: given the possible interruptions during push, duration here is the sum of actual duration of transcoding instead of the interval between the start time and end time. |
| ModuleCodec | String | Codec with modules, Example: liveprocessor_H264: LVB transcoding - H264, liveprocessor_H265: LVB transcoding - H265, topspeed_H264: top speed codec - H264, topspeed_H265: top speed codec - H265. |
| Bitrate | Integer | Bitrate. |
| Type | String | Type. Valid values: Transcode, MixStream, WaterMark. |
| PushDomain | String | Push domain name. |
| Resolution | String | Resolution. |
Watermark information.
Used by actions: DescribeLiveWatermark, DescribeLiveWatermarks.
| Name | Type | Description |
|---|---|---|
| WatermarkId | Integer | Watermark ID. |
| PictureUrl | String | Watermark image URL. |
| XPosition | Integer | Display position: X-axis offset. |
| YPosition | Integer | Display position: Y-axis offset. |
| WatermarkName | String | Watermark name. |
| Status | Integer | Current status. 0: not used. 1: in use. |
| CreateTime | String | Creation time. |
| Width | Integer | Watermark width. |
| Height | Integer | Watermark height. |
Was this page helpful?