Alias-value configuration information.
Used by actions: CreateStreamPackageChannelEndpoint, ModifyStreamPackageChannelEndpoint.
Name | Type | Required | Description |
---|---|---|---|
Alias | String | No | Alias. |
Value | String | No | Value. |
Cache configuration
Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels, ModifyStreamPackageChannel.
Name | Type | Required | Description |
---|---|---|---|
Info | Array of CacheInfoInfo | No | List of timeout parameter configuration Note: this field may return null , indicating that no valid value was found. |
Timeout information for cache configuration
Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels, ModifyStreamPackageChannel.
Name | Type | Required | Description |
---|---|---|---|
Timeout | Integer | Yes | Timeout period (ms), which must be an integer multiple of 1000 .m3u8/.mpd: [1000, 60000] .ts/.m4s/.mp4: [10000, 1800000] |
Ext | String | No | File extension. Valid values: .m3u8, .ts, .mpd, .m4s, .mp4 Note: this field may return null , indicating that no valid value was found. |
Channel information.
Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels.
Name | Type | Description |
---|---|---|
Id | String | Channel ID. |
Name | String | Channel name. |
Protocol | String | Channel protocol. |
Points | PointInfo | Channel input and output. |
CacheInfo | CacheInfo | Cache configuration Note: this field may return null , indicating that no valid value was found. |
Parameter configuration.
Used by actions: CreateStreamPackageChannelEndpoint, ModifyStreamPackageChannelEndpoint.
Name | Type | Required | Description |
---|---|---|---|
ParamName | String | No | parameter name. |
AliasValueList | Array of AliasValueConf | No | Alias-value configuration. |
The authentication information of channel endpoints.
Used by actions: CreateStreamPackageChannelEndpoint, ModifyStreamPackageChannelEndpoint.
Name | Type | Required | Description |
---|---|---|---|
WhiteIpList | Array of String | No | The security group allowlist in CIDR format. Note: this field may return null, indicating that no valid values can be obtained. |
BlackIpList | Array of String | No | The security group blocklist in CIDR format. Note: this field may return null, indicating that no valid values can be obtained. |
AuthKey | String | No | The authentication key. Its value is same as X-TENCENT-PACKAGE set in the HTTP request header.Note: this field may return null, indicating that no valid values can be obtained. |
Channel endpoint information.
Used by actions: CreateStreamPackageChannel, CreateStreamPackageChannelEndpoint, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels.
Name | Type | Description |
---|---|---|
Name | String | Endpoint name. |
Url | String | Endpoint URL. |
AuthInfo | EndpointAuthInfo | Endpoint authentication information. |
Protocol | String | Endpoint protocol. |
Manifest | String | Manifest name, default is main. |
TimeShiftEnable | Boolean | Whether to turn on the time shift function, true: on, false: off, the default is off. |
TimeShiftDuration | Integer | The number of days in the time shift window, up to 30 days. Valid when TimeShiftEnable is turned on. |
SSAIEnable | Boolean | Advertising insertion function switch. |
SSAIInfo | SSAIConf | Ad insertion function configuration information. |
CustomUrlParamIndex | Integer | The customer-defined url parameter is inserted into the subscript at the specified position of the Endpoint url. The optional range of the subscript is: [0,3]. |
CustomUrlParam | String | Customer-defined url parameters are inserted into the specified position of the Endpoint url based on the CustomUrlParamIndex. The parameters can only contain digits, letters, underscores (_), and hyphens (-), with a length of 1 to 64 chars. |
HarvestJob response info.
Used by actions: CreateStreamPackageHarvestJob, DescribeStreamPackageHarvestJob, DescribeStreamPackageHarvestJobs.
Name | Type | Description |
---|---|---|
ID | String | HarvestJob ID, a globally unique identifier. |
ChannelName | String | The associated channel name. |
EndpointName | String | The associated endpoint name. |
TimeFormat | String | Time format, supports the following types: 1. Epoch seconds 2. ISO-8601 |
StartTime | String | HarvestJob start time. |
EndTime | String | HarvestJob end time. |
Destination | String | The path where the recording file is stored in COS. |
Manifest | String | The file name of the recording file stored in COS. |
Status | String | The task status is divided into running: Running, execution completed: Completed, and execution failure: Failed. |
ErrMessage | String | HarvestJob error message. |
CreateTime | Integer | HarvestJob creation time, timestamp in seconds. |
ChannelId | String | The associated ChannelID. |
Region | String | The region corresponding to the harvest job. |
Channel input authentication information.
Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels, ModifyStreamPackageChannelInputAuthInfo.
Name | Type | Description |
---|---|---|
Username | String | Username. Note: this field may return null, indicating that no valid values can be obtained. |
Password | String | Password. Note: this field may return null, indicating that no valid values can be obtained. |
Channel input.
Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels.
Name | Type | Description |
---|---|---|
Url | String | Channel input URL. Note: this field may return null, indicating that no valid values can be obtained. |
AuthInfo | InputAuthInfo | Channel input authentication information. |
Channel input and output.
Used by actions: CreateStreamPackageChannel, DeleteStreamPackageChannels, DescribeStreamPackageChannel, DescribeStreamPackageChannels.
Name | Type | Description |
---|---|---|
Inputs | Array of InputInfo | Channel input list. |
Endpoints | Array of EndpointInfo | Channel output list. Note: this field may return null, indicating that no valid values can be obtained. |
SSAI ad insertion configuration.
Used by actions: CreateStreamPackageChannelEndpoint, ModifyStreamPackageChannelEndpoint.
Name | Type | Required | Description |
---|---|---|---|
AdsUrl | String | No | Advertising Decision Server URL (ADS). |
ConfigAliases | Array of ConfigAliasesInfo | No | Parameter configuration. |
SlateAd | String | No | Default advertising url. |
Threshold | Integer | No | Maximum unfilled duration, unit: seconds. |
DashMPDLocation | Boolean | No | Whether to enable mpd location, true corresponds to enable, false corresponds to disable. |
AdMarkerPassthrough | Boolean | No | Whether to enable transparent transmission of advertising tags. |
SCTE35AdType | Integer | No | How to process tags in advertisements, optional values: [1,2] 1: Process all SCTE-35 type tags - all (default) 2: SCTE-35enhanced, parse some types. |
AdTriggers | Array of Integer | No | The type of tag that is regarded as an advertisement, optional values: [1,8] 1. Splice insert 2. Provider advertisement 3. Distributor advertisement 4. Provider placement opportunity 5. Distributor placement opportunity 6. Break 7. Provider overlay placement opportunity 8. Distributor overlay placement opportunity. |
DeliveryRestrictions | Integer | No | The type of distribution restriction that is considered an advertisement, optional values: [1,4] 1:None 2:Restricted (default) 3:Unrestricted 4.Both. |
Was this page helpful?