History
Introduction
API Category
Making API Requests
Region APIs
Instance APIs
Cloud Hosting Cluster APIs
Image APIs
Instance Launch Template APIs
Placement Group APIs
Key APIs
Security Group APIs
Network APIs
Data Types
Error Codes
AdBreakInfo.
Used by actions: CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms, ModifyStreamPackageLinearAssemblyProgram.
| Name | Type | Required | Description |
|---|---|---|---|
| SourceLocationId | String | No | SourceLocationId. |
| VodSourceName | String | No | VodSourceName. |
| Offset | Integer | No | Offset. |
| MessageType | String | No | MessageType, divided into SpliceInsert and TimeSignal. |
| TimeSignalConf | TimeSignalInfo | No | TimeSignalConf. |
| SpliceInsertConf | SpliceInsertInfo | No | SpliceInsertConf. |
| Metadatas | Array of Metadata | No | Metadatas. |
| SourceLocationName | String | No | SourceLocationName. |
Alias-value configuration information.
Used by actions: CreateStreamPackageSSAIChannel, ModifyStreamPackageChannelEndpoint, ModifyStreamPackageSSAIChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Alias | String | No | Alias. |
| Value | String | No | Value. |
Channel-associated domain information list.
Used by actions: DescribeLinearAssemblyCDNDomainWithChannel, DescribeLinearAssemblyCDNDomainWithChannels.
| Name | Type | Description |
|---|---|---|
| TotalSize | Integer | Total list size. |
| Records | Array of DomainRecordInfo | List of associated domain name information. |
Linear assembly channel alarm return information.
Used by actions: DescribeStreamPackageLinearAssemblyChannelAlerts.
| Name | Type | Description |
|---|---|---|
| ProgramAlertCounts | Array of ProgramAlertCounts | Program alarm aggregation information. |
| ProgramAlertInfos | Array of ProgramAlertInfos | Program alarm details. |
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. |
Spacer configuration.
Used by actions: CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms, ModifyStreamPackageLinearAssemblyProgram.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | The vod type is valid, the content is valid starting time, Entire and SpecifyTimeRange are optional. |
| StartOffset | Integer | No | Start offset, Valid when the Type is SpecifyTimeRange. |
| EndOffset | Integer | No | End offset, valid when Type is SpecifyTimeRange. |
Parameter configuration.
Used by actions: CreateStreamPackageSSAIChannel, ModifyStreamPackageChannelEndpoint, ModifyStreamPackageSSAIChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| ParamName | String | No | parameter name. |
| AliasValueList | Array of AliasValueConf | No | Alias-value configuration. |
cos input information
Used by actions: CreateStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTasks.
| Name | Type | Required | Description |
|---|---|---|---|
| Bucket | String | Yes | COS bucket name |
| Region | String | Yes | Region |
| Object | String | Yes | File object path |
VOD remux task cos output storage.
Used by actions: CreateStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTasks.
| Name | Type | Required | Description |
|---|---|---|---|
| Bucket | String | Yes | cos bucket name. |
| Region | String | Yes | region name of your cos bucket. |
| OutputDir | String | Yes | cos directory of vod remux task result. |
DRM configure info.
Used by actions: CreateStreamPackageChannelEndpoint, ModifyStreamPackageChannelEndpoint.
| Name | Type | Required | Description |
|---|---|---|---|
| EncryptionMethod | String | No | Encryption method, optional values: CBCS, CENC. |
| DRMSystems | Array of String | No | DRM system providers, when the encryption method is CBCS, the optional values are PlayReady, Widevine, FairPlay; when the encryption method is CENC, the oprional values are PlayReady, Widevine. |
| ResourceID | String | No | The resource ID sent to the key server. It can contain 1 to 128 characters, including numbers, letters, underscores (_), and hyphens (-). |
| KeyServerUrl | String | No | Key server address; must start with https://. |
| VideoEncryptionPreset | String | No | Video encryption presets, options: Preset Video 1 - Encrypts all video tracks with one keyPreset Video 2 - Encrypts SD and HD video tracks with 2 different keysPreset Video 3 - Encrypts SD, HD and UHD video tracks with 3 different keysPreset Video 4 - Encrypts SD, HD, UHD1 and UHD2 video tracks with 4 different keysPreset Video 5 - Encrypts SD, HD1, HD2, UHD1 and UHD2 video tracks with 5 different keysPreset Video 6 - Encrypts SD, HD1, HD2, UHD video tracks with 4 different keysPreset Video 7 - Encrypts SD + HD1, HD2, UHD video tracks with 3 different keysPreset Video 8 - Encrypts SD + HD1, HD2, UHD1, UHD2 video tracks with 4 different keysShared - Encrypts all video and audio tracks with one keyUnencrypted - Does not encrypt any track |
| AudioEncryptionPreset | String | No | Audio encryption presets, options:Preset Audio 1 - Encrypts all audio tracks with one keyPreset Audio 2 - Encrypts STEREO and MULTICHANNEL audio tracks with 2 different keysPreset Audio 3 - Encrypts STEREO, MULTICHANNEL 3-6 and MULTICHANNEL 7 audio tracks with 3 different keysShared - Encrypts all video and audio tracks with one keyUnencrypted - Does not encrypt any track |
| ConstantInitializationVector | String | No | Optional, used together with the key to encrypt the content; a 128-bit, 32-character, hexadecimal-encoded string. |
| KeyRotationInterval | Integer | No | Optional, specifies the rotation interval in seconds; empty, or an integer between 300-2592000. |
The manifest info used when Type is DASH.
Used by actions: CreateStreamPackageLinearAssemblyChannel, ModifyStreamPackageLinearAssemblyChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Windows | Integer | No | The total duration of each manifest in seconds. [30, 3600], type: integer, default value 60. |
| MinBufferTime | Integer | No | The minimum cache time (in seconds) that the player keeps in the buffer. [2, 60], type: integer, default value 30. |
| MinUpdatePeriod | Integer | No | The minimum time (in seconds) that the player should wait before requesting an update to the manifest. [2, 60], type: integer, default value 2. |
| SuggestedPresentationDelay | Integer | No | The time from the latest live broadcast time point when the player starts broadcasting is a rollback amount (in seconds). [2, 60], type: integer, default value 10. |
Channel-associated domain record information.
Used by actions: DescribeLinearAssemblyCDNDomainWithChannel, DescribeLinearAssemblyCDNDomainWithChannels.
| Name | Type | Description |
|---|---|---|
| CdnDomain | String | Associated playback domain name. |
| Region | String | Belonging region. |
| ChannelId | String | Channel ID. |
| Id | String | The ID of a record |
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, supports HLS, CMAF, CMAF-HLS. |
| 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. |
| DRMEnabled | Boolean | DRM switch. If it is turned on, only CMAF will take effect. |
| DRMInfo | DRMInfo | DRM configuration information. |
| AbsolutePathEnable | Boolean | The switch of absolute path. |
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. |
| CallbackURL | String | Callback URL after recording is completed |
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. |
VOD remux task input file information.
Used by actions: CreateStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTasks.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | Input file Type. The input types include COS and URL. |
| CosInputInfo | CosInputInfo | No | cos input informations. |
| Url | String | No | input file url. |
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. |
Linearly assembled channel information.
Used by actions: CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Linear assembly channel name. |
| Tier | String | No | Define the characteristics of the channel. Standard supports live broadcast and on-demand sources, while Basic only supports on-demand source arrangement. |
| PlaybackMode | String | No | The source switching mode in the channel is divided into Linear and Loop. Live broadcast only supports Linear. |
| TimeShiftConf | TimeShiftInfo | No | Time shift configuration, vod is valid. |
| SlateConf | SlateInfo | No | Spacer configuration. |
| Outputs | Array of OutputInfo | No | output information. |
| AttachedPrograms | Array of String | No | List of programs bound to this channel. |
| ProgramSchedules | Array of ProgramScheduleInfo | No | program information. |
| Id | String | No | ID. |
| Region | String | No | Region. |
| State | String | No | State. |
| TimeShiftEnable | Boolean | No | Time shift on switch. |
| CreateTime | Integer | No | Channel creation time, unix seconds timestamp. |
Channel linear assembly program information.
Used by actions: CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | Channel linear assembly program information. |
| SourceType | String | No | The type of the arrangement target source, divided into live broadcast and on-demand. |
| SourceLocationId | String | No | The associated source location id. |
| SourceId | String | No | SourceId, uniquely identifies a source. |
| SourceName | String | No | The associated live broadcast or on-demand broadcast, source name, and location are globally unique. |
| AttachedChannel | String | No | The bound channel. |
| PlaybackConf | PlaybackInfo | No | Play configuration. |
| AdBreaks | Array of AdBreakInfo | No | AdBreaks. |
| Id | String | No | ID. |
| Region | String | No | Region. |
| SourceLocationName | String | No | SourceLocation name. |
Channel Linear Assembly Location Alarm Information.
Used by actions: DescribeStreamPackageSourceLocationAlerts.
| Name | Type | Description |
|---|---|---|
| LocationId | String | Location ID. |
| Code | Integer | Alarm event code. |
| Category | String | Alarm classification. |
| Message | String | Alarm message. |
| LastModifiedTime | Integer | Update time. |
| LocationName | String | Location name. |
Linear assembly channel configuration.
Used by actions: CreateStreamPackageLinearAssemblyChannel, ModifyStreamPackageLinearAssemblyChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Windows | Integer | No | Time window, in seconds. |
| AdMarkupType | String | No | Enter the format of the output advertising tag. Optional values are: Date Range and Enhanced SCTE-35. |
Metadata.
Used by actions: CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms, ModifyStreamPackageLinearAssemblyProgram.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | Key. |
| Value | String | No | Value. |
Custom server information.
Used by actions: CreateStreamPackageSourceLocation, ModifyStreamPackageSourceLocation.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | name. |
| Url | String | No | address. |
Channel linear assembly output information.
Used by actions: CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels, ModifyStreamPackageLinearAssemblyChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | HLS DASH. |
| GroupName | String | No | The output group name can be associated with the source group name. |
| ManifestName | String | No | The file name output by the channel program after scheduling. |
| ManifestConf | ManifestInfo | No | The manifest info, used when Type is HLS. |
| PlaybackURL | String | No | Playback address. |
| DashManifestConf | DashManifestInfo | No | The manifest info, used when Type is DASH. |
Channel linear assembly output information.
Used by actions: CreateStreamPackageLinearAssemblyChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | No | Output type, distinguish HLS DASH. |
| GroupName | String | No | The output group name can be associated with the source group name. |
| ManifestName | String | No | The file name output by the channel program after scheduling. |
| ManifestConf | ManifestInfo | No | The manifest info, used when Type is HLS. |
| DashManifestConf | DashManifestInfo | No | The manifest info, used when Type is DASH. |
VOD remux task Output Storage.
Used by actions: CreateStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTasks.
| Name | Type | Required | Description |
|---|---|---|---|
| Type | String | Yes | VOD remux task output storage type. Only support COS type. |
| CosOutputStorage | CosOutputStorage | Yes | cos output storage information. |
program playback configuration.
Used by actions: CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms.
| Name | Type | Required | Description |
|---|---|---|---|
| Duration | Integer | No | Program duration, in milliseconds, valid for live broadcast. |
| TransitionType | String | No | Program startup method, live broadcast only supports Absolute, on-demand also supports Relative. |
| StartTime | Integer | No | Unix timestamp, the start execution time of the program in the Absolute scenario. |
| RelativePosition | String | No | It is related to the insertion order of the selected program, divided into After and Before. |
| RelativeProgramId | String | No | The selected insertion reference program id. |
| ClipRangeConf | ClipRangeInfo | No | Spacer configuration. |
| RelativeProgramName | String | No | RelativeProgramName. |
program playback configuration request.
Used by actions: CreateStreamPackageLinearAssemblyProgram, ModifyStreamPackageLinearAssemblyProgram.
| Name | Type | Required | Description |
|---|---|---|---|
| TransitionType | String | No | Program startup method, live broadcast only supports Absolute, on-demand also supports Relative. Optional values: Absolute, Relative. |
| StartTime | Integer | No | Unix timestamp, the start execution time of the program in absolute scenarios. |
| Duration | Integer | No | Program duration, in milliseconds, valid for live broadcast. |
| RelativePosition | String | No | It is related to the insertion order of the selected program, divided into After and Before. |
| RelativeProgramId | String | No | The selected insertion reference program id. |
| ClipRangeConf | ClipRangeInfo | No | Spacer configuration. |
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. |
Channel Linear Assembly Program Aggregation Alarm Information
Used by actions: DescribeStreamPackageLinearAssemblyChannelAlerts.
| Name | Type | Description |
|---|---|---|
| ProgramId | String | Program ID. |
| ProgramName | String | Program name. |
| Category | String | Alarm classification. |
| Count | Integer | The number of occurrences |
| LastModifiedTime | Integer | Update time. |
Channel linear assembly program alarm information details.
Used by actions: DescribeStreamPackageLinearAssemblyChannelAlerts.
| Name | Type | Description |
|---|---|---|
| ChannelId | String | Channel ID. |
| ChannelName | String | Channel name. |
| ProgramId | String | ProgramID. |
| ProgramName | String | ProgramName. |
| Code | Integer | Alarm event code. |
| Category | String | Alarm classification. |
| Message | String | Alarm message. |
| LastModifiedTime | Integer | Update time. |
The scheduling information of the Program under this channel.
Used by actions: CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels.
| Name | Type | Required | Description |
|---|---|---|---|
| ProgramName | String | No | program name. |
| ProgramId | String | No | program id. |
| SourceType | String | No | source type. |
| SourceId | String | No | source id. |
| SourceLocationId | String | No | The id of the source location. |
| StartTime | Integer | No | Start timestamp. |
| Duration | String | No | Duration. |
Ad insertion channel configuration information.
Used by actions: CreateStreamPackageSSAIChannel, DescribeStreamPackageSSAIChannel, DescribeStreamPackageSSAIChannels.
| Name | Type | Required | Description |
|---|---|---|---|
| ID | String | No | SSAI configuration ID, globally unique identifier |
| Name | String | No | Configuration name |
| ContentSource | String | No | Content source stream prefix |
| PlaybackPrefix | String | No | Generated playback address prefix |
| SSAIInfo | SSAIConf | No | SSAI configuration info |
| Region | String | No | Region info |
| SessionInitPrefix | String | No | Used for clickthrough addresses |
SSAI ad insertion configuration.
Used by actions: CreateStreamPackageChannelEndpoint, CreateStreamPackageSSAIChannel, DescribeStreamPackageSSAIChannel, DescribeStreamPackageSSAIChannels, ModifyStreamPackageChannelEndpoint, ModifyStreamPackageSSAIChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| AdsUrl | String | No | Advertising Decision Server URL (ADS). |
| ConfigAliases | Array of ConfigAliasesInfo | No | Parameter configuration. |
| 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. |
| 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. |
| 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. |
| SourceCDNPrefix | String | No | Source CDN prefix, needs to start with http:// or https:// |
| AdCDNPrefix | String | No | Advertising CDN prefix needs to start with http:// or https:// |
| PreRollAdsUrl | String | No | Pre-roll ad decision service address. |
| PreRollMaxAllowedDuration | Integer | No | The maximum allowed duration of pre-roll ads, (0, 3600]. |
SSAI usage information.
Used by actions: DescribeStreamPackageSSAIUsage.
| Name | Type | Description |
|---|---|---|
| AdRequestSuccess | Integer | Number of successful ad requests. |
| AdRequestFail | Integer | Number of failed ad requests. |
| Impression | Integer | Exposure count. |
| MidFillRate | Float | Fill factor for personalized ads. |
| AdMarkerTime | Float | Advertising tag time. |
| ReplacedTime | Float | Personalization replacement time. |
| PreReplaceRate | Float | Ad replacement rate. |
| PreReqNum | Integer | Number of pre-roll ad requests. |
| PreReplacedNum | Integer | Number of pre-roll ad replacements. |
| UsageDetails | Array of UsageDetail | Configures usage for each ad. Note: This field may return null, indicating that no valid values can be obtained. |
SourceLocation shim configuration.
Used by actions: CreateStreamPackageSourceLocation, DescribeStreamPackageSourceLocation, DescribeStreamPackageSourceLocations, ModifyStreamPackageSourceLocation.
| Name | Type | Required | Description |
|---|---|---|---|
| DefaultSegmentUrl | String | No | Default content source address. |
| NameServers | Array of NameServer | No | Custom server address. |
Channel linear assembly channel spacer configuration.
Used by actions: CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels, ModifyStreamPackageLinearAssemblyChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| SourceLocationId | String | No | The ID of the source location. |
| VodSourceName | String | No | The corresponding vod shim content source name. |
Channel Linear Assembly Location Alarm Information
Used by actions: DescribeStreamPackageSourceAlerts.
| Name | Type | Description |
|---|---|---|
| SourceId | String | Source ID. |
| SourceName | String | Source name. |
| Code | Integer | Alarm event code. |
| Category | String | Alarm classification. |
| Message | String | Alarm message. |
| LastModifiedTime | Integer | Update time. |
SourceInfo.
Used by actions: CreateStreamPackageSource, DescribeStreamPackageSource, DescribeStreamPackageSources.
| Name | Type | Required | Description |
|---|---|---|---|
| Name | String | No | name. |
| Type | String | No | The source type distinguishes between live broadcast and on-demand Vod. |
| PackageConf | Array of SourcePackageConf | No | Source configuration. |
| Id | String | No | ID. |
| CreateTime | Integer | No | Create timestamp. |
| UpdateTime | Integer | No | Update timestamp. |
| Region | String | No | Region. |
SourceLocation configuration information.
Used by actions: CreateStreamPackageSourceLocation, DescribeStreamPackageSourceLocation, DescribeStreamPackageSourceLocations.
| Name | Type | Required | Description |
|---|---|---|---|
| Id | String | No | ID, unique identification. |
| Name | String | No | SourceLocation name. |
| Region | String | No | area. |
| BaseUrl | String | No | BaseUrl information. |
| SegmentDeliverEnable | Boolean | No | Whether to enable patching. |
| SegmentDeliverConf | SegmentDeliverInfo | No | Patch configuration. |
| AttachedLiveSources | Array of String | No | List of bound live broadcast source ids. |
| AttachedVodSources | Array of String | No | List of bound on-demand source ids. |
| CreateTime | Integer | No | Source location creation time, Unix timestamp. |
| UpdateTime | Integer | No | Source location last modified time, Unix timestamp. |
| SegmentDeliverUsePackageEnable | Boolean | No | Whether to enable package distribution sharding, it is enabled by default. |
Source file information.
Used by actions: CreateStreamPackageSource, DescribeStreamPackageSource, DescribeStreamPackageSources, ModifyStreamPackageSource.
| Name | Type | Required | Description |
|---|---|---|---|
| GroupName | String | No | Group name. When the channel is in Linear mode and vod source is selected, the group name corresponds to the output group name of the channel output. |
| Type | String | No | Type, distinguish between HLS and DASH, optional values: HLS, DASH. |
| Path | String | No | access path. |
type SourceTag struct {
Key string json:"Key"
Value string json:"Value"
}
Used by actions: CreateStreamPackageSource, ModifyStreamPackageSource.
| Name | Type | Required | Description |
|---|---|---|---|
| Key | String | No | The key of the source tag supports capital letters, numbers, underscores, and dashes from 1 to 50 digits |
| Value | String | No | The value of the source tag supports letters, numbers, underscores, dashes, periods, and percent signs (%) ranging from 1 to 200 characters |
SpliceInsertInfo.
Used by actions: CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms, ModifyStreamPackageLinearAssemblyProgram.
| Name | Type | Required | Description |
|---|---|---|---|
| EventID | String | No | EventID. |
| AvailNum | String | No | AvailNum. |
| AvailExpected | String | No | AvailExpected. |
| ProgramID | String | No | ProgramID. |
Linearly assembled channel time-shift configuration information.
Used by actions: CreateStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannel, DescribeStreamPackageLinearAssemblyChannels, ModifyStreamPackageLinearAssemblyChannel.
| Name | Type | Required | Description |
|---|---|---|---|
| TimeWindows | Integer | No | Lookback window, in seconds. |
TimeSignalInfo.
Used by actions: CreateStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgram, DescribeStreamPackageLinearAssemblyProgramSchedules, DescribeStreamPackageLinearAssemblyPrograms, ModifyStreamPackageLinearAssemblyProgram.
| Name | Type | Required | Description |
|---|---|---|---|
| EventID | String | No | EventID. |
| UPIDType | String | No | UPIDType. |
| UPID | String | No | UPID. |
| TypeID | String | No | TypeID. |
| Num | String | No | Num. |
| Expected | String | No | Expected. |
| SubsegmentNum | String | No | SubsegmentNum. |
| SubsegmentsExpected | String | No | SubsegmentsExpected. |
Ad insertion configuration and SSAI usage detail by advertisement type dimension.
Used by actions: DescribeStreamPackageSSAIUsage.
| Name | Type | Description |
|---|---|---|
| UniqId | String | Ad insertion configuration uniq_id. |
| ChannelId | String | Ad insertion configuration id. |
| ChannelName | String | Ad insertion configuration name. |
| AdType | String | Ad type. |
| AdRequestSuccess | Integer | Number of successful ad requests. |
| AdRequestFail | Integer | Number of failed ad requests. |
| Impression | Integer | Number of ad exposures. |
| Start | Integer | Number of ad playbacks started. |
| FirstQuarter | Integer | Ad plays at 1/4 point. |
| Midpoint | Integer | Ad plays at 1/2 point. |
| ThirdQuarter | Integer | Ad plays at 3/4 point. |
| Complete | Integer | Number of ad playbacks completed. |
| ADMarkerFound | Integer | Number of ad tags found in the list |
| MakeAdsRequest | Integer | Request advertising frequency from ADS |
| VASTResponse | Integer | Received VAST returns from ADS |
| FilledAvail | Integer | Successfully filled the ad count |
| WarningNoAd | Integer | The number of issues encountered during ad replacement execution |
| ErrorAdsTimeout | Integer | The number of timeouts returned by ADS |
| EmptyVASTResponse | Integer | The number of empty VAST responses returned by ADS |
| EmptyVMAPResponse | Integer | The number of empty VMAP responses returned by ADS |
| Date | String | Date |
| StartTime | String | Start time |
| EndTime | String | End time |
VOD remux task informations.
Used by actions: CreateStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTask, DescribeStreamPackageVodRemuxTasks.
| Name | Type | Required | Description |
|---|---|---|---|
| Id | String | Yes | VOD remux task ID. |
| Name | String | Yes | VOD remux task name. |
| Type | String | Yes | VOD remux task type. |
| InputFileInfo | InputFileInfo | Yes | VOD remux task input file information. |
| OutputStorage | OutputStorage | Yes | VOD remux task output storage information. |
| CreateTime | Integer | Yes | VOD remux task created time. |
| UpdateTime | Integer | Yes | VOD remux task updated time. |
| State | String | Yes | VOD remux task's state. |
| ErrorMsg | String | Yes | VOD remux task's error message. |
| StartTime | Integer | No | VOD remux task process started time. |
| EndTime | Integer | No | VOD remux task process end time. |
| Region | String | No | Common Params. For more information, please see the list of regions supported by the product. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan