tencent cloud

Cloud Object Storage

Release Notes and Announcements
Release Notes
Announcements
Product Introduction
Overview
Features
Use Cases
Strengths
Concepts
Regions and Access Endpoints
Specifications and Limits
Service Regions and Service Providers
Billing
Billing Overview
Billing Method
Billable Items
Free Tier
Billing Examples
Viewing and Downloading Bill
Payment Overdue
FAQs
Getting Started
Console
Getting Started with COSBrowser
User Guide
Creating Request
Bucket
Object
Data Management
Batch Operation
Global Acceleration
Monitoring and Alarms
Operations Center
Data Processing
Content Moderation
Smart Toolbox
Data Processing Workflow
Application Integration
User Tools
Tool Overview
Installation and Configuration of Environment
COSBrowser
COSCLI (Beta)
COSCMD
COS Migration
FTP Server
Hadoop
COSDistCp
HDFS TO COS
GooseFS-Lite
Online Tools
Diagnostic Tool
Use Cases
Overview
Access Control and Permission Management
Performance Optimization
Accessing COS with AWS S3 SDK
Data Disaster Recovery and Backup
Domain Name Management Practice
Image Processing
Audio/Video Practices
Workflow
Direct Data Upload
Content Moderation
Data Security
Data Verification
Big Data Practice
COS Cost Optimization Solutions
Using COS in the Third-party Applications
Migration Guide
Migrating Local Data to COS
Migrating Data from Third-Party Cloud Storage Service to COS
Migrating Data from URL to COS
Migrating Data Within COS
Migrating Data Between HDFS and COS
Data Lake Storage
Cloud Native Datalake Storage
Metadata Accelerator
GooseFS
Data Processing
Data Processing Overview
Image Processing
Media Processing
Content Moderation
File Processing Service
File Preview
Troubleshooting
Obtaining RequestId
Slow Upload over Public Network
403 Error for COS Access
Resource Access Error
POST Object Common Exceptions
API Documentation
Introduction
Common Request Headers
Common Response Headers
Error Codes
Request Signature
Action List
Service APIs
Bucket APIs
Object APIs
Batch Operation APIs
Data Processing APIs
Job and Workflow
Content Moderation APIs
Cloud Antivirus API
SDK Documentation
SDK Overview
Preparations
Android SDK
C SDK
C++ SDK
.NET(C#) SDK
Flutter SDK
Go SDK
iOS SDK
Java SDK
JavaScript SDK
Node.js SDK
PHP SDK
Python SDK
React Native SDK
Mini Program SDK
Error Codes
Harmony SDK
Endpoint SDK Quality Optimization
Security and Compliance
Data Disaster Recovery
Data Security
Cloud Access Management
FAQs
Popular Questions
General
Billing
Domain Name Compliance Issues
Bucket Configuration
Domain Names and CDN
Object Operations
Logging and Monitoring
Permission Management
Data Processing
Data Security
Pre-signed URL Issues
SDKs
Tools
APIs
Agreements
Service Level Agreement
Privacy Policy
Data Processing And Security Agreement
Contact Us
Glossary
DocumentationCloud Object StorageAPI DocumentationJob and WorkflowAppendixStructure

Structure

PDF
Focus Mode
Font Size
Last updated: 2024-06-12 16:01:53

MediaWorkflow_Topology_Nodes_Start_Input

Node Name (Keyword)
Description
Type
Required
Constraints
ObjectPrefix
Object prefix
String
Yes
None
QueueId
Queue ID
String
Yes
None
PicProcessQueueId
Image processing queue ID
String
Yes if there is an image processing node
None
SpeechRecognitionQueueId
Speech recognition queue ID
String
Yes if there is a speech recognition node
None
AIProcessQueueId
AI processing queue ID
String
Yes if there is an AI-based recognition node
None
NotifyConfig
Callback information. If none is specified, the queue callback information is used.
Container
No
None
ExtFilter
Filename extension filter.
Container
No
None

NotifyConfig
has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Default Value
Constraints
Url
Callback address
String
Yes
None
The callback address cannot be a private network address.
Type
Callback type
String
Yes
None
Url: URL callback
TDMQ: TDMQ message callback
Event
Callback information
String
Yes
None
TaskFinish: Job completed
WorkflowFinish: Workflow completed
You can configure multiple events separated by comma.
ResultFormat
Callback format
String
No
XML
XML
JSON
MqRegion
TDMQ region
String
No
None
Yes if the callback type is TDMQ. For supported regions, see Request Domain Description.
MqMode
TDMQ mode
String
No
None
Yes if the callback type is TDMQ.
Topic: Topic subscription
Queue: Queue service
MqName
TDMQ topic name
String
No
None
Yes if the callback type is TDMQ.

ExtFilter
has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Default Value
Constraints
State
Switch.
String
No
Off
On/Off
Video
Require a video extension.
String
No
false
false/true
Audio
Require an audio extension.
String
No
false
false/true
Image
Require an image extension.
String
No
false
false/true
ContentType
Require a content type.
String
No
false
false/true
Custom
Require a custom extension.
String
No
false
false/true
CustomExts
Custom extension.
String
No
None
Separate filename extensions by slash (/). Up to ten extensions are supported.
If Custom is true, this parameter is required.
AllFile
All files
String
No
false
false/true

MediaWorkflow_Topology_Nodes_***_Operation_Output

Node Name (Keyword)
Description
Type
Required
Constraints
Region
Bucket region
String
Yes
None
Bucket
Bucket name
String
Yes
None
Object
Result filename
String
Yes
If the workflow node type is Snapshot or SmartCover, and there are more than one result file, ${Number} $ must be included.
If the workflow node type is Segment, Duration is specified, and Format is not HLS or m3u8, ${Number} must be included.
SpriteObject
Image sprite name
String
No
If the workflow node type is Snapshot and the image sprite feature is enabled, this field is required.
AuObject
Voice result filename
String
No
If the workflow node type is VoiceSeparate and there is a voice output, this field is required.

MediaWorkflow_Topology_Nodes_Snapshot_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Screenshot template ID
String
Yes
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_Animation_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Video-to-animated image conversion template ID
String
Yes
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_SmartCover_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Intelligent thumbnail template ID
String
No
None
SmartCover
Intelligent thumbnail parameter
Container. For more information, see SmartCover.
No
None
Output
Output address
Container. For more information, see Output.
Yes
None
Note:
Both TemplateId and SmartCover can be left empty, in which case three thumbnails will be generated according to the original video size by default. If both of them are specified, TemplateId will take effect.

MediaWorkflow_Topology_Nodes_Transcode_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Audio/Video transcoding template ID
String
No
None
WatermarkTemplateId
Watermark template ID
String array
No
Up to three watermark template IDs are supported.
RemoveWatermark
Watermark removal parameter
Container. For more information, see RemoveWatermark.
No
None
DigitalWatermark
Digital watermark parameter
Container. For more information, see DigitalWatermark.
No
None
Output
Output address
Container. For more information, see Output.
Yes
None
Input
Input configuration
Container
No
None
MediaWorkflow_Topology_Nodes_Transcode_\\*\\*\\*_Operation.Input has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Constraints
SpeedTranscodingQueueId
Accelerated transcoding queue
String
No
None

MediaWorkflow_Topology_Nodes_Concat_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Splicing template ID
String
Yes
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_VoiceSeparate_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Voice/Sound separation template ID
String
Yes
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_VideoMontage_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Video montage template ID
String
Yes
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_SDRtoHDR_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
SDRtoHDR
SDR-to-HDR configuration
Container
Yes
None
TranscodeTemplateId
Audio/Video transcoding template ID
String
Yes
None
WatermarkTemplateId
Watermark template ID
String array
No
Up to three watermark template IDs are supported.
Output
Output address
Container. For more information, see Output.
Yes
None
SDRtoHDR has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Constraints
HdrMode
HDR mode
String
Yes
HLG
HDR10

MediaWorkflow_Topology_Nodes_VideoProcess_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Video enhancement template ID
String
Yes
None
TranscodeTemplateId
Audio/Video transcoding template ID
String
Yes
None
WatermarkTemplateId
Watermark template ID
String array
No
Up to three watermark template IDs are supported.
DigitalWatermark
Digital watermark parameter
Container. For more information, see DigitalWatermark.
No
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_SCF_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
SCF
SCF function information
Container
Yes
None
SCF has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Constraints
Region
Function region
String
Yes
None
FunctionName
Function name
String
Yes
None
Namespace
Namespace
String
No
None
Alias
Function alias
String
No
None

MediaWorkflow_Topology_Nodes_SuperResolution_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Super resolution template ID
String
Yes
None
TranscodeTemplateId
Audio/Video transcoding template ID
String
Yes
None
WatermarkTemplateId
Watermark template ID
String array
No
Up to three watermark template IDs are supported.
DigitalWatermark
Digital watermark parameter
Container. For more information, see DigitalWatermark.
No
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_Segment_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
Segment
Audio/Video remuxing parameter
Container
Yes
None
Output
Output address
Container. For more information, see Output.
Yes
None
Segment has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Constraints
Format
Container format
String
Yes
aac, mp3, flac, mp4, ts, mkv, avi, hls, m3u8
Duration
Remuxing duration in seconds
String
No
The value must be an integer equal to or greater than 5.
HlsEncrypt
HLS encryption configuration
Container
No
This parameter takes effect only when the container format is hls. For more information, see HlsEncrypt.

MediaWorkflow_Topology_Nodes_PicProcess_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Image processing template ID
String
Yes
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_Tts_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Text-to-speech template ID
String
Yes
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_SpeechRecognition_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
Output
Output address
Container. For more information, see Output.
Yes
None
StreamPackConfig
Packaging configuration
Container
Yes
None

MediaWorkflow_Topology_Nodes_StreamPackConfig_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
StreamPackConfig
Packaging configuration
Container
No
None
StreamPackConfig has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Constraints
PackType
Packaging type. Default value: HLS.
String
No
HLS/DASH
IgnoreFailedStream
Whether to ignore the substream failed to be transcoded and continue packaging. Default value: true.
String
No
true/false

MediaWorkflow_Topology_Nodes_VideoStream_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
TemplateId
Audio/Video transcoding template ID
String
No
None
WatermarkTemplateId
Watermark template ID
String array
No
Up to three watermark template IDs are supported.
RemoveWatermark
Watermark removal parameter
Container. For more information, see RemoveWatermark.
No
None
Output
Output address
Container. For more information, see Output.
Yes
None

MediaWorkflow_Topology_Nodes_StreamPack_***_Operation

Node Name (Keyword)
Description
Type
Required
Constraints
StreamPackInfo
Packaging rule
Container
No
None
StreamPackInfo has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Constraints
VideoStreamConfig
Video substream configuration
Container
No
None
VideoStreamConfig has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Constraints
VideoStreamName
Video substream name
String
Yes
It must be consistent with the existing video node.
BandWidth
Video substream bandwidth limit. Unit: b/s. Value range: [0, 2000000000], where 0 indicates no limit.
String
No
The value must be equal to or greater than 0. The default value is 0.

AudioMix

Node Name (Keyword)
Description
Type
Required
Default Value
Constraints
AudioSource
Address of the audio track file to be mixed
String
Yes
None
It must be stored in the same bucket as the input media file.
MixMode
Audio mix mode
String
No
Repeat
Repeat: Repeats the background sound
Once: Plays back the background sound once
Replace
Whether to replace the original audio of the input media file with the mixed audio track
String
No
false
true/false
EffectConfig
Audio mix transition configuration
Container
No
false
None
EffectConfig has the following sub-nodes:
Node Name (Keyword)
Description
Type
Required
Default Value
Constraints
EnableStartFadein
Enables fade-in
String
No
false
true/false
StartFadeinTime
Fade-in duration
String
No
None
A floating point number above 0
EnableEndFadeout
Enables fade-out
String
No
false
true/false
EndFadeoutTime
Fade-out duration
String
No
None
A floating point number above 0
EnableBgmFade
Enables fade-in for background music transition
String
No
false
true/false
BgmFadeTime
Fade-in duration for background music transition
String
No
None
A floating point number above 0

CallBackMqConfig

Node Name (Keyword)
Description
Type
Required
MqRegion
Message queue region. Valid values: sh (Shanghai), bj (Beijing), gz (Guangzhou), cd (Chengdu), hk (Hong Kong, China).
String
Yes
MqMode
Message queue mode. Default value: Queue.
Topic: Topic subscription
Queue: Queue service
String
Yes
MqName
TDMQ topic name
String
Yes

DigitalWatermark

Node Name (Keyword)
Description
Type
Required
Constraints
Message
The watermark information embedded by the digital watermark
String
Yes
It can contain up to 64 letters, digits, underscores (_), hyphens (-), and asterisks (*).
Type
Digital watermark type
String
Yes
It currently can be set to Text only.
Version
Digital watermark version
String
Yes
It currently can be set to V1 only.
IgnoreError
Whether to ignore the watermarking failure and continue the job.
String
Yes
Valid values: true, false.
State
Whether the watermark is added successfully. Valid values: Running, Success, Failed.
string
No
This field cannot be set actively; instead, it will be returned after the job is submitted successfully.

DashEncrypt

Node Name (Keyword)
Description
Type
Required
Default Value
Constraints
IsEncrypt
Whether to enable DASH encryption
String
No
false
true/false
UriKey
DASH encryption key
String
No
None
This parameter will take effect only when IsEncrypt is true.

HlsEncrypt

Node Name (Keyword)
Description
Type
Required
Default Value
Constraints
IsEncrypt
Whether to enable HLS encryption
String
No
false
true/false
UriKey
HLS encryption key
String
No
None
This parameter will take effect only when IsEncrypt is true.

RemoveWatermark

Node Name (Keyword)
Description
Type
Required
Constraints
Dx
X-axis offset of the top-left corner origin
String
Yes
Value range: [0, 4096]
Unit: px
Dy
Y-axis offset of the top-left corner origin
String
Yes
Value range: [0, 4096]
Unit: px
Width
Watermark width
String
Yes
Value range: (0, 4096]
Unit: px
Height
Watermark height
String
Yes
Value range: (0, 4096]
Unit: px

SmartCover

Node Name (Keyword)
Description
Type
Required
Default Value
Constraints
Format
Image format
String
No
jpg
jpg, png, webp
Width
Width
String
No
Original video width
Value range: [128, 4096]
Unit: px
If only Width is set, Height is calculated based on the original video aspect ratio.
Height
Height
String
No
Original video height
Value range: [128, 4096]
Unit: px
If only Height is set, Width is calculated based on the original video aspect ratio.
Count
Number of screenshots
String
No
3
[1,10]
DeleteDuplicates
Whether to deduplicate thumbnails.
String
No
false
true/false
Previous Topic: Pulling Jobs in BatchesNext Topic: Single Image Moderation

Help and Support

Was this page helpful?

Help us improve! Rate your documentation experience in 5 mins.

Feedback