tencent cloud

APIs

DokumentasiAPIsStreamLiveData Types

Data Types

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-05-29 16:46:06

AVTemplate

Audio/Video transcoding template

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Name String Yes Name of an audio/video transcoding template, which can contain 1-20 case-sensitive letters and digits
NeedVideo Integer No Whether video is needed. 0: not needed; 1: needed
Vcodec String No Video codec. Valid values: H264, H265. If this parameter is left empty, the original video codec will be used.
Width Integer No Video width. The input range is (0, 4096] and must be a multiple of 2. If left blank, it represents passthrough.
Height Integer No Video height. Input range is (0, 4096] and must be a multiple of 2. Leave empty to represent passthrough.
Fps Integer No Video frame rate. Valid when you select SPECIFIED_HZ for FrameRateType. Input range is [1, 240]. Leave blank to represent passthrough.
TopSpeed String No Whether to enable top speed codec transcoding. Valid values: CLOSE (disable), OPEN (enable). Default value: CLOSE
BitrateCompressionRatio Integer No Compression ratio for top speed codec transcoding. Value range: [0, 50]. The lower the compression ratio, the higher the image quality.
NeedAudio Integer No Whether audio is needed. 0: not needed; 1: needed
Acodec String No Audio encoding format, can only be AAC or PASSTHROUGH. Default is AAC.
AudioBitrate Integer No Audio bitrate. If this parameter is left empty, the original bitrate 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
VideoBitrate Integer No Video bitrate. Value range: [50000, 40000000]. The value must be an integer multiple of 1000. If this parameter is left empty, the original bitrate will be used.
RateControlMode String No Bitrate control mode. Optional values: [CBR
WatermarkId String No Watermark ID
SmartSubtitles Integer No Whether to convert audio to text. 0 (default): No; 1: Yes.
SubtitleConfiguration String No The subtitle settings. Currently, the following subtitles are supported:
eng2eng: English speech to English text.
eng2chs: English speech to Chinese text.
eng2chseng: English speech to English and Chinese text.
chs2chs: Chinese speech to Chinese text.
chs2eng: Chinese speech to English text.
chs2chseng: Chinese speech to Chinese and English text.
FaceBlurringEnabled Integer No Whether to enable the face blur function, 1 is on, 0 is off, and the default is 0.
AudioSelectorName String No Only AttachedInputs.AudioSelectors.Name can be selected. The following types need to be filled in: 'RTP_PUSH', 'SRT_PUSH', 'UDP_PUSH', 'RTP-FEC_PUSH'.
AudioNormalization AudioNormalizationSettings No Audio transcoding special configuration information.
AudioSampleRate Integer No Audio sampling rate, unit HZ.
FrameRateType String No This field indicates how to specify the output video frame rate. If FOLLOW_SOURCE is selected, the output video frame rate is set to equal the frame rate of the first input video. If SPECIFIED_FRACTION is selected, the output video frame rate is determined by the fraction (frame rate numerator and frame rate denominator). If SPECIFIED_HZ is selected, the frame rate of the output video is confirmed by the HZ you input.
FrameRateNumerator Integer No Valid when you select SPECIFIED_FRACTION as the FrameRateType. Set the output frame rate molecular.
FrameRateDenominator Integer No Valid when you select SPECIFIED_FRACTION for FrameRateType. Output frame rate denominator set.
BFramesNum Integer No Number of B-frames 1-3.
RefFramesNum Integer No Refer to the number of frames 1-16.
AdditionalRateSettings AdditionalRateSetting No Additional video bitrate configuration.
VideoCodecDetails VideoCodecDetail No Video encoding configuration.
AudioCodecDetails AudioCodecDetail No Audio encoding configuration.
MultiAudioTrackEnabled Integer No Whether to enable multiple audio tracks. 0: not required 1: required. Default value: 0.
AudioTracks Array of AudioTrackInfo No Limit on the number 0-20. Valid when MultiAudioTrackEnabled is enabled.
VideoEnhanceEnabled Integer No Whether to enable video enhancement, 1: enable 0: disable.
VideoEnhanceSettings Array of VideoEnhanceSetting No Video enhancement configuration array.
GopSize Integer No Keyframe interval, 300-10000, optional.
GopSizeUnits String No Key frame measurement unit currently only supports MILLISECONDS (ms).
ColorSpaceSettings ColorSpaceSetting No Colorspace configuration.
ForensicWatermarkIds Array of String No Traceable watermark.

AbWatermarkDetectionInfo

AbWatermarkDetectionInfo

Used by actions: DescribeWatermarkDetection, DescribeWatermarkDetections.

Name Type Required Description
TaskId String No Task ID
Type String No Types of testing
State String No State
Result String No Result
ErrorCode Integer No Error code
ErrorMsg String No Error message
InputInfo AbWatermarkInputInfo No Input information
TaskNotifyConfig TaskNotifyConfig No Task notification configuration
CreateTime Integer No Create time
UpdateTime Integer No Update time
InputFileInfo InputFileInfo No Input file information

AbWatermarkInputInfo

InputInfo

Used by actions: CreateWatermarkDetection, DescribeWatermarkDetection, DescribeWatermarkDetections.

Name Type Required Description
Type String No Input type, optional URL/COS, currently only supports URL
UrlInputInfo UrlInputInfo No URL input information

AbWatermarkSettingsReq

AB watermark configuration.

Used by actions: CreateStreamLiveWatermark, ModifyStreamLiveWatermark.

Name Type Required Description
Type String No Optional values: A/B.

AbWatermarkSettingsResp

AbWatermarkSettingsResp

Used by actions: DescribeStreamLiveWatermark, DescribeStreamLiveWatermarks.

Name Type Description
Type String AB watermark type.
Content String Watermark payload.

AdBreakSetting

AdBreakSetting

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
Format String No Advertising type, currently supports L-SQUEEZE
Duration Integer No Duration, in milliseconds, requires 1000<duration<=600000 The current accuracy is seconds, which is a multiple of 1000
AdSource String No AdSource type, supports UPLOAD_CREATIVES
LSqueezeSetting LSqueezeSetting No L-type compression recovery configuration
PipSetting PipSetting No
BorderFrameSetting BorderFrameSetting No

AdditionalRateSetting

Additional bitrate configuration for video template.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
VideoMaxBitrate Integer No The maximum bitrate in the VBR scenario must be a multiple of 1000 and between 50000 and 40000000.
BufferSize Integer No Cache configuration supports configuration as 1-4x the Max Bitrate value.
QualityLevel Integer No Valid in VBR scenarios. Video quality level. Only supports user input of numbers between 1 and 51.

AmazonS3Settings

Amazon S3 address configuration

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
AccessKeyID String No Access key ID of the S3 sub-user.
SecretAccessKey String No Secret access key of the S3 sub-user.
Region String No S3 region.
Bucket String No Bucket name of S3.
FilePath String No File output path, can be empty, starts and ends with / if not empty.
FileName String No User-defined name supports 1 to 32 characters consisting of digits, letters, underscores (_), and hyphens (-).
FileExt String No File suffix only supports jpg.
TimeFormat String No Support [unix

AttachedInput

Channel-associated input

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Id String Yes Input ID
AudioSelectors Array of AudioSelectorInfo No Audio selector for the input. There can be 0 to 20 audio selectors.
Note: this field may return null, indicating that no valid value was found.
PullBehavior String No Pull mode. If the input type is HLS_PULL or MP4_PULL, you can set this parameter to LOOP or ONCE. LOOP is the default value.
Note: this field may return null, indicating that no valid value was found.
FailOverSettings FailOverSettings No Input failover configuration
Note: this field may return null, indicating that no valid value was found.
CaptionSelectors Array of CaptionSelector No Subtitle selector.
Note: This field may return null, indicating that no valid values can be obtained.

AudioCodecDetail

Audio codec configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
ChannelMode String No Sound track configuration. Available values: MONO, STEREO, 5.1.
Profile String No Level in aac, available values: "LC", "HE-aac", "HE-AACV2".

AudioNormalizationSettings

Special configuration information for audio transcoding.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
AudioNormalizationEnabled Integer No Whether to enable special configuration for audio transcoding: 1: Enable 0: Disable, the default value is 0.
TargetLUFS Float No Loudness value, floating-point number, rounded to one decimal place, range -5 to -70.

AudioPidSelectionInfo

Audio Pid selection.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Pid Integer No Audio Pid. Default value: 0.

AudioPipelineInputStatistics

Pipeline input audio statistics.

Used by actions: DescribeStreamLiveChannelInputStatistics.

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.

AudioSelectorInfo

Audio selector.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Name String Yes Audio name, which can contain 1-32 letters, digits, and underscores.
AudioPidSelection AudioPidSelectionInfo No Audio Pid selection.
AudioSelectorType String No Audio input type. Value range: 'PID_SELECTOR'
AudioTrackSelection InputTracks No AudioTrack configuration.

AudioTemplateInfo

Audio transcoding template.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

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 encoding format, can only be AAC or PASSTHROUGH. Default is 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, length 2-20.
AudioNormalization AudioNormalizationSettings No Audio transcoding special configuration information.
AudioSampleRate Integer No Audio sampling rate, unit HZ.
AudioCodecDetails AudioCodecDetail No Audio encoding parameters.
LanguageDescription String No Audio language description, maximum length 100

AudioTrackInfo

Audio track configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
TrackName String No User input, limited to letters and digits, length not exceeding 20, non-repeating in the same channel.
AudioCodec String No Audio encoding format, can only be AAC or PASSTHROUGH. Default is AAC.
AudioBitrate Integer No Audio bitrate.
AudioSampleRate Integer No Audio sample rate.
AudioSelectorName String No Input Only the value defined in AttachedInputs.$.AudioSelectors.$.audioPidSelection.pid.
AudioNormalization AudioNormalizationSettings No Audio loudness configuration.
AudioCodecDetails AudioCodecDetail No Additional audio mode and sound channel configuration.

BorderFrameSetting

BorderFrameSetting

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
LiveSourceLayout SourceLayout Yes
BackgroundImgUrl String No

CaptionSelector

Subtitle selector.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Name String No Digits, uppercase and lowercase letters, underscore, length 1-32.
CaptionSourceType String No Supports only SCTE-128.

ChannelAlertInfos

Channel alarm information.

Used by actions: DescribeStreamLiveChannelAlerts.

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.
PipelineAActiveAlerts Integer Pipeline 0 total active alarm count
PipelineBActiveAlerts Integer Pipeline 1 total active alarm count

ChannelInputStatistics

Channel output statistics.

Used by actions: DescribeStreamLiveChannelInputStatistics.

Name Type Description
InputId String Input ID.
Statistics InputStatistics Input statistics.

ChannelOutputsStatistics

Channel output information.

Used by actions: DescribeStreamLiveChannelOutputStatistics.

Name Type Description
OutputGroupName String Output group name.
Statistics OutputsStatistics Output group statistics.

ChannelPipelineAlerts

Channel alarm details.

Used by actions: DescribeStreamLiveChannelAlerts.

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.

ColorSpaceSetting

Colorspace configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
ColorSpace String No Colorspace, supports PASSTHROUGH (passthrough, only supports H265). Can be empty.

CosSettings

Cos address configuration

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Region String No Region of COS.
Bucket String No Bucket name of COS.
FilePath String No COS file output path, can be empty, ends with / if not empty.
FileName String No User-defined name supports 1 to 32 characters consisting of digits, letters, underscores (_), and hyphens (-).
FileExt String No COS file suffix is only supported for jpg.
TimeFormat String No Support [unix

CreateImageSettings

Watermark image settings

Used by actions: CreateStreamLiveWatermark, ModifyStreamLiveWatermark.

Name Type Required Description
ImageType String No Image file format. Valid values: png, jpg.
ImageContent String No Base64 encoded image content
Location String No Origin. Valid values: TOP_LEFT, BOTTOM_LEFT, TOP_RIGHT, BOTTOM_RIGHT.
XPos Integer No The watermark's horizontal distance from the origin as a percentage of the video width. Value range: 0-100. Default: 10.
YPos Integer No The watermark's vertical distance from the origin as a percentage of the video height. Value range: 0-100. Default: 10.
Width Integer No The watermark image's width as a percentage of the video width. Value range: 0-100. Default: 10.
0 means to scale the width proportionally to the height.
You cannot set both Width and Height to 0.
Height Integer No The watermark image's height as a percentage of the video height. Value range: 0-100. Default: 10.
0 means to scale the height proportionally to the width.
You cannot set both Width and Height to 0.

CreateTextSettings

Watermark text settings

Used by actions: CreateStreamLiveWatermark, ModifyStreamLiveWatermark.

Name Type Required Description
Text String Yes Text
Location String No Origin. Valid values: TOP_LEFT, BOTTOM_LEFT, TOP_RIGHT, BOTTOM_RIGHT.
XPos Integer No The watermark's horizontal distance from the origin as a percentage of the video width. Value range: 0-100. Default: 10.
YPos Integer No The watermark's vertical distance from the origin as a percentage of the video height. Value range: 0-100. Default: 10.
FontSize Integer No Font size. Value range: 25-50.
FontColor String No Font color, which is an RGB color value. Default value: 0x000000.

DashRemuxSettingsInfo

DASH configuration information.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

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.
H265PackageType String No The HLS package type when the H.265 codec is used. Valid values: hvc1, hev1 (default).

DeliveryRestrictionsInfo

Distribution configuration information.

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
WebDeliveryAllowed String No Corresponds to SCTE-35 web_delivery_allowed_flag parameter.
NoRegionalBlackout String No Corresponds to SCTE-35 no_regional_blackout_flag parameter.
ArchiveAllowed String No Corresponds to SCTE-35 archive_allowed_flag.
DeviceRestrictions String No Corresponds to SCTE-35 device_restrictions parameter.

DescribeImageSettings

Watermark image settings

Used by actions: DescribeStreamLiveWatermark, DescribeStreamLiveWatermarks.

Name Type Description
Location String Origin
XPos Integer The watermark image’s horizontal distance from the origin as a percentage of the video width
YPos Integer The watermark image’s vertical distance from the origin as a percentage of the video height
Width Integer The watermark image’s width as a percentage of the video width
Height Integer The watermark image’s height as a percentage of the video height

DescribeTextSettings

Watermark text settings

Used by actions: DescribeStreamLiveWatermark, DescribeStreamLiveWatermarks.

Name Type Description
Text String Text
Location String Origin
XPos Integer The watermark image's horizontal distance from the origin as a percentage of the video width
YPos Integer The watermark image's vertical distance from the origin as a percentage of the video height
FontSize Integer Font size
FontColor String Font color

DescribeTranscodeDetailInfo

Transcoding details.

Used by actions: DescribeStreamLiveTranscodeDetail.

Name Type Description
ChannelId String The channel ID.
StartTime String The start time (UTC+8) of transcoding in the format of yyyy-MM-dd HH:mm:ss.
EndTime String The end time (UTC+8) of transcoding in the format of yyyy-MM-dd HH:mm:ss.
Duration Integer The duration (s) of transcoding.
ModuleCodec String The encoding method.
Examples:
liveprocessor_H264: Live transcoding-H264
liveprocessor_H265: Live transcoding-H265
topspeed_H264: Top speed codec-H264
topspeed_H265: Top speed codec-H265
Bitrate Integer The target bitrate (Kbps).
Type String The transcoding type.
PushDomain String The push domain name.
Resolution String The target resolution.

DescribeWatermarkInfo

Watermark information

Used by actions: DescribeStreamLiveWatermark, DescribeStreamLiveWatermarks.

Name Type Description
Id String Watermark ID
Name String Watermark name
Type String Watermark type. Valid values: STATIC_IMAGE, TEXT.
ImageSettings DescribeImageSettings Watermark image settings. This parameter is valid if Type is STATIC_IMAGE.
Note: This field may return null, indicating that no valid value was found.
TextSettings DescribeTextSettings Watermark text settings. This parameter is valid if Type is TEXT.
Note: This field may return null, indicating that no valid value was found.
UpdateTime String Last modified time (UTC+0) of the watermark, in the format of 2020-01-01T12:00:00Z
Note: This field may return null, indicating that no valid value was found.
AttachedChannels Array of String List of channel IDs the watermark is bound to
Note: This field may return null, indicating that no valid value was found.
AbWatermarkSettings AbWatermarkSettingsResp AB watermark configuration.

DestinationInfo

Relay destination address.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
OutputUrl String Yes Relay destination address. Length limit: [1,512].
AuthKey String No Authentication key, length limited to [1, 128].
Username String No Authentication username, length limited to [1, 128].
Password String No Authentication password, length limited to [1, 128].
DestinationType String No The destination type for relay. Available values: Standard, AWS_MediaPackageV1, AWS_MediaPackageV2. Default: Standard. AWS_AmazonS3 or COS is supported when FrameCapture group is selected.
AmazonS3Settings AmazonS3Settings No Forward the Aws S3 address information.
CosSettings CosSettings No Forward COS address information.

DrmKey

Custom DRM key.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

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 Widevine encryption is required. Selectable options: SD/HD/UHD1/UHD2/AUDIO/ALL.
Among them, ALL represents select ALL. If ALL is specified, you cannot add other tracks.
KeyId String No KeyId for Widevine encryption, a 32-bit length hexadecimal string.
Note: The string will be modified to lowercase.
Iv String No Iv for AES encryption in Fairplay, a 32-bit length hexadecimal string.
Iv parsing reference
https://tools.ietf.org/html/rfc3826
Note: The string will be modified to lowercase.
KeyUri String No uri of the license server. AES128 is used. Can be empty.

DrmSettingsInfo

DRM configuration information, which takes effect only for HLS and DASH.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
State String No Whether DRM encryption is enabled. Option: CLOSE/OPEN. Default: CLOSE.
Currently only support HLS/DASH/HLS_ARCHIVE/DASH_ARCHIVE/HLS_MEDIAPACKAGE/DASH_MEDIAPACKAGE.
Scheme String No Optional [CustomDRMKeys
ContentId String No Scheme is CustomDRMKeys, required, filled in by the user.
Scheme is SDMCDRM, optional, defaults to ChannelId. The format supports digits, upper- and lower-case letters, hyphens, and underscores, with a length of [1, 36].
Keys Array of DrmKey No Required when Scheme is CustomDRMKeys. The content is the key customized by users.
SDMCSettings SDMCSettingsInfo No SDMC key configuration information, used when Scheme is SDMCDRM.
DrmType String No Optional type:
FAIRPLAY WIDEVINE PLAYREADY AES128
HLS-TS supports FAIRPLAY and AES128.
HLS-FMP4 supports FAIRPLAY, WIDEVINE, PLAYREADY, AES128, and permutation and combination of two or three from FAIRPLAY, WIDEVINE, PLAYREADY (use commas to concatenate, such as "FAIRPLAY,WIDEVINE,PLAYREADY").
DASH supports WIDEVINE, PLAYREADY, and the permutation and combination of PLAYREADY and WIDEVINE (use commas to concatenate, such as "PLAYREADY,WIDEVINE").

EventNotifySetting

The callback settings.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
PushEventSettings PushEventSetting No Inference stream callback configuration. Currently supports rtmp_push, rtmps_push, and rtmp_pull input types.

EventSettingsDestinationReq

Destination address information in event settings

Used by actions: CreateStreamLivePlan.

Name Type Required Description
Url String Yes URL of the COS bucket to save recording files

EventSettingsDestinationResp

Destination address information in event settings

Used by actions: DescribeStreamLivePlans.

Name Type Required Description
Url String Yes URL of the COS bucket where recording files are saved

EventSettingsReq

Configuration information of an event in the plan

Used by actions: CreateStreamLivePlan.

Name Type Required Description
EventType String Yes Valid values: INPUT_SWITCH, TIMED_RECORD, SCTE35_TIME_SIGNAL, SCTE35_SPLICE_INSERT, SCTE35_RETURN_TO_NETWORK,TIMED_METADATA,STATIC_IMAGE_ACTIVATE,STATIC_IMAGE_DEACTIVATE. If it is not specified, INPUT_SWITCH will be used.
InputAttachment String No ID of the input to attach, which is required if EventType is INPUT_SWITCH.
PipelineId Integer No When the type is FIXED_PTS, it is mandatory and defaults to 0
OutputGroupName String No Name of the output group to attach. This parameter is required if EventType is TIMED_RECORD.
ManifestName String No Name of the manifest file for timed recording, which must end with .m3u8 for HLS and .mpd for DASH. This parameter is required if EventType is TIMED_RECORD.
Destinations Array of EventSettingsDestinationReq No URL of the COS bucket to save recording files. This parameter is required if EventType is TIMED_RECORD. It may contain 1 or 2 URLs. The first URL corresponds to pipeline 0 and the second pipeline 1.
SCTE35SegmentationDescriptor Array of SegmentationDescriptorInfo No SCTE-35 configuration information.
SpliceEventID Integer No A 32-bit unique segmentation event identifier.Only one occurrence of a given segmentation_event_id value shall be active at any one time.
SpliceDuration Integer No The duration of the segment in 90kHz ticks.It used to give the splicer an indication of when the break will be over and when the network In Point will occur. If not specifyed,the splice_insert will continue when enter a return_to_network to end the splice_insert at the appropriate time.
TimedMetadataSetting TimedMetadataInfo No Meta information plan configuration.
StaticImageActivateSetting StaticImageActivateSetting No Static image activate setting.
StaticImageDeactivateSetting StaticImageDeactivateSetting No Static image deactivate setting.
MotionGraphicsActivateSetting MotionGraphicsActivateSetting No Dynamic graphic overlay activate configuration
AdBreakSetting AdBreakSetting No Ad Settings

EventSettingsResp

Configuration information of an event in the plan

Used by actions: DescribeStreamLivePlans.

Name Type Required Description
EventType String Yes Valid values: INPUT_SWITCH, TIMED_RECORD, SCTE35_TIME_SIGNAL, SCTE35_SPLICE_INSERT, SCTE35_RETURN_TO_NETWORK, STATIC_IMAGE_ACTIVATE, STATIC_IMAGE_DEACTIVATE.
InputAttachment String No ID of the input attached, which is not empty if EventType is INPUT_SWITCH
PipelineId Integer No When the type is FIXED_PTS, it is mandatory and defaults to 0
OutputGroupName String No Name of the output group attached. This parameter is not empty if EventType is TIMED_RECORD.
ManifestName String No Name of the manifest file for timed recording, which ends with .m3u8 for HLS and .mpd for DASH. This parameter is not empty if EventType is TIMED_RECORD.
Destinations Array of EventSettingsDestinationResp No URL of the COS bucket where recording files are saved. This parameter is not empty if EventType is TIMED_RECORD. It may contain 1 or 2 URLs. The first URL corresponds to pipeline 0 and the second pipeline 1.
SCTE35SegmentationDescriptor Array of SegmentationDescriptorRespInfo No SCTE-35 configuration information.
SpliceEventID Integer No A 32-bit unique segmentation event identifier.Only one occurrence of a given segmentation_event_id value shall be active at any one time.
SpliceDuration String No The duration of the segment in 90kHz ticks.It used to give the splicer an indication of when the break will be over and when the network In Point will occur. If not specifyed,the splice_insert will continue when enter a return_to_network to end the splice_insert at the appropriate time.
TimedMetadataSetting TimedMetadataInfo No Meta information plan configuration.
StaticImageActivateSetting StaticImageActivateSetting No Static image activate setting.
StaticImageDeactivateSetting StaticImageDeactivateSetting No Static image deactivate setting.
MotionGraphicsActivateSetting MotionGraphicsActivateSetting No Dynamic graphic overlay activate configuration.
AdBreakSetting AdBreakSetting No Ad Settings

FailOverSettings

Input failover settings

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
SecondaryInputId String No Input Id of the backup stream.
LossThreshold Integer No The wait time (ms) for triggering failover after the primary input becomes unavailable. Value range: [1000, 86400000]. Default value: 3000
RecoverBehavior String No Failover policy. Valid values: CURRENT_PREFERRED (default), PRIMARY_PREFERRED

FrameCaptureTemplate

Chart template.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Name String Yes Screenshot template name. Limited to uppercase and lowercase letters and digits. Length [1, 20].
Width Integer No Screenshot width. Optional. The input range is [0, 3000] and must be a multiple of 2.
Height Integer No Screenshot height, optional, input range [0, 3000], must be a multiple of 2
CaptureInterval Integer No Screenshot interval, an integer between 1 and 3600.
CaptureIntervalUnits String No Screenshot measurement unit, supports only SECONDS.
ScalingBehavior String No Stretch behavior, supports [DEFAULT
Sharpness Integer No Sharpening degree, an integer between 0 and 100.

GeneralSetting

Common configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
StaticImageSettings StaticImageSettings No Static image overlay configuration.
MotionGraphicsSettings MotionGraphicsSetting No Real-time graphic overlay configuration.
ThumbnailSettings ThumbnailSettings No Thumbnail configuration

HighlightInfo

Highlight configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
HighlightEnabled Integer No Whether to enable input recognition 0: disabled 1: enabled Default value: 0.
Type String No Products to save results. Option: COS.
Currently supports Tencent Cloud COS only. AWS S3 integration will be supported later. Default is COS.
Region String No Valid when Type is COS. Region of COS storage.
Bucket String No Valid when Type is COS. Bucket name of COS storage.
Path String No Valid when Type is COS. Path of COS storage.
Filename String No Valid when Type is COS. Name of the stored file in COS.
TimestampFormat String No Valid when Type is COS. The file extension of COS storage is automatically generated in time format. Available values: unix, utc.
unix is a second-level timestamp. utc 0 represents the year, month, day.
AudioSelectorNames Array of String No Audio selector list, selectable, can be left blank. By default, an audio is used as the output of the recognition result.

HlsRemuxSettingsInfo

HLS protocol configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
SegmentDuration Integer No Segment duration in milliseconds. Input range is [1000, 30000], default 4000, can only be a multiple of 1000.
SegmentNumber Integer No Number of shards. Input range [3, 30]. Default is 5.
PdtInsertion String No Whether to enable Pdt insertion. CLOSE/OPEN. Default is CLOSE.
PdtDuration Integer No Pdt duration in seconds. Input range (0, 3000]. Default 600.
Scheme String No Video packaging type, selectable SEPARATE
SegmentType String No Segment type, supports [ts
H265PackageType String No When the transcoding type is H265, the HLS H265 encapsulation type is selectable [hvc1
LowLatency Integer No Whether to enable low delay. 0:CLOSE. Default is 0. 1:OPEN.
PartialSegmentDuration Integer No Small slice size in milliseconds. Value ranges from 200 to SegmentDuration (integer). Default value: 500 ms.
PartialSegmentPlaySite Integer No Small slice playback position in milliseconds. Value ranges from 3PartiSegmentDuration to 3SegmentDuration (integer). Default value: 3*PartiSegmentDuration.
StreamOrder Integer No Hls master m3u8 file sorting rule by bitrate. Available values:
1: Video bitrate ascending 2: Video bitrate descending
Default value: 1
VideoResolution Integer No Whether the Hls master m3u8 file contains resolution information. Available values:
1: INCLUDE includes video resolution 2: EXCLUDE excludes video resolution.
Default value: 1.
EndListTag Integer No Whether the content contains the EXT-X-ENDLIST tag. 1: contains; 2: does not contain. Default: 1.
AdMarkupType String No Option: ENHANCED_SCTE35, DATERANGE; default ENHANCED_SCTE35.

InputAnalysisInfo

Input content identification configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
HighlightSetting HighlightInfo No Highlights configuration.

InputFileInfo

InputFileInfo

Used by actions: CreateWatermarkDetection, DescribeWatermarkDetection, DescribeWatermarkDetections.

Name Type Required Description
SegmentDuration Integer No Segment duration, in milliseconds, ranging from 1000-10000, must be a multiple of 1000. The input video duration should be between SegmentDuration * 90 and SegmentDuration * 180

InputInfo

Input information.

Used by actions: DescribeStreamLiveInput, DescribeStreamLiveInputs.

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.

InputLossBehaviorInfo

Complement the last video frame related settings.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
RepeatLastFrameMs Integer No The time to fill in the last video frame, unit ms, range 0-1000000, 1000000 means always inserting, default 0 means filling in black screen frame.
InputLossImageType String No Fill frame type, COLOR means solid color filling, IMAGE means picture filling, the default is COLOR.
ColorRGB String No When the type is COLOR, the corresponding rgb value
ImageUrl String No When the type is IMAGE, the corresponding image url value

InputSecurityGroupInfo

Input security group information.

Used by actions: DescribeStreamLiveInputSecurityGroup, DescribeStreamLiveInputSecurityGroups.

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.

InputSettingInfo

The input settings.
The format of an RTMP_PUSH/RTMPS_PUSH address is ${InputAddress}/${AppName}/${StreamName}.
The format of an SRT_PUSH address is ${InputAddress}?streamid=${StreamName},h=${InputDomain}.

Used by actions: CreateStreamLiveInput, DescribeStreamLiveInput, DescribeStreamLiveInputs, ModifyStreamLiveInput.

Name Type Required Description
AppName String No Application name, which is valid if Type is RTMP_PUSH or RTMPS_PUSH, and can contain 1-32 letters and digits
Note: This field may return null, indicating that no valid value was found.
StreamName String No Stream name, which is valid if Type is RTMP_PUSH or RTMPS_PUSH, and can contain 1-32 letters and digits
Note: This field may return null, indicating that no valid value was found.
SourceUrl String No Source URL, which is valid if Type is RTMP_PULL, HLS_PULL, MP4_PULL, RTSP_PULL or SRT_PULL, and can contain 1-512 characters
Note: This field may return null, indicating that no valid value was found.
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.
SourceType String No Source type for stream pulling and relaying. To pull content from private-read COS buckets under the current account, set this parameter to TencentCOS; otherwise, leave it empty.
Note: this field may return null, indicating that no valid value was found.
DelayTime Integer No Delayed time (ms) for playback, which is valid if Type is RTMP_PUSH or RTMPS_PUSH.
Value range: 0 (default) or 10000-600000.
The value must be a multiple of 1,000.
Note: This field may return null, indicating that no valid value was found.
InputDomain String No The domain name of the SRT_PUSH push address. No need to fill in the input parameter.
UserName String No The username, which is used for authentication.
Note: This field may return null, indicating that no valid value was found.
Password String No The password, which is used for authentication.
Note: This field may return null, indicating that no valid value was found.
ContentType String No This parameter is valid when the input source is HLS_PULL and MP4_PULL. It indicates the type of file the source is. The optional values are: LIVE, VOD. Please note that if you do not enter this parameter, the system will take the default input value VOD.

InputStatistics

Input statistics.

Used by actions: DescribeStreamLiveChannelInputStatistics.

Name Type Description
Pipeline0 Array of PipelineInputStatistics Input statistics of pipeline 0.
Pipeline1 Array of PipelineInputStatistics Input statistics of pipeline 1.

InputStreamInfo

The input stream information.

Used by actions: QueryInputStreamState.

Name Type Description
InputAddress String The input stream address.
AppName String The input stream path.
StreamName String The input stream name.
Status Integer The input stream status. 1 indicates the stream is active.

InputTrack

Audio track configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
TrackIndex Integer No Audio track index 1-based index mapping to the specified audio track Integer starting from 1.

InputTracks

Audio track configuration list.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Tracks Array of InputTrack No Audio track configuration message.

LSqueezeSetting

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
Location Integer Yes Advertising benchmark position, 0 top left, 1 top right, 2 bottom right, 3 bottom left, default value 0, corresponding TOP_LEFT,TOP_RIGHT,BOTTOM_RIGHT,BOTTOM_LEFT
OffsetX Integer Yes The default value for the percentage in the X-axis direction is 20, with a range of 0-50
OffsetY Integer Yes The default value for the percentage in the Y-axis direction is 20, with a range of 0-50
BackgroundImgUrl String No Background image URL, starting with http/https and ending in jpg/jpeg/png
SqueezeInPeriod Integer No Compress time. Unit ms, default value 2000, range: 500-10000, SqueezeInPeriod+SqueezeOutPeriod cannot be greater than duration, included in duration
SqueezeOutPeriod Integer No Restore to full screen time. Unit ms, default value 2000, range 500-10000, SqueezeInPeriod+SqueezeOutPeriod cannot be greater than duration, included in duration

LogInfo

Log information.

Used by actions: DescribeStreamLiveChannelLogs.

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.

LogMessageInfo

Log details.

Used by actions: DescribeStreamLiveChannelLogs.

Name Type Description
StreamInfo StreamInfo Push information.
Note: this field may return null, indicating that no valid values can be obtained.

MotionGraphicsActivateSetting

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
Duration Integer No Duration in ms, valid when MOTION_Graphics_ACTIVATE, required; An integer in the range of 0-86400000, where 0 represents the duration until the end of the live stream.
Url String No The address of HTML5 needs to comply with the format specification of http/https.

MotionGraphicsSetting

Dynamic graphic configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
MotionGraphicsOverlayEnabled Integer No Whether to enable dynamic graphic overlay. 0: not enabled, 1: enabled. Default: 0.
Note: This field may return null, indicating that no valid values can be obtained.

OutputInfo

Output information.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Name String Yes Output name.
AudioTemplateNames Array of String No Audio transcoding template name array.
RTMP limit [0, 1], other limits [0, 20].
VideoTemplateNames Array of String No Video transcoding template name array, with the maximum number of [0, 1].
Scte35Settings Scte35SettingsInfo No Scte-35 information configuration.
AVTemplateNames Array of String No Audio/video transcoding template name array, with the maximum number of 1.
CaptionTemplateNames Array of String No The used subtitle template is only valid for merge template.
TimedMetadataSettings TimedMetadataSettingInfo No Meta-information control configuration.
FrameCaptureTemplateNames Array of String No Screenshot transcode template name array. Limit: 1.
NameModifier String No Modify the name of the sub-m3u8.

OutputsStatistics

Channel output statistics.

Used by actions: DescribeStreamLiveChannelOutputStatistics.

Name Type Description
Pipeline0 Array of PipelineOutputStatistics Output information of pipeline 0.
Pipeline1 Array of PipelineOutputStatistics Output information of pipeline 1.

PipSetting

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
AudioSelection String Yes
LiveSourceLayout SourceLayout Yes
AdSourceLayout SourceLayout Yes
BackgroundImgUrl String No
AdSourceUrl String No

PipelineInputSettingsInfo

Pipeline failover information.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
FaultBehavior String No Pipeline disaster recovery configuration. Value: PIPELINE_FAILOVER (mutual disaster recovery for channels if unable), PIPELINE_FILLING (channel fill automatically).
Default value: PIPELINE_FAILOVER. If failover between channels fails, auto-execute PIPELINE_FILLING. Specific content is specified by InputLossBehavior.

PipelineInputStatistics

Pipeline input statistics.

Used by actions: DescribeStreamLiveChannelInputStatistics.

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.
SessionId String Session ID
RTT Integer Rtt time, in milliseconds
NetworkValid Integer Is the Network parameter valid? 0 indicates invalid, 1 indicates valid

PipelineLogInfo

Pipeline log information.

Used by actions: DescribeStreamLiveChannelLogs.

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.

PipelineOutputStatistics

Channel output statistics.

Used by actions: DescribeStreamLiveChannelOutputStatistics.

Name Type Description
Timestamp Integer Timestamp.
In seconds, indicating data time.
NetworkOut Integer Output bandwidth in bps.
NetworkValid Integer Is the Network parameter valid? 0 indicates invalid, 1 indicates valid

PlanReq

Event configuration information

Used by actions: CreateStreamLivePlan.

Name Type Required Description
EventName String Yes Event name
TimingSettings TimingSettingsReq Yes Event trigger time settings
EventSettings EventSettingsReq Yes Event configuration

PlanResp

Event configuration information

Used by actions: DescribeStreamLivePlans.

Name Type Required Description
EventName String Yes Event name
TimingSettings TimingSettingsResp Yes Event trigger time settings
EventSettings EventSettingsResp Yes Event configuration

PlanSettings

Event settings

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
TimedRecordSettings TimedRecordSettings No Configuration message of the scheduled recording task.

PushEventSetting

The callback configuration for push events.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
NotifyUrl String Yes The callback URL (required).
NotifyKey String No The callback key (optional).

QueryDispatchInputInfo

The stream status of the queried input.

Used by actions: QueryInputStreamState.

Name Type Description
InputID String The input ID.
InputName String The input name.
Protocol String The input protocol.
InputStreamInfoList Array of InputStreamInfo The stream status of the input.

RegionInfo

Region information

Used by actions: DescribeStreamLiveRegions.

Name Type Description
Name String Region name

SDMCSettingsInfo

SDMC DRM configuration information. This parameter is valid only when Scheme is set to SDMCDRM.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Uid String Yes User ID in the SDMC DRM system
Tracks Integer Yes Tracks of the SDMC DRM system. This parameter is valid for DASH output groups.
1: audio
2: SD
4: HD
8: UHD1
16: UHD2

Default value: 31 (audio + SD + HD + UHD1 + UHD2)
SecretId String Yes Key ID in the SDMC DRM system; required
SecretKey String Yes Key in the SDMC DRM system; required
Url String Yes Key request URL of the SDMC DRM system, which is https://uat.multidrm.tv/cpix/2.2/getcontentkey by default
TokenName String Yes Token name in an SDMC key request URL, which is token by default

Scte35SettingsInfo

SCTE-35 configuration information.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Behavior String No Whether to pass through SCTE-35 information. Valid values: NO_PASSTHROUGH/PASSTHROUGH. Default value: NO_PASSTHROUGH.

SegmentationDescriptorInfo

SCTE-35 configuration information.

Used by actions: CreateStreamLivePlan.

Name Type Required Description
EventID Integer No A 32-bit unique segmentation event identifier. Only one occurrence of a given segmentation_event_id value shall be active at any one time.
EventCancelIndicator Integer No Indicates that a previously sent segmentation event, identified by segmentation_event_id, has been cancelled.
DeliveryRestrictions DeliveryRestrictionsInfo No Distribution configuration.
Duration Integer No The duration of the segment in 90kHz ticks. indicat when the segment will be over and when the next segmentation message will occur.Shall be 0 for end messages.the time signal will continue until insert a cancellation message when not specify the duration.
UPIDType Integer No Corresponds to SCTE-35 segmentation_upid_type parameter.
UPID String No Corresponds to SCTE-35 segmentation_upid.
TypeID Integer No Corresponds to SCTE-35 segmentation_type_id.
Num Integer No Corresponds to SCTE-35 segment_num. This field provides support for numbering segments within a given collection of segments.
Expected Integer No Corresponds to SCTE-35 segment_expected.This field provides a count of the expected number of individual segments within a collection of segments.
SubSegmentNum Integer No Corresponds to SCTE-35 sub_segment_num.This field provides identification for a specific sub-segment within a collection of sub-segments.
SubSegmentsExpected Integer No Corresponds to SCTE-35 sub_segments_expected.This field provides a count of the expected number of individual sub-segments within the collection of sub-segments.

SegmentationDescriptorRespInfo

SCTE-35 configuration information.

Used by actions: DescribeStreamLivePlans.

Name Type Required Description
EventID Integer No A 32-bit unique segmentation event identifier. Only one occurrence of a given segmentation_event_id value shall be active at any one time.
EventCancelIndicator Integer No Indicates that a previously sent segmentation event, identified by segmentation_event_id, has been cancelled.
DeliveryRestrictions DeliveryRestrictionsInfo No Distribution configuration.
Duration String No The duration of the segment in 90kHz ticks. indicat when the segment will be over and when the next segmentation message will occur.Shall be 0 for end messages.the time signal will continue until insert a cancellation message when not specify the duration.
UPIDType Integer No Corresponds to SCTE-35 segmentation_upid_type parameter.
UPID String No Corresponds to SCTE-35 segmentation_upid.
TypeID Integer No Corresponds to SCTE-35 segmentation_type_id.
Num Integer No Corresponds to SCTE-35 segment_num. This field provides support for numbering segments within a given collection of segments.
Expected Integer No Corresponds to SCTE-35 segment_expected.This field provides a count of the expected number of individual segments within a collection of segments.
SubSegmentNum Integer No Corresponds to SCTE-35 sub_segment_num.This field provides identification for a specific sub-segment within a collection of sub-segments.
SubSegmentsExpected Integer No Corresponds to SCTE-35 sub_segments_expected.This field provides a count of the expected number of individual sub-segments within the collection of sub-segments.

SourceLayout

SourceLayout

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
LeftOffset Integer No
RightOffset Integer No
BottomOffset Integer No

StaticImageActivateSetting

Static image activate setting.

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
ImageUrl String No The address of the image to be inserted, starting with http or https and ending with .png .PNG .bmp .BMP .tga .TGA.
Layer Integer No The layer of the superimposed image, 0-7; the default value is 0, and a higher layer means it is on the top.
Opacity Integer No Opacity, range 0-100; the default value is 100, which means completely opaque.
ImageX Integer No The distance from the left edge in pixels; the default value is 0 and the maximum value is 4096.
ImageY Integer No The distance from the top edge in pixels; the default value is 0 and the maximum value is 2160.
Width Integer No The width of the image superimposed on the video frame, in pixels. The default value is empty (not set), which means using the original image size. The minimum value is 1 and the maximum value is 4096.
Height Integer No The height of the image superimposed on the video frame, in pixels. The default value is empty (not set), which means the original image size is used. The minimum value is 1 and the maximum value is 2160.
Duration Integer No Overlay duration, in milliseconds, range 0-86400000; default value 0, 0 means continuous.
FadeIn Integer No Fade-in duration, in milliseconds, range 0-5000; default value 0, 0 means no fade-in effect.
FadeOut Integer No Fade-out duration, in milliseconds, range 0-5000; default value 0, 0 means no fade-out effect.

StaticImageDeactivateSetting

Static image deactivate setting.

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
Layer Integer No The overlay level to be canceled, range 0-7, default value 0.
FadeOut Integer No Fade-out duration, in milliseconds, range 0-5000; default value 0, 0 means no fade-out effect.

StaticImageSettings

Static image overlay configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
GlobalImageOverlayEnabled Integer No Whether global static image overlay is enabled. 0: not enabled, 1: enabled. Default value: 0.

StreamAudioInfo

Audio information.

Used by actions: DescribeStreamLiveChannelLogs.

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.

StreamInfo

Push information.

Used by actions: DescribeStreamLiveChannelLogs.

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.

StreamLiveChannelInfo

Channel information

Used by actions: DescribeStreamLiveChannel, DescribeStreamLiveChannels.

Name Type Description
Id String Channel ID
State String Channel status
AttachedInputs Array of AttachedInput Information of attached inputs
OutputGroups Array of StreamLiveOutputGroupsInfo Information of output groups
Name String Channel name
AudioTemplates Array of AudioTemplateInfo Audio transcoding templates
Note: this field may return null, indicating that no valid value was found.
VideoTemplates Array of VideoTemplateInfo Video transcoding templates
Note: this field may return null, indicating that no valid value was found.
AVTemplates Array of AVTemplate Audio/Video transcoding templates
Note: this field may return null, indicating that no valid value was found.
CaptionTemplates Array of SubtitleConf Caption templates.
PlanSettings PlanSettings Event settings
Note: This field may return null, indicating that no valid value was found.
EventNotifySettings EventNotifySetting The callback settings.
Note: This field may return null, indicating that no valid value was found.
InputLossBehavior InputLossBehaviorInfo Supplement the last video frame configuration settings.
PipelineInputSettings PipelineInputSettingsInfo Pipeline configuration.
InputAnalysisSettings InputAnalysisInfo Recognition configuration for input content.
Tags Array of Tag Console tag list.
FrameCaptureTemplates Array of FrameCaptureTemplate Frame capture templates.
GeneralSettings GeneralSetting General settings.

StreamLiveOutputGroupsInfo

Channel output group information

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Name String Yes Output group name, which can contain 1-32 case-sensitive letters, digits, and underscores and must be unique at the channel level
Type String Yes Output protocol type.
Selectable HLS/DASH/HLS_ARCHIVE/DASH_ARCHIVE/HLS_STREAM_PACKAGE/DASH_STREAM_PACKAGE/FRAME_CAPTURE/RTP/RTMP/M2TS.
Outputs Array of OutputInfo Yes Output information.
RTMP/RTP/FRAME_CAPTURE limit [1,1], HLS/DASH limit [1,10].
Destinations Array of DestinationInfo Yes Relay destinations. Quantity: [1, 2]
HlsRemuxSettings HlsRemuxSettingsInfo No HLS protocol configuration info, valid only for HLS/HLS_ARCHIVE.
DrmSettings DrmSettingsInfo No DRM configuration message.
DashRemuxSettings DashRemuxSettingsInfo No DASH protocol configuration info, valid only for DASH/DSAH_ARCHIVE.
StreamPackageSettings StreamPackageSettingsInfo No Configuration message for media encapsulation. Requires filling in when Type is related to StreamPackage.
TimeShiftSettings TimeShiftSettingsInfo No Time shift configuration information.

StreamLiveRegionInfo

StreamLive region information

Used by actions: DescribeStreamLiveRegions.

Name Type Description
Regions Array of RegionInfo List of StreamLive regions

StreamPackageSettingsInfo

StreamPackage settings when the output type is StreamPackage

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Id String Yes Channel ID in StreamPackage

StreamScte35Info

SCTE-35 information.

Used by actions: DescribeStreamLiveChannelLogs.

Name Type Description
Pid Integer SCTE-35 Pid.
Note: this field may return null, indicating that no valid values can be obtained.

StreamVideoInfo

Video information of pushed streams.

Used by actions: DescribeStreamLiveChannelLogs.

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.

SubtitleConf

Subtitle template configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Name String No Template Name
CaptionSelectorName String No Name of the subtitle selector. Required when CaptionSource is set to INPUT.
CaptionSource String No Available values: INPUT (source subtitle information), ANALYSIS (intelligent voice recognition to subtitle).
ContentType Integer No Available values: 1 Source, 2 Source+Target, 3 Target (source language only, source language + target language, target language). When the output is WebVTT, it can only output one language.
TargetType Integer No Output mode: 1 Burn in, 2 Embedded, 3 WebVTT. When CaptionSource is INPUT, it supports only 2. When CaptionSource is ANALYSIS, it supports 1, 3.
SourceLanguage String No Original speech languages: Chinese, English, Japanese, Korean.
TargetLanguage String No Target languages: Chinese, English, Japanese, Korean.
FontStyle SubtitleFontConf No Font style configuration. Required for BurnIn.
StateEffectMode String No STEADY and DYNAMIC modes correspond to steady state and non-steady state respectively. Default is STEADY. Only select STEADY when the output is WebVTT.
SteadyStateDelayedTime Integer No Steady-state delay time in seconds. Value range: 10, 20. Default: 10.
AudioSelectorName String No Audio selector name, required for speech recognition to generate WebVTT subtitles, can be empty
WebVTTFontStyle WebVTTFontStyle No Format configuration for WebVTT output in speech recognition.
LanguageCode String No Language code, length 2-20.
LanguageDescription String No Language description, length less than 100.

SubtitleFontConf

Subtitle style configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
LineSpacing Integer No Line spacing.
Margins Integer No Margin.
Lines Integer No Number of rows.
CharactersPerLine Integer No Number of characters per line.
SourceTextFont String No Original font Heiti: simhei.ttf Song Typeface: simsun.ttc Huakang Diamond Black (Dynacw Diamond Black): hkjgh.ttf Helvetica: helvetica.ttf; Needs to be set in Source or Source+Target mode.
TextColor String No Font color, represented by 6 characters in hexadecimal RGB.
BackgroundColor String No Background color, represented by 6 characters in hexadecimal RGB.
BackgroundAlpha Integer No Background opacity. A number from 0 to 100.
PreviewContent String No Preview the copywriting.
PreviewWindowHeight Integer No Preview window height.
PreviewWindowWidth Integer No Preview window width.
TranslatedTextFont String No Font for the target language. The enumeration value is the same as SourceTextFont. Case-sensitive language support for fonts. TextColor needs to be set in Target or Source+Target mode.

Tag

Console tag, documentation link: https://www.tencentcloud.com/document/product/651.?from_cn_redirect=1

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
TagKey String Yes Tag key. Refer to the tag document (https://www.tencentcloud.com/document/product/651/13354?from_cn_redirect=1) for limits.
TagValue String Yes Tag value. For reference, see the tag document at https://www.tencentcloud.com/document/product/651/13354.?from_cn_redirect=1
Category String No Tag type, optional. See the tag document for reference (https://www.tencentcloud.com/document/product/651/35327?from_cn_redirect=1#Tag).

TaskNotifyConfig

TaskNotifyConfig

Used by actions: CreateWatermarkDetection, DescribeWatermarkDetection, DescribeWatermarkDetections.

Name Type Required Description
Type String No Notification type. Currently only supports URLs
NotifyUrl String No Callback URL. Starting with http/https, supporting a maximum of 512 characters

ThumbnailSettings

Thumbnail configuration

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
ThumbnailEnabled Integer No Whether to generate thumbnails 0: disabled 1: enabled Default value: 0

TimeShiftSettingsInfo

Time-shift configuration. This parameter is valid only for HLS_ARCHIVE and DASH_ARCHIVE output groups.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
State String No Whether to enable time shifting. Option [OPEN
PlayDomain String No Enable time-shift bound domain name.
StartoverWindow Integer No The time when time-shift replay starts, in seconds, range [300, 1209600], default value 300.

TimedMetadataInfo

Transparent transmission of meta information plan configuration.

Used by actions: CreateStreamLivePlan, DescribeStreamLivePlans.

Name Type Required Description
ID3 String No Base64-encoded ID3 metadata information, with a maximum limit of 1024 characters. When both ID3 and Tag have values, the ID3 value takes precedence
Tag String No Label, the maximum supported length is 1024 characters for the label,

TimedMetadataSettingInfo

Transparent transmission of ID3 information configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Behavior Integer No Whether to pass through ID3 info. Available values:
0:NO_PASSTHROUGH, 1:PASSTHROUGH, default 0.

TimedRecordSettings

Timed recording settings

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
AutoClear String No Whether to automatically clear ended recording tasks. Options: [CLOSE

TimingSettingsReq

Event trigger time settings

Used by actions: CreateStreamLivePlan.

Name Type Required Description
StartType String Yes Event trigger type. Valid values: FIXED_TIME, IMMEDIATE,FIXED_PTS. This parameter is required if EventType is INPUT_SWITCH.
Time String No This parameter is required if EventType is INPUT_SWITCH and StartType is FIXED_TIME.
It must be in UTC format, e.g., 2020-01-01T12:00:00Z.
StartTime String No This parameter is required if EventType is TIMED_RECORD.
It specifies the recording start time in UTC format (e.g., 2020-01-01T12:00:00Z) and must be at least 1 minute later than the current time.
EndTime String No This parameter is required if EventType is TIMED_RECORD.
It specifies the recording end time in UTC format (e.g., 2020-01-01T12:00:00Z) and must be at least 1 minute later than the recording start time.
PTS Integer No Effective only when StartType is FIXED_PTS, with a range of 1-8589934592

TimingSettingsResp

Event trigger time settings

Used by actions: DescribeStreamLivePlans.

Name Type Required Description
StartType String Yes Event trigger type
Time String No Not empty if StartType is FIXED_TIME
UTC time, such as 2020-01-01T12:00:00Z
StartTime String No This parameter cannot be empty if EventType is TIMED_RECORD.
It indicates the start time for recording in UTC format (e.g., 2020-01-01T12:00:00Z) and must be at least 1 minute later than the current time.
EndTime String No This parameter cannot be empty if EventType is TIMED_RECORD.
It indicates the end time for recording in UTC format (e.g., 2020-01-01T12:00:00Z) and must be at least 1 minute later than the start time for recording.
PTS Integer No Effective only when StartType is FIXED_PTS, with a range of 1-8589934592

UrlInputInfo

UrlInputInfo

Used by actions: CreateWatermarkDetection.

Name Type Required Description
Url String No Video URL, starting with http/https, supports up to 512 characters, currently only supports complete single file videos, does not support streaming formats based on playlists and segments (such as HLS or DASH)

VideoCodecDetail

Additional configuration for video codec.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Profile String No Three image quality levels for H264, options include: BASELINE, HIGH, MAIN. The default option is MAIN.
Level String No Decoding performance of the profile. Options include 1, 1.1, 1.2, 1.3, 2, 2.1, 2.2, 2.3, 3, 3.1, 3.2, 4, 4.1, 4.2, 5, 5.1, AUTO. The default option is AUTO.
EntropyEncoding String No Encoding/decoding includes entropy encoding and lossless encoding. Options include CABAC and CAVLC. The default option is CABAC.
AdaptiveQuantization String No Mode, options include: AUTO, HIGH, HIGHER, LOW, MAX, MEDIUM, OFF. Default option: AUTO.
LookAheadRateControl String No Analyze subsequent coding frames in advance. Options include HIGH, LOW, and MEDIUM. Default option is MEDIUM.

VideoEnhanceSetting

Video enhancement configuration

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
Type String Yes Video enhancement type. Option: "GameEnhance", "ColorEnhance", "Debur", "Comprehensive", "Denoising", "SR", "OutdoorSportsCompetitions", "IndoorSportsCompetitions", "ShowEnhance".
Strength Float Yes Video enhancement intensity, 0-1.0, granularity 0.1

VideoPipelineInputStatistics

Pipeline input video statistics.

Used by actions: DescribeStreamLiveChannelInputStatistics.

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.

VideoTemplateInfo

Video transcoding template.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

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. The input range is (0, 4096] and must be a multiple of 2. If left blank, it represents passthrough.
Height Integer No Video height. Input range is (0, 4096] and must be a multiple of 2. Leave empty to represent passthrough.
Fps Integer No Video frame rate. Valid when you select SPECIFIED_HZ for FrameRateType. Input range is [1, 240]. Leave blank to represent passthrough.
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.
RateControlMode String No Bitrate control mode. Optional values: [CBR
WatermarkId String No Watermark Id.
FaceBlurringEnabled Integer No Whether to enable the face blur function, 1 is on, 0 is off, and the default is 0.
FrameRateType String No This field indicates how to specify the output video frame rate. If selected FOLLOW_SOURCE, the output video frame rate is set to equal the frame rate of the first input video. If selected SPECIFIED_FRACTION, the output video frame rate is determined by the fraction (frame rate molecular and frame rate denominator). If selected SPECIFIED_HZ, the frame rate of the output video is determined by the HZ you input.
FrameRateNumerator Integer No Valid when you select SPECIFIED_FRACTION as the FrameRateType. Set the output frame rate molecular.
FrameRateDenominator Integer No Valid when you select SPECIFIED_FRACTION for FrameRateType. Output frame rate denominator set.
BFramesNum Integer No Number of B-frames 1-3.
RefFramesNum Integer No Refer to the number of frames 1-16.
AdditionalRateSettings AdditionalRateSetting No Additional video bitrate configuration.
VideoCodecDetails VideoCodecDetail No Video encoding configuration.
VideoEnhanceEnabled Integer No Video enhancement switch, 1: enable 0: disable.
VideoEnhanceSettings Array of VideoEnhanceSetting No Video enhancement parameters array.
ColorSpaceSettings ColorSpaceSetting No Colorspace configuration.
ForensicWatermarkIds Array of String No Traceable watermark.

WebVTTFontStyle

WebVTT format configuration.

Used by actions: CreateStreamLiveChannel, DescribeStreamLiveChannel, DescribeStreamLiveChannels, ModifyStreamLiveChannel.

Name Type Required Description
TextColor String No Text color, 6 hexadecimal characters in RGB (not required #).
BackgroundColor String No Background color, 6 hexadecimal characters in RGB (not required #)
BackgroundAlpha Integer No Background opacity parameter. A number from 0 to 100. The default value is 0 (fully transparent).
FontSize Integer No Font size, in vh (1% of height), default value 0 means auto.
Line String No The position of the text box, default value AUTO, can be empty; it represents the percentage of video height and supports integers from 0 to 100.
LineAlignment String No The alignment mode of the text box on the Line. Available values: START, CENTER, END. Default: START. Can be blank.
Position String No The position of the text box in another direction is a percentage of the video width or height, defaults to AUTO, and can be empty.
PositionAlignment String No The alignment mode of the text box on Position. Available values: LINE_LEFT, LINE_RIGHT, CENTER, AUTO. Default value: AUTO. Can be empty.
CueSize String No The size of the text box, a percentage of video width/height, value (0, 100], default AUTO, can be empty.
TextAlignment String No Text alignment mode, available values START, CENTER, END, LEFT, RIGHT; default value CENTER, can be empty.
Topik sebelumnya: QueryInputStreamStateTopik selanjutnya: Error Codes

Bantuan dan Dukungan

Apakah halaman ini membantu?

masukan