International
中国站
Console
PrevNext
search by keyword

Recent Pages

Documentation
Documentation

Data Types

Last updated: 2021-04-15 16:25:49

BandwidthInfo

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.

BillAreaInfo

Region information, DescribeAreaBillBandwidthAndFluxList output parameter

Used by actions: DescribeAreaBillBandwidthAndFluxList.

Name Type Description
Name String Region name
Countrys Array of BillCountryInfo Detailed country information

BillCountryInfo

The bandwidth information of a country, DescribeAreaBillBandwidthAndFluxList output parameter

Used by actions: DescribeAreaBillBandwidthAndFluxList.

Name Type Description
Name String Country
BandInfoList Array of BillDataInfo Detailed bandwidth information

BillDataInfo

Bandwidth and traffic information.

Used by actions: DescribeAreaBillBandwidthAndFluxList, 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.

CallBackRuleInfo

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.

CallBackTemplateInfo

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.

CdnPlayStatData

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.

CertInfo

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: user-added certificate
1: Tencent Cloud-hosted certificate
CertExpireTime String Certificate expiration time in UTC format.
DomainList Array of String List of domain names that use this certificate.

ClientIpPlaySumInfo

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.

CommonMixControlParams

General stream mix control parameter

Used by actions: CreateCommonMixStream.

Name Type Required Description
UseMixCropCenter Integer No Value range: [0,1].
If 1 is entered, when the layer resolution in the parameter is different from the actual video resolution, the video will be automatically cropped according to the resolution set by the layer.
AllowCopy Integer No Value range: [0,1].
If this parameter is set to 1, when both InputStreamList and OutputParams.OutputStreamType are set to 1, you can copy a stream instead of canceling it.

CommonMixCropParams

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].

CommonMixInputParam

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.

CommonMixLayoutParams

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.

CommonMixOutputParams

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.

ConcurrentRecordStreamNum

Number of concurrent recording channels

Used by actions: DescribeConcurrentRecordStreamNum, DescribeUploadStreamNums.

Name Type Description
Time String Time point.
Num Integer Number of channels.

DayStreamPlayInfo

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.

DelayInfo

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.

DomainCertInfo

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.
CertDomains Array of String List of domain names in the certificate.
["*.x.com"] for example.
Note: this field may return null, indicating that no valid values can be obtained.
CloudCertId String Tencent Cloud SSL certificate ID.
Note: this field may return null, indicating that no valid values can be obtained.

DomainDetailInfo

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.

DomainInfo

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.

DomainInfoList

Multi-domain name information list

Used by actions: DescribeLiveDomainPlayInfoList.

Name Type Description
Domain String Domain name.
DetailInfoList Array of DomainDetailInfo Details.

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.

GroupProIspDataInfo

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.

HlsSpecialParam

HLS-specific recording parameter

Used by actions: CreateLiveRecordTemplate, DescribeLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate.

Name Type Required Description
FlowContinueDuration Integer No Timeout period for restarting an interrupted HLS push.
Value range: [0, 1,800].

HttpCodeInfo

HTTP return code and statistics

Used by actions: DescribePlayErrorCodeDetailInfoList.

Name Type Description
HttpCode String</