AIAnalysisTemplateItem
AI 智能分析模板详情
被如下接口引用:DescribeAIAnalysisTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 智能分析模板唯一标识。 示例值:10 |
| Name | String | 智能分析模板名称。 示例值:智能分析模板 |
| Comment | String | 智能分析模板描述信息。 示例值:智能分析模板描述 |
| ClassificationConfigure | ClassificationConfigureInfo | 智能分类任务控制参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| TagConfigure | TagConfigureInfo | 智能标签任务控制参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| CoverConfigure | CoverConfigureInfo | 智能封面任务控制参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| FrameTagConfigure | FrameTagConfigureInfo | 智能按帧标签任务控制参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2017-01-01T00:00:00+08:00 |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2017-01-01T00:00:00+08:00 |
| Type | String | 模板类型,取值范围: * Preset:系统预置模板; * Custom:用户自定义模板。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Preset |
AIRecognitionTemplateItem
视频内容识别模板详情
被如下接口引用:DescribeAIRecognitionTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频内容识别模板唯一标识。 示例值:10 |
| Name | String | 视频内容识别模板名称。 示例值:智能识别模板 |
| Comment | String | 视频内容识别模板描述信息。 示例值:智能识别模板描述 |
| FaceConfigure | FaceConfigureInfo | 人脸识别控制参数。 |
| OcrFullTextConfigure | OcrFullTextConfigureInfo | 文本全文识别控制参数。 |
| OcrWordsConfigure | OcrWordsConfigureInfo | 文本关键词识别控制参数。 |
| AsrFullTextConfigure | AsrFullTextConfigureInfo | 语音全文识别控制参数。 |
| AsrWordsConfigure | AsrWordsConfigureInfo | 语音关键词识别控制参数。 |
| TranslateConfigure | TranslateConfigureInfo | 语音翻译控制参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2017-01-01T00:00:00+08:00 |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2017-01-01T00:00:00+08:00 |
| Type | String | 模板类型,取值范围: * Preset:系统预置模板; * Custom:用户自定义模板。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Preset |
ActionConfigInfo
动作识别参数配置
被如下接口引用:RecognizeMediaForZhiXue。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 动作识别任务开关,可选值: 示例值:ON |
Activity
编排原子任务
被如下接口引用:CreateSchedule, DescribeSchedules, ModifySchedule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ActivityType | String | 是 | 原子任务类型: 示例值:input |
| ReardriveIndex | Array of Integer | 否 | 后驱节点索引数组 示例值:[3] |
| ActivityPara | ActivityPara | 否 | 原子任务参数 注意:此字段可能返回 null,表示取不到有效值。 |
ActivityPara
编排原子任务
被如下接口引用:CreateSchedule, ModifySchedule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TranscodeTask | TranscodeTaskInput | 否 | 视频转码任务 注意:此字段可能返回 null,表示取不到有效值。 |
| AnimatedGraphicTask | AnimatedGraphicTaskInput | 否 | 视频转动图任务 注意:此字段可能返回 null,表示取不到有效值。 |
| SnapshotByTimeOffsetTask | SnapshotByTimeOffsetTaskInput | 否 | 视频按时间点截图任务 注意:此字段可能返回 null,表示取不到有效值。 |
| SampleSnapshotTask | SampleSnapshotTaskInput | 否 | 视频采样截图任务 注意:此字段可能返回 null,表示取不到有效值。 |
| ImageSpriteTask | ImageSpriteTaskInput | 否 | 视频截雪碧图任务 注意:此字段可能返回 null,表示取不到有效值。 |
| AdaptiveDynamicStreamingTask | AdaptiveDynamicStreamingTaskInput | 否 | 转自适应码流任务 注意:此字段可能返回 null,表示取不到有效值。 |
| AiContentReviewTask | AiContentReviewTaskInput | 否 | 视频内容审核类型任务 注意:此字段可能返回 null,表示取不到有效值。 |
| AiAnalysisTask | AiAnalysisTaskInput | 否 | 视频内容分析类型任务 注意:此字段可能返回 null,表示取不到有效值。 |
| AiRecognitionTask | AiRecognitionTaskInput | 否 | 视频内容识别类型任务 注意:此字段可能返回 null,表示取不到有效值。 |
| QualityControlTask | AiQualityControlTaskInput | 否 | 媒体质检任务 注意:此字段可能返回 null,表示取不到有效值。 |
| ExecRulesTask | ExecRulesTask | 否 | 任务条件判断 注意:此字段可能返回 null,表示取不到有效值。 |
| SmartSubtitlesTask | SmartSubtitlesTaskInput | 否 | 智能字幕任务 注意:此字段可能返回 null,表示取不到有效值。 |
| SmartEraseTask | SmartEraseTaskInput | 否 | 智能擦除任务 注意:此字段可能返回 null,表示取不到有效值。 |
ActivityResItem
编排子任务输出
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| TranscodeTask | MediaProcessTaskTranscodeResult | 转码任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| AnimatedGraphicTask | MediaProcessTaskAnimatedGraphicResult | 转动图任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| SnapshotByTimeOffsetTask | MediaProcessTaskSnapshotByTimeOffsetResult | 时间点截图任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| SampleSnapshotTask | MediaProcessTaskSampleSnapshotResult | 采样截图任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| ImageSpriteTask | MediaProcessTaskImageSpriteResult | 雪碧图任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| AdaptiveDynamicStreamingTask | MediaProcessTaskAdaptiveDynamicStreamingResult | 自适应码流任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| RecognitionTask | ScheduleRecognitionTaskResult | 识别任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| ReviewTask | ScheduleReviewTaskResult | 审核任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| AnalysisTask | ScheduleAnalysisTaskResult | 分析任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| QualityControlTask | ScheduleQualityControlTaskResult | 媒体质检任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| ExecRuleTask | ScheduleExecRuleTaskResult | 条件判断任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| SmartSubtitlesTask | ScheduleSmartSubtitleTaskResult | 智能字幕任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| SmartEraseTask | SmartEraseTaskResult | 智能擦除任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
ActivityResult
编排任务输出
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ActivityType | String | 原子任务类型。 示例值:Transcode |
| ActivityResItem | ActivityResItem | 原子任务输出。 |
AdaptiveDynamicStreamingInfoItem
转自适应码流信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 转自适应码流规格。 示例值:10 |
| Package | String | 打包格式,可能为 HLS和 MPEG-DASH 两种。 示例值:HLS |
| Path | String | 播放路径。 示例值:/output/xxxxxx/ada_10.m3u8 |
| Storage | TaskOutputStorage | 自适应码流文件的存储位置。 |
AdaptiveDynamicStreamingTaskInput
对视频转自适应码流的输入参数类型
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 转自适应码流模板 ID。 示例值:10 |
| WatermarkSet | Array of WatermarkInput | 否 | 水印列表,支持多张图片或文字水印,最大可支持 10 张。 |
| OutputStorage | TaskOutputStorage | 否 | 转自适应码流后文件的目标存储,不填则继承上层的 OutputStorage 值。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputObjectPath | String | 否 | 转自适应码流后,manifest 文件的输出路径,可以为相对路径或者绝对路径。 若需定义输出路径,路径需以 .{format}结尾。变量名请参考 文件名变量说明。相对路径示例: 绝对路径示例: 如果不填,则默认为相对路径:{inputName}_adaptiveDynamicStreaming_{definition}.{format}。 示例值:{inputName}_adaptiveDynamicStreaming_{definition}.{format} |
| SubStreamObjectName | String | 否 | 转自适应码流后,子流文件的输出路径,只能为相对路径。如果不填,则默认为相对路径:{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format}。示例值:{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}.{format} |
| SegmentObjectName | String | 否 | 转自适应码流(仅 HLS)后,分片文件的输出路径,只能为相对路径。如果不填,则默认为相对路径:{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format}。示例值:{inputName}_adaptiveDynamicStreaming_{definition}_{subStreamNumber}_{segmentNumber}.{format} |
| AddOnSubtitles | Array of AddOnSubtitle | 否 | 外挂字幕功能,指定要插入的字幕文件。 注意:此字段可能返回 null,表示取不到有效值。 |
| DrmInfo | DrmInfo | 否 | Drm信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| DefinitionType | String | 否 | 自适应转码模板类型: Common:音视频类型 PureAudio:纯音频类型 示例值:Common |
| SubtitleTemplate | SubtitleTemplate | 否 | 硬字幕(压制字幕)功能,指定字幕来源、字体大小、位置等字幕参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| StdExtInfo | String | 否 | 转码参数扩展字段 示例值:{"audio_info": {"codec": "vivid"}} |
AdaptiveDynamicStreamingTemplate
转自适应码流模板详情
被如下接口引用:DescribeAdaptiveDynamicStreamingTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 转自适应码流模板唯一标识。 示例值:105965 |
| Type | String | 模板类型,取值范围: 示例值:Custom |
| Name | String | 转自适应码流模板名称。 示例值:转自适应码流模板 |
| Comment | String | 转自适应码流模板描述信息。 示例值:转自适应码流模板 |
| Format | String | 转自适应码流格式,取值范围: 示例值:HLS |
| StreamInfos | Array of AdaptiveStreamTemplate | 转自适应码流输入流参数信息,最多输入10路流。 |
| DisableHigherVideoBitrate | Integer | 是否禁止视频低码率转高码率,取值范围: 示例值:0 |
| DisableHigherVideoResolution | Integer | 是否禁止视频分辨率转高分辨率,取值范围: 示例值:0 |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2024-12-27T09:06:08Z |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2024-12-27T09:06:08Z |
| PureAudio | Integer | 是否为纯音频,0表示视频,1表示纯音频 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SegmentType | String | hls 分片类型,可选值: 默认值:ts-segment 注:自适应码流的hls分片格式已此字段为准 注意:此字段可能返回 null,表示取不到有效值。 示例值:ts-segment |
AdaptiveStreamTemplate
自适应转码流参数模板
被如下接口引用:CreateAdaptiveDynamicStreamingTemplate, DescribeAdaptiveDynamicStreamingTemplates, ModifyAdaptiveDynamicStreamingTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Audio | AudioTemplateInfo | 是 | 音频参数信息。 |
| Video | VideoTemplateInfo | 否 | 视频参数信息。 |
| RemoveAudio | Integer | 否 | 是否移除音频流,取值范围: 示例值:0 |
| RemoveVideo | Integer | 否 | 是否移除视频流,取值范围: 示例值:0 |
| AudioList | Array of AudioTemplateInfo | 否 | 音频参数信息列表。 注意:参数只在自适应转码使用音轨合并多音轨时使用, 参数数组长度最大为64。 注意:此字段可能返回 null,表示取不到有效值。 |
AddBlindWatermarkConfig
增加盲水印配置
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ON |
| EmbedInfo | BlindWatermarkEmbedInfo | 否 | 盲水印嵌入数据 注意:此字段可能返回 null,表示取不到有效值。 |
AddOnSubtitle
外挂字幕。
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | 插入形式,可选值: 注意:此字段可能返回 null,表示取不到有效值。 示例值:subtitle-stream |
| Subtitle | MediaInputInfo | 否 | 字幕文件。 注意:此字段可能返回 null,表示取不到有效值。 |
| SubtitleName | String | 否 | 字幕名称 。 注意:仅支持中文、英文、数字、空格、下划线(_)、短横线(-)、句点(.)和中英文括号,长度不能超过64个字符。 注意:此字段可能返回 null,表示取不到有效值。 示例值:字幕1 |
| OutputFormat | String | 否 | 字幕输出格式。取值{"WebVTT","TTML"}。 默认值:"WebVTT" 示例值:WebVTT |
| DefaultTrack | Boolean | 否 | 默认字幕轨道。为true时指定当前字幕为默认字幕轨道,最多可指定1条默认字幕轨道。 默认值:false 示例值:false |
AiAnalysisResult
智能分析结果
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 任务的类型,可以取的值有: 示例值:Classification |
| ClassificationTask | AiAnalysisTaskClassificationResult | 视频内容分析智能分类任务的查询结果,当任务类型为 Classification 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| CoverTask | AiAnalysisTaskCoverResult | 视频内容分析智能封面任务的查询结果,当任务类型为 Cover 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| TagTask | AiAnalysisTaskTagResult | 视频内容分析智能标签任务的查询结果,当任务类型为 Tag 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| FrameTagTask | AiAnalysisTaskFrameTagResult | 视频内容分析智能按帧标签任务的查询结果,当任务类型为 FrameTag 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| HighlightTask | AiAnalysisTaskHighlightResult | 视频内容分析集锦任务的查询结果,当任务类型为 Highlight时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| DeLogoTask | AiAnalysisTaskDelLogoResult | 视频内容分析智能擦除任务的查询结果,当任务类型为 DeLogo 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| SegmentTask | AiAnalysisTaskSegmentResult | 视频内容分析拆条任务的查询结果,当任务类型为 SegmentRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| HeadTailTask | AiAnalysisTaskHeadTailResult | 视频内容分析片头片尾任务的查询结果,当任务类型为 HeadTailRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| DescriptionTask | AiAnalysisTaskDescriptionResult | 视频内容分析摘要任务的查询结果,当任务类型为 Description 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| HorizontalToVerticalTask | AiAnalysisTaskHorizontalToVerticalResult | 视频内容分析横转竖任务的查询结果,当任务类型为 HorizontalToVertical 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| DubbingTask | AiAnalysisTaskDubbingResult | 视频内容分析译制任务的查询结果,当任务类型为 Dubbing 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| VideoRemakeTask | AiAnalysisTaskVideoRemakeResult | 视频内容分析去重任务的查询结果,当任务类型为 VideoRemake 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| VideoComprehensionTask | AiAnalysisTaskVideoComprehensionResult | 视频(音频)理解任务的查询结果,当任务类型为 VideoComprehension 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
AiAnalysisTaskClassificationInput
智能分类任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频智能分类模板 ID。 示例值:10 |
AiAnalysisTaskClassificationOutput
智能分类结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ClassificationSet | Array of MediaAiAnalysisClassificationItem | 视频智能分类列表。 |
AiAnalysisTaskClassificationResult
智能分类任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:NULL |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:NULL |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:NULL |
| Message | String | 错误信息。 示例值:NULL |
| Input | AiAnalysisTaskClassificationInput | 智能分类任务输入。 示例值:NULL |
| Output | AiAnalysisTaskClassificationOutput | 智能分类任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiAnalysisTaskCoverInput
智能分类任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频智能封面模板 ID。 示例值:10 |
AiAnalysisTaskCoverOutput
智能封面结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| CoverSet | Array of MediaAiAnalysisCoverItem | 智能封面列表。 |
| OutputStorage | TaskOutputStorage | 智能封面的存储位置。 |
AiAnalysisTaskCoverResult
智能封面结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:NULL |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:NULL |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:NULL |
| Message | String | 错误信息。 示例值:NULL |
| Input | AiAnalysisTaskCoverInput | 智能封面任务输入。 示例值:NULL |
| Output | AiAnalysisTaskCoverOutput | 智能封面任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiAnalysisTaskDelLogoInput
智能擦除任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频智能擦除模板 ID。 示例值:293034 |
AiAnalysisTaskDelLogoOutput
智能擦除结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Path | String | 擦除后文件的路径。 示例值:/output/test-result.mp4 |
| OutputStorage | TaskOutputStorage | 擦除后文件的存储位置。 |
| OriginSubtitlePath | String | 基于画面提取的字幕文件路径。 示例值:/output/1869644145.vtt |
| TranslateSubtitlePath | String | 基于画面提取的字幕翻译文件路径。 示例值:/output/1869644146.vtt |
| SubtitlePos | SubtitlePosition | 擦除的字幕位置。注意:仅对字幕提取且开启返回字幕位置时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| VoiceClonedVideo | String | 音色克隆后的视频文件地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:/output/delogo-result-0.mp4 |
| VoiceClonedMarkFile | String | 音色克隆的标注文件地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:/output/delogo-result-0.json |
AiAnalysisTaskDelLogoResult
智能擦除结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiAnalysisTaskDelLogoInput | 智能擦除任务输入。 |
| Output | AiAnalysisTaskDelLogoOutput | 智能擦除任务输出。 注意:此字段可能返回 null,表示取不到有效值。 |
AiAnalysisTaskDescriptionInput
智能分类任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频智能描述模板 ID。 示例值:10 |
AiAnalysisTaskDescriptionOutput
智能描述结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| DescriptionSet | Array of MediaAiAnalysisDescriptionItem | 视频智能描述列表。 |
AiAnalysisTaskDescriptionResult
智能描述结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiAnalysisTaskDescriptionInput | 智能描述任务输入。 |
| Output | AiAnalysisTaskDescriptionOutput | 智能描述任务输出。 注意:此字段可能返回 null,表示取不到有效值。 |
AiAnalysisTaskDubbingInput
智能译制任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频译制模板 ID。 示例值:32 |
AiAnalysisTaskDubbingOutput
智能译制结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| VideoPath | String | 译制视频路径。 示例值:/output/dub-result-0.mp4 |
| SpeakerPath | String | 标记文件路径 示例值:/output/dub-result-0.json |
| OutputStorage | TaskOutputStorage | 译制视频存储位置。 |
AiAnalysisTaskDubbingResult
智能译制结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiAnalysisTaskDubbingInput | 智能译制任务输入。 |
| Output | AiAnalysisTaskDubbingOutput | 智能译制任务输出。 注意:此字段可能返回 null,表示取不到有效值。 |
AiAnalysisTaskFrameTagInput
智能按帧标签任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频智能按帧标签模板 ID。 示例值:20 |
AiAnalysisTaskFrameTagOutput
智能按帧标签结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| SegmentSet | Array of MediaAiAnalysisFrameTagSegmentItem | 视频按帧标签列表。 |
AiAnalysisTaskFrameTagResult
智能按帧标签结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:NULL |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:NULL |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:NULL |
| Message | String | 错误信息。 示例值:NULL |
| Input | AiAnalysisTaskFrameTagInput | 智能按帧标签任务输入。 示例值:NULL |
| Output | AiAnalysisTaskFrameTagOutput | 智能按帧标签任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiAnalysisTaskHeadTailInput
片头片尾任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 片头片尾识别模板 ID。 示例值:319919 |
AiAnalysisTaskHeadTailOutput
片头片尾结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| HeadTimeOffset | Float | 片头pts。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| TailTimeOffset | Float | 片尾pts。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
AiAnalysisTaskHeadTailResult
片头片尾结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiAnalysisTaskHeadTailInput | 片头片尾任务输入。 |
| Output | AiAnalysisTaskHeadTailOutput | 片头片尾任务输出。 注意:此字段可能返回 null,表示取不到有效值。 |
AiAnalysisTaskHighlightInput
智能精彩片段任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频智能精彩片段模板 ID。 示例值:26 |
AiAnalysisTaskHighlightOutput
智能精彩片段结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| HighlightSet | Array of MediaAiAnalysisHighlightItem | 视频智能精彩片段列表。 |
| OutputStorage | TaskOutputStorage | 精彩片段的存储位置。 注意:此字段可能返回 null,表示取不到有效值。 |
AiAnalysisTaskHighlightResult
智能精彩片段结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiAnalysisTaskHighlightInput | 智能精彩片段任务输入。 |
| Output | AiAnalysisTaskHighlightOutput | 智能精彩片段任务输出。 注意:此字段可能返回 null,表示取不到有效值。 |
AiAnalysisTaskHorizontalToVerticalInput
智能横转竖任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频智能横转竖模板 ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:28 |
AiAnalysisTaskHorizontalToVerticalOutput
智能横转竖结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Path | String | 视频智能横转竖列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:/output/htv-process-result.mp4 |
| OutputStorage | TaskOutputStorage | 智能横转竖视频的存储位置 注意:此字段可能返回 null,表示取不到有效值。 |
| Confidence | Float | 置信度。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
AiAnalysisTaskHorizontalToVerticalResult
智能横转竖结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种 注意:此字段可能返回 null,表示取不到有效值。 示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败 注意:此字段可能返回 null,表示取不到有效值。 示例值:40000 |
| Message | String | 错误信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:SUCCESS |
| Input | AiAnalysisTaskHorizontalToVerticalInput | 智能横转竖任务输入 注意:此字段可能返回 null,表示取不到有效值。 |
| Output | AiAnalysisTaskHorizontalToVerticalOutput | 智能横转竖任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
AiAnalysisTaskInput
AI 视频智能分析输入参数类型
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 视频内容分析模板 ID。 示例值:28 |
| ExtendedParameter | String | 否 | 扩展参数,其值为序列化的 json字符串。 注意:此参数为定制需求参数,参考如下: 智能檫除 智能拆条 高光集锦 智能横转竖 注意:此字段可能返回 null,表示取不到有效值。 示例值:"{"htv": {} }" |
AiAnalysisTaskSegmentInput
拆条任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 拆条任务模板 ID。 示例值:27 |
AiAnalysisTaskSegmentOutput
智能拆条结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| SegmentSet | Array of SegmentRecognitionItem | 智能拆条子片段列表。 |
| Abstract | String | 视频摘要,离线场景用。 注意:此字段可能返回 null,表示取不到有效值。 示例值:This video introduces Tencent cloud streaming products, including Stream Live, Stream Link, and Stream Package. |
AiAnalysisTaskSegmentResult
拆条结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiAnalysisTaskSegmentInput | 拆条任务输入。 |
| Output | AiAnalysisTaskSegmentOutput | 拆条任务输出。 注意:此字段可能返回 null,表示取不到有效值。 |
AiAnalysisTaskTagInput
智能标签任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频智能标签模板 ID。 示例值:20 |
AiAnalysisTaskTagOutput
智能标签结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| TagSet | Array of MediaAiAnalysisTagItem | 视频智能标签列表。 |
AiAnalysisTaskTagResult
智能标签结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiAnalysisTaskTagInput | 智能标签任务输入。 示例值:NULL |
| Output | AiAnalysisTaskTagOutput | 智能标签任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiAnalysisTaskVideoComprehensionInput
视频(音频)理解任务输入
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频(音频)理解模板ID 示例值:33 |
AiAnalysisTaskVideoComprehensionOutput
视频(音频)理解输出内容结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| VideoComprehensionAnalysisResult | String | 视频(音频)理解内容详情 示例值:您好!作为一名专业的音乐分析师,非常荣幸能为您分析这段《梦中的婚礼》的钢琴弹奏。这是一首非常优美且广为人知的曲子,能选择它来练习,说明您对音乐有很好的品味和追求.... |
AiAnalysisTaskVideoComprehensionResult
视频(音频)理解结果
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败 示例值:0 |
| Message | String | 错误信息 示例值:SUCCESS |
| Input | AiAnalysisTaskVideoComprehensionInput | 视频(音频)理解输入 |
| Output | AiAnalysisTaskVideoComprehensionOutput | 视频(音频)理解输出 注意:此字段可能返回 null,表示取不到有效值。 |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表 示例值:InvalidInput |
| Progress | Integer | 任务进度 示例值:100 |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 示例值:2024-05-25T02:55:55Z |
| FinishTime | String | 任务执行完毕时间,采用 ISO 日期格式。 示例值:2024-05-25T02:55:58Z |
AiAnalysisTaskVideoRemakeInput
视频去重任务输入类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 视频智能去重模板 ID 示例值:28 |
AiAnalysisTaskVideoRemakeOutput
视频去重结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Path | String | 视频智能去重文件路径 示例值:/output/htv-process-result.mp4 |
| OutputStorage | TaskOutputStorage | 智能视频去重的存储位置 |
AiAnalysisTaskVideoRemakeResult
视频去重结果数据结构
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败 示例值:0 |
| Message | String | 错误信息 示例值:SUCCESS |
| Input | AiAnalysisTaskVideoRemakeInput | 去重任务输入 |
| Output | AiAnalysisTaskVideoRemakeOutput | 去重任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
AiContentReviewResult
内容审核结果
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 任务的类型,可以取的值有: 示例值:"Political" |
| SampleRate | Float | 采样频率,即对视频每秒截取进行审核的帧数。 示例值:0 |
| Duration | Float | 审核的视频时长,单位:秒。 示例值:0 |
| PornTask | AiReviewTaskPornResult | 视频内容审核智能画面鉴黄任务的查询结果,当任务类型为 Porn 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| TerrorismTask | AiReviewTaskTerrorismResult | 视频内容审核智能画面敏感任务的查询结果,当任务类型为 Terrorism 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| PoliticalTask | AiReviewTaskPoliticalResult | 视频内容审核智能画面敏感任务的查询结果,当任务类型为 Political 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| PornAsrTask | AiReviewTaskPornAsrResult | 视频内容审核 Asr 文字鉴黄任务的查询结果,当任务类型为 Porn.Asr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| PornOcrTask | AiReviewTaskPornOcrResult | 视频内容审核 Ocr 文字鉴黄任务的查询结果,当任务类型为 Porn.Ocr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| PoliticalAsrTask | AiReviewTaskPoliticalAsrResult | 视频内容审核 Asr 文字敏感任务的查询结果,当任务类型为 Political.Asr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| PoliticalOcrTask | AiReviewTaskPoliticalOcrResult | 视频内容审核 Ocr 文字敏感任务的查询结果,当任务类型为 Political.Ocr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| TerrorismOcrTask | AiReviewTaskTerrorismOcrResult | 视频内容审核 Ocr 文字敏感任务的查询结果,当任务类型为 Terrorism.Ocr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| ProhibitedAsrTask | AiReviewTaskProhibitedAsrResult | 视频内容审核 Asr 文字鉴违禁任务的查询结果,当任务类型为 Prohibited.Asr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| ProhibitedOcrTask | AiReviewTaskProhibitedOcrResult | 视频内容审核 Ocr 文字鉴违禁任务的查询结果,当任务类型为 Prohibited.Ocr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiContentReviewTaskInput
智能内容审核任务类型
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 视频内容审核模板 ID。 示例值:10 |
AiParagraphInfo
分段信息。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Summary | String | 分段摘要 注意:此字段可能返回 null,表示取不到有效值。 示例值:This video highlights the live streaming services provided by Ten Cent Cloud Media Services |
| Title | String | 分段标题 示例值:Tencent Cloud Media Services: Streamlining Live Streaming Solutions |
| Keywords | Array of String | 分段关键词 示例值:["words1","words2"] |
| StartTimeOffset | Float | 分段起始时间点,秒 注意:此字段可能返回 null,表示取不到有效值。 示例值:2.532 |
| EndTimeOffset | Float | 分段结束时间点,秒 注意:此字段可能返回 null,表示取不到有效值。 示例值:5.532 |
AiQualityControlTaskInput
媒体质检输入参数类型
被如下接口引用:CreateSchedule, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 否 | 媒体质检模板 ID 。 可以直接使用预设模板,也可以在控制台自定义模板。预设模板如下: - 10:开启所有质检项; - 20:仅开启格式诊断对应质检项; - 30:仅开启无参考打分对应质检项; - 40:仅开启画面质量对应质检项。 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
| ChannelExtPara | String | 否 | 渠道扩展参数json序列化字符串。 注意:此字段可能返回 null,表示取不到有效值。 示例值:{"OutputDir":"/test/output/1abc***12345/"} |
AiRecognitionResult
智能识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 任务的类型,取值范围: 示例值:FaceRecognition |
| FaceTask | AiRecognitionTaskFaceResult | 人脸识别结果,当 Type 为 FaceRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| AsrWordsTask | AiRecognitionTaskAsrWordsResult | 语音关键词识别结果,当 Type 为 AsrWordsRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| AsrFullTextTask | AiRecognitionTaskAsrFullTextResult | 语音全文识别结果,当 Type 为 AsrFullTextRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| OcrWordsTask | AiRecognitionTaskOcrWordsResult | 文本关键词识别结果,当 Type 为 OcrWordsRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| OcrFullTextTask | AiRecognitionTaskOcrFullTextResult | 文本全文识别结果,当 Type 为 OcrFullTextRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| TransTextTask | AiRecognitionTaskTransTextResult | 翻译结果,当 Type 为 TransTextRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| ObjectTask | AiRecognitionTaskObjectResult | 物体识别结果,当Type 为 ObjectRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiRecognitionTaskAsrFullTextResult
语音全文识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiRecognitionTaskAsrFullTextResultInput | 语音全文识别任务输入信息。 示例值:NULL |
| Output | AiRecognitionTaskAsrFullTextResultOutput | 语音全文识别任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| Progress | Integer | 任务进度。 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
AiRecognitionTaskAsrFullTextResultInput
语音全文识别的输入。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 语音全文识别模板 ID。 示例值:10101 |
AiRecognitionTaskAsrFullTextResultOutput
语音全文识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| SegmentSet | Array of AiRecognitionTaskAsrFullTextSegmentItem | 语音全文识别片段列表。 |
| SubtitlePath | String | 字幕文件地址。 示例值:http://lily-1256342427.cos.ap-shanghai.myqcloud.com/3109868718.vtt |
AiRecognitionTaskAsrFullTextSegmentItem
语音全文识别片段。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:100 |
| StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 示例值:3.204 |
| EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 示例值:7.204 |
| Text | String | 识别文本。 示例值:腾讯云媒体处理 |
| Wordlist | Array of WordResult | 字词时间戳信息。 |
AiRecognitionTaskAsrWordsResult
语音关键词识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiRecognitionTaskAsrWordsResultInput | 语音关键词识别任务输入信息。 示例值:NULL |
| Output | AiRecognitionTaskAsrWordsResultOutput | 语音关键词识别任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiRecognitionTaskAsrWordsResultInput
语音关键词识别输入。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 语音关键词识别模板 ID。 示例值:20 |
AiRecognitionTaskAsrWordsResultItem
语音关键词识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Word | String | 语音关键词。 示例值:关键词 |
| SegmentSet | Array of AiRecognitionTaskAsrWordsSegmentItem | 语音关键词出现的时间片段列表。 |
AiRecognitionTaskAsrWordsResultOutput
语音关键词识别输出。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResultSet | Array of AiRecognitionTaskAsrWordsResultItem | 语音关键词识别结果集。 |
AiRecognitionTaskAsrWordsSegmentItem
语音识别片段。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 示例值:4.096 |
| EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 示例值:5.546 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:100 |
AiRecognitionTaskFaceResult
人脸识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiRecognitionTaskFaceResultInput | 人脸识别任务输入信息。 示例值:NULL |
| Output | AiRecognitionTaskFaceResultOutput | 人脸识别任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiRecognitionTaskFaceResultInput
人脸识别输入。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 人脸识别模板 ID。 示例值:10 |
AiRecognitionTaskFaceResultItem
人脸识别结果
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 人物唯一标识 ID。 示例值:9527 |
| Type | String | 人物库类型,表示识别出的人物来自哪个人物库: 示例值:Default |
| Name | String | 人物名称。 示例值:张三 |
| SegmentSet | Array of AiRecognitionTaskFaceSegmentItem | 人物出现的片段结果集。 示例值:NULL |
| Gender | String | 人物性别: 示例值:Male |
| Birthday | String | 人物出生日期。 示例值:1953年6月 |
| Profession | String | 人物职业或者职务。 示例值:歌手 |
| SchoolOfGraduation | String | 人物毕业院校。 示例值:清华大学 |
| Abstract | String | 人物简介。 示例值:知名歌手,代表作xxx |
| PlaceOfBirth | String | 人物出生地或者籍贯。 示例值:湖北武汉 |
| PersonType | String | 人物类型: 示例值:Politician |
| Remark | String | 敏感度标注: 示例值:Normal |
| Url | String | 截图链接 示例值:https://test-result.com/face-recognition-person1.jpg |
AiRecognitionTaskFaceResultOutput
智能人脸识别输出。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResultSet | Array of AiRecognitionTaskFaceResultItem | 智能人脸识别结果集。 |
AiRecognitionTaskFaceSegmentItem
人脸识别结果片段
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 示例值:0.033 |
| EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 示例值:0.035 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:95 |
| AreaCoordSet | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。 示例值: [807,345,985,523] |
AiRecognitionTaskInput
视频内容识别输入参数类型
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, DescribeWorkflows, ModifySchedule, ParseNotification, ProcessLiveStream, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 视频智能识别模板 ID 。 示例值:10 |
| UserExtPara | String | 否 | 用户扩展字段,一般场景不用填。 示例值:{"ParaTest":"test"} |
AiRecognitionTaskObjectResult
物体识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCode | Integer | 错误码,0:成功,其他值:失败。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiRecognitionTaskObjectResultInput | 物体识别任务输入信息。 |
| Output | AiRecognitionTaskObjectResultOutput | 物体识别任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 |
AiRecognitionTaskObjectResultInput
物体识别任务输入类型。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 物体识别模板 ID。 示例值:20 |
AiRecognitionTaskObjectResultItem
单个物体识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 识别的物体名称。 示例值:人脸 |
| SegmentSet | Array of AiRecognitionTaskObjectSeqmentItem | 物体出现的片段列表。 |
AiRecognitionTaskObjectResultOutput
智能物体识别输出。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResultSet | Array of AiRecognitionTaskObjectResultItem | 智能物体识别结果集。 |
AiRecognitionTaskObjectSeqmentItem
物体识别结果片段。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 示例值:1.034 |
| EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 示例值:1.035 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:100 |
| AreaCoordSet | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。 示例值:[932,342,1275,787] |
AiRecognitionTaskOcrFullTextResult
文本全文识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiRecognitionTaskOcrFullTextResultInput | 文本全文识别任务输入信息。 示例值:NULL |
| Output | AiRecognitionTaskOcrFullTextResultOutput | 文本全文识别任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiRecognitionTaskOcrFullTextResultInput
文本全文识别输入。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 文本全文识别模板 ID。 示例值:20 |
AiRecognitionTaskOcrFullTextResultOutput
文本全文识别输出。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| SegmentSet | Array of AiRecognitionTaskOcrFullTextSegmentItem | 文本全文识别结果集。 |
AiRecognitionTaskOcrFullTextSegmentItem
文本全文识别片段。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 示例值:2.035 |
| EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 示例值:2.035 |
| TextSet | Array of AiRecognitionTaskOcrFullTextSegmentTextItem | 识别片段结果集。 |
AiRecognitionTaskOcrFullTextSegmentTextItem
文本全文识别片段。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:100 |
| AreaCoordSet | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。 示例值: [1592,84,1774,131] |
| Text | String | 识别文本。 示例值:腾讯云 |
AiRecognitionTaskOcrWordsResult
文本关键识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiRecognitionTaskOcrWordsResultInput | 文本关键词识别任务输入信息。 示例值:NULL |
| Output | AiRecognitionTaskOcrWordsResultOutput | 文本关键词识别任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiRecognitionTaskOcrWordsResultInput
文本关键词识别输入。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 文本关键词识别模板 ID。 示例值:10 |
AiRecognitionTaskOcrWordsResultItem
文本关键词识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Word | String | 文本关键词。 示例值:关键词 |
| SegmentSet | Array of AiRecognitionTaskOcrWordsSegmentItem | 文本关键出现的片段列表。 |
AiRecognitionTaskOcrWordsResultOutput
文本关键词识别输出。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResultSet | Array of AiRecognitionTaskOcrWordsResultItem | 文本关键词识别结果集。 |
AiRecognitionTaskOcrWordsSegmentItem
文本识别片段。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 示例值:4.096 |
| EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 示例值:5.546 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:100 |
| AreaCoordSet | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。 示例值:[729,939,1159,1014] |
AiRecognitionTaskTransTextResult
翻译结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiRecognitionTaskTransTextResultInput | 翻译任务输入信息。 示例值:NULL |
| Output | AiRecognitionTaskTransTextResultOutput | 翻译任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| Progress | Integer | 任务进度。 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
AiRecognitionTaskTransTextResultInput
翻译的输入。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 翻译模板 ID。 示例值:10103 |
AiRecognitionTaskTransTextResultOutput
翻译结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| SegmentSet | Array of AiRecognitionTaskTransTextSegmentItem | 翻译片段列表。 示例值:NULL |
| SubtitlePath | String | 字幕文件地址。 示例值:http://lily-1256342427.cos.ap-shanghai.myqcloud.com/3109868718.vtt |
AiRecognitionTaskTransTextSegmentItem
翻译片段。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:100 |
| StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 示例值:17.45 |
| EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 示例值:29.99 |
| Text | String | 识别文本。 示例值:你好 |
| Trans | String | 翻译文本。 示例值:Hello |
| Wordlist | Array of WordResult | 字词时间戳信息。 |
AiReviewPoliticalAsrTaskInput
内容审核 Asr 文字敏感任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 模板 ID。 示例值:0 |
AiReviewPoliticalAsrTaskOutput
Asr 文字敏感信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | Asr 文字敏感评分,分值为0到100。 示例值:0 |
| Suggestion | String | Asr 文字敏感结果建议,取值范围: 示例值:review |
| SegmentSet | Array of MediaContentReviewAsrTextSegmentItem | Asr 文字敏感嫌疑的视频片段列表。 |
AiReviewPoliticalOcrTaskInput
内容审核 Ocr 文字敏感任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 模板 ID。 示例值:0 |
AiReviewPoliticalOcrTaskOutput
Ocr 文字敏感信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | Ocr 文字敏感评分,分值为0到100。 示例值:0 |
| Suggestion | String | Ocr 文字敏感结果建议,取值范围: 示例值:review |
| SegmentSet | Array of MediaContentReviewOcrTextSegmentItem | Ocr 文字有敏感嫌疑的视频片段列表。 |
AiReviewPoliticalTaskInput
内容审核敏感任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 模板 ID。 示例值:0 |
AiReviewPoliticalTaskOutput
涉敏信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 视频涉敏评分,分值为0到100。 示例值:0 |
| Suggestion | String | 涉敏结果建议,取值范围: 示例值:review |
| Label | String | 视频涉敏结果标签。内容审核模板画面涉敏任务控制参数里 LabelSet 参数与此参数取值范围的对应关系: violation_photo: 其他(即 politician/entertainment/sport/entrepreneur/scholar/celebrity/military): 示例值:politician |
| SegmentSet | Array of MediaContentReviewPoliticalSegmentItem | 有涉敏嫌疑的视频片段列表。 |
AiReviewPornAsrTaskInput
内容审核 Asr 文字鉴黄任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 鉴黄模板 ID。 示例值:20 |
AiReviewPornAsrTaskOutput
Asr 文字涉黄信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | Asr 文字涉黄评分,分值为0到100。 示例值:75 |
| Suggestion | String | Asr 文字涉黄结果建议,取值范围: 示例值:review |
| SegmentSet | Array of MediaContentReviewAsrTextSegmentItem | Asr 文字有涉黄嫌疑的视频片段列表。 |
AiReviewPornOcrTaskInput
内容审核 Ocr 文字鉴黄任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 鉴黄模板 ID。 示例值:20 |
AiReviewPornOcrTaskOutput
Ocr 文字涉黄信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | Ocr 文字涉黄评分,分值为0到100。 示例值:75 |
| Suggestion | String | Ocr 文字涉黄结果建议,取值范围: 示例值:review |
| SegmentSet | Array of MediaContentReviewOcrTextSegmentItem | Ocr 文字有涉黄嫌疑的视频片段列表。 |
AiReviewPornTaskInput
内容审核鉴黄任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 鉴黄模板 ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
AiReviewPornTaskOutput
鉴黄结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 视频鉴黄评分,分值为0到100。 示例值:75 |
| Suggestion | String | 鉴黄结果建议,取值范围: 示例值:review |
| Label | String | 视频鉴黄结果标签,取值范围: 示例值:porn |
| SegmentSet | Array of MediaContentReviewSegmentItem | 有涉黄嫌疑的视频片段列表。 |
AiReviewProhibitedAsrTaskInput
内容审核 Asr 文字鉴违禁任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 鉴违禁模板 ID。 示例值:20 |
AiReviewProhibitedAsrTaskOutput
Asr 文字涉违禁信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | Asr 文字涉违禁评分,分值为0到100。 示例值:90 |
| Suggestion | String | Asr 文字涉违禁结果建议,取值范围: 示例值:review |
| SegmentSet | Array of MediaContentReviewAsrTextSegmentItem | Asr 文字有涉违禁嫌疑的视频片段列表。 |
AiReviewProhibitedOcrTaskInput
内容审核 Ocr 文字鉴违禁任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 鉴违禁模板 ID。 示例值:20 |
AiReviewProhibitedOcrTaskOutput
Ocr 文字涉违禁信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | Ocr 文字涉违禁评分,分值为0到100。 示例值:90 |
| Suggestion | String | Ocr 文字涉违禁结果建议,取值范围: 示例值:review |
| SegmentSet | Array of MediaContentReviewOcrTextSegmentItem | Ocr 文字有涉违禁嫌疑的视频片段列表。 |
AiReviewTaskPoliticalAsrResult
内容审核 Asr 文字敏感任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewPoliticalAsrTaskInput | 内容审核 Asr 文字敏感任务输入。 |
| Output | AiReviewPoliticalAsrTaskOutput | 内容审核 Asr 文字敏感任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTaskPoliticalOcrResult
内容审核 Ocr 文字敏感任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS,FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewPoliticalOcrTaskInput | 内容审核 Ocr 文字敏感任务输入。 |
| Output | AiReviewPoliticalOcrTaskOutput | 内容审核 Ocr 文字敏感任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTaskPoliticalResult
内容审核涉敏任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewPoliticalTaskInput | 内容审核涉敏任务输入。 |
| Output | AiReviewPoliticalTaskOutput | 内容审核涉敏任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTaskPornAsrResult
内容审核 Asr 文字鉴黄任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewPornAsrTaskInput | 内容审核 Asr 文字鉴黄任务输入。 示例值:NULL |
| Output | AiReviewPornAsrTaskOutput | 内容审核 Asr 文字鉴黄任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTaskPornOcrResult
内容审核 Ocr 文字鉴黄任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewPornOcrTaskInput | 内容审核 Ocr 文字鉴黄任务输入。 示例值:NULL |
| Output | AiReviewPornOcrTaskOutput | 内容审核 Ocr 文字鉴黄任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTaskPornResult
内容审核鉴黄任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewPornTaskInput | 内容审核鉴黄任务输入。 示例值:NULL |
| Output | AiReviewPornTaskOutput | 内容审核鉴黄任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTaskProhibitedAsrResult
内容审核 Asr 文字鉴任违禁务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewProhibitedAsrTaskInput | 内容审核 Asr 文字鉴违禁任务输入。 示例值:NULL |
| Output | AiReviewProhibitedAsrTaskOutput | 内容审核 Asr 文字鉴违禁任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTaskProhibitedOcrResult
内容审核 Ocr 文字鉴任违禁务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewProhibitedOcrTaskInput | 内容审核 Ocr 文字鉴违禁任务输入。 示例值:NULL |
| Output | AiReviewProhibitedOcrTaskOutput | 内容审核 Ocr 文字鉴违禁任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTaskTerrorismOcrResult
内容审核 Ocr 文字敏感任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewTerrorismOcrTaskInput | 内容审核 Ocr 文字敏感任务输入。 示例值:NULL |
| Output | AiReviewTerrorismOcrTaskOutput | 内容审核 Ocr 文字敏感任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTaskTerrorismResult
内容审核涉敏任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiReviewTerrorismTaskInput | 内容审核涉敏任务输入。 示例值:NULL |
| Output | AiReviewTerrorismTaskOutput | 内容审核涉敏任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
AiReviewTerrorismOcrTaskInput
内容审核 Ocr 文字敏感任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 模板 ID。 示例值:0 |
AiReviewTerrorismOcrTaskOutput
Ocr 文字涉敏信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | Ocr 文字涉敏评分,分值为0到100。 示例值:0 |
| Suggestion | String | Ocr 文字涉敏结果建议,取值范围: 示例值:review |
| SegmentSet | Array of MediaContentReviewOcrTextSegmentItem | Ocr 文字有涉敏嫌疑的视频片段列表。 示例值:NULL |
AiReviewTerrorismTaskInput
内容审核涉敏任务输入参数类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 模板 ID。 示例值:0 |
AiReviewTerrorismTaskOutput
涉敏信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 视频涉敏评分,分值为0到100。 示例值:20 |
| Suggestion | String | 涉敏结果建议,取值范围: 示例值:pass |
| Label | String | 视频涉敏结果标签,取值范围: 示例值:crowd |
| SegmentSet | Array of MediaContentReviewSegmentItem | 有涉敏嫌疑的视频片段列表。 示例值:[] |
AiSampleFaceInfo
AI 样本管理,人脸信息。
被如下接口引用:CreatePersonSample, DescribePersonSamples, ModifyPersonSample。
| 名称 | 类型 | 描述 |
|---|---|---|
| FaceId | String | 人脸图片 ID。 示例值:151*** |
| Url | String | 人脸图片地址。 示例值:http://1234567.vod2.myqcloud.com/****/95f****d-****-****-****-132c8****9c73.jpeg |
AiSampleFaceOperation
AI 样本管理,人脸数据操作。
被如下接口引用:ModifyPersonSample。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 操作类型,可选值:add(添加)、delete(删除)、reset(重置)。重置操作将清空该人物已有人脸数据,并添加 FaceContents 指定人脸数据。 示例值:add |
| FaceIds | Array of String | 否 | 人脸 ID 集合,当 Type为delete 时,该字段必填。 示例值:["151***"] |
| FaceContents | Array of String | 否 | 人脸图片 Base64 编码后的字符串集合。 注意:图片必须是单人像正面人脸较清晰的照片,像素不低于 200200。 示例值:["/9j/4***SkZJRg****SABIAAD"] |
AiSampleFailFaceInfo
AI 样本管理,处理失败的人脸信息
被如下接口引用:CreatePersonSample, ModifyPersonSample。
| 名称 | 类型 | 描述 |
|---|---|---|
| Index | Integer | 对应入参 FaceContents 中错误图片下标,从 0 开始。 示例值:0 |
| ErrCode | Integer | 错误码,取值: 示例值:501 |
| Message | String | 错误描述。 示例值:remote call error |
AiSamplePerson
AI 样本管理,人物信息。
被如下接口引用:CreatePersonSample, DescribePersonSamples, ModifyPersonSample。
| 名称 | 类型 | 描述 |
|---|---|---|
| PersonId | String | 人物 ID。 示例值:9527 |
| Name | String | 人物名称。 示例值:Default |
| Description | String | 人物描述。 示例值:张三 |
| FaceInfoSet | Array of AiSampleFaceInfo | 人脸信息。 示例值:NULL |
| TagSet | Array of String | 人物标签。 示例值:NULL |
| UsageSet | Array of String | 应用场景。 示例值:NULL |
| CreateTime | String | 创建时间,使用 ISO 日期格式。 示例值:2025-03-25T06:16:39Z |
| UpdateTime | String | 最后修改时间,使用 ISO 日期格式。 示例值:2025-03-25T06:16:39Z |
AiSampleTagOperation
AI 样本管理,标签操作。
被如下接口引用:ModifyPersonSample, ModifyWordSample。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 操作类型,可选值:add(添加)、delete(删除)、reset(重置)。 示例值:add |
| Tags | Array of String | 是 | 标签,长度限制:128 个字符。 示例值:明星 |
AiSampleWord
AI 样本管理,关键词输出信息。
被如下接口引用:DescribeWordSamples。
| 名称 | 类型 | 描述 |
|---|---|---|
| Keyword | String | 关键词。 示例值:张三 |
| TagSet | Array of String | 关键词标签。 示例值: ["明星","艺人"] |
| UsageSet | Array of String | 关键词应用场景。 示例值:["Recognition.Ocr", "Recognition.Asr"] |
| CreateTime | String | 创建时间,使用 ISO 日期格式。 示例值:2018-10-01T10:00:00Z |
| UpdateTime | String | 最后修改时间,使用 ISO 日期格式。 示例值:2018-10-01T10:00:00Z |
AiSampleWordInfo
AI 样本管理,关键词输入信息。
被如下接口引用:CreateWordSamples。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Keyword | String | 是 | 关键词,长度限制:20 个字符。 示例值:张三 |
| Tags | Array of String | 否 | 关键词标签 示例值:["明星","艺人"] |
AnimatedGraphicTaskInput
转动图任务类型。
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 视频转动图模板 ID。 示例值:20000 |
| StartTimeOffset | Float | 是 | 动图在视频中的开始时间,单位为秒。 示例值:1.5 |
| EndTimeOffset | Float | 是 | 动图在视频中的结束时间,单位为秒。 示例值:11.2 |
| OutputStorage | TaskOutputStorage | 否 | 转动图后文件的目标存储,不填则继承上层的 OutputStorage 值。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputObjectPath | String | 否 | 转动图后文件的输出路径,可以为相对路径或者绝对路径。 若需定义输出路径,路径需以 .{format}结尾。变量名请参考 文件名变量说明。相对路径示例: 绝对路径示例: 如果不填,则默认为相对路径: {inputName}_animatedGraphic_{definition}.{format}。示例值:文件名_{变量名}.{format} |
AnimatedGraphicsTemplate
转动图模板详情。
被如下接口引用:DescribeAnimatedGraphicsTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 转动图模板唯一标识。 示例值:20001 |
| Type | String | 模板类型,取值范围: 示例值:Preset |
| Name | String | 转动图模板名称。 示例值:转动图模板 |
| Comment | String | 转动图模板描述。 示例值:转动图模板说明 |
| Width | Integer | 动图宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 示例值:0 |
| Height | Integer | 动图高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 示例值:0 |
| ResolutionAdaptive | String | 分辨率自适应,可选值: 默认值:open。 示例值:close |
| Format | String | 动图格式。 示例值:gif |
| Fps | Integer | 帧率。 示例值:2 |
| Quality | Float | 图片质量。 示例值:75 |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2016-12-31T16:00:00Z |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2016-12-31T16:00:00Z |
ArtifactRepairConfig
去伪影(毛刺)配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 类型,可选值: 默认值:weak。 注意:此字段可能返回 null,表示取不到有效值。 示例值:weak |
AsrFullTextConfigureInfo
语音全文识别任务控制参数
被如下接口引用:CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 语音全文识别任务开关,可选值: 示例值:ON |
| SubtitleFormat | String | 否 | 生成的字幕文件格式,不填或者填空字符串表示不生成字幕文件,可选值: 示例值:vtt |
| SourceLanguage | String | 否 | 视频源语言。 示例值:zh |
AsrFullTextConfigureInfoForUpdate
语音全文识别任务控制参数
被如下接口引用:ModifyAIRecognitionTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 语音全文识别任务开关,可选值: 示例值:ON |
| SubtitleFormat | String | 否 | 生成的字幕文件格式,填空字符串表示不生成字幕文件,可选值: 示例值:vtt |
| SourceLanguage | String | 否 | 视频源语言。 示例值:zh |
AsrHotWordsConfigure
智能字幕热词参数
被如下接口引用:BatchProcessMedia, CreateSmartSubtitleTemplate, DescribeSmartSubtitleTemplates, ModifySmartSubtitleTemplate, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 热词开关 注意:此字段可能返回 null,表示取不到有效值。 示例值:ON |
| LibraryId | String | 否 | 热词库ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:hwd-2670a776bb5eccccc324 |
AsrHotwordsSet
热词库查询返回结果集
被如下接口引用:DescribeAsrHotwordsList。
| 名称 | 类型 | 描述 |
|---|---|---|
| HotwordsId | String | 热词库 Id 注意:此字段可能返回 null,表示取不到有效值。 示例值:hwd-aftgxxx |
| Status | Integer | 当前热词库状态,数值表示绑定该热词库的智能字幕模板数量。 Status 为 0 ,表示该热词库没有被智能字幕模板引用可以删除; Status 不为 0,表示该热词库不能被删除。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| Name | String | 热词库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:hotwordname |
| WordCount | Integer | 热词库中的热词数量 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| FileName | String | 热词文件上传时的文件名 注意:此字段可能返回 null,表示取不到有效值。 示例值:hwd.txt |
| CreateTime | String | 热词库创建时间 ISOUTC 时间格式 2006-01-02T15:04:05Z 注意:此字段可能返回 null,表示取不到有效值。 示例值:2006-01-02T15:04:05Z |
| UpdateTime | String | 热词库创建时间 ISOUTC 时间格式 2006-01-02T15:04:05Z 注意:此字段可能返回 null,表示取不到有效值。 示例值:2006-01-02T15:04:05Z |
| Type | Integer | 0:临时热词库 1:文件热词库 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
AsrHotwordsSetItem
单个热词信息
被如下接口引用:DescribeAsrHotwords。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | Integer | 热词的序号 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
| Text | String | 热词文本 注意:此字段可能返回 null,表示取不到有效值。 示例值:腾讯云 |
| Weight | Integer | 词语权重,取值范围 1-10,11,100 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
AsrWordsConfigureInfo
语音关键词识别控制参数。
被如下接口引用:CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 语音关键词识别任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["明星","艺人"] |
AsrWordsConfigureInfoForUpdate
语音关键词识别控制参数。
被如下接口引用:ModifyAIRecognitionTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 语音关键词识别任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["明星","艺人"] |
AudioBeautifyConfig
音量美化配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Types | Array of String | 否 | 类型,可多选,可选值: 默认值:declick。 注意:此字段可能返回 null,表示取不到有效值。 示例值:declick |
AudioDenoiseConfig
音频降噪配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
AudioEnhanceConfig
音频增强配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Denoise | AudioDenoiseConfig | 否 | 音频降噪配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| Separate | AudioSeparateConfig | 否 | 音频分离配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| VolumeBalance | VolumeBalanceConfig | 否 | 音量均衡配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| Beautify | AudioBeautifyConfig | 否 | 音频美化配置。 注意:此字段可能返回 null,表示取不到有效值。 |
AudioSeparateConfig
音频分离配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 场景类型,可选值: 默认值:normal。 注意:此字段可能返回 null,表示取不到有效值。 示例值:normal |
| Track | String | 否 | 输出音轨,可选值: 默认值:vocal。 注意:此字段可能返回 null,表示取不到有效值。 示例值:vocal |
AudioTemplateInfo
音频流配置参数
被如下接口引用:CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Codec | String | 是 | 音频流的编码格式。 当不需要对音频进行转码时,可选值为: 当外层参数 Container 为 mp3 时,可选值为: 当外层参数 Container 为 ogg 或 flac 时,可选值为: 当外层参数 Container 为 m4a 时,可选值为: 当外层参数 Container 为 mp4 或 flv 时,可选值为: 当外层参数 Container 为 hls 时,可选值为: 示例值:aac |
| Bitrate | Integer | 是 | 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。 当取值为 0,表示音频码率和原始音频保持一致。 注意:如果使用自适应转码音轨合并TrackChannelInfo参数,取值范围: 1)、不能填0; 2)、Codec为:aac时,取值范围:[26, 256]; 3)、Codec为:ac3时,取值范围:[26, 640]; 4)、Codec为:eac3时,取值范围:[26, 6144],备注:当SampleRate为44100HZ,最大值为:5644,当SampleRate为48000HZ,最大值为:6144, 示例值:0 |
| SampleRate | Integer | 是 | 音频流的采样率,不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。 详细参考音频采样率支持范围文档 单位:Hz 注意:请确保源音频流的采样率在上述选项范围内,否则可能导致转码失败! 示例值:44100 |
| AudioChannel | Integer | 否 | 音频通道方式,可选值: 当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为5.1声道。 默认值:2。 示例值:2 |
| TrackChannelInfo | AudioTrackChannelInfo | 否 | 合并音轨信息。 注意:此字段只是自适应转码生效, 注意:此字段可能返回 null,表示取不到有效值。 |
AudioTemplateInfoForUpdate
音频流配置参数
被如下接口引用:CreateWorkflow, ModifyTranscodeTemplate, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Codec | String | 否 | 音频流的编码格式。 当不需要对音频进行转码时,可选值为: 当外层参数 Container 为 mp3 时,可选值为: 当外层参数 Container 为 ogg 或 flac 时,可选值为: 当外层参数 Container 为 m4a 时,可选值为: 当外层参数 Container 为 mp4 或 flv 时,可选值为: 当外层参数 Container 为 hls 时,可选值为: 注意:此字段可能返回 null,表示取不到有效值。 示例值:aac |
| Bitrate | Integer | 否 | 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。 当取值为 0,表示音频码率和原始音频保持一致。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SampleRate | Integer | 否 | 音频流的采样率,不同编码标准支持的采样率选项不同。填0代表使用源音频的采样率数值。 详细参考音频采样率支持范围文档 单位:Hz 注意:请确保源音频流的采样率在上述选项范围内,否则可能导致转码失败! 注意:此字段可能返回 null,表示取不到有效值。 示例值:44100 |
| AudioChannel | Integer | 否 | 音频通道方式,可选值: 当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为5.1声道。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| StreamSelects | Array of Integer | 否 | 指定输出要保留的音频轨道。默认是全部保留源的。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[0] |
AudioTrackChannelInfo
音轨信息
被如下接口引用:CreateTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ChannelsRemix | Integer | 否 | 是否开启混音,可选值: 0:表示不开启混音 1:表示开启混音 默认值:0 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SelectType | String | 否 | 合并音轨输入类型,可选值: track:表示使用音轨id; track_channel: 表示使用音轨id和声道id; 默认:track。 注意:如果原视频是多声道,建议使用track_channel。 注意:此字段可能返回 null,表示取不到有效值。 示例值:track |
| InputTrackInfo | Array of TrackInfo | 否 | 音轨信息 注意:此字段可能返回 null,表示取不到有效值。 |
AwsS3FileUploadTrigger
AWS S3 文件是上传触发器。
被如下接口引用:CreateSchedule, CreateWorkflow, ModifySchedule, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| S3Bucket | String | 是 | 绑定的 AWS S3 存储桶。 示例值:mps-test-s3 |
| S3Region | String | 是 | 绑定的桶所在 AWS 区域,目前支持: us-east-1 eu-west-3 示例值:us-east-1 |
| Dir | String | 否 | 绑定的输入路径目录,必须为绝对路径,即以 / 开头和结尾。如/movie/201907/,不填代表根目录/。 示例值:/Dir/ |
| Formats | Array of String | 否 | 允许触发的文件格式列表,如 ["mp4", "flv", "mov"]。不填代表所有格式的文件都可以触发工作流。 示例值:["mp4", "flv", "mov"] |
| S3SecretId | String | 否 | 绑定的 AWS S3 存储桶的秘钥ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:AKIA***123W |
| S3SecretKey | String | 否 | 绑定的 AWS S3 存储桶的秘钥Key。 注意:此字段可能返回 null,表示取不到有效值。 示例值:AKIA***123W |
| AwsSQS | AwsSQS | 否 | 绑定的 AWS S3 存储桶对应的 SQS事件队列。 注意:队列和桶需要在同一区域。 注意:此字段可能返回 null,表示取不到有效值。 |
AwsSQS
Aws SQS 队列信息
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSchedule, CreateVideoDatabaseEntryTask, CreateVideoSearchTask, CreateWorkflow, DescribeBatchTaskDetail, DescribeTaskDetail, EditMedia, ModifySchedule, ProcessMedia, ResetWorkflow, WithdrawsWatermark。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SQSRegion | String | 是 | SQS 队列区域。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-southeast-1 |
| SQSQueueName | String | 是 | SQS 队列名称。 注意:此字段可能返回 null,表示取不到有效值。 示例值:mps123_s3_sqs |
| S3SecretId | String | 否 | 读写SQS的秘钥id。 注意:此字段可能返回 null,表示取不到有效值。 示例值:AKIA***123W |
| S3SecretKey | String | 否 | 读写SQS的秘钥key。 注意:此字段可能返回 null,表示取不到有效值。 示例值:AKIA***123W |
BatchSmartSubtitlesResult
智能字幕结果。
被如下接口引用:DescribeBatchTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Input | SmartSubtitleTaskResultInput | 智能字幕任务输入信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| Outputs | Array of SmartSubtitleTaskBatchOutput | 智能字幕输出信息 注意:此字段可能返回 null,表示取不到有效值。 |
BatchSubTaskResult
批量任务子任务结果
被如下接口引用:DescribeBatchTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| InputInfos | Array of MediaInputInfo | 批量任务输入信息 注意:此字段可能返回 null,表示取不到有效值。 |
| Metadatas | Array of MediaMetaData | 原始视频的元信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| SmartSubtitlesTaskResult | BatchSmartSubtitlesResult | 智能字幕任务的执行结果 注意:此字段可能返回 null,表示取不到有效值。 |
BeautyConfig
美颜配置
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| BeautyEffectItems | Array of BeautyEffectItemConfig | 否 | 美颜效果 |
| BeautyFilterItems | Array of BeautyFilterItemConfig | 否 | 美颜滤镜 |
BeautyEffectItemConfig
美颜效果配置项
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 类型名称。取值如下: 示例值:Whiten |
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Value | Integer | 否 | 效果强度,值范围:[0, 100]。 示例值:40 |
| ResourcePath | String | 否 | 附加资源路径。 示例值:/makeupRes/video_makeup_mitao |
| ExtInfo | String | 否 | 自定义参数。 示例值:{"Color":"#ff0000"} |
BeautyFilterItemConfig
美颜滤镜配置项
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 类型名称。取值如下: 示例值:Qingjiaopian |
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Value | Integer | 否 | 效果强度,值范围:[-100, 100]。 示例值:70 |
BlindWatermarkConfig
盲水印配置
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AddBlindWatermark | AddBlindWatermarkConfig | 否 | 增加盲水印 注意:此字段可能返回 null,表示取不到有效值。 |
| ExtractBlindWatermark | ExtractBlindWatermarkConfig | 否 | 提取盲水印 注意:此字段可能返回 null,表示取不到有效值。 |
| RemoveBlindWatermark | RemoveBlindWatermarkConfig | 否 | 移除盲水印 注意:此字段可能返回 null,表示取不到有效值。 |
BlindWatermarkEmbedInfo
嵌入盲水印配置
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EmbedText | String | 否 | 盲水印文字,经过URL安全的Base64编码的4Byte数据。Base64解码之后,少于4Byte将会填充0x00到4Byte,超过4Byte将会截断为4Byte。 注意:此字段可能返回 null,表示取不到有效值。 示例值:dGVzdA== |
ClassificationConfigureInfo
智能分类任务控制参数
被如下接口引用:CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 智能分类任务开关,可选值: 示例值:ON |
ClassificationConfigureInfoForUpdate
智能分类任务控制参数
被如下接口引用:ModifyAIAnalysisTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 智能分类任务开关,可选值: 示例值:ON |
ColorEnhanceConfig
色彩增强配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate, ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 类型,可选值: 默认值:weak。 注意:此字段可能返回 null,表示取不到有效值。 示例值:weak |
ComposeAudioItem
视频编辑/合成任务 音频元素信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceMedia | ComposeSourceMedia | 是 | 元素对应媒体信息。 |
| TrackTime | ComposeTrackTime | 否 | 元素在轨道时间轴上的时间信息,不填则紧跟上一个元素。 |
| AudioOperations | Array of ComposeAudioOperation | 否 | 对音频进行操作,如静音等。 |
ComposeAudioOperation
视频编辑/合成任务 音频操作。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 音频操作类型,取值有: 示例值:Volume |
| Volume | Float | 否 | 当 Type = Volume 时有效。音量调节参数,取值范围: 0~5。 示例值:1 |
ComposeAudioStream
视频编辑/合成任务 音频流信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Codec | String | 否 | 音频流的编码方式,可选值: 示例值:AAC |
| SampleRate | Integer | 否 | 音频流的采样率,单位:Hz,可选值: 示例值:16000 |
| AudioChannel | Integer | 否 | 声道数,可选值: 示例值:2 |
| Bitrate | Integer | 否 | 参考码率,单位 kbps,范围:26~10000。 如果设置,编码时会尽量按该码率进行编码。 如果不设置,服务将根据音频参数自动采用合适的码率。 示例值:128 |
ComposeCanvas
视频编辑/合成任务画布信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Color | String | 否 | 背景颜色对应的 RGB 参考值,取值格式: #RRGGBB,如 #F0F0F0 。 默认值:#000000(黑色)。 示例值:#000000 |
| Width | Integer | 否 | 画布宽度,即输出视频的宽度,取值范围:0~ 3840,单位:px。 默认值:0,表示和第一个视频宽度一致。 示例值:0 |
| Height | Integer | 否 | 画布高度,即输出视频的高度,取值范围:0~ 3840,单位:px。 默认值:0,表示和第一个视频高度一致。 示例值:0 |
ComposeEmptyItem
视频编辑/合成任务 空白占位元素信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Duration | String | 是 | 元素时长,时间支持: 示例值:3.5s |
ComposeImageItem
视频编辑/合成任务 图片元素信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceMedia | ComposeSourceMedia | 是 | 元素对应媒体信息。 |
| TrackTime | ComposeTrackTime | 否 | 元素在轨道时间轴上的时间信息,不填则紧跟上一个元素。 |
| XPos | String | 否 | 元素中心点距离画布原点的水平位置。支持 %、px 两种格式: 默认:50%。 示例值:50% |
| YPos | String | 否 | 元素中心点距离画布原点的垂直位置。支持 %、px 两种格式: 默认:50%。 示例值:100px |
| Width | String | 否 | 视频片段的宽度。支持 %、px 两种格式: 为空(或0) 的场景: 示例值:10% |
| Height | String | 否 | 元素的高度。支持 %、px 两种格式: 为空(或0) 的场景: 示例值:100px |
| ImageOperations | Array of ComposeImageOperation | 否 | 对图像画面进行的操作,如图像旋转等。 |
ComposeImageOperation
视频编辑/合成任务 视频图像转换操作。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 类型,取值有: 示例值:Rotate |
| RotateAngle | Float | 否 | 当 Type = Rotate 时有效。图像以中心点为原点进行旋转的角度,取值范围0~360。 示例值:0 |
| FlipType | String | 否 | 当 Type = Flip 时有效。图像翻转动作,取值有: 示例值:Horizental |
ComposeMediaConfig
视频编辑/合成任务 信息。
关于 轨道、元素、时间轴 关系示意图:

被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TargetInfo | ComposeTargetInfo | 否 | 合成目标视频信息。 |
| Canvas | ComposeCanvas | 否 | 合成目标视频的画布信息。 |
| Styles | Array of ComposeStyles | 否 | 全局样式,和轨道 Tracks 配合使用,用于定于样式,如字幕样式。 |
| Tracks | Array of ComposeMediaTrack | 否 | 用于描述合成视频的轨道列表,包括:视频、音频、图片、文字等元素组成的多个轨道信息。关于轨道和时间:
|
ComposeMediaItem
视频编辑/合成任务 轨道元素信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 元素类型。取值有: 示例值:Video |
| Video | ComposeVideoItem | 否 | 视频元素,当 Type = Video 时有效。 |
| Audio | ComposeAudioItem | 否 | 音频元素,当 Type = Audio 时有效。 |
| Image | ComposeImageItem | 否 | 图片元素,当 Type = Image 时有效。 |
| Transition | ComposeTransitionItem | 否 | 转场元素,当 Type = Transition 时有效。 |
| Subtitle | ComposeSubtitleItem | 否 | 字幕元素,当 Type = Subtitle 是有效。 |
| Empty | ComposeEmptyItem | 否 | 空白元素,当 Type = Empty 时有效。用于时间轴的占位。 |
ComposeMediaTrack
视频编辑/合成任务 轨道信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 轨道类型,取值有:
示例值:Video |
| Items | Array of ComposeMediaItem | 是 | 轨道上的元素列表。 |
ComposeSourceMedia
视频编辑/合成任务 媒体素材源信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FileId | String | 是 | 媒体对应的素材ID,即 FileInfos 列表中对应素材的 ID。 示例值:f4 |
| StartTime | String | 否 | 媒体位于素材的起始时间,时间点支持 s、% 两种格式: 默认:0s 示例值:1s |
| EndTime | String | 否 | 媒体位于素材的结束时间,和 StartTime 构成媒体在源素材的时间区间,时间点支持 s、% 两种格式: 默认:如果对应轨道时长有设置,则默认轨道时长,否则为素材时长,无时长的素材默认为 1 秒。 注意:至少需要大于 StartTime 0.02 秒。 示例值:12.2s |
ComposeStyles
视频编辑/合成任务 样式信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | String | 是 | 样式 Id,用于和轨道元素中的样式关联。 注意:允许字母、数字、-、_ 组合,最长 32 字符。 示例值:s1 |
| Type | String | 是 | 样式类型,取值有: 示例值:Subtitle |
| Subtitle | ComposeSubtitleStyle | 否 | 字幕样式信息,当 Type = Subtitle 时有效。 |
ComposeSubtitleItem
视频编辑/合成任务 字幕元素信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| StyleId | String | 是 | 字幕样式,Styles 列表中对应的 Subtitle样式的 ID。 示例值:s1 |
| Text | String | 是 | 字幕文本。 注:长文本可能超出画面范围,建议使用 \n 进行换行。 示例值:测试字幕中文 |
| TrackTime | ComposeTrackTime | 否 | 元素在轨道时间轴上的时间信息,不填则紧跟上一个元素。 |
ComposeSubtitleStyle
视频编辑/合成任务 字幕样式。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Height | String | 否 | 字幕高度。支持 %、px 两种格式: 默认为 FontSize 大小。 示例值:10% |
| MarginBottom | String | 否 | 字幕距离下边框距离,支持 %、px 两种格式: 默认:0px 示例值:10px |
| FontType | String | 否 | 字体类型,支持: 示例值:SimHei |
| FontSize | String | 否 | 字体大小,支持 %、px 两种格式: 默认:2% 示例值:2% |
| FontBold | Integer | 否 | 是否使用粗体,和字体相关,可选值: 示例值:0 |
| FontItalic | Integer | 否 | 是否使用斜体,和字体相关,可选值: 示例值:0 |
| FontColor | String | 否 | 字体颜色,格式:#RRGGBBAA。 默认值:0x000000FF(黑色)。 注意:其中 AA 部分指的是透明度,为可选。 示例值:0x000000FF |
| FontAlign | String | 否 | 文字对齐方式: 示例值:Center |
| FontAlignMargin | String | 否 | 用于字幕对齐留白: 支持 %、px 两种格式: 示例值:10% |
| BorderWidth | String | 否 | 字体边框宽度,支持 %、px 两种格式: 默认: 0,表示不需要边框。 示例值:10px |
| BorderColor | String | 否 | 边框颜色,当 BorderWidth 不为 0 时生效,其值格式和 FontColor 一致。 示例值:0x000000FF |
| BottomColor | String | 否 | 文字底色,其值格式和 FontColor 一致。 默认为空, 表示不使用底色。 示例值:0x000000FF |
ComposeTargetInfo
视频编辑/合成任务 目标视频信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Container | String | 否 | 封装容器格式,可选值: 示例值:mp4 |
| RemoveVideo | Integer | 否 | 是否去除视频数据,可选值: 示例值:0 |
| RemoveAudio | Integer | 否 | 是否去除音频数据,可选值: 示例值:0 |
| VideoStream | ComposeVideoStream | 否 | 输出视频流信息。 |
| AudioStream | ComposeAudioStream | 否 | 输出音频流信息。 |
ComposeTrackTime
视频编辑/合成任务 对应元素在目标视频轨道上的时间信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Start | String | 否 | 元素在轨道上的起始时间,时间点支持: 注意:不填则默认为前一个元素的结束时间,此时可以通过 ComposeEmptyItem 元素来进行占位,实现轨道起始时间设置。 示例值:0s |
| Duration | String | 否 | 元素时长,时间支持: 默认:取对应 ComposeSourceMedia 媒体的有效时长(即 EndTime-StartTime),没有 ComposeSourceMedia 则默认为 1 秒。 示例值:12s |
ComposeTransitionItem
视频编辑/合成任务 转场元素信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Duration | String | 否 | 元素时长,时间支持: 默认:1s 注意: 示例值:1s |
| Transitions | Array of ComposeTransitionOperation | 否 | 转场操作列表。 默认:淡入淡出。 注意:图像转场操作和音频转场操作各自最多支持一个。 |
ComposeTransitionOperation
视频编辑/合成任务 元素转场信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 转场类型。 图像的转场操作,用于两个视频片段图像间的转场处理: 音频的转场操作,用于两个音频片段间的转场处理: 示例值:ImageFadeInFadeOut |
ComposeVideoItem
视频编辑/合成任务 视频元素信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceMedia | ComposeSourceMedia | 是 | 元素对应媒体信息。 |
| TrackTime | ComposeTrackTime | 否 | 元素在轨道时间轴上的时间信息,不填则紧跟上一个元素。 |
| XPos | String | 否 | 元素中心点距离画布原点的水平位置。支持 %、px 两种格式: 默认:50%。 示例值:10% |
| YPos | String | 否 | 元素中心点距离画布原点的垂直位置。支持 %、px 两种格式: 默认:50%。 示例值:100px |
| Width | String | 否 | 视频片段的宽度。支持 %、px 两种格式: 为空(或0) 的场景: 示例值:10% |
| Height | String | 否 | 元素的高度。支持 %、px 两种格式: 为空(或0) 的场景: 示例值:100px |
| ImageOperations | Array of ComposeImageOperation | 否 | 对图像画面进行的操作,如图像旋转等。 |
| AudioOperations | Array of ComposeAudioOperation | 否 | 对音频进行操作,如静音等。 |
ComposeVideoStream
视频编辑/合成任务 视频流信息。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Codec | String | 否 | 视频流的编码方式,可选值: 示例值:H.264 |
| Fps | Integer | 否 | 视频帧率,取值范围:[0, 60],单位:Hz。 默认值:0,表示和第一个视频帧率一致。 示例值:0 |
| Bitrate | Integer | 否 | 参考码率,单位 kbps,范围:50~35000。 如果设置,编码时会尽量按该码率进行编码。 如果不设置,服务将通过画面复杂度自动采用合适的码率。 示例值:128 |
ContainerDiagnoseResultItem
容器格式诊断结果
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Category | String | 诊断出的异常类别,取值范围: DecodeParamException:解码参数异常 TimeStampException:时间戳异常 FrameException: 帧率异常 StreamStatusException:流状态异常 StreamInfo:流信息异常 StreamAbnormalCharacteristics:流特征异常 DecodeException:解码异常 HLSRequirements:HLS 格式异常 注意:此字段可能返回 null,表示取不到有效值。 示例值:DecodeException |
| Type | String | 诊断出的具体异常类型,取值如下: VideoResolutionChanged:视频分辨率变化 AudioSampleRateChanged:音频采样率变化 AudioChannelsChanged:音频通道数变化 ParameterSetsChanged:流参数集信息发生变化 DarOrSarInvalid:视频的宽高比异常 TimestampFallback:DTS时间戳回退 DtsJitter:DTS抖动过大 PtsJitter:PTS抖动过大 AACDurationDeviation:AAC帧时间戳间隔不合理 AudioDroppingFrames:音频丢帧 VideoDroppingFrames:视频丢帧 AVTimestampInterleave:音视频交织不合理 PtsLessThanDts:媒体流的 pts 小于 dts ReceiveFpsJitter:网络接收帧率抖动过大 ReceiveFpsTooSmall:网络接收视频帧率过小 FpsJitter:通过PTS计算得到的流帧率抖动过大 StreamOpenFailed:流打开失败 StreamEnd:流结束 StreamParseFailed:流解析失败 VideoFirstFrameNotIdr:首帧不是IDR帧 StreamNALUError:NALU起始码错误 TsStreamNoAud:mpegts的H26x流缺失 AUD NALU AudioStreamLack:无音频流 VideoStreamLack:无视频流 LackAudioRecover:缺失音频流恢复 LackVideoRecover:缺失视频流恢复 VideoBitrateOutofRange:视频流码率(kbps)超出范围 AudioBitrateOutofRange:音频流码率(kbps)超出范围 VideoDecodeFailed:视频解码错误 AudioDecodeFailed:音频解码错误 AudioOutOfPhase:双通道音频相位相反 VideoDuplicatedFrame:视频流中存在重复帧 AudioDuplicatedFrame:音频流中存在重复帧 VideoRotation:视频画面旋转 TsMultiPrograms:MPEG2-TS流有多个program Mp4InvalidCodecFourcc:MP4中codec fourcc不符合Apple HLS要求 HLSBadM3u8Format:无效的m3u8文件 HLSInvalidMasterM3u8:无效的main m3u8文件 HLSInvalidMediaM3u8:无效的media m3u8文件 HLSMasterM3u8Recommended:main m3u8缺少标准推荐的参数 HLSMediaM3u8Recommended:media m3u8缺少标准推荐的参数 HLSMediaM3u8DiscontinuityExist:media m3u8存在EXT-X-DISCONTINUITY HLSMediaSegmentsStreamNumChange:切片的流数目发生变化 HLSMediaSegmentsPTSJitterDeviation:切片间PTS跳变且没有EXT-X-DISCONTINUITY HLSMediaSegmentsDTSJitterDeviation:切片间DTS跳变且没有EXT-X-DISCONTINUITY TimecodeTrackExist:MP4存在tmcd轨道 注意:此字段可能返回 null,表示取不到有效值。 示例值:VideoDecodeFailed |
| SeverityLevel | String | 诊断出的异常级别,取值范围: Fatal:影响后续播放和解析, Error: 可能会影响播放, Warning: 可能会有潜在风险,但不一定会影响播放, Notice:比较重要的流信息, Info:一般性的流信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Fatal |
| DateTimeSet | Array of String | 警告出现的时间点,形式如 “2022-12-25T13:14:16Z” 注意:此字段可能返回 null,表示取不到有效值。 示例值:["2023-06-09T06:54:32Z","2023-06-09T06:54:32Z"] |
| TimestampSet | Array of Float | 时间戳 注意:此字段可能返回 null,表示取不到有效值。 示例值:[4.783, 5.966] |
ContentReviewTemplateItem
内容审核模板详情
被如下接口引用:DescribeContentReviewTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 内容审核模板唯一标识。 示例值:0 |
| Name | String | 内容审核模板名称,长度限制:64 个字符。 示例值:内容审核模板1 |
| Comment | String | 内容审核模板描述信息,长度限制:256 个字符。 示例值:包含图片和文本审核 |
| PornConfigure | PornConfigureInfo | 鉴黄控制参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| TerrorismConfigure | TerrorismConfigureInfo | 涉敏控制参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| PoliticalConfigure | PoliticalConfigureInfo | 涉敏控制参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| ProhibitedConfigure | ProhibitedConfigureInfo | 违禁控制参数。违禁内容包括: 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| UserDefineConfigure | UserDefineConfigureInfo | 用户自定义内容审核控制参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2025-03-23T07:14:27+08:00 |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2025-03-23T07:14:27+08:00 |
| Type | String | 模板类型,取值范围: * Preset:系统预置模板; * Custom:用户自定义模板。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Custom |
CosFileUploadTrigger
绑定到 COS 的输入规则。
被如下接口引用:CreateSchedule, CreateWorkflow, ModifySchedule, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Bucket | String | 是 | 工作流绑定的 COS Bucket 名,如 TopRankVideo-125xxx88。 示例值:CosVideoFile-125xxx88 |
| Region | String | 是 | 工作流绑定的 COS Bucket 所属园区,如 ap-chongiqng。 示例值:ap-nanjing |
| Dir | String | 否 | 工作流绑定的输入路径目录,必须为绝对路径,即以 / 开头和结尾。如/movie/201907/,不填代表根目录/。示例值:/trigger-dir/ |
| Formats | Array of String | 否 | 工作流允许触发的文件格式列表,如 ["mp4", "flv", "mov"]。不填代表所有格式的文件都可以触发工作流。 示例值:["mp4","flv","mov"] |
CosInputInfo
媒体处理 COS 对象信息。
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateVideoDatabaseEntryTask, DescribeBatchTaskDetail, DescribeMediaMetaData, ParseNotification, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Bucket | String | 是 | 媒体处理对象文件所在的 COS Bucket 名,如 TopRankVideo-125xxx88。 示例值:TopRankVideo-125xxx88 |
| Region | String | 是 | 媒体处理对象文件所在的 COS Bucket 所属园区,如 ap-chongqing。 示例值:ap-chongqing |
| Object | String | 是 | 媒体处理对象文件的输入路径,如/movie/201907/WildAnimal.mov。示例值:/movie/201907/WildAnimal.mov |
CosOutputStorage
媒体处理 COS 输出对象信息。
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSchedule, CreateWorkflow, EditMedia, ModifySchedule, ProcessImage, ProcessLiveStream, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Bucket | String | 否 | 媒体处理生成的文件输出的目标 Bucket 名,如 TopRankVideo-125xxx88。如果不填,表示继承上层。 示例值:TopRankVideo-125xxx88 |
| Region | String | 否 | 媒体处理生成的文件输出的目标 Bucket 的园区,如 ap-chongqing。如果不填,表示继承上层。 示例值:ap-chongqing |
CoverConfigureInfo
智能封面任务控制参数
被如下接口引用:CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 智能封面任务开关,可选值: 示例值:ON |
CoverConfigureInfoForUpdate
智能封面任务控制参数
被如下接口引用:ModifyAIAnalysisTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 智能封面任务开关,可选值: 示例值:ON |
CreateInput
创建输入的配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InputName | String | 是 | 输入名称,可填大小写、数字和下划线,长度为[1, 32]。 示例值:input |
| Protocol | String | 是 | 输入的协议,可选[SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST]。 示例值:SRT |
| Description | String | 否 | 输入描述,长度为[0, 255]。 示例值:input description |
| AllowIpList | Array of String | 否 | 输入的IP白名单,格式为CIDR。 示例值:["0.0.0.0/0"] |
| SRTSettings | CreateInputSRTSettings | 否 | 输入的SRT配置信息。 |
| RTPSettings | CreateInputRTPSettings | 否 | 输入的RTP配置信息。 |
| FailOver | String | 否 | 输入的主备开关,可选[OPEN|CLOSE],默认为CLOSE。 示例值:CLOSE |
| RTMPPullSettings | CreateInputRTMPPullSettings | 否 | 输入的RTMP_PULL配置信息。 |
| RTSPPullSettings | CreateInputRTSPPullSettings | 否 | 输入的RTSP_PULL配置信息。 |
| HLSPullSettings | CreateInputHLSPullSettings | 否 | 输入的HLS_PULL配置信息。 |
| ResilientStream | ResilientStreamConf | 否 | 延播平滑吐流配置信息。 |
| SecurityGroupIds | Array of String | 否 | 绑定的输入安全组 ID。 示例值:["01937702ecc509dc0f3269ca3420"] |
| Zones | Array of String | 否 | 可用区,非必填,如果开启容灾必须输入两个不同的可用区,否则最多只允许输入一个可用区。 示例值:["ap-shanghai-1"] |
| RISTSettings | CreateInputRISTSettings | 否 | 输入的RIST配置信息。 |
| InputRegion | String | 否 | 输入节点的地区 示例值:ap-mumbai |
| FailOverOption | FailOverOption | 否 | 冷热备相关 |
CreateInputHLSPullSettings
创建的输入HLS拉流的配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceAddresses | Array of HLSPullSourceAddress | 是 | HLS源站的源站地址,有且只能有一个。 |
CreateInputRISTSettings
创建的输入RIST的配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Mode | String | 否 | RIST模式,可选[LISTENER],默认为LISTENER。 示例值:LISTENER |
| Profile | String | 否 | RIST配置方案,可选[MAIN|SIMPLE],默认为MAIN。 示例值:MAIN |
| Buffer | Integer | 否 | RIST缓冲区大小,单位为毫秒。最小值为50毫秒,最大值为5000毫秒。默认值:120 示例值:120 |
CreateInputRTMPPullSettings
创建的输入RTMP拉流的配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceAddresses | Array of RTMPPullSourceAddress | 是 | RTMP源站的源站地址,有且只能有一个。 |
CreateInputRTPSettings
创建输入的RTP配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FEC | String | 否 | 默认为“none”,可选值['none']。 示例值:none |
| IdleTimeout | Integer | 否 | 空闲超时时间,默认5000,单位ms,范围为[1000, 10000]。 示例值:1000 |
CreateInputRTSPPullSettings
创建的输入RTSP拉流的配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceAddresses | Array of RTSPPullSourceAddress | 是 | RTSP源站的源站地址,有且只能有一个。 |
CreateInputSRTSettings
创建的输入SRT的配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Mode | String | 否 | SRT模式,可选[LISTENER|CALLER],默认为LISTENER。 示例值:LISTENER |
| StreamId | String | 否 | 流Id,可选大小写字母、数字和特殊字符(.#!:&,=_-),长度为0~512。具体格式可以参考:https://github.com/Haivision/srt/blob/master/docs/features/access-control.md#standard-keys。 示例值:streamId |
| Latency | Integer | 否 | 延迟,默认120,单位ms,范围为[0, 3000]。 示例值:120 |
| RecvLatency | Integer | 否 | 接收延迟,默认120,单位ms,范围为[0, 3000]。 示例值:0 |
| PeerLatency | Integer | 否 | 对端延迟,默认120,单位ms,范围为[0, 3000]。 示例值:0 |
| PeerIdleTimeout | Integer | 否 | 对端超时时间,默认5000,单位ms,范围为[1000, 10000]。 示例值:5000 |
| Passphrase | String | 否 | 解密密钥,默认为空,表示不加密。只可填ascii码值,长度为[10, 79]。 示例值:passphrase |
| PbKeyLen | Integer | 否 | 密钥长度,默认为0,可选[0|16|24|32]。 示例值:0 |
| SourceAddresses | Array of SRTSourceAddressReq | 否 | SRT对端地址,当Mode为CALLER时必填,且只能填1组。 |
| FEC | SRTFECSimpleOptions | 否 | SRT FEC 设置 |
CreateOutputInfo
创建输出的配置信息。
被如下接口引用:CreateStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| OutputName | String | 是 | 输出的名称。 示例值:OutputName |
| Description | String | 是 | 输出描述。 示例值:OutputName |
| Protocol | String | 是 | 输出的转推协议,支持SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST。 示例值:SRT |
| OutputRegion | String | 是 | 输出地区。 示例值:ap-hongkong |
| OutputType | String | 否 | 输出类型:Internet/TencentCSS 示例值:TencentCSS |
| OutputKind | String | 否 | 输出模块类型,包括Pinpoint(单点输出,最多支持四路并发输出);MultiMesh(多路输出,支持大于四路的并发输出,目前可以达到200路)。默认类型为 Pinpoint 输出。对于单个 Flow 一个区域最多只能有一个 MultiMesh 输出 示例值:Pinpoint |
| SRTSettings | CreateOutputSRTSettings | 否 | 输出的SRT的配置。 |
| RTMPSettings | CreateOutputRTMPSettings | 否 | 输出的RTMP的配置。 |
| RTPSettings | CreateOutputInfoRTPSettings | 否 | 输出的RTP的配置。 |
| AllowIpList | Array of String | 否 | IP白名单列表,格式为CIDR,如0.0.0.0/0。 当Protocol为RTMP_PULL有效,为空代表不限制客户端IP。 示例值:["0.0.0.0"] |
| MaxConcurrent | Integer | 否 | 最大拉流并发数,最大4,默认4。 示例值:1 |
| SecurityGroupIds | Array of String | 否 | 绑定的输入安全组 ID。 示例值:["01937702c54509dc0f3269ca341f"] |
| Zones | Array of String | 否 | 可用区,output最多只支持输入一个可用区。 示例值:["ap-shanghai-1"] |
| RISTSettings | CreateOutputRistSettings | 否 | 输出的RIST的配置。 |
| StreamSelector | StreamSelector | 否 | 对于含有多个音/视频轨的流,可以指定需要使用的轨道。PidSelector 与 TrackSelector 只能存在一个 |
CreateOutputInfoRTPSettings
创建媒体传输流的输出的RTP配置。
被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Destinations | Array of CreateOutputRTPSettingsDestinations | 是 | 转推的目标地址,可填1~2个。 示例值:0 |
| FEC | String | 是 | 只能填none。 示例值:none |
| IdleTimeout | Integer | 是 | 空闲超时时间,单位ms。 示例值:1000 |
CreateOutputRTMPSettings
创建媒体传输流的输出的RTMP配置。
被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Destinations | Array of CreateOutputRtmpSettingsDestinations | 是 | 转推的目标地址,可填1~2个。 示例值:your address |
| ChunkSize | Integer | 否 | RTMP的Chunk大小,范围为[4096, 40960]。 示例值:4096 |
CreateOutputRTPSettingsDestinations
创建媒体传输流的输出的RTP的目标地址。
被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 是 | 转推的目标IP。 示例值:ip |
| Port | Integer | 是 | 转推的目标端口。 示例值:port |
CreateOutputRistSettings
创建媒体传输流的输出的RIST配置。
被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Mode | String | 否 | RIST模式,可选[LISTENER|CALLER],默认为LISTENER。 示例值:LISTENER |
| Profile | String | 否 | RIST配置方案,可选[MAIN|SIMPLE],默认为MAIN。 示例值:MAIN |
| Buffer | Integer | 否 | RIST缓冲区大小,单位为毫秒。最小值为50毫秒,最大值为5000毫秒。默认值:120 示例值:120 |
CreateOutputRtmpSettingsDestinations
创建媒体传输流的输出的RTMP的目标地址。
被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Url | String | 是 | 转推的URL,格式如:rtmp://domain/live。 示例值:rtmp://example.com/live |
| StreamKey | String | 是 | 转推的StreamKey,格式如:stream?key=value。 示例值:stream_key |
CreateOutputSRTSettings
创建媒体传输流的输出的SRT配置。
被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Destinations | Array of CreateOutputSRTSettingsDestinations | 是 | 转推的目标地址,当Mode为CALLER时必填,且只能填1组。 |
| StreamId | String | 否 | 转推SRT的流Id,可选大小写字母、数字和特殊字符(.#!:&,=_-),长度为0~512。 示例值:StreamId |
| Latency | Integer | 否 | 转推SRT的延迟,默认120,单位ms,范围为[0, 3000]。此参数同时设置了发送方和接收方的延迟(recvlatency和peerlatency)为相同的值。建议配置为至少3倍RTT,以确保在网络拥塞时能够有效处理数据包的重传和确认 示例值:120 |
| RecvLatency | Integer | 否 | 转推SRT的接收延迟,默认120,单位ms,范围为[0, 3000]。 此参数表示接收方用于缓存数据包的时间长度 示例值:0 |
| PeerLatency | Integer | 否 | 转推SRT的对端延迟,默认120,单位ms,范围为[0, 3000]。 此参数由发送方设置,用于告知接收方其期望的延迟缓冲时间 示例值:0 |
| PeerIdleTimeout | Integer | 否 | 转推SRT的对端空闲超时时间,默认5000,单位ms,范围为[1000, 10000]。 如果连接在设定的超时时间内没有活动,将会被关闭 示例值:5000 |
| Passphrase | String | 否 | 转推SRT的加密密钥,默认为空,表示不加密。只可填ascii码值,长度为[10, 79]。 示例值:passphrase |
| PbKeyLen | Integer | 否 | 转推SRT的密钥长度,默认为0,可选[0|16|24|32]。 示例值:0 |
| Mode | String | 否 | SRT模式,可选[LISTENER|CALLER],默认为CALLER。 示例值:CALLER |
| FEC | SRTFECFullOptions | 否 | SRT FEC 设置 |
CreateOutputSRTSettingsDestinations
创建媒体传输流的输出SRT的目标地址。
被如下接口引用:CreateStreamLinkOutputInfo, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 是 | 输出的IP或域名。 示例值:0.0.0.0 |
| Port | Integer | 是 | 输出的端口。 示例值:10 |
DescribeEvent
查询Event的配置信息。
被如下接口引用:CreateStreamLinkEvent, DescribeStreamLinkEvent, DescribeStreamLinkEvents。
| 名称 | 类型 | 描述 |
|---|---|---|
| EventName | String | Event的名称。 示例值:eventnametest |
| EventId | String | Event的Id,唯一标识一个event。 示例值:eventidtest |
| CreateTime | String | Event创建时间,格式为yyyy-MM-ddTHH:mm:ssZ。 示例值:2022-12-01T20:00:00Z |
| Description | String | Event的描述。 示例值:descri |
| Status | Integer | Event的状态信息 0:未运行 1:运行中 示例值:0 |
| AttachedFlowGroup | Array of DescribeFlowId | Event关联的Flow列表。 注意:此字段可能返回 null,表示取不到有效值。 |
DescribeFlow
查询Flow的配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows。
| 名称 | 类型 | 描述 |
|---|---|---|
| FlowId | String | 流Id。 示例值:01937702c54509dc0f3269ca341f |
| FlowName | String | 流名称。 示例值:example-flow |
| State | String | 流状态,目前有IDLE/RUNNING。 示例值:IDLE |
| MaxBandwidth | Integer | 最大带宽值。 示例值:10000000 |
| InputGroup | Array of DescribeInput | 输入组。 |
| OutputGroup | Array of DescribeOutput | 输出组。 注意:此字段可能返回 null,表示取不到有效值。 |
| EventId | String | 该Flow关联的媒体传输事件EventId。 示例值:eventid |
| Region | String | 媒体传输输入流所属的区域,取值和InputRegion相同。 示例值:ap-shanghai |
| AllowedInputProtocols | Array of String | 该Flow允许创建的输入协议 示例值:[SRT, RTMP] |
| AllowedOutputProtocols | Array of String | 该Flow允许创建的输出协议 示例值:[SRT, RTMP] |
DescribeFlowId
Event管理的Flow列表
被如下接口引用:CreateStreamLinkEvent, DescribeStreamLinkEvent, DescribeStreamLinkEvents。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FlowId | String | 是 | FlowId,唯一标识一个flow。 示例值:flowidtest |
| Region | String | 是 | flow所在的区域名称。 示例值:ap-shanghai |
DescribeHLSPullSourceAddress
查询输入的HLS配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| Url | String | HLS源站的Url地址。 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://domain[:port]/server_URL |
DescribeInput
查询输入配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| InputId | String | 输入Id。 示例值:id |
| InputName | String | 输入名称。 示例值:inputName |
| Description | String | 输入描述。 注意:此字段可能返回 null,表示取不到有效值。 示例值:description |
| Protocol | String | 输入协议。 示例值:SRT |
| InputAddressList | Array of InputAddress | 输入地址列表。 示例值:0 |
| AllowIpList | Array of String | 输入IP白名单列表。 示例值:0 |
| SRTSettings | DescribeInputSRTSettings | 输入的SRT配置信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| RTPSettings | DescribeInputRTPSettings | 输入的RTP配置信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| InputRegion | String | 输入的地区。 示例值:ap-hongkong |
| RTMPSettings | DescribeInputRTMPSettings | 输入的RTMP配置信息。 示例值:0 |
| FailOver | String | 输入的主备开关。 注意:此字段可能返回 null,表示取不到有效值。 示例值:CLOSE |
| RTMPPullSettings | DescribeInputRTMPPullSettings | 输入的RTMP_PULL配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| RTSPPullSettings | DescribeInputRTSPPullSettings | 输入的RTSP_PULL配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| HLSPullSettings | DescribeInputHLSPullSettings | 输入的HLS_PULL配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| ResilientStream | ResilientStreamConf | 延播平滑吐流配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| SecurityGroupIds | Array of String | 绑定的输入安全组 ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:["ff96r1fd7ab41ekj06497cdecbb0"] |
| Zones | Array of String | 可用区配置,开启容灾情况下最多有两个,顺序和pipeline 0、1对应,否则最多只有一个可用区。 示例值:["ap-shanghai-1"] |
| RISTSettings | DescribeInputRISTSettings | 输入的RIST配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| StreamUrls | Array of StreamUrlDetail | 输入模块配置相关的URL信息,包含提供的推流地址,或者配置的第三方源流地址 |
DescribeInputHLSPullSettings
查询输入的HLS配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| SourceAddresses | Array of DescribeHLSPullSourceAddress | HLS源站地址信息。 |
DescribeInputRISTSettings
查询输入的RIST配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| Mode | String | RIST模式,可选[LISTENER|CALLER],默认为LISTENER。 示例值:LISTENER |
| Profile | String | RIST配置方案,可选[MAIN|SIMPLE],默认为MAIN。 示例值:MAIN |
| Buffer | Integer | RIST缓冲区大小,单位为毫秒。最小值为50毫秒,最大值为5000毫秒。默认值:120 示例值:120 |
DescribeInputRTMPPullSettings
查询输入的RTMP配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| SourceAddresses | Array of DescribeRTMPPullSourceAddress | RTMP源站地址信息。 示例值:streamKey |
DescribeInputRTMPSettings
查询输入的RTMP配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| AppName | String | RTMP的推流路径。 注意:此字段可能返回 null,表示取不到有效值。 示例值:live_appid |
| StreamKey | String | RTMP的推流StreamKey。 RTMP的推流地址拼接规则为:rtmp://Ip:1935/AppName/StreamKey 示例值:inputid_index |
DescribeInputRTPSettings
查询输入的RTP配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| FEC | String | 是否FEC。 示例值:FEC |
| IdleTimeout | Integer | 空闲超时时间。 示例值:timeout |
DescribeInputRTSPPullSettings
查询输入的RTSP配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| SourceAddresses | Array of DescribeRTSPPullSourceAddress | RTSP源站地址信息。 |
DescribeInputSRTSettings
查询输入的SRT配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| Mode | String | SRT模式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:LISTENER |
| StreamId | String | 流Id。 示例值:StreamId |
| Latency | Integer | 延迟。 示例值:0 |
| RecvLatency | Integer | 接收延迟。 示例值:120 |
| PeerLatency | Integer | 对端延迟。 示例值:0 |
| PeerIdleTimeout | Integer | 对端空闲超时时间。 示例值:5000 |
| Passphrase | String | 解密密钥。 示例值:passphrase |
| PbKeyLen | Integer | 密钥长度。 示例值:0 |
| SourceAddresses | Array of SRTSourceAddressResp | SRT对端地址。 注意:此字段可能返回 null,表示取不到有效值。 |
| FEC | SRTFECSimpleOptions | FEC 设置 |
DescribeOutput
查询输出的配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| OutputId | String | 输出Id。 示例值:AB342ED131CE |
| OutputName | String | 输出名称。 示例值:OutputName |
| OutputType | String | 输出类型。 示例值:Internet |
| OutputKind | String | 输出模块类型,包括Pinpoint(单点输出,最多支持四路并发输出);MultiMesh(多路输出,支持大于四路的并发输出,目前可以达到200路)。默认类型为 Pinpoint 输出。对于单个 Flow 一个区域最多只能有一个 MultiMesh 输出。 示例值:Pinpoint |
| Description | String | 输出描述。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Description |
| Protocol | String | 输出协议。 示例值:RTMP |
| OutputAddressList | Array of OutputAddress | 输出的出口地址信息列表。 |
| OutputRegion | String | 输出的地区。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ap-shanghai |
| SRTSettings | DescribeOutputSRTSettings | 输出的SRT配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| RTPSettings | DescribeOutputRTPSettings | 输出的RTP配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| RTMPSettings | DescribeOutputRTMPSettings | 输出的RTMP配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| RTMPPullSettings | DescribeOutputRTMPPullSettings | 输出的RTMP拉流配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| AllowIpList | Array of String | CIDR白名单列表。 当Protocol为RTMP_PULL有效,为空代表不限制客户端IP。 注意:此字段可能返回 null,表示取不到有效值。 示例值:["0.0.0.0"] |
| RTSPPullSettings | DescribeOutputRTSPPullSettings | 输出的RTSP拉流配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| HLSPullSettings | DescribeOutputHLSPullSettings | 输出的HLS拉流配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| MaxConcurrent | Integer | 最大拉流并发数,最大为4,默认4。 示例值:1 |
| SecurityGroupIds | Array of String | 绑定的安全组 ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:["019202e96d9f09dc0f325e7f7a2a"] |
| Zones | Array of String | 可用区,output目前最多只支持一个。 示例值:["ap-shanghai"] |
| RISTSettings | DescribeOutputRISTSettings | 输出的RIST配置信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| StreamUrls | Array of StreamUrlDetail | 输出模块配置,相关的URL,包括提供的拉流地址,或者配置的输出到第三方的转推地址 |
| StreamSelector | StreamSelector | 对于含有多个音/视频轨的流,可以指定需要使用的轨道 |
DescribeOutputHLSPullServerUrl
查询输出的HLS拉流URL信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Url | String | HLS拉流地址的Url。 示例值:http://domain[port]/server_URL |
DescribeOutputHLSPullSettings
查询输出的HLS拉流配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| ServerUrls | Array of DescribeOutputHLSPullServerUrl | HLS拉流地址列表。 注意:此字段可能返回 null,表示取不到有效值。 |
DescribeOutputRISTSettings
查询输出的RIST拉流配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Mode | String | RIST模式,可选[LISTENER|CALLER],默认为LISTENER。 示例值:LISTENER |
| Profile | String | RIST配置方案,可选[MAIN|SIMPLE],默认为MAIN。 示例值:MAIN |
| Buffer | Integer | RIST缓冲区大小,单位为毫秒。最小值为50毫秒,最大值为5000毫秒。默认值:120 示例值:120 |
| SourceAddresses | Array of OutputRISTSourceAddressResp | 服务器监听地址,RIST模式为LISTENER时使用。 注意:此字段可能返回 null,表示取不到有效值。 |
DescribeOutputRTMPPullServerUrl
查询输出的RTMP拉流URL信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| TcUrl | String | RTMP拉流地址的tcUrl。 示例值:rtmp://1.1.1.1:1/live |
| StreamKey | String | RTMP拉流地址的流key。 示例值:AB342ED131CE |
DescribeOutputRTMPPullSettings
查询输出的RTMP拉流配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| ServerUrls | Array of DescribeOutputRTMPPullServerUrl | 拉流地址列表。 注意:此字段可能返回 null,表示取不到有效值。 |
DescribeOutputRTMPSettings
查询输出的RTMP配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| IdleTimeout | Integer | 空闲超时时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:60 |
| ChunkSize | Integer | Chunk大小。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1024 |
| Destinations | Array of RTMPAddressDestination | 转推RTMP的目标地址信息列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:address |
DescribeOutputRTPSettings
查询输出的RTP配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Destinations | Array of RTPAddressDestination | 转推RTP的目标地址信息列表。 注意:此字段可能返回 null,表示取不到有效值。 |
| FEC | String | 是否FEC。 注意:此字段可能返回 null,表示取不到有效值。 示例值:FEC |
| IdleTimeout | Integer | 空闲超时时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:3000 |
DescribeOutputRTSPPullServerUrl
查询输出的RTSP拉流URL信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Url | String | RTSP拉流地址的Url。 示例值:rtsp://ip_or_domain[:rtsp_port]/server_URL |
DescribeOutputRTSPPullSettings
查询输出的RTSP拉流配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| ServerUrls | Array of DescribeOutputRTSPPullServerUrl | RTSP拉流地址列表。 注意:此字段可能返回 null,表示取不到有效值。 |
DescribeOutputSRTSettings
查询输出的SRT配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Destinations | Array of SRTAddressDestination | 转推的目标的地址信息列表,SRT模式为CALLER时使用。 注意:此字段可能返回 null,表示取不到有效值。 |
| StreamId | String | 流Id。 注意:此字段可能返回 null,表示取不到有效值。 示例值:StreamId |
| Latency | Integer | 延迟。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| RecvLatency | Integer | 接收延迟。 注意:此字段可能返回 null,表示取不到有效值。 示例值:120 |
| PeerLatency | Integer | 对端延迟。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| PeerIdleTimeout | Integer | 对端空闲超时时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:5000 |
| Passphrase | String | 加密密钥。 注意:此字段可能返回 null,表示取不到有效值。 |
| PbKeyLen | Integer | 加密密钥长度。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Mode | String | SRT模式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:CALLER |
| SourceAddresses | Array of OutputSRTSourceAddressResp | 服务器监听地址,SRT模式为LISTENER时使用。 注意:此字段可能返回 null,表示取不到有效值。 |
| FEC | SRTFECFullOptions | FEC 配置 |
DescribeRTMPPullSourceAddress
查询输入的RTMP配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| TcUrl | String | RTMP源站的TcUrl地址。 注意:此字段可能返回 null,表示取不到有效值。 示例值:rtmp://domain/live |
| StreamKey | String | RTMP源站的StreamKey。 RTMP源站地址拼接规则为:$TcUrl/$StreamKey。 示例值:streamKey |
DescribeRTSPPullSourceAddress
查询输入的RTSP配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| Url | String | RTSP源站的Url地址。 注意:此字段可能返回 null,表示取不到有效值。 示例值:rtsp://ip_or_domain[:rtsp_port]/server_URL |
DiagnoseResult
诊断结果项。
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Category | String | 诊断出的异常类别,取值范围: DecodeParamException:解码参数异常 TimeStampException:时间戳异常 FrameException: 帧率异常 StreamStatusException:流状态异常 StreamInfo:流信息异常 StreamAbnormalCharacteristics:流特征异常 DecodeException:解码异常 HLSRequirements:HLS 格式异常 注意:此字段可能返回 null,表示取不到有效值。 示例值:DecodeException |
| Type | String | 诊断出的具体异常类型,取值如下: VideoResolutionChanged:视频分辨率变化 AudioSampleRateChanged:音频采样率变化 AudioChannelsChanged:音频通道数变化 ParameterSetsChanged:流参数集信息发生变化 DarOrSarInvalid:视频的宽高比异常 TimestampFallback:DTS时间戳回退 DtsJitter:DTS抖动过大 PtsJitter:PTS抖动过大 AACDurationDeviation:AAC帧时间戳间隔不合理 AudioDroppingFrames:音频丢帧 VideoDroppingFrames:视频丢帧 AVTimestampInterleave:音视频交织不合理 PtsLessThanDts:媒体流的 pts 小于 dts ReceiveFpsJitter:网络接收帧率抖动过大 ReceiveFpsTooSmall:网络接收视频帧率过小 FpsJitter:通过PTS计算得到的流帧率抖动过大 StreamOpenFailed:流打开失败 StreamEnd:流结束 StreamParseFailed:流解析失败 VideoFirstFrameNotIdr:首帧不是IDR帧 StreamNALUError:NALU起始码错误 TsStreamNoAud:mpegts的H26x流缺失 AUD NALU AudioStreamLack:无音频流 VideoStreamLack:无视频流 LackAudioRecover:缺失音频流恢复 LackVideoRecover:缺失视频流恢复 VideoBitrateOutofRange:视频流码率(kbps)超出范围 AudioBitrateOutofRange:音频流码率(kbps)超出范围 VideoDecodeFailed:视频解码错误 AudioDecodeFailed:音频解码错误 AudioOutOfPhase:双通道音频相位相反 VideoDuplicatedFrame:视频流中存在重复帧 AudioDuplicatedFrame:音频流中存在重复帧 VideoRotation:视频画面旋转 TsMultiPrograms:MPEG2-TS流有多个program Mp4InvalidCodecFourcc:MP4中codec fourcc不符合Apple HLS要求 HLSBadM3u8Format:无效的m3u8文件 HLSInvalidMasterM3u8:无效的main m3u8文件 HLSInvalidMediaM3u8:无效的media m3u8文件 HLSMasterM3u8Recommended:main m3u8缺少标准推荐的参数 HLSMediaM3u8Recommended:media m3u8缺少标准推荐的参数 HLSMediaM3u8DiscontinuityExist:media m3u8存在EXT-X-DISCONTINUITY HLSMediaSegmentsStreamNumChange:切片的流数目发生变化 HLSMediaSegmentsPTSJitterDeviation:切片间PTS跳变且没有EXT-X-DISCONTINUITY HLSMediaSegmentsDTSJitterDeviation:切片间DTS跳变且没有EXT-X-DISCONTINUITY TimecodeTrackExist:MP4存在tmcd轨道 注意:此字段可能返回 null,表示取不到有效值。 示例值:VideoDecodeFailed |
| Timestamp | Float | 诊断出异常开始的PTS时间戳。 注意:此字段可能返回 null,表示取不到有效值。 示例值:5.966 |
| Description | String | 诊断出的异常描述。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Open url http://xxx.mp4 failed. |
| DateTime | String | 诊断到异常的北京时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2023-06-09T06:54:32Z |
| SeverityLevel | String | 诊断出的异常级别,取值范围: Fatal:影响后续播放和解析, Error: 可能会影响播放, Warning: 可能会有潜在风险,但不一定会影响播放, Notice:比较重要的流信息, Info:一般性的流信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Fatal |
DrmInfo
Drm 加密信息。
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 加密类型: - simpleaes 只能用于HLS,切片格式支持ts和mp4 只能使用切片模式,不能使用singlefile模式 - fairplay: 只能用于HLS,切片格式只能是mp4 可以使用切片模式或singlefile模式 - widevine: 可以用于HLS和DASH,切片格式只能是mp4 输出HLS:可以使用切片模式或singlefile模式 输出DASH:只能singlefile模式 - playready: 可以用于HLS和DASH,切片格式只能是mp4 输出HLS:可以使用切片模式或singlefile模式 输出DASH:只能singlefile模式 示例值:widevine |
| SimpleAesDrm | SimpleAesDrm | 否 | SimpleAes 加密信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| SpekeDrm | SpekeDrm | 否 | FairPlay,WideVine,PlayReady 加密信息。 |
EditMediaFileInfo
编辑点播视频文件信息
被如下接口引用:DescribeTaskDetail, EditMedia, ParseNotification。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InputInfo | MediaInputInfo | 是 | 视频的输入信息。 |
| StartTimeOffset | Float | 否 | 【剪辑】任务生效,视频剪辑的起始时间偏移,单位:秒。 示例值:1 |
| EndTimeOffset | Float | 否 | 【剪辑】任务生效,视频剪辑的结束时间偏移,单位:秒。 示例值:10 |
| Id | String | 否 | 【合成】任务必选,用于轨道元素中媒体关联源素材 ID。 注意:允许字母、数字、-、_ ,最长 32 字符 注意:此字段可能返回 null,表示取不到有效值。 示例值:id1 |
EditMediaOutputConfig
编辑视频的结果文件输出配置。
被如下接口引用:EditMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Container | String | 否 | 封装格式,可选值:mp4、hls、mov、flv、avi。默认是 mp4。 注意:此字段可能返回 null,表示取不到有效值。 示例值:mp4 |
| Type | String | 否 | 剪辑模式,可选值: normal(默认):精准编辑 fast:快速编辑,处理速度更快但精准度一定程度降低 注意:fast只支持单文件,normal默认输出转码格式是h264 注意:此字段可能返回 null,表示取不到有效值。 示例值:fast |
EditMediaTask
编辑视频任务信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务 ID。 示例值:26xxxxxx12-EditMediaTask-28xxxxxxxxxx6batt6 |
| Status | String | 任务状态,取值: 示例值:FINISH |
| ErrCode | Integer | 错误码 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | EditMediaTaskInput | 视频编辑任务的输入。 |
| Output | EditMediaTaskOutput | 视频编辑任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 |
EditMediaTaskInput
编辑视频任务的输入。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| FileInfoSet | Array of EditMediaFileInfo | 输入的视频文件信息。 |
EditMediaTaskOutput
编辑视频任务的输出
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| OutputStorage | TaskOutputStorage | 编辑后文件的目标存储。 |
| Path | String | 编辑后的视频文件路径。 示例值:/xx.mp4 |
| MetaData | MediaMetaData | 编辑后的视频文件元信息。 注意:此字段可能返回 null,表示取不到有效值。 |
EnhanceConfig
音视频增强配置
被如下接口引用:CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ModifyTranscodeTemplate, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VideoEnhance | VideoEnhanceConfig | 否 | 视频增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| AudioEnhance | AudioEnhanceConfig | 否 | 音频增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
EraseArea
智能擦除,擦除区域坐标配置。
区域由左上角与右下角点的坐标确定。
坐标原点为画面左上角,坐标点可使用像素值或百分比单位指定。
对自动擦除区域:
当单位为%时,坐标范围为[0,1];
当单位为px时,X值范围为 [0,视频画面宽度],Y值范围为 [0,视频画面高度]
对指定擦除区域:
当单位为%时,坐标范围为[0,1);
当单位为px时,X值范围为 [0,视频画面宽度],Y值范围为 [0,视频画面高度]
被如下接口引用:CreateSmartEraseTemplate, ModifySmartEraseTemplate, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| LeftTopX | Float | 是 | 区域左上角X坐标。 如当Unit取1即使用百分比单位时,0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。 示例值:0.0500 |
| LeftTopY | Float | 是 | 区域左上角Y坐标。 如当Unit取1即使用百分比单位时,0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。 示例值:0.1000 |
| RightBottomX | Float | 是 | 区域右下角X坐标。 如当Unit取1即使用百分比单位时,0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。 示例值:0.7500 |
| RightBottomY | Float | 是 | 区域右下角Y坐标。 如当Unit取1即使用百分比单位时,0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。 示例值:0.9000 |
| Unit | Integer | 是 | 坐标单位 - 1 百分比 - 2 像素值 示例值:1 |
EraseTimeArea
智能擦除,指定擦除区域配置。
对指定时间段内的指定区域直接进行擦除。
当BeginMs和EndMs均取0时对整个视频内的指定区域直接进行擦除。
被如下接口引用:CreateSmartEraseTemplate, ModifySmartEraseTemplate, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| BeginMs | Integer | 是 | 开始时间,单位:毫秒 示例值:200 |
| EndMs | Integer | 是 | 结束时间,单位:毫秒 示例值:3000 |
| Areas | Array of EraseArea | 是 | 时间段内擦除区域列表 |
EvaluationMediaInputInfo
视频评测任务的视频来源信息
被如下接口引用:CreateMediaEvaluation。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SourceId | String | 否 | 对比视频的来源 ID,当评测任务的类型为 BD_RATE 且对比视频来自用户输入时有效;当对比视频来自转码模板时为空 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| InputInfo | MediaInputInfo | 否 | 对比视频的输入信息 注意:此字段可能返回 null,表示取不到有效值。 |
EvaluationTaskInput
评测任务输入参数类型
被如下接口引用:CreateMediaEvaluation。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TaskType | String | 是 | 评测任务类型,可选 NORMAL、BD_RATE 示例值:NORMAL |
| EvaluationTypeSet | Array of String | 是 | 评测类型,可选 PSNR、SSIM、VMAF、VMAF_NEG 示例值:["PSNR"] |
| EvaluationRangeType | String | 否 | 评测范围类型,可选 ALL(全部时长)、TIME(指定时长范围)、FRAME(指定帧数范围) 示例值:ALL |
| ContrastMediaSet | Array of EvaluationMediaInputInfo | 否 | 对比视频信息。 |
| ContrastTemplateSet | Array of EvaluationTemplateInputInfo | 否 | 对比转码模板信息。 |
| StartTime | Integer | 否 | 开始评测时间,单位秒,当 EvaluationRangeType 为 TIME 时有效。 示例值:0 |
| EndTime | Integer | 否 | 结束评测时间,单位秒,当 EvaluationRangeType 为 TIME 时有效。 示例值:10 |
| StartFrameIndex | Integer | 否 | 评测开始帧,默认从0开始,当 EvaluationRangeType 为FRAME 时有效。 示例值:0 |
| EndFrameIndex | Integer | 否 | 评测结束帧,默认为视频中可以参与评测的最后一帧,当 EvaluationRangeType 为 FRAME 时有效。 示例值:9 |
| ResolutionAlignmentMode | String | 否 | 分辨率对齐模式,默认对齐到低分辨率的视频,可选 ALIGN_HIGH_RESOLUTION、ALIGN_LOW_RESOLUTION 示例值:ALIGN_HIGH_RESOLUTION |
| BitrateSet | Array of Integer | 否 | 指定码率评测,当评测任务类型为 BD_RATE 有效。 示例值:[1500,2000,2500,3000] |
| VCRFSet | Array of Integer | 否 | 指定 vcrf 评测,当评测任务类型为 BD_RATE 有效。 示例值:[20,24,30,34] |
EvaluationTemplateInputInfo
在评测中使用的转码模板的信息
被如下接口引用:CreateMediaEvaluation。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 转码模板的 ID。 注意:此字段可能返回 null,表示取不到有效值。 示例值:100010 |
ExecRuleTaskData
条件判断输出
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| RearDriveIndex | Array of Integer | 质检条件判断需要执行的节点索引。 示例值:[2,3] |
ExecRulesTask
任务判断条件
被如下接口引用:CreateSchedule, DescribeTaskDetail, ModifySchedule, ParseNotification。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Rules | Array of Rules | 否 | 条件判断信息 注意:此字段可能返回 null,表示取不到有效值。 |
ExpressionConfigInfo
表情识别参数配置
被如下接口引用:RecognizeMediaForZhiXue。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 表情识别任务开关,可选值: 示例值:ON |
ExtractBlindWatermarkConfig
提取盲水印配置
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ON |
ExtractBlindWatermarkTask
提取视频数字水印任务信息
被如下接口引用:DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 媒体处理任务 ID。 示例值:125xxx65-ExtractBlindWatermark-bffb15f07530b57bc1aabb01fac74bca |
| Status | String | 任务流状态,取值: 示例值:PROCESSING |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败。 示例值:0 |
| Message | String | 错误信息。 示例值:NULL |
| InputInfo | MediaInputInfo | 媒体处理的目标文件信息。 |
| Type | String | 数字水印类型,可选值: 示例值:blind-basic |
| IsDetected | Boolean | 标记是否检测到水印,如果该参数为true, Result字段将返回水印提取结果,如果该参数为false,Result字段不会返回。 示例值:false |
| Result | String | 提取出的数字水印内容,当没有检测到水印时该字段不会返回。 示例值:数字水印文本 |
| ExtractBlindWatermarkConfig | ExtractBlindWatermarkTaskConfig | 提取数字水印配置。 |
ExtractBlindWatermarkTaskConfig
提取视频转码数字水印任务配置
被如下接口引用:DescribeTaskDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SegmentDuration | Integer | 是 | 当提取数字水印类型为blind-abseq时有效,用于指定输入视频的切片时长,单位:毫秒。 如果不填默认切片时长为5秒。 注意:此字段可能返回 null,表示取不到有效值。 示例值:5000 |
FaceConfigureInfo
人脸识别任务控制参数
被如下接口引用:CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 人脸识别任务开关,可选值: 示例值:ON |
| Score | Float | 否 | 人脸识别过滤分数,当识别结果达到该分数以上,返回识别结果。默认 95 分。取值范围:0 - 100。 示例值:95 |
| DefaultLibraryLabelSet | Array of String | 否 | 默认人物过滤标签,指定需要返回的默认人物的标签。如果未填或者为空,则全部默认人物结果都返回。标签可选值: 示例值:["entertainment"] |
| UserDefineLibraryLabelSet | Array of String | 否 | 用户自定义人物过滤标签,指定需要返回的用户自定义人物的标签。如果未填或者为空,则全部自定义人物结果都返回。 标签个数最多 100 个,每个标签长度最多 16 个字符。 示例值:["artist"] |
| FaceLibrary | String | 否 | 人物库选择,可选值: 默认值:All,使用系统默认人物库及用户自定义人物库。 示例值:Default |
FaceConfigureInfoForUpdate
人脸识别任务控制参数
被如下接口引用:ModifyAIRecognitionTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 人脸识别任务开关,可选值: 示例值:ON |
| Score | Float | 否 | 人脸识别过滤分数,当识别结果达到该分数以上,返回识别结果。取值范围:0-100。 示例值:80 |
| DefaultLibraryLabelSet | Array of String | 否 | 默认人物过滤标签,指定需要返回的默认人物的标签。如果未填或者为空,则全部默认人物结果都返回。标签可选值: 示例值:["entertainment"] |
| UserDefineLibraryLabelSet | Array of String | 否 | 用户自定义人物过滤标签,指定需要返回的用户自定义人物的标签。如果未填或者为空,则全部自定义人物结果都返回。 标签个数最多 100 个,每个标签长度最多 16 个字符。 示例值:["artist"] |
| FaceLibrary | String | 否 | 人物库选择,可选值: 示例值:Default |
FaceEnhanceConfig
人脸增强配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate, ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Intensity | Float | 否 | 强度,取值范围:0.0~1.0。 默认:0.0。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
FailOverOption
type FailOverOption struct
{ FailOverType string json:"FailOverType" // 新增 冷/热备 COLDSTANDBY、HOTSTANDBY }
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FailOverType | String | 否 | 热备 示例值:HOTSTANDBY |
FlowAudio
流的音频数据。
被如下接口引用:DescribeStreamLinkFlowStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Fps | Integer | 帧率。 示例值:30 |
| Rate | Integer | 码率,单位是bps。 示例值:1000 |
| Pid | Integer | 音频Pid。 示例值:256 |
FlowInOutResp
查询Flow的配置信息。
被如下接口引用:DescribeGroupAttachFlowsById。
| 名称 | 类型 | 描述 |
|---|---|---|
| FlowId | String | 流Id。 示例值:01937702c54509dc0f3269ca341f |
| FlowName | String | 流名称。 示例值:019202e96d9f09dc0f325e7f7a2a |
| EventId | String | 该Flow关联的媒体传输事件EventId。 示例值:eventid |
| FlowRegion | String | 媒体传输输入流所属的区域,取值和InputRegion相同。 示例值:ap-shanghai |
| OutputRegion | String | 当返回是输出类型时非空,output所在Region。 示例值:ap-shanghai |
| EventName | String | EventName。 示例值:example-event |
| InputName | String | InOutType为Input有效。 示例值:studio-one |
| OutputName | String | InOutType为Output有效。 示例值:shanghai-ouput |
| InOutId | String | Input或者Output的Id。 示例值:065422a22c771ebd470401elkijg |
| InOutType | String | 输入/输出类型,可选值: Input:输入 Outpu:输出。 示例值:Input |
FlowLogInfo
传输流日志信息。
被如下接口引用:DescribeStreamLinkFlowLogs。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | Integer | 时间戳,单位为秒。 示例值:12 |
| Type | String | 输入输出类型(input/output)。 示例值: input |
| InputOutputId | String | 输入或输出Id。 示例值: 12478 |
| Protocol | String | 协议。 示例值: RTMP |
| EventCode | String | 事件代码。 示例值: 10224 |
| EventMessage | String | 事件信息。 示例值: test |
| RemoteIp | String | 对端IP。 示例值: ip |
| RemotePort | String | 对端端口。 示例值: port |
| Pipeline | String | 主备通道,0为主通道,1为备通道。 示例值: 1 |
| InputOutputName | String | 输入或输出的名称。 示例值: name |
FlowMediaAudio
传输流媒体的音频数据。
被如下接口引用:DescribeStreamLinkFlowMediaStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Fps | Integer | 帧率。 示例值:30 |
| Rate | Integer | 码率,单位是bps。 示例值:1477 |
| Pid | Integer | 音频Pid。 示例值:10227 |
| SessionId | String | 标志同一次推流。 示例值:20147 |
FlowMediaInfo
传输流的媒体数据。
被如下接口引用:DescribeStreamLinkFlowMediaStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | Integer | 时间戳,单位是秒。 示例值:1610954100 |
| Network | Integer | 总带宽。 示例值:2824932 |
| Video | Array of FlowMediaVideo | 传输流的视频数据。 示例值:0 |
| Audio | Array of FlowMediaAudio | 传输流的音频数据。 示例值:0 |
| SessionId | String | 标志同一次推流。 示例值:412573995 |
| ClientIp | String | 客户端IP。 示例值:1.1.1.1 |
FlowMediaVideo
传输流媒体的视频数据。
被如下接口引用:DescribeStreamLinkFlowMediaStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Fps | Integer | 帧率。 示例值:30 |
| Rate | Integer | 码率,单位是bps。 示例值:1477 |
| Pid | Integer | 视频Pid。 示例值:10251 |
| SessionId | String | 标志同一次推流。 示例值:14557 |
FlowRealtimeStatusCommon
实时流状态查询的通用状态信息。
被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| State | String | 当前连接状态,Connected|Waiting|Idle。 示例值:Connected |
| Mode | String | 连接模式,Listener|Caller。 示例值:Listener |
| ConnectedTime | Integer | 已连接时长,单位为ms。 示例值:1 |
| Bitrate | Integer | 实时码率,单位为bps。 示例值:1 |
| Reconnections | Integer | 重试次数。 示例值:1 |
FlowRealtimeStatusItem
流状态实时查询接口的流状态信息
被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 类型,Input|Output。 示例值:Input |
| InputId | String | 输入Id,如果Type为Input,此字段不为空。 示例值:0176ac7f1af30956b92d2aad1e6e |
| OutputId | String | 输出Id,如果Type为Output,此字段不为空。 示例值:2176ac7f1af20956b92d2aad1234 |
| FlowId | String | 流Id。 示例值:asd5ac7f1af20956b92d2aadq231 |
| Protocol | String | 协议, SRT | RTMP。 示例值:SRT |
| CommonStatus | FlowRealtimeStatusCommon | 共同状态信息。 |
| SRTStatus | FlowRealtimeStatusSRT | 如果是SRT协议则有此字段。 注意:此字段可能返回 null,表示取不到有效值。 |
| RTMPStatus | FlowRealtimeStatusRTMP | 如果是RTMP协议则有此字段。 注意:此字段可能返回 null,表示取不到有效值。 |
| ConnectServerIP | String | 服务器IP。 示例值:121.23.56.99 |
| RTPStatus | FlowRealtimeStatusRTP | 如果是RTP协议则有此字段。 注意:此字段可能返回 null,表示取不到有效值。 |
FlowRealtimeStatusRTMP
流状态实时查询接口的RTMP信息。
被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| VideoFPS | Integer | 视频帧率。 示例值:25 |
| AudioFPS | Integer | 音频帧率。 示例值:48 |
FlowRealtimeStatusRTP
流状态实时查询接口的RTP流状态信息
被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| Packets | Integer | 传输的包个数 示例值:30 |
FlowRealtimeStatusSRT
流状态实时查询接口的SRT信息。
被如下接口引用:DescribeStreamLinkFlowRealtimeStatus。
| 名称 | 类型 | 描述 |
|---|---|---|
| Latency | Integer | 延迟,单位为ms。 示例值:1 |
| RTT | Integer | RTT,单位为ms。 示例值:1 |
| Packets | Integer | 实时发包数或者收包数。 示例值:1 |
| PacketLossRate | Float | 丢包率。 示例值:0.01 |
| RetransmitRate | Float | 重传率。 示例值:0.01 |
| DroppedPackets | Integer | 实时丢包数。 示例值:1 |
| Encryption | String | 是否加密,On|Off。 示例值:On |
FlowSRTInfo
传输流的SRT质量数据。
被如下接口引用:DescribeStreamLinkFlowSRTStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | Integer | 时间戳,单位是秒。 示例值:1611288000 |
| SendPacketLossRate | Integer | 发送丢包率。 示例值:0 |
| SendRetransmissionRate | Integer | 发送重传率。 示例值:0 |
| RecvPacketLossRate | Integer | 接收丢包率。 示例值:0 |
| RecvRetransmissionRate | Integer | 接收重传率。 示例值:0 |
| RTT | Integer | 与对端的RTT时延。 示例值:100 |
| SessionId | String | 标志同一次推流。 示例值:15346848 |
| SendPacketDropNumber | Integer | 发送弃包数。 示例值:0 |
| RecvPacketDropNumber | Integer | 接收弃包数。 示例值:0 |
FlowStatistics
流的统计数据。
被如下接口引用:DescribeStreamLinkFlowStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| SessionId | String | 会话Id。 示例值:1564865 |
| ClientIp | String | 对端IP。 示例值:1.1.1.1 |
| Network | Integer | 总带宽。 示例值:2000 |
| Video | Array of FlowVideo | 视频数据。 示例值:0 |
| Audio | Array of FlowAudio | 音频数据。 示例值:0 |
FlowStatisticsArray
流的统计数据列表。
被如下接口引用:DescribeStreamLinkFlowStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Timestamp | Integer | 时间戳。 示例值:1611288000 |
| FlowStatistics | Array of FlowStatistics | 每个会话的统计数据。 示例值:0 |
FlowVideo
流的视频数据。
被如下接口引用:DescribeStreamLinkFlowStatistics。
| 名称 | 类型 | 描述 |
|---|---|---|
| Fps | Integer | 帧率。 示例值:30 |
| Rate | Integer | 码率,单位是bps。 示例值:1000 |
| Pid | Integer | 音频Pid。 示例值:257 |
FrameRateConfig
插帧帧率配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Fps | Integer | 否 | 帧率,取值范围:[0, 100],单位:Hz。 默认值 0。 注意:对于转码,该参数会覆盖 VideoTemplate 内部的 Fps。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
FrameTagConfigureInfo
智能按帧标签任务控制参数
被如下接口引用:CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 智能按帧标签任务开关,可选值: 示例值:ON |
FrameTagConfigureInfoForUpdate
智能按帧标签任务控制参数
被如下接口引用:ModifyAIAnalysisTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 智能按帧标签任务开关,可选值: 示例值:ON |
HLSConfigureInfo
HLS配置参数
被如下接口引用:CreateLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ItemDuration | Integer | 否 | 单个 TS 文件时长,单位:秒,取值范围 5-30 秒。 不填默认为 30 秒。 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
| Interval | Integer | 否 | 录制周期,单位:秒,取值范围 10 分钟到 12 小时。 不填默认为 10分钟(3600 秒)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:3600 |
| ContinueTimeout | Integer | 否 | 续录等待时间,单位:秒。取值范围为60秒-1800秒。 不填默认为0(不启用续录)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:60 |
HLSPullSourceAddress
创建的输入HLS拉流源站配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Url | String | 是 | HLS源站的Url地址。 示例值:http://testdomain.com:8806/live/streamname |
HdrConfig
HDR配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 类型,可选值: 默认值:HDR10。 注意:video的编码方式需要为h265; 注意:视频编码位深为10。 注意:此字段可能返回 null,表示取不到有效值。 示例值:HDR10 |
HeadTailParameter
片头片尾参数
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| HeadSet | Array of MediaInputInfo | 否 | 片头列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[ { "Type": "URL", "UrlInputInfo": { "Url": "htt |
| TailSet | Array of MediaInputInfo | 否 | 片尾列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[ { "Type": "URL", "UrlInputInfo": { "Url": "htt |
HighlightSegmentItem
智能精彩集锦片段列表。
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 置信度。 示例值:80.55 |
| StartTimeOffset | Float | 片段起始时间偏移。 示例值:10.05 |
| EndTimeOffset | Float | 片段结束时间偏移。 示例值:20.05 |
| SegmentTags | Array of String | 片段标签 注意:此字段可能返回 null,表示取不到有效值。 示例值:["Goal"] |
| BeginTime | String | 直播切片对应直播起始时间点,采用 ISO 日期格式。 示例值:2024-10-21T17:18:34+08:00 |
| EndTime | String | 直播切片对应直播结束时间点,采用 ISO 日期格式。 示例值:2024-10-21T17:26:19+08:00 |
| Title | String | 集锦标题。 示例值:title |
| Summary | String | 集锦概要。 示例值:summary |
ImageAreaBoxInfo
图片框选区域信息
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | 图片框选区域类型,可选值: 默认值:logo。 注意:此字段可能返回 null,表示取不到有效值。 示例值:logo |
| AreaCoordSet | Array of Integer | 否 | 图片框选区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。 示例值:[101, 85, 111, 95] 注意:此字段可能返回 null,表示取不到有效值。 示例值:[101, 85, 111, 95] |
| BoundingBox | Array of Float | 否 | 图片框选区域坐标,[x1, y1, x2, y2],即左上角坐标、右下角坐标, 当AreaCoordSet未指定时生效。 - [0.1, 0.1, 0.3, 0.3] : 表示比例 (数值小于1) - [50, 50, 350, 280] : 表示像素 (数值大于等于1) 注意:此字段可能返回 null,表示取不到有效值。 示例值:[0.1, 0.1, 0.2, 0.2] |
ImageDenoiseConfig
图片降噪配置
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 类型,可选值: 默认值:weak。 注意:此字段可能返回 null,表示取不到有效值。 示例值:weak |
ImageEncodeConfig
图片编码格式参数
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Format | String | 否 | 图片格式,取值范围:JPEG、PNG、BMP、WebP,缺省为原图格式。不支持动画。 注意:此字段可能返回 null,表示取不到有效值。 示例值:JPEG |
| Quality | Integer | 否 | 图片的相对质量,取值范围:1 - 100,数值以原图质量为标准,缺省为原图质量。 注意:此字段可能返回 null,表示取不到有效值。 示例值:50 |
ImageEnhanceConfig
图片增强参数
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SuperResolution | SuperResolutionConfig | 否 | 超分配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| Denoise | ImageDenoiseConfig | 否 | 降噪配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| ImageQualityEnhance | ImageQualityEnhanceConfig | 否 | 综合增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| ColorEnhance | ColorEnhanceConfig | 否 | 色彩增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| SharpEnhance | SharpEnhanceConfig | 否 | 细节增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| FaceEnhance | FaceEnhanceConfig | 否 | 人脸增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| LowLightEnhance | LowLightEnhanceConfig | 否 | 低光照增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
ImageEraseConfig
图片擦除参数
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImageEraseLogo | ImageEraseLogoConfig | 否 | 图标擦除配置。 注意:此字段可能返回 null,表示取不到有效值。 |
ImageEraseLogoConfig
图标擦除配置
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ON |
| ImageAreaBoxes | Array of ImageAreaBoxInfo | 否 | 需要擦除的多个框选区域,最多开启16个区域。 注意:此字段可能返回 null,表示取不到有效值。 注意:此字段可能返回 null,表示取不到有效值。 |
| DetectTypes | Array of String | 否 | 图片框选区域类型,可选值: 注意:此字段可能返回 null,表示取不到有效值。 示例值:["logo", "text"] |
ImageProcessTaskOutput
图片处理结果信息
被如下接口引用:DescribeImageTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Path | String | 输出文件的路径。 注意:此字段可能返回 null,表示取不到有效值。 示例值:/output/test.jpeg |
| OutputStorage | TaskOutputStorage | 输出文件的存储位置。 注意:此字段可能返回 null,表示取不到有效值。 |
| SignedUrl | String | 输出文件的URL。 示例值:https://abc123.com/output/test.jpeg |
ImageProcessTaskResult
图片处理任务结果类型
被如下接口引用:DescribeImageTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 注意:此字段可能返回 null,表示取不到有效值。 示例值:SUCCESS |
| Message | String | 错误信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:SUCCESS |
| Output | ImageProcessTaskOutput | 转码任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 |
| Progress | Integer | 转码进度,取值范围 [0-100] 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
ImageQualityEnhanceConfig
综合增强配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate, ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 类型,可选值: 默认值:weak。 注意:此字段可能返回 null,表示取不到有效值。 示例值:weak |
ImageSpriteTaskInput
对视频截雪碧图任务输入参数类型
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 雪碧图模板 ID。 示例值:10001 |
| OutputStorage | TaskOutputStorage | 否 | 截取雪碧图后文件的目标存储,不填则继承上层的 OutputStorage 值。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputObjectPath | String | 否 | 截取雪碧图后,雪碧图图片文件的输出路径,可以为相对路径或者绝对路径。 若需定义输出路径,路径需以 .{format}结尾。变量名请参考 文件名变量说明。相对路径示例: 绝对路径示例: 如果不填,则默认为相对路径: {inputName}_imageSprite_{definition}_{number}.{format}。示例值:xxx_imageSprite_10001_0.png |
| WebVttObjectName | String | 否 | 截取雪碧图后,Web VTT 文件的输出路径,只能为相对路径。如果不填,则默认为相对路径:{inputName}_imageSprite_{definition}.{format}。示例值:xxx_imageSprite_10001_0.vtt |
| ObjectNumberFormat | NumberFormat | 否 | 截取雪碧图后输出路径中的{number}变量的规则。注意:此字段可能返回 null,表示取不到有效值。 |
ImageSpriteTemplate
雪碧图模板详情
被如下接口引用:DescribeImageSpriteTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 雪碧图模板唯一标识。 示例值:0 |
| Type | String | 模板类型,取值范围: 示例值:Custom |
| Name | String | 雪碧图模板名称。 示例值:ImageSprite |
| Width | Integer | 雪碧图中小图的宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 示例值:0 |
| Height | Integer | 雪碧图中小图的高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 示例值:0 |
| ResolutionAdaptive | String | 分辨率自适应,可选值: 默认值:open。 示例值:open |
| SampleType | String | 采样类型。 示例值:Time |
| SampleInterval | Integer | 采样间隔。 示例值:0 |
| RowCount | Integer | 雪碧图中小图的行数。 示例值:0 |
| ColumnCount | Integer | 雪碧图中小图的列数。 示例值:0 |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2025-03-23T07:14:27+08:00 |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2025-03-23T07:14:37+08:00 |
| FillType | String | 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: 默认值:black 。 示例值:black |
| Comment | String | 模板描述信息。 示例值:雪碧图模板 |
| Format | String | 图片格式。 示例值:png |
ImageTaskInput
图片任务输入参数
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EncodeConfig | ImageEncodeConfig | 否 | 图片编码配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| EnhanceConfig | ImageEnhanceConfig | 否 | 图片增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| EraseConfig | ImageEraseConfig | 否 | 图片擦除配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| BlindWatermarkConfig | BlindWatermarkConfig | 否 | 盲水印配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| BeautyConfig | BeautyConfig | 否 | 美颜配置。 |
ImageWatermarkInput
图片水印模板输入参数
被如下接口引用:CreateWatermarkTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImageContent | String | 是 | 水印图片 Base64 编码后的字符串。支持 jpeg、png 图片格式。 示例值:AKIAABC***12345W |
| Width | String | 否 | 水印的宽度。支持 %、px 两种格式: 当宽高都不填或者为0时,默认为 10%。 示例值:10% |
| Height | String | 否 | 水印的高度。支持 %、px 两种格式: 默认值:0px,表示 Height 按照原始水印图片的宽高比缩放。 示例值:10% |
| RepeatType | String | 否 | 水印重复类型。使用场景:水印为动态图像。取值范围: 示例值:once |
ImageWatermarkInputForUpdate
图片水印模板输入参数
被如下接口引用:ModifyWatermarkTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImageContent | String | 否 | 水印图片 Base64 编码后的字符串。支持 jpeg、png 图片格式。 示例值:AKIAABC***12345W |
| Width | String | 否 | 水印的宽度。支持 %、px 两种格式: 示例值:10% |
| Height | String | 否 | 水印的高度。支持 %、px 两种格式: 示例值:10% |
| RepeatType | String | 否 | 水印重复类型。使用场景:水印为动态图像。取值范围: 示例值:once |
ImageWatermarkTemplate
图片水印模板
被如下接口引用:DescribeWatermarkTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| ImageUrl | String | 水印图片地址。 示例值:http://test-watermark.com/image-watermark.png |
| Width | String | 水印的宽度。支持 %、px 两种格式: 示例值:10px |
| Height | String | 水印的高度。支持 %、px 两种格式: 0px:表示 Height 按照 Width 对视频宽度的比例缩放。 示例值:10px |
| RepeatType | String | 水印重复类型。使用场景:水印为动态图像。取值范围: 示例值:repeat |
InputAddress
输入地址信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 描述 |
|---|---|---|
| Ip | String | 输入地址的IP。 示例值:ip |
| Port | Integer | 输入地址的端口。 示例值:port |
LiveActivityResItem
直播编排子任务输出
被如下接口引用:DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| LiveRecordTask | LiveScheduleLiveRecordTaskResult | 直播录制任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
| LiveQualityControlTask | ScheduleQualityControlTaskResult | 媒体质检任务输出 注意:此字段可能返回 null,表示取不到有效值。 |
LiveActivityResult
直播编排任务输出
被如下接口引用:DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| ActivityType | String | 原子任务类型。 示例值:LiveRecord |
| LiveActivityResItem | LiveActivityResItem | 原子任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
LiveRecordFile
直播录制输出文件信息
被如下接口引用:DescribeTaskDetail, ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Url | String | 直播录制文件地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://xxx.m3u8 |
| Size | Integer | 直播录制文件大小 注意:此字段可能返回 null,表示取不到有效值。 示例值:1024 |
| Duration | Integer | 直播录制文件时长 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
| StartTime | String | 直播录制文件开始时间,使用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-23T07:14:27+08:00 |
| EndTime | String | 直播录制文件结束时间,使用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-23T07:16:17+08:00 |
LiveRecordResult
直播录制结果
被如下接口引用:DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| OutputStorage | TaskOutputStorage | 直播录制文件的目标存储。 注意:此字段可能返回 null,表示取不到有效值。 |
| FileList | Array of LiveRecordFile | 直播录制文件列表 注意:此字段可能返回 null,表示取不到有效值。 |
LiveRecordTaskInput
直播录制任务输入参数类型
被如下接口引用:DescribeTaskDetail。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 直播录制模板 ID。 示例值:10 |
| OutputStorage | TaskOutputStorage | 否 | 直播录制后文件的目标存储,不填则继承上层的 OutputStorage 值。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputObjectPath | String | 否 | 直播录制后文件的输出路径。 注意:此字段可能返回 null,表示取不到有效值。 示例值:/xxx-LiveScheduleTask-xxx |
LiveRecordTemplate
直播录制模板详情
被如下接口引用:DescribeLiveRecordTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 录制模板唯一标识。 示例值:20001 |
| HLSConfigure | HLSConfigureInfo | HLS 配置参数 示例值:hls |
| MP4Configure | MP4ConfigureInfo | MP4配置参数 示例值:{"interval":600} |
| Name | String | 录制模板名称。 示例值:录制模板 |
| Comment | String | 模板描述信息。 示例值:默认录制模板 |
| Type | String | 模板类型,取值: 示例值:Preset或Custom |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2023-10-23T22:30:00+08:00 |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2023-10-23T22:30:00+08:00 |
| RecordType | String | 录制类型,取值为video(音视频录制)、audio(纯音频录制)、auto(自动探测)。 示例值:video |
LiveScheduleLiveRecordTaskResult
直播编排直播录制任务结果类型
被如下接口引用:DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:PROCESSING |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Message | String | 错误信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:record failed. |
| Input | LiveRecordTaskInput | 直播录制任务的输入。 注意:此字段可能返回 null,表示取不到有效值。 |
| Output | LiveRecordResult | 直播录制任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-22T23:14:20+08:00 |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-22T23:22:44+08:00 |
LiveScheduleTask
直播编排任务信息
被如下接口引用:DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 直播编排任务 ID。 示例值:24xxxx-LiveScheduleTask-bd221bcc6xxxxxx |
| Status | String | 任务流状态,取值: 示例值:FINISH |
| ErrCode | Integer | 源异常时返回非0错误码,返回0 时请使用各个具体任务的 ErrCode。 示例值:0 |
| Message | String | 源异常时返回对应异常Message,否则请使用各个具体任务的 Message。 示例值:record failed |
| Url | String | 直播流 URL。 示例值:http://xxx.flv |
| LiveActivityResultSet | Array of LiveActivityResult | 直播编排任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
LiveStreamAiAnalysisResultInfo
直播流分析结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResultSet | Array of LiveStreamAiAnalysisResultItem | 直播分析子任务结果,暂时只支持直播拆条。 注意:此字段可能返回 null,表示取不到有效值。 |
LiveStreamAiAnalysisResultItem
直播流 AI 分析结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 结果的类型,取值范围: 示例值:SegmentRecognition |
| SegmentResultSet | Array of SegmentRecognitionItem | 拆条结果,当 Type 为 SegmentRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| HighlightResultSet | Array of MediaAiAnalysisHighlightItem | 集锦结果,当Type 为 Highlight 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
LiveStreamAiQualityControlResultInfo
直播流媒体质检结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| QualityControlResultSet | Array of QualityControlResult | 内容质检结果列表。 注意:此字段可能返回 null,表示取不到有效值。 |
| DiagnoseResultSet | Array of DiagnoseResult | 格式诊断结果列表。 注意:此字段可能返回 null,表示取不到有效值。 |
LiveStreamAiRecognitionResultInfo
直播流 AI 识别结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResultSet | Array of LiveStreamAiRecognitionResultItem | 内容识别结果列表。 |
LiveStreamAiRecognitionResultItem
直播流 AI 识别结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 结果的类型,取值范围: 示例值:FaceRecognition |
| FaceRecognitionResultSet | Array of LiveStreamFaceRecognitionResult | 人脸识别结果,当 Type 为 FaceRecognition 时有效。 示例值:NULL |
| AsrWordsRecognitionResultSet | Array of LiveStreamAsrWordsRecognitionResult | 语音关键词识别结果,当 Type 为 AsrWordsRecognition 时有效。 示例值:NULL |
| OcrWordsRecognitionResultSet | Array of LiveStreamOcrWordsRecognitionResult | 文本关键词识别结果,当 Type 为 OcrWordsRecognition 时有效。 示例值:NULL |
| AsrFullTextRecognitionResultSet | Array of LiveStreamAsrFullTextRecognitionResult | 语音全文识别结果,当 Type 为 AsrFullTextRecognition 时有效。 示例值:NULL |
| OcrFullTextRecognitionResultSet | Array of LiveStreamOcrFullTextRecognitionResult | 文本全文识别结果,当 Type 为 OcrFullTextRecognition 时有效。 示例值:NULL |
| TransTextRecognitionResultSet | Array of LiveStreamTransTextRecognitionResult | 翻译结果,当Type 为 TransTextRecognition 时有效。 示例值:NULL |
| ObjectRecognitionResultSet | Array of LiveStreamObjectRecognitionResult | 目标检测结果,当Type为 ObjectRecognition 时有效。 示例值:NULL |
| TagRecognitionResultSet | Array of LiveStreamTagRecognitionResult | 打点结果,当Type 为 TagRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
LiveStreamAiReviewImagePoliticalResult
直播 AI 内容审核图片敏感结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartPtsTime | Float | 嫌疑片段起始的 PTS 时间,单位:秒。 示例值:26.5 |
| EndPtsTime | Float | 嫌疑片段结束的 PTS 时间,单位:秒。 示例值:29.5 |
| Confidence | Float | 嫌疑片段敏感分数。 示例值:90 |
| Suggestion | String | 嫌疑片段鉴黄结果建议,取值范围: 示例值:block |
| Label | String | 视频敏感结果标签,取值范围: 示例值:politician |
| Name | String | 敏感人物、违规图标名字。 示例值:人物1 |
| AreaCoordSet | Array of Integer | 敏感人物、违规图标出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。 示例值:[101, 85, 111, 95] |
| Url | String | 嫌疑图片 URL (图片不会永久存储,到达 PicUrlExpireTime 时间点后图片将被删除)。 示例值:http://252525.xx.myqcloud.com/1a168d62xxx0/bcf0c036xxxxxxxc/30xxx.jpg |
| PicUrlExpireTime | String | 嫌疑图片 URL 失效时间,使用 ISO 日期格式。 示例值:20xx-10-01T18:00:00+08:00 |
LiveStreamAiReviewImagePornResult
直播 AI 内容审核图片鉴黄结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartPtsTime | Float | 嫌疑片段起始的 PTS 时间,单位:秒。 示例值:0.266 |
| EndPtsTime | Float | 嫌疑片段结束的 PTS 时间,单位:秒。 示例值:4.146 |
| Confidence | Float | 嫌疑片段涉黄分数。 示例值:98 |
| Suggestion | String | 嫌疑片段鉴黄结果建议,取值范围: 示例值:block |
| Label | String | 视频鉴黄结果标签,取值范围: 示例值:porn |
| Url | String | 嫌疑图片 URL (图片不会永久存储,到达 PicUrlExpireTime 时间点后图片将被删除)。 示例值:http://ai-review.com/review-result.jpg |
| PicUrlExpireTime | String | 嫌疑图片 URL 失效时间,使用 ISO 日期格式。 示例值:2025-03-25T06:16:39Z |
LiveStreamAiReviewImageTerrorismResult
直播 AI 内容审核图片涉敏结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartPtsTime | Float | 嫌疑片段起始的 PTS 时间,单位:秒。 示例值:26.5 |
| EndPtsTime | Float | 嫌疑片段结束的 PTS 时间,单位:秒。 示例值:29.5 |
| Confidence | Float | 嫌疑片段涉敏分数。 示例值:85 |
| Suggestion | String | 嫌疑片段涉敏结果建议,取值范围: 示例值:block |
| Label | String | 视频涉敏结果标签,取值范围: 示例值:guns |
| Url | String | 嫌疑图片 URL (图片不会永久存储,到达 PicUrlExpireTime 时间点后图片将被删除)。 示例值:http://252525.xx.myqcloud.com/a168d6/xxxxxx.jpg |
| PicUrlExpireTime | String | 嫌疑图片 URL 失效时间,使用 ISO 日期格式。 示例值:20xx-10-01T18:00:00+08:00 |
LiveStreamAiReviewResultInfo
直播流 AI 审核结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ResultSet | Array of LiveStreamAiReviewResultItem | 内容审核结果列表。 |
LiveStreamAiReviewResultItem
直播流 AI 审核结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 审核结果的类型,可以取的值有: 示例值:ImagePorn |
| ImagePornResultSet | Array of LiveStreamAiReviewImagePornResult | 图片鉴黄的结果,当 Type 为 ImagePorn 时有效。 |
| ImageTerrorismResultSet | Array of LiveStreamAiReviewImageTerrorismResult | 图片涉敏的结果,当 Type 为 ImageTerrorism 时有效。 |
| ImagePoliticalResultSet | Array of LiveStreamAiReviewImagePoliticalResult | 图片涉敏的结果,当 Type 为 ImagePolitical 时有效。 |
| VoicePornResultSet | Array of LiveStreamAiReviewVoicePornResult | 声音违规的结果,当 Type 为 VoicePorn 时有效。 |
LiveStreamAiReviewVoicePornResult
直播 AI 内容审核声音鉴黄结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartPtsTime | Float | 嫌疑片段起始的 PTS 时间,单位:秒。 示例值:0.266 |
| EndPtsTime | Float | 嫌疑片段结束的 PTS 时间,单位:秒。 示例值:4.146 |
| Confidence | Float | 嫌疑片段涉黄分数。 示例值:98 |
| Suggestion | String | 嫌疑片段鉴黄结果建议,取值范围: 示例值:block |
| Label | String | 视频鉴黄结果标签,取值范围: 示例值:sexual_moan |
LiveStreamAsrFullTextRecognitionResult
直播识别 Asr 全文识别
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Text | String | 识别文本。 示例值:你好 |
| StartPtsTime | Float | 识别片段起始的 PTS 时间,单位:秒。 示例值:123.301 |
| EndPtsTime | Float | 识别片段终止的 PTS 时间,单位:秒。 示例值:125.301 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:99 |
| StartTime | String | 识别开始UTC时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-21T10:11:13Z |
| EndTime | String | 识别结束UTC时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-21T10:13:13Z |
| SteadyState | Boolean | 稳态标记。 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
| UserId | String | websocket与trtc识别结果的UserId 注意:此字段可能返回 null,表示取不到有效值。 示例值:bot |
LiveStreamAsrWordsRecognitionResult
直播 AI Asr 单词识别结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Word | String | 语音关键词。 示例值:张三 |
| StartPtsTime | Float | 识别片段起始的 PTS 时间,单位:秒。 示例值:0.266 |
| EndPtsTime | Float | 识别片段终止的 PTS 时间,单位:秒。 示例值:4.146 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:98 |
LiveStreamFaceRecognitionResult
直播 AI 人脸识别结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 人物唯一标识 ID。 示例值:1001 |
| Name | String | 人物名称。 示例值:张三 |
| Type | String | 人物库类型,表示识别出的人物来自哪个人物库: 示例值:Default |
| StartPtsTime | Float | 识别片段起始的 PTS 时间,单位:秒。 示例值:10.05 |
| EndPtsTime | Float | 识别片段终止的 PTS 时间,单位:秒。 示例值:12.05 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:80 |
| AreaCoordSet | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。 示例值:[1500,80,1800,120] |
LiveStreamObjectRecognitionResult
直播 AI 物体识别结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 识别的物体名称。 示例值:足球 |
| StartPtsOffset | Float | 识别片段起始的 PTS 时间,单位:秒。 示例值:61.08 |
| EndPtsOffset | Float | 识别片段终止的 PTS 时间,单位:秒。 示例值:65.54 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:90 |
| AreaCoordSet | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。 示例值:[1590,84,1867,129] |
| Url | String | 截图链接。 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://252525.xx.myqcloud.com/a168d6/xxxxxx.jpg |
LiveStreamOcrFullTextRecognitionResult
直播识别 Ocr 全文识别
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Text | String | 语音文本。 示例值:腾讯视频 |
| StartPtsTime | Float | 识别片段起始的 PTS 时间,单位:秒。 示例值:1.034 |
| EndPtsTime | Float | 识别片段终止的 PTS 时间,单位:秒。 示例值: 1.035 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:95 |
| AreaCoordSet | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。 示例值:[1500,80,1800,120] |
LiveStreamOcrWordsRecognitionResult
直播 AI Ocr 单词识别结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Word | String | 文本关键词。 示例值:腾讯视频 |
| StartPtsTime | Float | 识别片段起始的 PTS 时间,单位:秒。 示例值:14.047 |
| EndPtsTime | Float | 识别片段终止的 PTS 时间,单位:秒。 示例值:14.047 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:95 |
| AreaCoords | Array of Integer | 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。 示例值:[700,900,1000,1100] |
LiveStreamProcessErrorInfo
直播流处理错误信息
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| ErrCode | Integer | 错误码: 示例值:0 |
| Message | String | 错误信息。 示例值:open url failed |
LiveStreamProcessTask
直播处理任务信息
被如下接口引用:DescribeTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 媒体处理任务 ID。 示例值:NULL |
| Status | String | 任务流状态,取值: 示例值:NULL |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败。 示例值:NULL |
| Message | String | 错误信息。 示例值:NULL |
| Url | String | 直播流 URL。 示例值:NULL |
LiveStreamRecordResultInfo
直播流录制结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| RecordOver | Integer | 录制是否结束。 0:录制未结束,返回单个文件结果 1:录制结束,返回所有录制文件结果 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| FileResults | Array of LiveRecordFile | 文件列表 注意:此字段可能返回 null,表示取不到有效值。 |
LiveStreamTagRecognitionResult
直播 AI 打点识别结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 打点事件。 示例值:击杀黑暗暴君 |
| StartPtsTime | Float | 识别片段起始的 PTS 时间,单位:秒。 示例值:899.916 |
| EndPtsTime | Float | 识别片段终止的 PTS 时间,单位:秒。 示例值:899.916 |
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:100 |
LiveStreamTaskNotifyConfig
任务处理的事件通知配置。
被如下接口引用:ProcessLiveStream。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NotifyType | String | 否 | 通知类型: TDMQ-CMQ:消息队列 "URL": 指定URL时HTTP回调推送到 NotifyUrl 指定的地址,回调协议http+json,包体内容同解析直播事件通知接口 的输出参数 注:不填或为空时默认 CMQ,如需采用其他类型需填写对应类型值。 示例值:URL |
| NotifyUrl | String | 否 | HTTP回调地址,NotifyType为URL时必填。 示例值:http://www.qq.com/callback |
| CmqModel | String | 否 | 有 Queue 和 Topic 两种模型。 示例值:Queue |
| CmqRegion | String | 否 | TDMQ-CMQ 的园区,如 sh,bj 等。 示例值:sh |
| QueueName | String | 否 | 当模型为 Queue 时有效,表示接收事件通知的 TDMQ-CMQ 的队列名。 示例值:mpstest-queue |
| TopicName | String | 否 | 当模型为 Topic 时有效,表示接收事件通知的 TDMQ-CMQ 的主题名。 示例值:mpstest-topic |
| NotifyKey | String | 否 | 用于生成回调签名的 Key。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0se***9idaY |
LiveStreamTransTextRecognitionResult
直播实时翻译结果
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Text | String | 识别文本。 示例值:Hello |
| StartPtsTime | Float | 翻译片段起始的 PTS 时间,单位:秒。 示例值:8.764 |
| EndPtsTime | Float | 翻译片段终止的 PTS 时间,单位:秒。 示例值:15.977 |
| Confidence | Float | 翻译片段置信度。取值:0~100。 示例值:99 |
| Trans | String | 翻译文本。 示例值:你好 |
| StartTime | String | 翻译开始UTC时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-21T10:11:52Z |
| EndTime | String | 翻译结束UTC时间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2025-03-21T10:12:52Z |
| SteadyState | Boolean | 稳态标记。 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
| UserId | String | websocket与trtc实时翻译的UserId 注意:此字段可能返回 null,表示取不到有效值。 示例值:bot |
LowLightEnhanceConfig
低光照增强配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate, ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 类型,可选值: 默认值:normal。 注意:此字段可能返回 null,表示取不到有效值。 示例值:normal |
MP4ConfigureInfo
MP4配置参数
被如下接口引用:CreateLiveRecordTemplate, DescribeLiveRecordTemplates, ModifyLiveRecordTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Interval | Integer | 否 | 录制周期,单位:秒,取值范围 10 分钟到720分钟。默认值:60分钟(3600秒)。 示例值:3600 |
MediaAiAnalysisClassificationItem
智能分类结果
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Classification | String | 智能分类的类别名称。 示例值:影视 |
| Confidence | Float | 智能分类的可信度,取值范围是 0 到 100。 示例值:99.50 |
MediaAiAnalysisCoverItem
智能封面信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| CoverPath | String | 智能封面存储路径。 示例值:/xxx.jpg |
| Confidence | Float | 智能封面的可信度,取值范围是 0 到 100。 示例值:70 |
MediaAiAnalysisDescriptionItem
智能描述信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Description | String | 智能描述。 示例值:本段主要讲述了xxxxx内容 |
| Confidence | Float | 智能描述的可信度,取值范围是 0 到 100。 示例值:90 |
| Title | String | 智能描述标题 示例值:标题1 |
| Keywords | Array of String | 智能描述关键词 示例值:["word1","word2"] |
| Paragraphs | Array of AiParagraphInfo | 分段结果。 注意:此字段可能返回 null,表示取不到有效值。 |
| MindMapUrl | String | 摘要思维导图地址 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://xxxx.cos.myqcloud.com |
MediaAiAnalysisFrameTagItem
智能按帧标签结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Tag | String | 按帧标签名称。 示例值:寺庙 |
| CategorySet | Array of String | 按帧标签名称的分类列表,CategorySet.N 表示第 N+1级分类。 比如 Tag 为“塔楼”时,CategorySet 包含两个元素:CategorySet.0 为“场景”,CategorySet.1为 “建筑”,表示按帧标签为“塔楼”,且第1级分类是“场景”,第2级分类是“建筑”。 示例值:["场景","人文建筑"] |
| Confidence | Float | 按帧标签的可信度,取值范围是 0 到 100。 示例值:60 |
MediaAiAnalysisFrameTagSegmentItem
按帧标签片段列表
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 按帧标签起始的偏移时间。 示例值:10.052 |
| EndTimeOffset | Float | 按帧标签结束的偏移时间。 示例值:15.052 |
| TagSet | Array of MediaAiAnalysisFrameTagItem | 时间片段内的标签列表。 示例值:[{"Tag": "寺庙","CategorySet":["场景", "人文建筑"],"Confidence": 26}] |
MediaAiAnalysisHighlightItem
智能精彩片段信息
被如下接口引用:DescribeTaskDetail, ParseLiveStreamProcessNotification, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| HighlightPath | String | 智能精彩集锦地址。 示例值:/AItst/hht-2025031xxx-021354578E_17243423310test-0.mp4 |
| CovImgPath | String | 智能精彩集锦封面地址。 示例值:/AItest/hht-2025031xxx-021245578E_17243423310test-0.jpg |
| Confidence | Float | 智能精彩集锦的可信度,取值范围是 0 到 100。 示例值:92.56 |
| Duration | Float | 智能精彩集锦持续时间。 示例值:43.76 |
| SegmentSet | Array of HighlightSegmentItem | 智能精彩集锦子片段列表。 |
| HighlightUrl | String | 智能精彩集锦地址。 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://test-12246.cos.ap-nanjing.myqcloud.com/AItest/hht-2025031xxx-02135468E_17243423310test-0.mp4 |
| CovImgUrl | String | 智能精彩集锦封面地址。 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://test-12246.cos.ap-nanjing.myqcloud.com/AItest/hht-2025031xxx-02134468E_17243423310test-0.jpg |
MediaAiAnalysisTagItem
智能标签结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Tag | String | 标签名称。 示例值:影视综艺,影视片段 |
| Confidence | Float | 标签的可信度,取值范围是 0 到 100。 示例值:77.00 |
| SpecialInfo | String | 根据不同类型决定 示例值:额外输出信息 |
MediaAnimatedGraphicsItem
视频转动图结果信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Storage | TaskOutputStorage | 转动图文件的存储位置。 |
| Path | String | 转动图的文件路径。 示例值:/xxx.gif |
| Definition | Integer | 转动图模板 ID,参见转动图参数模板。 示例值:20000 |
| Container | String | 动图格式,如 gif。 示例值:gif |
| Height | Integer | 动图的高度,单位:px。 示例值:1080 |
| Width | Integer | 动图的宽度,单位:px。 示例值:1920 |
| Bitrate | Integer | 动图码率,单位:bps。 示例值:0 |
| Size | Integer | 动图大小,单位:字节。 示例值:1048576 |
| Md5 | String | 动图的md5值。 示例值:xxxx1b3082d8b18de1xxxx |
| StartTimeOffset | Float | 动图在视频中的起始时间偏移,单位:秒。 示例值:1.5 |
| EndTimeOffset | Float | 动图在视频中的结束时间偏移,单位:秒。 示例值:5.5 |
MediaAudioStreamItem
点播文件音频流信息
被如下接口引用:DescribeBatchTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Bitrate | Integer | 音频流的码率,单位:bps。 示例值:122748 |
| SamplingRate | Integer | 音频流的采样率,单位:hz。 示例值:44100 |
| Codec | String | 音频流的编码格式,例如 aac。 示例值:aac |
| Channel | Integer | 音频声道数,例如 2。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
| Codecs | String | 音频Codecs。 注意:此字段可能返回 null,表示取不到有效值。 示例值:mp4a.40.2 |
| Loudness | Float | 音频响度。 注意:此字段可能返回 null,表示取不到有效值。 示例值:-17.01 |
MediaContentReviewAsrTextSegmentItem
内容审核 Asr 文字审核嫌疑片段
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 嫌疑片段起始的偏移时间,单位:秒。 示例值:10.05 |
| EndTimeOffset | Float | 嫌疑片段结束的偏移时间,单位:秒。 示例值:15.00 |
| Confidence | Float | 嫌疑片段置信度。 示例值:90.00 |
| Suggestion | String | 嫌疑片段审核结果建议,取值范围: 示例值:pass |
| KeywordSet | Array of String | 嫌疑关键词列表。 示例值:["张三"] |
MediaContentReviewOcrTextSegmentItem
内容审核 Ocr 文字审核嫌疑片段
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 嫌疑片段起始的偏移时间,单位:秒。 示例值:10.05 |
| EndTimeOffset | Float | 嫌疑片段结束的偏移时间,单位:秒。 示例值:15.00 |
| Confidence | Float | 嫌疑片段置信度。 示例值:90 |
| Suggestion | String | 嫌疑片段审核结果建议,取值范围: 示例值:review |
| KeywordSet | Array of String | 嫌疑关键词列表。 示例值:['张三'] |
| AreaCoordSet | Array of Integer | 嫌疑文字出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。 示例值:[500,150,700,300] |
| Url | String | 嫌疑图片 URL (图片不会永久存储,到达 PicUrlExpireTime 时间点后图片将被删除)。 示例值:http://xxx.jpg |
| PicUrlExpireTime | String | 嫌疑图片 URL 失效时间,使用 ISO 日期格式。 示例值:2025-03-23T07:14:47+08:00 |
MediaContentReviewPoliticalSegmentItem
内容审核涉敏嫌疑片段
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 嫌疑片段起始的偏移时间,单位:秒。 示例值:0.04 |
| EndTimeOffset | Float | 嫌疑片段结束的偏移时间,单位:秒。 示例值:6.04 |
| Confidence | Float | 嫌疑片段涉敏分数。 示例值:98 |
| Suggestion | String | 嫌疑片段涉敏结果建议,取值范围: 示例值:block |
| Name | String | 涉敏人物、违规图标名字。 示例值:测试人物1 |
| Label | String | 嫌疑片段涉敏结果标签。内容审核模板画面涉敏任务控制参数里 LabelSet 参数与此参数取值范围的对应关系: violation_photo: politician: entertainment: sport: entrepreneur: scholar: celebrity: military: 示例值:sensitive_entertainment |
| Url | String | 嫌疑图片 URL (图片不会永久存储,到达 PicUrlExpireTime 时间点后图片将被删除)。 示例值:http://252325.test2.myqcloud.com/1a168dtest/test01_01.jpg |
| AreaCoordSet | Array of Integer | 涉敏人物、违规图标出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。 示例值:[801, 952, 808, 996] |
| PicUrlExpireTime | String | 嫌疑图片 URL 失效时间,使用 ISO 日期格式。 示例值:2023-xx-xxT10:11:32.392Z |
MediaContentReviewSegmentItem
内容审核涉黄/涉敏嫌疑片段
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| StartTimeOffset | Float | 嫌疑片段起始的偏移时间,单位:秒。 示例值:0.04 |
| EndTimeOffset | Float | 嫌疑片段结束的偏移时间,单位:秒。 示例值:6.04 |
| Confidence | Float | 嫌疑片段涉黄分数。 示例值:88 |
| Label | String | 嫌疑片段鉴黄结果标签。 示例值:sexy |
| Suggestion | String | 嫌疑片段鉴黄结果建议,取值范围: 示例值:block |
| Url | String | 嫌疑图片 URL (图片不会永久存储,到达 PicUrlExpireTime 时间点后图片将被删除)。 示例值:http://252452.test.myqcloud.com/1a168abcd12345560/419f9123123_01.jpg |
| PicUrlExpireTime | String | 嫌疑图片 URL 失效时间,使用 ISO 日期格式。 示例值:2023-03-28T10:12:16.948Z |
MediaImageSpriteItem
雪碧图信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 雪碧图规格,参见雪碧图参数模板。 示例值:0 |
| Height | Integer | 雪碧图小图的高度。 示例值:150 |
| Width | Integer | 雪碧图小图的宽度。 示例值:200 |
| TotalCount | Integer | 每一张雪碧图大图里小图的数量。 示例值:22 |
| ImagePathSet | Array of String | 每一张雪碧图大图的路径。 示例值:["/imageSprite_0.jpg"] |
| WebVttPath | String | 雪碧图子图位置与时间关系的 WebVtt 文件路径。WebVtt 文件表明了各个雪碧图小图对应的时间点,以及在雪碧大图里的坐标位置,一般被播放器用于实现预览。 示例值:/webvtt.vtt |
| Storage | TaskOutputStorage | 雪碧图文件的存储位置。 |
MediaInputInfo
媒体处理的输入对象信息。
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateVideoDatabaseEntryTask, CreateWorkflow, DescribeBatchTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, EditMedia, ParseNotification, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, ResetWorkflow, WithdrawsWatermark。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 输入来源对象的类型,支持: 示例值:NULL |
| CosInputInfo | CosInputInfo | 否 | 当 Type 为 COS 时有效,则该项为必填,表示媒体处理 COS 对象信息。 |
| UrlInputInfo | UrlInputInfo | 否 | 当 Type 为 URL 时有效,则该项为必填,表示媒体处理 URL 对象信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| S3InputInfo | S3InputInfo | 否 | 当 Type 为 AWS-S3 时有效,则该项为必填,表示媒体处理 AWS S3 对象信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| VODInputInfo | VODInputInfo | 否 | 当 Type 为 VOD 时有效,则该项为必填,表示媒体处理 点播专业版 对象信息。 注意:此字段可能返回 null,表示取不到有效值。 |
MediaMetaData
点播媒体文件元信息
被如下接口引用:DescribeBatchTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Size | Integer | 上传的媒体文件大小(视频为 HLS 时,大小是 m3u8 和 ts 文件大小的总和),单位:字节。 示例值:3771548 |
| Container | String | 容器类型,例如 m4a,mp4 等。 示例值:flv |
| Bitrate | Integer | 视频流码率平均值与音频流码率平均值之和,单位:bps。 示例值:611594 |
| Height | Integer | 视频流高度的最大值,单位:px。 示例值:480 |
| Width | Integer | 视频流宽度的最大值,单位:px。 示例值:854 |
| Duration | Float | 视频时长,单位:秒。 示例值:49.334 |
| Rotate | Integer | 视频拍摄时的选择角度,单位:度。 示例值:0 |
| VideoStreamSet | Array of MediaVideoStreamItem | 视频流信息。 |
| AudioStreamSet | Array of MediaAudioStreamItem | 音频流信息。 |
| VideoDuration | Float | 视频时长,单位:秒。 示例值:49.334 |
| AudioDuration | Float | 音频时长,单位:秒。 示例值:49.334 |
MediaProcessTaskAdaptiveDynamicStreamingResult
对视频转自适应码流任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:NULL |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:NULL |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:NULL |
| Message | String | 错误信息。 示例值:NULL |
| Input | AdaptiveDynamicStreamingTaskInput | 对视频转自适应码流任务的输入。 示例值:NULL |
| Output | AdaptiveDynamicStreamingInfoItem | 对视频转自适应码流任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-07-16T06:21:28Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-07-16T06:21:46Z |
MediaProcessTaskAnimatedGraphicResult
转动图任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:NULL |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:NULL |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:NULL |
| Message | String | 错误信息。 示例值:NULL |
| Input | AnimatedGraphicTaskInput | 转动图任务的输入。 示例值:NULL |
| Output | MediaAnimatedGraphicsItem | 转动图任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-07-16T06:21:28Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-07-16T06:21:46Z |
MediaProcessTaskImageSpriteResult
对视频截雪碧图任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | ImageSpriteTaskInput | 对视频截雪碧图任务的输入。 |
| Output | MediaImageSpriteItem | 对视频截雪碧图任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:28Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:46Z |
MediaProcessTaskInput
媒体处理任务类型
被如下接口引用:CreateWorkflow, DescribeWorkflows, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TranscodeTaskSet | Array of TranscodeTaskInput | 否 | 视频转码任务列表。 示例值:NULL |
| AnimatedGraphicTaskSet | Array of AnimatedGraphicTaskInput | 否 | 视频转动图任务列表。 示例值:NULL |
| SnapshotByTimeOffsetTaskSet | Array of SnapshotByTimeOffsetTaskInput | 否 | 对视频按时间点截图任务列表。 示例值:NULL |
| SampleSnapshotTaskSet | Array of SampleSnapshotTaskInput | 否 | 对视频采样截图任务列表。 示例值:NULL |
| ImageSpriteTaskSet | Array of ImageSpriteTaskInput | 否 | 对视频截雪碧图任务列表。 示例值:NULL |
| AdaptiveDynamicStreamingTaskSet | Array of AdaptiveDynamicStreamingTaskInput | 否 | 转自适应码流任务列表。 示例值:NULL |
MediaProcessTaskResult
任务查询结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 任务的类型,可以取的值有: 示例值:Transcode |
| TranscodeTask | MediaProcessTaskTranscodeResult | 视频转码任务的查询结果,当任务类型为 Transcode 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| AnimatedGraphicTask | MediaProcessTaskAnimatedGraphicResult | 视频转动图任务的查询结果,当任务类型为 AnimatedGraphics 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| SnapshotByTimeOffsetTask | MediaProcessTaskSnapshotByTimeOffsetResult | 对视频按时间点截图任务的查询结果,当任务类型为 SnapshotByTimeOffset 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| SampleSnapshotTask | MediaProcessTaskSampleSnapshotResult | 对视频采样截图任务的查询结果,当任务类型为 SampleSnapshot 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| ImageSpriteTask | MediaProcessTaskImageSpriteResult | 对视频截雪碧图任务的查询结果,当任务类型为 ImageSprite 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| AdaptiveDynamicStreamingTask | MediaProcessTaskAdaptiveDynamicStreamingResult | 转自适应码流任务查询结果,当任务类型为 AdaptiveDynamicStreaming 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
MediaProcessTaskSampleSnapshotResult
对视频做采样截图任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | SampleSnapshotTaskInput | 对视频做采样截图任务输入。 |
| Output | MediaSampleSnapshotItem | 对视频做采样截图任务输出。 注意:此字段可能返回 null,表示取不到有效值。 |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:28Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:46Z |
MediaProcessTaskSnapshotByTimeOffsetResult
对视频按指定时间点截图任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | SnapshotByTimeOffsetTaskInput | 对视频按指定时间点截图任务输入。 示例值:NULL |
| Output | MediaSnapshotByTimeOffsetItem | 对视频按指定时间点截图任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:28Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:46Z |
MediaProcessTaskTranscodeResult
转码任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | TranscodeTaskInput | 转码任务的输入。 |
| Output | MediaTranscodeItem | 转码任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 |
| Progress | Integer | 转码进度,取值范围 [0-100] 示例值:100 |
MediaSampleSnapshotItem
采样截图信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 采样截图规格 ID,参见采样截图参数模板。 示例值:10 |
| SampleType | String | 采样方式,取值范围: 示例值:Percent |
| Interval | Integer | 采样间隔 示例值:10 |
| Storage | TaskOutputStorage | 截图后文件的存储位置。 示例值:{ "Type": "COS", "CosOutputStorage": { "Bucket": "mpstest-12xxxxxx7", "Region": "ap-nanjing"} } |
| ImagePathSet | Array of String | 生成的截图 path 列表。 示例值:["/output/test_sampleByOffset_10_0.jpg"] |
| WaterMarkDefinition | Array of Integer | 截图如果被打上了水印,被打水印的模板 ID 列表。 示例值:100001 |
MediaSnapshotByTimeOffsetItem
点播文件指定时间点截图信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 指定时间点截图规格,参见指定时间点截图参数模板。 示例值:10 |
| PicInfoSet | Array of MediaSnapshotByTimePicInfoItem | 同一规格的截图信息集合,每个元素代表一张截图。 |
| Storage | TaskOutputStorage | 指定时间点截图文件的存储位置。 |
MediaSnapshotByTimePicInfoItem
指定时间点截图信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| TimeOffset | Float | 该张截图对应视频文件中的时间偏移,单位为秒。 示例值:3.5 |
| Path | String | 该张截图的路径。 示例值:/output/689a7xxxxxa/test_snapshotByOffset_23123x_0.jpg |
| WaterMarkDefinition | Array of Integer | 截图如果被打上了水印,被打水印的模板 ID 列表。 示例值:[1011] |
MediaTranscodeItem
转码信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| OutputStorage | TaskOutputStorage | 转码后文件的目标存储。 示例值:null |
| Path | String | 转码后的视频文件路径。 示例值:/output/test.mp4 |
| Definition | Integer | 转码规格 ID,参见转码参数模板。 示例值:10 |
| Bitrate | Integer | 视频流码率平均值与音频流码率平均值之和, 单位:bps。 示例值:1000 |
| Height | Integer | 视频流高度的最大值,单位:px。 示例值:1080 |
| Width | Integer | 视频流宽度的最大值,单位:px。 示例值:1920 |
| Size | Integer | 媒体文件总大小(视频为 HLS 时,大小是 m3u8 和 ts 文件大小的总和),单位:字节。 示例值:20000 |
| Duration | Float | 视频时长,单位:秒。 示例值:15 |
| Container | String | 容器类型,例如 m4a,mp4 等。 示例值:mp4 |
| Md5 | String | 视频的 md5 值。 示例值:"xxxx" |
| AudioStreamSet | Array of MediaAudioStreamItem | 音频流信息。 |
| VideoStreamSet | Array of MediaVideoStreamItem | 视频流信息。 |
| CallBackExtInfo | String | 视频转码使用增强项说明,增强项解释 注意:此字段可能返回 null,表示取不到有效值。 示例值:"{"enhance_item":["hdr","color_enhance"]}" |
MediaVideoStreamItem
点播文件视频流信息
被如下接口引用:DescribeBatchTaskDetail, DescribeMediaMetaData, DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Bitrate | Integer | 视频流的码率,单位:bps。 示例值:100000 |
| Height | Integer | 视频流的高度,单位:px。 示例值:1920 |
| Width | Integer | 视频流的宽度,单位:px。 示例值:1080 |
| Codec | String | 视频流的编码格式,例如 h264。 示例值:h264 |
| Fps | Integer | 帧率,单位:hz。 示例值:30 |
| ColorPrimaries | String | 色彩空间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:bt470bg |
| ColorSpace | String | 色彩空间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:gbr |
| ColorTransfer | String | 色彩空间。 注意:此字段可能返回 null,表示取不到有效值。 示例值:bt709 |
| HdrType | String | HDR类型。 注意:此字段可能返回 null,表示取不到有效值。 示例值:sdr |
| Codecs | String | 视频Codecs。 注意:此字段可能返回 null,表示取不到有效值。 示例值:avc1.ffe100 |
| FpsNumerator | Integer | 帧率分子部分 注意:此字段可能返回 null,表示取不到有效值。 示例值:30 |
| FpsDenominator | Integer | 帧率分母部分 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
ModifyInput
修改输入信息的参数。
被如下接口引用:ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InputId | String | 是 | 输入Id。 示例值:InputId |
| InputName | String | 是 | 输入名称。 示例值:InputName |
| Description | String | 是 | 输入描述。 示例值:Description |
| AllowIpList | Array of String | 是 | 允许的推流的IP,CIDR格式。 示例值:["0.0.0.0/0"] |
| SRTSettings | CreateInputSRTSettings | 是 | SRT的配置信息。 |
| RTPSettings | CreateInputRTPSettings | 是 | RTP的配置信息。 |
| Protocol | String | 否 | 输入的协议,可选[SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST]。 - 示例值:SRT |
| FailOver | String | 否 | 输入的主备开关,可选[OPEN|CLOSE]。 示例值:CLOSE |
| RTMPPullSettings | CreateInputRTMPPullSettings | 否 | RTMP_PULL的配置信息。 |
| RTSPPullSettings | CreateInputRTSPPullSettings | 否 | RTSP_PULL的配置信息。 |
| HLSPullSettings | CreateInputHLSPullSettings | 否 | HLS_PULL的配置信息。 |
| ResilientStream | ResilientStreamConf | 否 | 延播平滑吐流配置信息。 |
| SecurityGroupIds | Array of String | 否 | 绑定的输入安全组 ID。 仅支持关联一组安全组。 示例值:["019631fd7ab41ea506497cedffg"] |
| Zones | Array of String | 否 | 可用区,非必填,最多支持输入两个可用区,对于需改接口,只要第二个可用区会参与到资源分配。如果input开启容灾或者涉及RTSP_PULL协议切换时有效(会重新分配地址)。 示例值:["ap-shanghai-1"] |
| RISTSettings | CreateInputRISTSettings | 否 | RIST的配置信息。 |
| InputRegion | String | 否 | 输入节点的地区 示例值:ap-shanghai |
| FailOverOption | FailOverOption | 否 | 冷热备相关 |
ModifyOutputInfo
修改Output配置。
被如下接口引用:ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| OutputId | String | 是 | 需要修改的Output的Id。 示例值:019202e96d9f09dc0f325e7f7a2a |
| OutputName | String | 是 | 输出的名称。 示例值:OutputName |
| Description | String | 是 | 输出的描述。 示例值:Description |
| Protocol | String | 是 | 输出的转推协议,支持SRT|RTP|RTMP|RTMP_PULL|RTSP_PULL|RIST。 示例值:SRT |
| OutputKind | String | 否 | 输出模块类型,包括Pinpoint(单点输出,最多支持四路并发输出);MultiMesh(多路输出,支持大于四路的并发输出,目前可以达到200路)。默认类型为 Pinpoint 输出。对于单个 Flow 一个区域最多只能有一个 MultiMesh 输出。 示例值:Pinpoint |
| SRTSettings | CreateOutputSRTSettings | 否 | 转推SRT的配置。 |
| RTPSettings | CreateOutputInfoRTPSettings | 否 | 转推RTP的配置。 |
| RTMPSettings | CreateOutputRTMPSettings | 否 | 转推RTMP的配置。 |
| AllowIpList | Array of String | 否 | IP白名单列表,格式为CIDR,如0.0.0.0/0。 当Protocol为RTMP_PULL有效,为空代表不限制客户端IP。 示例值:["0.0.0.0/0"] |
| MaxConcurrent | Integer | 否 | 最大拉流并发数,最大4,默认4。 示例值:1 |
| SecurityGroupIds | Array of String | 否 | 绑定的安全组 ID。 仅支持关联一组安全组。 示例值:["035hk1fd7ab41ea5064bb9"] |
| Zones | Array of String | 否 | 可用区 示例值:["ap-shanghai-1"] |
| RISTSettings | CreateOutputRistSettings | 否 | 转推RIST的配置。 |
| OutputType | String | 否 | 输出类型:Internet/TencentCSS/StreamLive 示例值:TencentCSS |
| StreamSelector | StreamSelector | 否 | 对于含有多个音/视频轨的流,可以指定需要使用的轨道 |
MosaicInput
媒体处理任务中的马赛克参数类型
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CoordinateOrigin | String | 否 | 原点位置,目前仅支持: 默认值:TopLeft。 示例值:NULL |
| XPos | String | 否 | 马赛克原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式: 默认值:0px。 示例值:NULL |
| YPos | String | 否 | 马赛克原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式: 默认值:0px。 示例值:NULL |
| Width | String | 否 | 马赛克的宽度。支持 %、px 两种格式: 默认值:10%。 示例值:NULL |
| Height | String | 否 | 马赛克的高度。支持 %、px 两种格式: 默认值:10%。 示例值:NULL |
| StartTimeOffset | Float | 否 | 马赛克的起始时间偏移,单位:秒。不填或填0,表示马赛克从画面出现时开始显现。 示例值:NULL |
| EndTimeOffset | Float | 否 | 马赛克的结束时间偏移,单位:秒。 示例值:NULL |
NumberFormat
输出文件名的{number}变量的规则。
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| InitialValue | Integer | 否 | {number}变量的起始值,默认为0。示例值:0 |
| Increment | Integer | 否 | {number}变量的增长步长,默认为1。示例值:1 |
| MinLength | Integer | 否 | {number}变量的最小长度,不足时补占位符。默认为1。示例值:1 |
| PlaceHolder | String | 否 | {number}变量的长度不足时,补充的占位符。默认为"0"。示例值:0 |
OcrFullTextConfigureInfo
文本全文本识别任务控制参数
被如下接口引用:CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 文本全文识别任务开关,可选值: 示例值:ON |
OcrFullTextConfigureInfoForUpdate
文本全文本识别任务控制参数
被如下接口引用:ModifyAIRecognitionTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 文本全文识别任务开关,可选值: 示例值:ON |
OcrWordsConfigureInfo
文本关键词识别控制参数。
被如下接口引用:CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 文本关键词识别任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["腾讯云"] |
OcrWordsConfigureInfoForUpdate
文本关键词识别控制参数。
被如下接口引用:ModifyAIRecognitionTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 文本关键词识别任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["腾讯云"] |
OutputAddress
输出的出口的地址。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Ip | String | 出口IP。 示例值:ip |
OutputRISTSourceAddressResp
RIST输出的监听地址。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Ip | String | 监听IP。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.1.1.1 |
| Port | Integer | 监听端口。 注意:此字段可能返回 null,表示取不到有效值。 示例值:65535 |
OutputSRTSourceAddressResp
SRT输出的监听地址。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 是 | 监听IP。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.1.1.1 |
| Port | Integer | 是 | 监听端口。 注意:此字段可能返回 null,表示取不到有效值。 示例值:65535 |
OverrideEraseParameter
智能擦除自定义参数
被如下接口引用:ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EraseType | String | 否 | 擦除类型 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护 示例值:subtitle |
| EraseSubtitleConfig | UpdateSmartEraseSubtitleConfig | 否 | 字幕擦除配置; 当EraseType值为:subtitle,此字段为必填参数 |
| EraseWatermarkConfig | UpdateSmartEraseWatermarkConfig | 否 | 水印擦除配置; 当EraseType值为:watermark,此字段为必填参数 |
| ErasePrivacyConfig | UpdateSmartErasePrivacyConfig | 否 | 隐私保护配置; 当EraseType值为:privacy,此字段为必填参数 |
OverrideTranscodeParameter
自定义转码的规格参数。用于覆盖模板中对应参数值。
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Container | String | 否 | 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a。其中,mp3、flac、ogg、m4a 为纯音频文件。 示例值:mp4 |
| RemoveVideo | Integer | 否 | 是否去除视频数据,取值: 示例值:0 |
| RemoveAudio | Integer | 否 | 是否去除音频数据,取值: 示例值:0 |
| VideoTemplate | VideoTemplateInfoForUpdate | 否 | 视频流配置参数。 |
| AudioTemplate | AudioTemplateInfoForUpdate | 否 | 音频流配置参数。 |
| TEHDConfig | TEHDConfigForUpdate | 否 | 极速高清转码参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| SubtitleTemplate | SubtitleTemplate | 否 | 字幕流配置参数。 |
| AddonAudioStream | Array of MediaInputInfo | 否 | 外挂音轨参数。 |
| StdExtInfo | String | 否 | 转码扩展字段。 示例值:{"audio_info": {"codec": "vivid"}} |
| AddOnSubtitles | Array of AddOnSubtitle | 否 | 要插入的字幕文件。 |
PidSelector
对于含有多个音/视频轨的流,可以指定需要使用的轨道
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AudioPID | Array of Integer | 否 | 对于含有多音轨的流, 可以通过输入PID来指定需要使用的音轨,PID可以输入1到8191之间的正整数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[123,124] |
| VideoPID | Array of Integer | 否 | 对于含有多个视频轨的流,可以通过输入PID来指定需要使用的视频轨,PID可以输入1到8191之间的正整数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[123,124] |
PoliticalAsrReviewTemplateInfo
语音涉敏任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 语音涉敏任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:100 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:75 |
PoliticalAsrReviewTemplateInfoForUpdate
语音涉敏任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 语音涉敏任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:85 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:75 |
PoliticalConfigureInfo
涉敏任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImgReviewInfo | PoliticalImgReviewTemplateInfo | 否 | 画面涉敏控制参数。 |
| AsrReviewInfo | PoliticalAsrReviewTemplateInfo | 否 | 语音涉敏控制参数。 |
| OcrReviewInfo | PoliticalOcrReviewTemplateInfo | 否 | 文本涉敏控制参数。 |
PoliticalConfigureInfoForUpdate
涉敏任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImgReviewInfo | PoliticalImgReviewTemplateInfoForUpdate | 否 | 画面涉敏控制参数。 示例值:NULL |
| AsrReviewInfo | PoliticalAsrReviewTemplateInfoForUpdate | 否 | 语音涉敏控制参数。 示例值:NULL |
| OcrReviewInfo | PoliticalOcrReviewTemplateInfoForUpdate | 否 | 文本涉敏控制参数。 示例值:NULL |
PoliticalImgReviewTemplateInfo
画面涉敏任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 画面涉敏任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 画面涉敏过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为: 示例值:violation_photo |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 97 分。取值范围:0~100。 示例值:97 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 95 分。取值范围:0~100。 示例值:95 |
PoliticalImgReviewTemplateInfoForUpdate
画面涉敏任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 画面涉敏任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 画面涉敏过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为: 示例值:violation_photo |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:0 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:0 |
PoliticalOcrReviewTemplateInfo
文本涉敏任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 文本涉敏任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:0 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:0 |
PoliticalOcrReviewTemplateInfoForUpdate
文本涉敏任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 文本涉敏任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:0 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:0 |
PornAsrReviewTemplateInfo
语音鉴黄任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 语音鉴黄任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:80 |
PornAsrReviewTemplateInfoForUpdate
语音鉴黄任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 语音鉴黄任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:80 |
PornConfigureInfo
鉴黄任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImgReviewInfo | PornImgReviewTemplateInfo | 否 | 画面鉴黄控制参数。 |
| AsrReviewInfo | PornAsrReviewTemplateInfo | 否 | 语音鉴黄控制参数。 |
| OcrReviewInfo | PornOcrReviewTemplateInfo | 否 | 文本鉴黄控制参数。 |
PornConfigureInfoForUpdate
鉴黄任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImgReviewInfo | PornImgReviewTemplateInfoForUpdate | 否 | 画面鉴黄控制参数。 |
| AsrReviewInfo | PornAsrReviewTemplateInfoForUpdate | 否 | 语音鉴黄控制参数。 |
| OcrReviewInfo | PornOcrReviewTemplateInfoForUpdate | 否 | 文本鉴黄控制参数。 |
PornImgReviewTemplateInfo
画面鉴黄任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 画面鉴黄任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 画面鉴黄过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为: 示例值:["porn","sexy"] |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 90 分。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 0 分。取值范围:0~100。 示例值:80 |
PornImgReviewTemplateInfoForUpdate
画面鉴黄任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 画面鉴黄任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 画面鉴黄过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为: 示例值:["porn","sexy"] |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:80 |
PornOcrReviewTemplateInfo
文本鉴黄任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 文本鉴黄任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:80 |
PornOcrReviewTemplateInfoForUpdate
文本鉴黄任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 文本鉴黄任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:80 |
ProhibitedAsrReviewTemplateInfo
语音违禁任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 语音违禁任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:80 |
ProhibitedAsrReviewTemplateInfoForUpdate
语音违禁任务控制参数
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 语音违禁任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:80 |
ProhibitedConfigureInfo
违禁任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AsrReviewInfo | ProhibitedAsrReviewTemplateInfo | 否 | 语音违禁控制参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| OcrReviewInfo | ProhibitedOcrReviewTemplateInfo | 否 | 文本违禁控制参数。 注意:此字段可能返回 null,表示取不到有效值。 |
ProhibitedConfigureInfoForUpdate
违禁任务控制参数
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| AsrReviewInfo | ProhibitedAsrReviewTemplateInfoForUpdate | 否 | 语音违禁控制参数。 |
| OcrReviewInfo | ProhibitedOcrReviewTemplateInfoForUpdate | 否 | 文本违禁控制参数。 |
ProhibitedOcrReviewTemplateInfo
文本违禁任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 文本违禁任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:80 |
ProhibitedOcrReviewTemplateInfoForUpdate
文本违禁任务控制参数
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 文本违禁任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:60 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:80 |
QualityControlData
媒体质检结果输出。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| NoAudio | Boolean | 为true时表示视频无音频轨。 示例值:true |
| NoVideo | Boolean | 为true时表示视频无视频轨。 示例值:true |
| QualityEvaluationScore | Integer | 视频无参考质量评分,百分制。 示例值:95 |
| QualityEvaluationMeanOpinionScore | Float | 视频无参考质量评分,MOS分数。 示例值:4.75 |
| QualityControlResultSet | Array of QualityControlResult | 内容质检检出异常项。 |
| ContainerDiagnoseResultSet | Array of ContainerDiagnoseResultItem | 格式诊断检出异常项。 |
QualityControlItem
质检结果项
被如下接口引用:ParseLiveStreamProcessNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Integer | 置信度,取值范围是 0 到 100。 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
| StartTimeOffset | Float | 出现的起始时间戳,秒。 示例值:12.31 |
| EndTimeOffset | Float | 出现的结束时间戳,秒。 示例值:15.72 |
| AreaCoordSet | Array of Integer | 区域坐标(px),即左上角坐标、右下角坐标。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[1324,140,1412,233] |
QualityControlItemConfig
质检项配置
被如下接口引用:CreateQualityControlTemplate, DescribeQualityControlTemplates, ModifyQualityControlTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 质检项名称。质检项取值如下: 示例值:Mosaic |
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ON |
| Sampling | String | 否 | 采样方式,取值范围: - Time:根据时间间隔采样。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Time |
| IntervalTime | Integer | 否 | 采样间隔时间,单位:ms。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
| Duration | Integer | 否 | 异常持续时间,单位:ms。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1000 |
| Threshold | String | 否 | 检测项对应的阈值,不同检测项对应阈值不同。 注意:此字段可能返回 null,表示取不到有效值。 示例值:80 |
QualityControlResult
质检异常项。
被如下接口引用:DescribeTaskDetail, ParseLiveStreamProcessNotification, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 异常类型,取值范围: Jitter:抖动, Blur:模糊, LowLighting:低光照, HighLighting:过曝, CrashScreen:花屏, BlackWhiteEdge:黑白边, SolidColorScreen:纯色屏, Noise:噪点, Mosaic:马赛克, QRCode:二维码, AppletCode:小程序码, BarCode:条形码, LowVoice:低音, HighVoice:爆音, NoVoice:静音, LowEvaluation:视频无参考评分(MOS)低于阈值, AudioEvaluation:音频无参考评分(MOS)低于阈值, AudioNoise:音频噪声。 示例值:Jitter |
| QualityControlItems | Array of QualityControlItem | 质检结果项。 |
QualityControlStrategy
媒体质检检测策略。
被如下接口引用:CreateQualityControlTemplate, DescribeQualityControlTemplates, ModifyQualityControlTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| StrategyType | String | 否 | 策略类型。取值: - TimeSpotCheck 示例值:TimeSpotCheck |
| TimeSpotCheck | TimeSpotCheck | 否 | 根据时间的抽检策略。 |
QualityControlTemplate
媒体质检模板详情
被如下接口引用:DescribeQualityControlTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 媒体质检模板唯一标识。 示例值:10 |
| Name | String | 媒体质检模板名称。 注意:此字段可能返回 null,表示取不到有效值。 示例值:test |
| Comment | String | 模板描述信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:my test media quality control template |
| Type | String | 模板类型,取值: 注意:此字段可能返回 null,表示取不到有效值。 示例值:Custom |
| QualityControlItemSet | Array of QualityControlItemConfig | 媒体质检配置参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2021-02-03T04:05:06Z |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2022-02-03T04:05:06Z |
| Strategy | QualityControlStrategy | 媒体质检的抽检策略。 示例值: { "StrategyType": "TimeSpotCheck", "TimeSpotCheck": { "CheckDuration": 50, "CheckInterval": 10, "SkipDuration": 10, "CirclesNumber": 10 } } |
RTMPAddressDestination
RTMP转推的目标地址信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Url | String | 转推RTMP的目标Url,格式如'rtmp://domain/live'。 示例值:url |
| StreamKey | String | 转推RTMP的目标StreamKey,格式如'steamid?key=value'。 示例值:streamkey |
RTMPPullSourceAddress
创建的输入RTMP拉流源站配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TcUrl | String | 是 | RTMP源站的TcUrl地址。 示例值:rtmp://domain/live |
| StreamKey | String | 是 | RTMP源站的StreamKey信息。 示例值:streamKey |
RTPAddressDestination
转推的RTP目标地址信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Ip | String | 转推的目标地址的IP。 示例值:ip |
| Port | Integer | 转推的目标地址的端口。 示例值:port |
RTSPPullSourceAddress
创建的输入RTSP拉流源站配置信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Url | String | 是 | RTSP源站的Url地址。 示例值:rtsp://9.223.70.41:8806/live/streamname |
RawImageWatermarkInput
图片水印模板输入参数
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImageContent | MediaInputInfo | 是 | 水印图片的输入内容。支持 jpeg、png 图片格式。 示例值:{} |
| Width | String | 否 | 水印的宽度。支持 %、px 两种格式: 默认值:10%。 示例值:10% |
| Height | String | 否 | 水印的高度。支持 %、px 两种格式: 默认值:0px,表示 Height 按照原始水印图片的宽高比缩放。 示例值:10% |
| RepeatType | String | 否 | 水印重复类型。使用场景:水印为动态图像。取值范围: 示例值:repeat |
RawSmartEraseParameter
智能擦除自定义参数
被如下接口引用:ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| EraseType | String | 是 | 擦除类型 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护 示例值:subtitle |
| EraseSubtitleConfig | SmartEraseSubtitleConfig | 否 | 字幕擦除配置; 当EraseType值为:subtitle,此字段为必填参数 注意:此字段可能返回 null,表示取不到有效值。 |
| EraseWatermarkConfig | SmartEraseWatermarkConfig | 否 | 水印擦除配置; 当EraseType值为:watermark,此字段为必填参数 注意:此字段可能返回 null,表示取不到有效值。 |
| ErasePrivacyConfig | SmartErasePrivacyConfig | 否 | 隐私保护配置; 当EraseType值为:privacy,此字段为必填参数 注意:此字段可能返回 null,表示取不到有效值。 |
RawSmartSubtitleParameter
自定义智能字幕参数
被如下接口引用:BatchProcessMedia, DescribeBatchTaskDetail, ParseNotification, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SubtitleType | Integer | 是 | 智能字幕字幕语言类型 0: 源语言 1: 翻译语言 2: 源语言+翻译语言 当TranslateSwitch为OFF时仅支持取0 当TranslateSwitch为ON时仅支持取1或2 示例值:0 |
| VideoSrcLanguage | String | 是 | 智能字幕视频源语言 当前支持以下语言: zh:简体中文 en:英语 ja:日语 ko:韩语 zh-PY:中英粤 zh-medical:中文医疗 yue:中文粤语 vi:越南语 ms:马来语 id:印度尼西亚语 fil:菲律宾语 th:泰语 pt:葡萄牙语 tr:土耳其语 ar:阿拉伯语 es:西班牙语 hi:印地语 fr:法语 de:德语 zh_dialect:中文方言 zh_en: 中英 prime_zh: 中英方言 示例值:zh |
| SubtitleFormat | String | 否 | 智能字幕文件格式 vtt: WebVTT 格式 srt: SRT格式 不填或填空:不生成字幕文件 注意:此字段可能返回 null,表示取不到有效值。 示例值:vtt |
| TranslateSwitch | String | 否 | 字幕翻译开关 ON: 开启翻译 OFF: 关闭翻译 注意:此字段可能返回 null,表示取不到有效值。 示例值:OFF |
| TranslateDstLanguage | String | 否 | 字幕翻译目标语言 当TranslateSwitch为ON的时候生效 当前支持以下语言: zh:简体中文 en:英语 ja:日语 ko:韩语 fr:法语 es:西班牙语 it:意大利语 de:德语 tr:土耳其语 ru:俄语 pt:葡萄牙语 vi:越南语 id:印度尼西亚语 ms:马来语 th:泰语 ar:阿拉伯语 hi:印地语 注意:此字段可能返回 null,表示取不到有效值。 示例值:en |
| AsrHotWordsConfigure | AsrHotWordsConfigure | 否 | ASR热词库参数 注意:此字段可能返回 null,表示取不到有效值。 |
| ExtInfo | String | 否 | 自定义参数 示例值:"{}" |
RawTranscodeParameter
自定义转码的规格参数。
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Container | String | 是 | 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a。其中,mp3、flac、ogg、m4a 为纯音频文件。 示例值:mp4 |
| RemoveVideo | Integer | 否 | 是否去除视频数据,取值: 默认值:0。 示例值:0 |
| RemoveAudio | Integer | 否 | 是否去除音频数据,取值: 默认值:0。 示例值:0 |
| VideoTemplate | VideoTemplateInfo | 否 | 视频流配置参数,当 RemoveVideo 为 0,该字段必填。 |
| AudioTemplate | AudioTemplateInfo | 否 | 音频流配置参数,当 RemoveAudio 为 0,该字段必填。 |
| TEHDConfig | TEHDConfig | 否 | 极速高清转码参数。 |
| StdExtInfo | String | 否 | 扩展参数,序列化的 json 字符串。 示例值:{"video_info":{"color_prim":"bt709"}} |
| EnhanceConfig | EnhanceConfig | 否 | 音视频增强配置 注意:此字段可能返回 null,表示取不到有效值。 |
| SubtitleTemplate | SubtitleTemplate | 否 | 字幕参数 注意:此字段可能返回 null,表示取不到有效值。 |
RawWatermarkParameter
自定义水印规格参数。
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 水印类型,可选值: 示例值:image |
| CoordinateOrigin | String | 否 | 原点位置,可选值: 默认值:TopLeft。 示例值:TopLeft |
| XPos | String | 否 | 水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式: 默认值:0px。 示例值:100px |
| YPos | String | 否 | 水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式: 默认值:0px。 示例值:80px |
| ImageTemplate | RawImageWatermarkInput | 否 | 图片水印模板,当 Type 为 image,该字段必填。当 Type 为 text,该字段无效。 示例值:{ "ImageContent": { "Type": "URL", "UrlInputInfo": { "Url": "https://xxxxx.cos.ap-nanjing.myqcloud.com/test.jpeg" } } } |
RegionInfo
地区信息。
被如下接口引用:DescribeStreamLinkRegions。
| 名称 | 类型 | 描述 |
|---|---|---|
| Name | String | 地区名称。 示例值:ap-shanghai |
RemoveBlindWatermarkConfig
移除盲水印配置
被如下接口引用:ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 注意:此字段可能返回 null,表示取不到有效值。 示例值:ON |
ResilientStreamConf
延播平滑吐流配置。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Enable | Boolean | 否 | 是否开启延播平滑吐流,true开启,false不开启,默认不开启。 注意:此字段可能返回 null,表示取不到有效值。 示例值:true |
| BufferTime | Integer | 否 | 延播时间,单位秒,目前支持的范围为10~300秒。 注意:此字段可能返回 null,表示取不到有效值。 示例值:133 |
RuleConditionItem
规则条件配置。
被如下接口引用:CreateSchedule, ModifySchedule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Key | String | 否 | 质检项条件对应的Key。 示例值:Resolution-1 |
| Value | String | 否 | 条件对应的Value。 示例值:720 |
Rules
任务判断条件
被如下接口引用:CreateSchedule, ModifySchedule。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Id | String | 否 | 判断条件id 注意:此字段可能返回 null,表示取不到有效值。 示例值:rule1-or-result-true |
| Conditions | Array of RuleConditionItem | 否 | 判断条件配置 注意:此字段可能返回 null,表示取不到有效值。 |
| Linker | String | 否 | 条件列表的链接符号,取值如下: - &&:逻辑与 - ||:逻辑或 示例值:"&&" |
| RearDriveIndexs | Array of Integer | 否 | 满足判断条件执行节点索引; 注意:此字段可能返回 null,表示取不到有效值。 示例值:[3,4] |
S3InputInfo
AWS S3存储输入
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateVideoDatabaseEntryTask, DescribeBatchTaskDetail, DescribeMediaMetaData, ParseNotification, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| S3Bucket | String | 是 | S3 bucket。 注意:此字段可能返回 null,表示取不到有效值。 示例值:mps-us-125678 |
| S3Region | String | 是 | S3 bucket 对应的区域,目前支持: us-east-1 eu-west-3 注意:此字段可能返回 null,表示取不到有效值。 示例值:us-east-1 |
| S3Object | String | 是 | S3 bucket 中的媒体资源路径。 注意:此字段可能返回 null,表示取不到有效值。 示例值:/test.mp4 |
| S3SecretId | String | 否 | AWS 内网访问 媒体资源的秘钥id。 注意:此字段可能返回 null,表示取不到有效值。 示例值:6bb5**eff |
| S3SecretKey | String | 否 | AWS 内网访问 媒体资源的秘钥key。 注意:此字段可能返回 null,表示取不到有效值。 示例值:6bbc5**eff |
S3OutputStorage
AWS S3 输出位置
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSchedule, CreateWorkflow, EditMedia, ModifySchedule, ProcessImage, ProcessLiveStream, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| S3Bucket | String | 是 | S3 bucket。 注意:此字段可能返回 null,表示取不到有效值。 示例值:mps-test |
| S3Region | String | 是 | S3 bucket 对应的区域。 注意:此字段可能返回 null,表示取不到有效值。 示例值:us-east-1 |
| S3SecretId | String | 否 | AWS 内网上传 媒体资源的秘钥id。 注意:此字段可能返回 null,表示取不到有效值。 示例值:AKI**5W |
| S3SecretKey | String | 否 | AWS 内网上传 媒体资源的秘钥key。 注意:此字段可能返回 null,表示取不到有效值。 示例值:d6abvc123****ABCS |
SRTAddressDestination
转推的目标地址信息。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Ip | String | 目标地址的IP。 示例值:ip |
| Port | Integer | 目标地址的端口。 示例值:port |
SRTFECFullOptions
SRT FEC 高级配置
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Enable | Boolean | 否 | 是否开启 FEC 示例值:true |
| Cols | Integer | 否 | FEC 数据包 Layout 列数量. 取值范围>0 示例值:3 |
| Rows | Integer | 否 | FEC 数据包 Layout 行数量. 取值范围 >=2 或者 <=-2 示例值:1 |
| ARQ | String | 否 | FEC 开启的情况下,ARQ的策略。取值 "always", "onreq", "never" 示例值:always |
| Layout | String | 否 | FEC 数据包 Layout 组织形式,取值 "even", "staircase" 示例值:staircase |
SRTFECSimpleOptions
SRT FEC 设置
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Enable | Boolean | 否 | 是否开启 FEC 示例值:false |
SRTSourceAddressReq
SRT输入源地址。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 是 | 对端IP或域名。 示例值:1.1.1.1 |
| Port | Integer | 是 | 对端端口。 示例值:65535 |
SRTSourceAddressResp
SRT输入源地址。
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Ip | String | 是 | 对端IP。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.1.1.1 |
| Port | Integer | 是 | 对端端口。 注意:此字段可能返回 null,表示取不到有效值。 示例值:65535 |
SampleSnapshotTaskInput
对视频做采样截图任务输入参数类型。
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 采样截图模板 ID。 示例值:10 |
| WatermarkSet | Array of WatermarkInput | 否 | 水印列表,支持多张图片或文字水印,最大可支持 10 张。 |
| OutputStorage | TaskOutputStorage | 否 | 采样截图后文件的目标存储,不填则继承上层的 OutputStorage 值。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputObjectPath | String | 否 | 采样截图后图片文件的输出路径,可以为相对路径或者绝对路径。 若需定义输出路径,路径需以 .{format}结尾。变量名请参考 文件名变量说明。相对路径示例: 绝对路径示例: 如果不填,则默认为相对路径: {inputName}_sampleSnapshot_{definition}_{number}.{format}。示例值:/{inputName}_snapshotByTimeOffsetTest_{definition}_{number}.{format} |
| ObjectNumberFormat | NumberFormat | 否 | 采样截图后输出路径中的{number}变量的规则。注意:此字段可能返回 null,表示取不到有效值。 |
SampleSnapshotTemplate
采样截图模板详情
被如下接口引用:DescribeSampleSnapshotTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 采样截图模板唯一标识。 示例值:10 |
| Type | String | 模板类型,取值范围: 示例值:Custom |
| Name | String | 采样截图模板名称。 示例值:采样截图模板test |
| Comment | String | 模板描述信息。 示例值:采样截图模板test |
| Width | Integer | 截图宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 示例值:400 |
| Height | Integer | 截图高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 示例值:400 |
| ResolutionAdaptive | String | 分辨率自适应,可选值: 默认值:open。 示例值:open |
| Format | String | 图片格式。 示例值:jpg |
| SampleType | String | 采样截图类型。 示例值:Time |
| SampleInterval | Integer | 采样间隔。 示例值:10 |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2024-08-13T04:32:21Z |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2024-08-13T04:32:21Z |
| FillType | String | 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: 默认值:black 。 示例值:black |
ScheduleAnalysisTaskResult
编排视频分析任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值: InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiAnalysisTaskInput | 分析任务的输入。 |
| Output | Array of AiAnalysisResult | 分析任务的输出。 |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:28Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:46Z |
ScheduleExecRuleTaskResult
媒体质检任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值: input |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | ExecRulesTask | 条件判断任务的输入。 |
| Output | ExecRuleTaskData | 条件判断任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 |
ScheduleQualityControlTaskResult
媒体质检任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiQualityControlTaskInput | 媒体质检任务的输入。 |
| Output | QualityControlData | 媒体质检任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 |
ScheduleRecognitionTaskResult
编排视频识别任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值: InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiRecognitionTaskInput | 识别任务的输入。 |
| Output | Array of AiRecognitionResult | 识别任务的输出。 |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:28Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:46Z |
ScheduleReviewTaskResult
编排视频审核任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值: |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | AiContentReviewTaskInput | 审核任务的输入。 示例值:NULL |
| Output | Array of AiContentReviewResult | 审核任务的输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-07-16T06:21:28Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2019-07-16T06:21:46Z |
ScheduleSmartSubtitleTaskResult
编排智能字幕任务结果类型
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:PROCESSING |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:具体错误信息 |
| Input | SmartSubtitlesTaskInput | 识别任务的输入。 |
| Output | Array of SmartSubtitlesResult | 识别任务的输出。 |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:28Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 示例值:2019-07-16T06:21:46Z |
ScheduleTask
编排任务信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 编排任务 ID。 示例值:2xxxxx123-ScheduleTask-1sbhsbhbhactest3a3aacxxx123 |
| Status | String | 任务流状态,取值: 示例值:FAIL |
| ErrCode | Integer | 源异常时返回非0错误码,返回0 时请使用各个具体任务的 ErrCode。 示例值:70000 |
| Message | String | 源异常时返回对应异常Message,否则请使用各个具体任务的 Message。 示例值:source file err |
| InputInfo | MediaInputInfo | 媒体处理的目标文件信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| MetaData | MediaMetaData | 原始视频的元信息。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| ActivityResultSet | Array of ActivityResult | 编排任务输出。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
SchedulesInfo
编排详情。
被如下接口引用:DescribeSchedules。
| 名称 | 类型 | 描述 |
|---|---|---|
| ScheduleId | Integer | 编排唯一标识。 示例值:123 |
| ScheduleName | String | 编排名称。 注意:此字段可能返回 null,表示取不到有效值。 示例值:普通转码编排test |
| Type | String | 编排类型,可选值: 注意:此字段可能返回 null,表示取不到有效值。 示例值:Custom |
| Status | String | 编排状态,取值范围: Enabled:已启用, Disabled:已禁用。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Enabled |
| Trigger | WorkflowTrigger | 编排绑定的触发规则。 注意:此字段可能返回 null,表示取不到有效值。 |
| Activities | Array of Activity | 编排任务列表。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputStorage | TaskOutputStorage | 媒体处理的文件输出存储位置。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputDir | String | 媒体处理生成的文件输出的目标目录。 注意:此字段可能返回 null,表示取不到有效值。 示例值:/output/ |
| TaskNotifyConfig | TaskNotifyConfig | 任务的事件通知配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreateTime | String | 创建时间,使用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-03-21T18:12:49+08:00 |
| UpdateTime | String | 最后编辑时间,使用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2024-03-21T18:12:49+08:00 |
| ResourceId | String | 资源ID,对于没有关联资源ID的,用账号主资源ID填充。 注意:此字段可能返回 null,表示取不到有效值。 示例值:vts-2xxxxx5-0 |
ScratchRepairConfig
去划痕配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Intensity | Float | 否 | 强度,取值范围:0.0~1.0。 默认:0.0。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.5 |
SearchTaskResult
视频检索的检索结果
被如下接口引用:DescribeVideoSearchTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| Score | Float | 视频在本次检索中的得分,得分越高和检索值越相似,取值范围[0,1] 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.60 |
| VideoId | String | 检索获得的视频ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:caf2c4be****abc |
SearchValueInput
视频检索的检索输入
被如下接口引用:CreateVideoSearchTask。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SearchValueType | String | 是 | 检索输入的类型,目前支持: Text:文本检索 示例值:Text |
| TextInput | String | 否 | 当SearchValueType为Text时有效且必填,用于检索视频的文本 注意:此字段可能返回 null,表示取不到有效值。 示例值:测试文本 |
SecurityGroupInfo
安全组信息。
被如下接口引用:DescribeStreamLinkSecurityGroups。
| 名称 | 类型 | 描述 |
|---|---|---|
| Id | String | 安全组 ID。 示例值:id |
| Name | String | 安全组名称。 示例值:name |
| Whitelist | Array of String | 白名单列表。 示例值:0.0.0.0/0 |
| OccupiedInputs | Array of String | 绑定的输入流列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:["034561fd7ab41ea506497cdecbbc"] |
| Region | String | 安全组地址。 示例值:ap-shanghai |
| OccupiedOutputs | Array of String | 绑定的输出流列表。 注意:此字段可能返回 null,表示取不到有效值。 示例值:["094561fd7ab41ea506497cdfffc"] |
SegmentRecognitionItem
智能拆条片段。
被如下接口引用:DescribeTaskDetail, ParseLiveStreamProcessNotification, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 置信度。 示例值:85.32 |
| StartTimeOffset | Float | 片段起始时间偏移。 示例值:0 |
| EndTimeOffset | Float | 片段结束时间偏移。 示例值:59.52 |
| SegmentUrl | String | 拆条片段URL。 示例值:http://www.example.com/mps/test.mp4 |
| CovImgUrl | String | 拆条片段封面。 示例值:http://www.example.com/mps/test.jpg |
| Title | String | 分段标题。 示例值:上海风云 |
| Summary | String | 分段概要。 示例值:本段描述从鸦片战争到民国时期,上海经历了巨大的变迁 |
| Keywords | Array of String | 分段关键词。 示例值:["明星","歌后"] |
| BeginTime | String | 直播切片对应直播起始时间点,采用 ISO 日期格式。 示例值:2024-10-21T17:18:34+08:00 |
| EndTime | String | 直播切片对应直播结束时间点,采用 ISO 日期格式。 示例值:2024-10-21T17:26:19+08:00 |
| AudioUrl | String | 直播拆条用,音频url。 示例值:http://www.example.com/mps/audio1.mp3 |
| AudioBeginTime | Float | 直播拆条用,音频对应起始时间戳; 示例值:3.438 |
| AudioEndTime | Float | 直播拆条用,音频对应结束时间戳。 示例值:7.438 |
| PersonPositionUrl | String | 直播拆条用,人物位置参考信息用于横转竖。 示例值:http://test-12345**9.test.ap-beijing.myqcloud.com/streamtmp/40_xx12345.json |
| PersonId | String | 指定人物ID。 示例值:party_xxxxxx |
SegmentSpecificInfo
切片特殊配置信息。
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 启动分片时长开关,可选值: on:打开 off:关闭 默认off 注意:此字段可能返回 null,表示取不到有效值。 示例值:off |
| FragmentTime | Integer | 否 | 启动时分片时长,单位:秒 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| FragmentEndNum | Integer | 否 | 生效分片数,表示前FragmentEndNum个分片以FragmentTime时长切片,取值>=1 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
SharpEnhanceConfig
细节增强配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate, ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Intensity | Float | 否 | 强度,取值范围:0.0~1.0。 默认:0.0。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
SimpleAesDrm
SimpleAes 加密信息。
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Uri | String | 是 | 请求解密秘钥uri地址。 注意:此字段可能返回 null,表示取不到有效值。 示例值:http://test.qq.com?vid=xxx |
| Key | String | 是 | 加密key(十六进制32字节字符串)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:14367588ab31370e32ae000544bd007d |
| Vector | String | 否 | 加密初始化向量(十六进制32字节字符串)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:452ac1553f19b846e2f2c4cffd8f4a9b |
SmartErasePrivacyConfig
智能擦除模板隐私保护配置
被如下接口引用:CreateSmartEraseTemplate, DescribeSmartEraseTemplates, ModifySmartEraseTemplate, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PrivacyModel | String | 是 | 隐私保护擦除方式。 - blur 模糊 - mosaic 马赛克 示例值:blur |
| PrivacyTargets | Array of String | 是 | 隐私保护目标,(在API Explorer上使用时无需传入数组,添加相应项并填入对应值即可)。 - face 人脸 - plate 车牌 示例值:["face","plate"] |
SmartEraseSubtitleConfig
智能擦除模板去字幕配置
被如下接口引用:CreateSmartEraseTemplate, DescribeSmartEraseTemplates, ModifySmartEraseTemplate, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SubtitleEraseMethod | String | 是 | 字幕擦除方式。 自动擦除:通过AI模型自动识别视频中的字幕文本内容,进行无痕化擦除,生成新的视频。但画面干扰、特殊字幕样式可能会带来一定漏擦误擦问题,可以通过指定区域擦除处理。 当使用自动擦除时,若您不指定AutoAreas,将对默认区域(画面中下部)进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。 指定区域擦除:若您的字幕位置较固定,建议您直接指定擦除区域,最大程度减少漏擦的情况。 当您选择指定区域擦除时,请在CustomAreas中至少传入一个指定区域。 - auto 自动擦除 - custom 指定区域擦除 示例值:auto |
| SubtitleModel | String | 是 | 字幕擦除模型。 标准版(推荐):若您的字幕样式标准,通常建议选择该版本,细节无痕化效果更好。 区域版:若您的字幕存在花体、阴影、动效等特殊样式,建议选择区域版,擦除面积更大,但细节效果不如标准版。 - standard 标准模型 - area 区域模型 示例值:standard |
| OcrSwitch | String | 否 | 是否开启OCR字幕提取,默认取OFF。 当且仅当SubtitleEraseMethod取auto时支持开启OCR字幕提取,开启后将识别自动擦除区域内出现时间最长且最稳定的文字区域为字幕区域,对字幕区域中的文字进行提取和擦除。 - ON 开启 - OFF 关闭 示例值:ON |
| SubtitleLang | String | 否 | 字幕语言,用于指导OCR识别,默认取zh_en;仅当OcrSwitch取"ON"时生效。 - zh_en 中英文 - multi 其他 其他具体支持识别如下语言: 中文、英文、日文、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语、印地语、阿拉伯语、印度-孟加拉语、印度-古吉拉特语、印度-卡纳达语 、印度-马拉亚拉姆语 、印度-泰米尔语、印度-泰卢固语、斯洛文尼亚语、波兰语、加泰罗尼亚语、波斯尼亚语、捷克语、爱沙尼亚语、克罗地亚语、旁遮普语、马拉地语、阿塞拜疆语、印尼语、卢森堡语 、立陶宛语、拉脱维亚语、马耳他语、斯洛伐克语、土耳其语、哈萨克语、希腊语、爱尔兰语、白俄罗斯语、高棉语、他加禄语、普什图语、波斯语、塔吉克斯坦语 示例值:zh_en |
| SubtitleFormat | String | 否 | 字幕文件格式,默认取vtt;仅当OcrSwitch取"ON"时生效。 - srt srt格式 - vtt WebVTT格式 示例值:vtt |
| TransSwitch | String | 否 | 是否开启字幕翻译,默认取OFF;仅当OcrSwitch取"ON"时生效。 - ON 开启 - OFF 关闭 示例值:ON |
| TransDstLang | String | 否 | 字幕翻译目标语言,默认取en;仅当TransSwitch取"ON"时生效。 当前支持以下语言: zh:简体中文 en:英语 ja:日语 ko:韩语 fr:法语 es:西班牙语 it:意大利语 de:德语 tr:土耳其语 ru:俄语 pt:葡萄牙语 vi:越南语 id:印度尼西亚语 ms:马来语 th:泰语 ar:阿拉伯语 hi:印地语 示例值:en |
| AutoAreas | Array of EraseArea | 否 | 自动擦除自定义区域。 对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。 注意:当擦除方式选择custom时,此参数将不会生效;修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。 |
| CustomAreas | Array of EraseTimeArea | 否 | 指定擦除自定义区域。 对选定区域,在选定时间段内不进行检测识别直接进行擦除。 注意:修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。 |
SmartEraseTaskInput
智能擦除任务
被如下接口引用:CreateSchedule, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 否 | 智能擦除模板id。 示例值:101 |
| RawParameter | RawSmartEraseParameter | 否 | 智能擦除自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定智能擦除参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| OverrideParameter | OverrideEraseParameter | 否 | 智能擦除自定义参数,当 Definition 不填 0 时有效。 当填写了该结构中的部分擦除参数时,将使用填写的参数覆盖智能擦除模板中的参数。 该参数用于高度定制场景,建议您仅使用 Definition 指定智能擦除参数。 |
| OutputStorage | TaskOutputStorage | 否 | 文件的目标存储,不填则继承上层的 OutputStorage 值。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputObjectPath | String | 否 | 文件的输出路径,可以为相对路径或者绝对路径。 若需定义输出路径,路径需以 .{format}结尾。变量名请参考 文件名变量说明。相对路径示例: 绝对路径示例: 注意:目前不支持 BatchProcessMedia接口。示例值:{inputName}_smarterase.{format} |
SmartEraseTaskResult
智能擦除任务结果
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| Message | String | 错误信息。 示例值:SUCCESS |
| Input | SmartEraseTaskInput | 智能擦除输入。 注意:此字段可能返回 null,表示取不到有效值。 |
| Output | AiAnalysisTaskDelLogoOutput | 智能擦除任务输出。 注意:此字段可能返回 null,表示取不到有效值。 |
| Progress | Integer | 任务进度。 示例值:100 |
| BeginProcessTime | String | 任务开始执行的时间,采用 ISO 日期格式。 示例值:2024-03-21T10:13:06Z |
| FinishTime | String | 任务执行完毕的时间,采用 ISO 日期格式。 示例值:2024-03-21T10:14:06Z |
SmartEraseTemplateItem
智能擦除模板详情
被如下接口引用:DescribeSmartEraseTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 智能擦除模板唯一标识 示例值:30 |
| Name | String | 智能擦除模板名称 示例值:模板1 |
| Comment | String | 智能擦除模板描述信息 示例值:用于A的模板 |
| Type | String | 模板类型,取值范围: * Preset:系统预置模板; * Custom:用户自定义模板。 示例值:Preset |
| EraseType | String | 擦除类型 - subtitle 去字幕 - watermark 去水印 - privacy 隐私保护 示例值:subtitle |
| EraseSubtitleConfig | SmartEraseSubtitleConfig | 字幕擦除配置 注意:此字段可能返回 null,表示取不到有效值。 |
| EraseWatermarkConfig | SmartEraseWatermarkConfig | 水印擦除配置 注意:此字段可能返回 null,表示取不到有效值。 |
| ErasePrivacyConfig | SmartErasePrivacyConfig | 隐私保护配置 注意:此字段可能返回 null,表示取不到有效值。 |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2023-10-05T14:30:00Z |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2024-10-05T14:32:00Z |
| AliasName | String | 智能擦除预设模板别名 示例值:PresetTemplate1 |
SmartEraseWatermarkConfig
智能擦除模板去水印配置
被如下接口引用:CreateSmartEraseTemplate, DescribeSmartEraseTemplates, ModifySmartEraseTemplate, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WatermarkEraseMethod | String | 是 | 水印擦除方式。 自动擦除:通过A模型自动识别视频中的水印,擦除后生成新的视频。适用于动态水印。 当使用自动擦除时,若您不指定AutoAreas,将对视频全屏进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。 指定区域擦除:针对位置较固定的静态水印,建议您直接指定擦除区域。 当您选择指定区域擦除时,请至少传入一个指定区域。 - auto 自动擦除 - custom 指定区域擦除 示例值:auto |
| WatermarkModel | String | 是 | 水印擦除模型。 基础版:效果一般,性价比高,适合动画或背景较干净的视频。 高级版:效果更好,适合短剧等现实风格视频。 - basic 基础版 - advanced 高级版 示例值:advanced |
| AutoAreas | Array of EraseArea | 否 | 自动擦除自定义区域。 对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。 注意,当擦除方式为custom时,此参数将不会生效。修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。 |
| CustomAreas | Array of EraseTimeArea | 否 | 指定擦除自定义区域。 对选定区域,在选定时间段内不进行检测识别直接进行擦除。 注意:修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。 |
SmartSubtitleTaskAsrFullTextResult
语音全文识别结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:PROCESSING |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:task fail |
| Input | SmartSubtitleTaskResultInput | 语音全文识别任务输入信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| Output | SmartSubtitleTaskAsrFullTextResultOutput | 语音全文识别任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| Progress | Integer | 任务进度。 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
SmartSubtitleTaskAsrFullTextResultOutput
语音全文识别结果。
被如下接口引用:DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| SegmentSet | Array of SmartSubtitleTaskAsrFullTextSegmentItem | 语音全文识别片段列表。 注意:此字段可能返回 null,表示取不到有效值。 |
| SubtitlePath | String | 字幕文件地址。 示例值:http://smart-subtitle-test-12******.cos.ap-shanghai.myqcloud.com/31*******8.vtt |
| OutputStorage | TaskOutputStorage | 字幕文件存储位置。 |
SmartSubtitleTaskAsrFullTextSegmentItem
语音全文识别片段。
被如下接口引用:DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:100.0 |
| StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 示例值:3.204 |
| EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 示例值:7.204 |
| Text | String | 识别文本。 示例值:腾讯云媒体处理 |
| Wordlist | Array of WordResult | 字词时间戳信息。 注意:此字段可能返回 null,表示取不到有效值。 |
SmartSubtitleTaskBatchOutput
智能字幕输出信息
被如下接口引用:DescribeBatchTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Progress | Integer | 任务进度。 示例值:100 |
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| Message | String | 错误信息。 示例值:task fail |
| TransTextTask | SmartSubtitleTaskTransTextResultOutput | 翻译任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| AsrFullTextTask | SmartSubtitleTaskAsrFullTextResultOutput | 语音全文识别任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 |
SmartSubtitleTaskResultInput
智能字幕翻译的输入。
被如下接口引用:DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 智能字幕模板 ID。 示例值:10 |
| RawParameter | RawSmartSubtitleParameter | 智能字幕自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定智能字幕参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:自定义参数 |
SmartSubtitleTaskTransTextResult
翻译结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Status | String | 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 示例值:SUCCESS |
| ErrCodeExt | String | 错误码,空字符串表示成功,其他值表示失败,取值请参考 媒体处理类错误码 列表。 示例值:InvalidInput |
| ErrCode | Integer | 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 示例值:0 |
| Message | String | 错误信息。 示例值:错误信息 |
| Input | SmartSubtitleTaskResultInput | 翻译任务输入信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| Output | SmartSubtitleTaskTransTextResultOutput | 翻译任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| Progress | Integer | 任务进度。 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
SmartSubtitleTaskTransTextResultOutput
翻译结果。
被如下接口引用:DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| SegmentSet | Array of SmartSubtitleTaskTransTextSegmentItem | 翻译片段列表。 注意:此字段可能返回 null,表示取不到有效值。 |
| SubtitlePath | String | 字幕文件地址。 示例值:http://lily-12*****.cos.ap-shanghai.myqcloud.com/310*****.vtt |
| OutputStorage | TaskOutputStorage | 字幕文件存储位置。 |
SmartSubtitleTaskTransTextSegmentItem
翻译片段。
被如下接口引用:DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Confidence | Float | 识别片段置信度。取值:0~100。 示例值:100 |
| StartTimeOffset | Float | 识别片段起始的偏移时间,单位:秒。 示例值:17.45 |
| EndTimeOffset | Float | 识别片段终止的偏移时间,单位:秒。 示例值:29.99 |
| Text | String | 识别文本。 示例值:你好 |
| Trans | String | 翻译文本。 示例值:Hello |
| Wordlist | Array of WordResult | 字词时间戳信息。 注意:此字段可能返回 null,表示取不到有效值。 |
SmartSubtitleTemplateItem
智能字幕模板详情
被如下接口引用:DescribeSmartSubtitleTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 智能字幕模板唯一标识 示例值:30 |
| Name | String | 智能字幕模板名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:模板1 |
| Comment | String | 智能字幕模板描述信息 注意:此字段可能返回 null,表示取不到有效值。 示例值:用于A的模板 |
| Type | String | 模板类型,取值范围: * Preset:系统预置模板; * Custom:用户自定义模板。 注意:此字段可能返回 null,表示取不到有效值。 示例值:Preset |
| AsrHotWordsConfigure | AsrHotWordsConfigure | ASR热词库参数 注意:此字段可能返回 null,表示取不到有效值。 |
| AsrHotWordsLibraryName | String | 模板关联热词库名称 注意:此字段可能返回 null,表示取不到有效值。 示例值:HotwordsName1 |
| VideoSrcLanguage | String | 智能字幕视频源语言 当前支持以下语言: zh:简体中文 en:英语 ja:日语 ko:韩语 zh-PY:中英粤 zh-medical:中文医疗 yue:中文粤语 vi:越南语 ms:马来语 id:印度尼西亚语 fil:菲律宾语 th:泰语 pt:葡萄牙语 tr:土耳其语 ar:阿拉伯语 es:西班牙语 hi:印地语 fr:法语 de:德语 zh_dialect:中文方言 示例值:zh |
| SubtitleFormat | String | 智能字幕文件格式 vtt: WebVTT 格式 不填或填空:不生成字幕文件 注意:此字段可能返回 null,表示取不到有效值。 示例值:vtt |
| SubtitleType | Integer | 智能字幕字幕语言类型 0: 源语言 1: 翻译语言 2: 源语言+翻译语言 当TranslateSwitch为OFF时仅支持取0 当TranslateSwitch为ON时仅支持取1或2 示例值:0 |
| TranslateSwitch | String | 字幕翻译开关 ON: 开启翻译 OFF: 关闭翻译 注意:此字段可能返回 null,表示取不到有效值。 示例值:ON |
| TranslateDstLanguage | String | 字幕翻译目标语言 当TranslateSwitch为ON的时候生效 当前支持以下语言: zh:简体中文 en:英语 ja:日语 ko:韩语 fr:法语 es:西班牙语 it:意大利语 de:德语 tr:土耳其语 ru:俄语 pt:葡萄牙语 vi:越南语 id:印度尼西亚语 ms:马来语 th:泰语 ar:阿拉伯语 hi:印地语 注意:此字段可能返回 null,表示取不到有效值。 示例值:en |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2023-10-05T14:30:00Z |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2024-10-05T14:32:00Z |
| AliasName | String | 智能字幕预设模板别名 注意:此字段可能返回 null,表示取不到有效值。 示例值:PresetTemplate1 |
SmartSubtitlesResult
智能字幕结果。
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Type | String | 任务的类型,取值范围: 示例值:AsrFullTextRecognition |
| AsrFullTextTask | SmartSubtitleTaskAsrFullTextResult | 语音全文识别结果,当 Type 为 AsrFullTextRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| TransTextTask | SmartSubtitleTaskTransTextResult | 翻译结果,当 Type 为 TransTextRecognition 时有效。 注意:此字段可能返回 null,表示取不到有效值。 |
SmartSubtitlesTaskInput
智能字幕输入结构体
被如下接口引用:BatchProcessMedia, CreateSchedule, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 否 | 智能字幕模板 ID 。 示例值:110167 |
| UserExtPara | String | 否 | 用户扩展字段,一般场景不用填。 示例值:用户扩展字段 |
| RawParameter | RawSmartSubtitleParameter | 否 | 智能字幕自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定智能字幕参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputStorage | TaskOutputStorage | 否 | 媒体处理输出文件的目标存储。不填则继承 InputInfo 中的存储位置。 注意:当InputInfo.Type为URL时,该参数是必填项。 注意:此字段可能返回 null,表示取不到有效值。 示例值:{ "Type": "COS", "CosOutputStorage": { "Bucket": "xxxx-yyy", "Region": "region" } } |
| OutputObjectPath | String | 否 | 生成字幕文件的输出路径,可以为相对路径或者绝对路径。 若需定义输出路径,路径需以 .{format}结尾。变量名请参考 文件名变量说明。相对路径示例: - 文件名_{变量名}.{format} - 文件名.{format} 绝对路径示例: - /自定义路径/文件名_{变量名}.{format} 如果不填,则默认为相对路径: {inputName}_smartsubtitle_{definition}.{format}。示例值:/storage/{inputName}_smartsubtitle_{definition}.{format} |
SnapshotByTimeOffsetTaskInput
对视频按指定时间点截图任务输入参数类型
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 指定时间点截图模板 ID。 示例值:11028 |
| ExtTimeOffsetSet | Array of String | 否 | 截图时间点列表,时间点支持 s、% 两种格式: 示例值:["3.5s", "50%"] |
| TimeOffsetSet | Array of Float | 否 | 截图时间点列表,单位为秒。此参数已不再建议使用,建议您使用 ExtTimeOffsetSet 参数。 示例值:[7.5, 10] |
| WatermarkSet | Array of WatermarkInput | 否 | 水印列表,支持多张图片或文字水印,最大可支持 10 张。 |
| OutputStorage | TaskOutputStorage | 否 | 时间点截图后文件的目标存储,不填则继承上层的 OutputStorage 值。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputObjectPath | String | 否 | 时间点截图后图片文件的输出路径,可以为相对路径或者绝对路径。 若需定义输出路径,路径需以 .{format}结尾。变量名请参考 文件名变量说明。相对路径示例: 绝对路径示例: 如果不填,则默认为相对路径: {inputName}_snapshotByTimeOffset_{definition}_{number}.{format}。示例值:/mps/output/{inputName}_test_{definition}.{format} |
| ObjectNumberFormat | NumberFormat | 否 | 时间点截图后输出路径中的{number}变量的规则。注意:此字段可能返回 null,表示取不到有效值。 |
SnapshotByTimeOffsetTemplate
时间点截图模板详情
被如下接口引用:DescribeSnapshotByTimeOffsetTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 时间点截图模板唯一标识。 示例值:239287 |
| Type | String | 模板类型,取值范围: 示例值:Custom |
| Name | String | 时间点截图模板名称。 示例值:时间点截图模板 |
| Comment | String | 模板描述信息。 示例值:时间点截图模板 |
| Width | Integer | 截图宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 示例值:400 |
| Height | Integer | 截图高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 示例值:400 |
| ResolutionAdaptive | String | 分辨率自适应,可选值: 默认值:open。 示例值:open |
| Format | String | 图片格式。 示例值:jpg |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2024-05-07T12:14:58Z |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2024-05-07T12:15:39Z |
| FillType | String | 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: 默认值:black 。 示例值:black |
SpekeDrm
FairPlay,WideVine,PlayReady 等Drm加密方式。
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ResourceId | String | 是 | 资源标记,该字段内容为用户自定义; 支持1-128个字符的数字、字母、下划线(_)、中划线(-)。 示例值:123xx |
| KeyServerUrl | String | 是 | DRM厂商访问地址,该字段内容从DRM厂商获取。 注: 不同DRM厂商对子流的数量限制不一样,如 PallyCon 限制不能超过5条子流,DRMtoday厂商最多仅支持9条子流加密 示例值:https://fe.drmtoday.com/frontend/cpix/v1/xxxxx?ticket=xxxxx |
| Vector | String | 是 | 加密初始化向量(十六进制32字节字符串),该字段内容为用户自定义。 示例值:452ac1553f19b846e2f2c4cffd8f4a9b |
| EncryptionMethod | String | 否 | 加密方式,FairPlay 默认cbcs,PlayReady,Widevine 默认cenc cbcs:PlayReady,Widevine,FairPlay 支持; cenc:PlayReady,Widevine支持; 示例值:cbcs |
| EncryptionPreset | String | 否 | 子流加密规则,默认 preset0 preset0:全部子流使用同一个key加密; preset1:每个子流使用不同的key加密; 示例值:preset0 |
StreamLinkRegionInfo
媒体传输的地区信息。
被如下接口引用:DescribeStreamLinkRegions。
| 名称 | 类型 | 描述 |
|---|---|---|
| Regions | Array of RegionInfo | 媒体直传输的地区信息列表。 |
StreamSelector
选择指定的音轨或者视频输出
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SelectorType | String | 否 | 选择类型: PID | TRACK 示例值:PID |
| PidSelector | PidSelector | 否 | 根据 PID 配置选择器 |
| TrackSelector | TrackSelector | 否 | 根据 Track 配置选择器 |
StreamUrlDetail
描述 URL 的完整信息
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkInput, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 描述 |
|---|---|---|
| Label | String | 会描述运营商信息等 示例值:BGP |
| Url | String | URL 示例值:rtmp://example.com/live/live_channel |
| Type | String | Playback: 拉流播放地址; RelayDestination:转推目的地址;SourceCaptureUrl:回源拉流地址;IngestEndpoint:推流地址 示例值:Playback |
SubtitlePosition
字幕位置信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| CenterY | Integer | 居中位置时Y的坐标值 示例值:970 |
SubtitleTemplate
字幕流配置参数。
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Path | String | 否 | 要压制到视频中的字幕文件地址。 注意:此字段可能返回 null,表示取不到有效值。 示例值:https://test-13xxxx46.cos.ap-nanjing.myqcloud.com/xxxxx/subtitle/1.srt |
| StreamIndex | Integer | 否 | 指定要压制到视频中的字幕轨道,Streamindex的取值从0开始,0表示使用源视频中的第一条字幕轨。如果指定了Path,则优先使用Path。Path 和 StreamIndex 至少指定一个。 - 注意:StreamIndex必须与源文件中的字幕轨索引一致。例如,源文件中的字幕轨为stream#0:3,则StreamIndex应为3,否则可能导致任务处理失败。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SubtitleFileInput | MediaInputInfo | 否 | 要压制到视频中的字幕文件的输入信息,目前仅支持存储在COS的字幕文件 注意:此字段可能返回 null,表示取不到有效值。 |
| FontType | String | 否 | 字体类型,支持: 默认:hei.ttf 黑体。注意:楷体推荐使用kai.ttf 注意:此字段可能返回 null,表示取不到有效值。 示例值:kai.ttf |
| FontSize | String | 否 | 字体大小,格式:Npx,N 为数值,不指定则以字幕文件中为准。 默认源视频高度的5%。 注意:此字段可能返回 null,表示取不到有效值。 示例值:50px |
| FontColor | String | 否 | 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0xFFFFFF |
| FontAlpha | Float | 否 | 文字透明度,取值范围:(0, 1] 默认值:1。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.0 |
| YPos | String | 否 | 字幕y轴坐标位置,指定此参数会忽略字幕文件自带坐标;支持像素和百分比格式: - 像素:Npx,N范围:[0,4096]。 - 百分百:N%,N范围:[0,100];例如10%表示字幕y坐标=10%源视频高度。 默认值:源视频高度4%。 注意:坐标轴原点在源视频中轴线底部,字幕基准点在字幕中轴线底部,参考下图: ![]() 注意:此字段可能返回 null,表示取不到有效值。 示例值:4% |
| BoardY | String | 否 | 字幕背景底板的y轴坐标位置;支持像素和百分比格式: - 像素:Npx,N范围:[0,4096]。 - 百分百:N%,N范围:[0,100];例如10%表示字幕背景底板y坐标=10%*源视频高度。 不传表示不开启字幕背景底板。 注意:坐标轴原点位于源视频的中轴线底部,字幕背景底板的基准点在其中轴线底部,参考下图: ![]() 注意:此字段可能返回 null,表示取不到有效值。 示例值:1% |
| BoardWidth | Integer | 否 | 底板的宽度,单位为像素,取值范围:[0,4096]。 默认源视频宽像素的90%。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1920 |
| BoardHeight | Integer | 否 | 底板的高度。单位为像素,取值范围:[0,4096]。 默认为源视频高像素的15%。 注意:此字段可能返回 null,表示取不到有效值。 示例值:100 |
| BoardColor | String | 否 | 底板颜色。格式:0xRRGGBB, 默认值:0x000000(黑色)。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0x000000 |
| BoardAlpha | Float | 否 | 字幕背景板透明度,取值范围:[0, 1] 默认值:0.8。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.8 |
| OutlineWidth | Float | 否 | 描边宽度 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.0 |
| OutlineColor | String | 否 | 描边颜色。6位16进制RGB 注意:此字段可能返回 null,表示取不到有效值。 示例值:0x000000 |
| OutlineAlpha | Float | 否 | 描边透明度。(0,1] 正浮点数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.8 |
| ShadowWidth | Float | 否 | 阴影宽度。浮点数 [0, 1000] 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.0 |
| ShadowColor | String | 否 | 阴影颜色。6位16进制RGB 注意:此字段可能返回 null,表示取不到有效值。 示例值:0x000000 |
| ShadowAlpha | Float | 否 | 阴影透明度。(0,1] 正浮点数 注意:此字段可能返回 null,表示取不到有效值。 示例值:0.9 |
| LineSpacing | Integer | 否 | 行间距。正整数 [0, 1000] 注意:此字段可能返回 null,表示取不到有效值。 示例值:5 |
| Alignment | String | 否 | 对齐方式,,取值:top: 顶部对齐,字幕顶部按位置固定,底部随行数变化。bottom: 底部对齐,字幕底部按位置固定,顶部随行数变化。 注意:此字段可能返回 null,表示取不到有效值。 示例值:bottom |
SuperResolutionConfig
超分配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate, ProcessImage。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 类型,可选值: 默认值:lq。 注意:此字段可能返回 null,表示取不到有效值。 示例值:lq |
| Size | Integer | 否 | 超分倍数,可选值: 默认值:2。 注意:此字段可能返回 null,表示取不到有效值。 示例值:2 |
SvgWatermarkInput
SVG水印模板输入参数
被如下接口引用:CreateWatermarkTemplate, DescribeWatermarkTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Width | String | 否 | 水印的宽度,支持 px,%,W%,H%,S%,L% 六种格式: Height 不为 0px 时,表示水印的宽度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的宽度取原始 SVG 图像的宽度; 默认值为 10W%。 示例值:10% |
| Height | String | 否 | 水印的高度,支持 px,W%,H%,S%,L% 六种格式: Width 不为 0px 时,表示水印的高度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的高度取原始 SVG 图像的高度; 默认值为 0px。 示例值:0px |
SvgWatermarkInputForUpdate
SVG水印模板输入参数
被如下接口引用:ModifyWatermarkTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Width | String | 否 | 水印的宽度,支持 px,%,W%,H%,S%,L% 六种格式: Height 不为 0px 时,表示水印的宽度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的宽度取原始 SVG 图像的宽度; 默认值为 10W%。 示例值:10% |
| Height | String | 否 | 水印的高度,支持 px,%,W%,H%,S%,L% 六种格式: Width 不为 0px 时,表示水印的高度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的高度取原始 SVG 图像的高度; 默认值为 0px。 示例值:0px |
TEHDConfig
极速高清参数配置。
被如下接口引用:CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 极速高清类型,可选值: 不填代表不启用极速高清。 示例值:TEHD-100 |
| MaxVideoBitrate | Integer | 否 | 视频码率上限,当 Type 指定了极速高清类型时有效。 不填或填0表示不设视频码率上限。 示例值:0 |
TEHDConfigForUpdate
极速高清参数配置。
被如下接口引用:CreateWorkflow, ModifyTranscodeTemplate, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 否 | 极速高清类型,可选值: 不填代表不修改。 注意:此字段可能返回 null,表示取不到有效值。 示例值:TEHD-100 |
| MaxVideoBitrate | Integer | 否 | 视频码率上限,不填代表不修改。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
TagConfigureInfo
智能标签任务控制参数
被如下接口引用:CreateAIAnalysisTemplate, DescribeAIAnalysisTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 智能标签任务开关,可选值: 示例值:ON |
TagConfigureInfoForUpdate
智能标签任务控制参数
被如下接口引用:ModifyAIAnalysisTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 智能标签任务开关,可选值: 示例值:ON |
TaskNotifyConfig
任务的事件通知配置。
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSchedule, CreateVideoDatabaseEntryTask, CreateVideoSearchTask, CreateWorkflow, DescribeBatchTaskDetail, DescribeSchedules, DescribeTaskDetail, DescribeWorkflows, EditMedia, ModifySchedule, ProcessMedia, ResetWorkflow, WithdrawsWatermark。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| NotifyType | String | 否 | 通知类型,可选值: 注:不填或为空时默认 TDMQ-CMQ,如需采用其他类型需填写对应类型值;如果使用TDMQ-CMQ消息队列,任务回包过大可能会写入队列失败 示例值:URL |
| NotifyMode | String | 否 | 工作流通知的模式,可取值有 Finish 和 Change,不填代表 Finish。 示例值:Finish |
| NotifyUrl | String | 否 | HTTP回调地址,NotifyType为URL时必填。 示例值:http://www.qq.com/callback |
| CmqModel | String | 否 | CMQ或TDMQ-CMQ 的模型,有 Queue 和 Topic 两种。 示例值:Queue |
| CmqRegion | String | 否 | CMQ或TDMQ-CMQ 的园区,如 sh,bj 等。 示例值:sh |
| TopicName | String | 否 | 当模型为 Topic 时有效,表示接收事件通知的 CMQ 或 TDMQ-CMQ 的主题名。 示例值:mps_notify |
| QueueName | String | 否 | 当模型为 Queue 时有效,表示接收事件通知的 CMQ 或 TDMQ-CMQ 的队列名。 示例值:mps_que |
| AwsSQS | AwsSQS | 否 | AWS SQS 回调,NotifyType为 AWS-SQS 时必填。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| NotifyKey | String | 否 | 用于生成回调签名的key。 示例值:0se***9idaY |
TaskOutputStorage
媒体处理输出对象信息。
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSchedule, CreateWorkflow, DescribeBatchTaskDetail, DescribeImageTaskDetail, DescribeSchedules, DescribeTaskDetail, DescribeWorkflows, EditMedia, ModifySchedule, ParseNotification, ProcessImage, ProcessLiveStream, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 媒体处理输出对象存储位置的类型,支持: 示例值:NULL |
| CosOutputStorage | CosOutputStorage | 否 | 当 Type 为 COS 时有效,则该项为必填,表示媒体处理 COS 输出位置。 注意:此字段可能返回 null,表示取不到有效值。 |
| S3OutputStorage | S3OutputStorage | 否 | 当 Type 为 AWS-S3 时有效,则该项为必填,表示媒体处理 AWS S3 输出位置。 注意:此字段可能返回 null,表示取不到有效值。 |
| VODOutputStorage | VODOutputStorage | 否 | 当 Type 为 VOD 时有效,则该项为必填,表示媒体处理 点播专业版 输出位置。 注意:此字段可能返回 null,表示取不到有效值。 |
TaskSimpleInfo
任务概要信息
被如下接口引用:DescribeTasks。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 任务 ID。 示例值:24022-WorkflowTask-99f82fb306909 |
| TaskType | String | 任务类型,包含: 示例值:WorkflowTask |
| CreateTime | String | 任务创建时间,使用 ISO 日期格式。 示例值:2024-05-17T08:56:12Z |
| BeginProcessTime | String | 任务开始执行时间,使用 ISO 日期格式。若任务尚未开始,该字段为:0000-00-00T00:00:00Z。 示例值:2024-05-17T08:56:26Z |
| FinishTime | String | 任务结束时间,使用 ISO 日期格式。若任务尚未完成,该字段为:0000-00-00T00:00:00Z。 示例值:2024-05-17T08:56:56Z |
| SubTaskTypes | Array of String | 子任务类型。 示例值:["Transcode", "AiRecognition"] |
TerrorismConfigureInfo
涉敏任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImgReviewInfo | TerrorismImgReviewTemplateInfo | 否 | 画面涉敏任务控制参数。 示例值:NULL |
| OcrReviewInfo | TerrorismOcrReviewTemplateInfo | 否 | 文本涉敏任务控制参数。 示例值:NULL |
TerrorismConfigureInfoForUpdate
涉敏任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| ImgReviewInfo | TerrorismImgReviewTemplateInfoForUpdate | 否 | 画面涉敏任务控制参数。 示例值:NULL |
| OcrReviewInfo | TerrorismOcrReviewTemplateInfoForUpdate | 否 | 文本涉敏任务控制参数。 示例值:NULL |
TerrorismImgReviewTemplateInfo
画面涉敏任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 画面涉敏任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 画面涉敏过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为: 示例值:bloody |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 90 分。取值范围:0~100。 示例值:95 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 80 分。取值范围:0~100。 示例值:80 |
TerrorismImgReviewTemplateInfoForUpdate
画面涉敏任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 画面涉敏任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 画面涉敏过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为: 示例值:guns |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:95 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:80 |
TerrorismOcrReviewTemplateInfo
文本涉敏任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 文本涉敏任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:0 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:0 |
TerrorismOcrReviewTemplateInfoForUpdate
文本涉敏任务控制参数
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 文本涉敏任务开关,可选值: 示例值:ON |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:0 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:0 |
TextWatermarkTemplateInput
文字水印模板
被如下接口引用:CreateWatermarkTemplate, DescribeWatermarkTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FontType | String | 是 | 字体类型,目前可以支持两种: 示例值:arial.ttf |
| FontSize | String | 是 | 字体大小,格式:Npx,N 为数值。N的取值范围:[0,1] 和 [8, 4096] 示例值:10px |
| FontColor | String | 是 | 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。 示例值:0xFFFFFF |
| FontAlpha | Float | 是 | 文字透明度,取值范围:(0, 1] 默认值:1。 示例值:0.5 |
| TextContent | String | 否 | 文字内容,长度不超过100个字符。 注意:此字段可能返回 null,表示取不到有效值。 示例值:mps水印测试 |
TextWatermarkTemplateInputForUpdate
文字水印模板
被如下接口引用:ModifyWatermarkTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FontType | String | 否 | 字体类型,目前可以支持两种: 示例值:simkai.ttf |
| FontSize | String | 否 | 字体大小,格式:Npx,N 为数值。N的取值范围:[0,1] 和 [8, 4096] 示例值:10px |
| FontColor | String | 否 | 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。 示例值:0xFFFFFF |
| FontAlpha | Float | 否 | 文字透明度,取值范围:(0, 1] 示例值:1 |
| TextContent | String | 否 | 文字内容,长度不超过100个字符。 示例值:mps水印测试 |
TimeSpotCheck
媒体质检的检测策略。
被如下接口引用:CreateQualityControlTemplate, ModifyQualityControlTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| CheckDuration | Integer | 否 | 每次循环检测的时长。取值范围(单位s): - 最小值:10 - 最大值:86400 示例值:30 |
| CheckInterval | Integer | 否 | 抽检间隔,表示在一次检测结束后,等待多长时间后,再次检测。取值范围(单位 s): - 最小值:10 - 最大值:3600 示例值:30 |
| SkipDuration | Integer | 否 | 片头跳过时长。取值范围(单位 s): - 最小值:1 - 最大值:1800 示例值:60 |
| CirclesNumber | Integer | 否 | 循环次数。取值范围: - 最小值:0 - 最大值:1000 取值为 0 或为空时,表示循环至视频结束。 示例值:10 |
TrackInfo
音轨信息
被如下接口引用:CreateTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| TrackNum | String | 否 | 音轨和声道数字,说明: 当:SelectType值为track,此值为整数类型,例如:1; 当:SelectType值为track_channel,此值为小数类型,例如:1.0; 默认值:1.0 注意:整数部分代表音轨序号,以小数部分代表声道。音轨序号即为音轨的stream index,支持输入0和正整数。小数部分最多支持2位小数,并且仅支持0-63,但是如果Codec为aac/eac3/ac3时,小数部分仅支持0-15。例如:对于stream index为1的音轨,1.0代表这个音轨的第1个声道,1.1代表这个音轨的第2个声道。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1.0 |
| ChannelVolume | Array of Float | 否 | 声道音量大小,说明: 当:AudioChannel的值为1时,此数组长度为1,例如:[6]; 当:AudioChannel的值为2时,此数组长度为2,例如:[0,6]; 当:AudioChannel的值为6时,此数组长度大于2小于16,例如:[-60,0,0,6]。 此值数组值取值范围:[-60, 6],其中-60代表静音、0代表保持原音量,6表示原音量增加一倍,默认值为-60。 注意:支持3位小数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:[-60, 0, 6] |
TrackSelector
音视频轨道选择
被如下接口引用:CreateStreamLinkFlow, CreateStreamLinkInput, CreateStreamLinkOutputInfo, DescribeStreamLinkEventAttachedFlows, DescribeStreamLinkFlow, DescribeStreamLinkFlows, ModifyStreamLinkOutputInfo。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| VideoIndex | Array of Integer | 否 | 视频轨道序号,从1开始. 示例值:[1,2] |
| AudioIndex | Array of Integer | 否 | 音频轨道序号,从1开始. 示例值:[1,2] |
TranscodeTaskInput
转码任务输入参数类型
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeTaskDetail, ModifySchedule, ParseNotification, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 视频转码模板 ID。 示例值:20 |
| RawParameter | RawTranscodeParameter | 否 | 视频转码自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定转码参数。 |
| OverrideParameter | OverrideTranscodeParameter | 否 | 视频转码自定义参数,当 Definition 不填 0 时有效。 当填写了该结构中的部分转码参数时,将使用填写的参数覆盖转码模板中的参数。 该参数用于高度定制场景,建议您仅使用 Definition 指定转码参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| WatermarkSet | Array of WatermarkInput | 否 | 水印列表,支持多张图片或文字水印,最大可支持 10 张。 |
| MosaicSet | Array of MosaicInput | 否 | 马赛克列表,最大可支持 10 张。 |
| StartTimeOffset | Float | 否 | 转码后的视频的起始时间偏移,单位:秒。 示例值:1.0 |
| EndTimeOffset | Float | 否 | 转码后视频的终止时间偏移,单位:秒。 示例值:15.0 |
| OutputStorage | TaskOutputStorage | 否 | 转码后文件的目标存储,不填则继承上层的 OutputStorage 值。 注意:此字段可能返回 null,表示取不到有效值。 |
| OutputObjectPath | String | 否 | 转码后主文件的输出路径,可以为相对路径或者绝对路径。 若需定义输出路径,路径需以 .{format}结尾。变量名请参考 文件名变量说明。相对路径示例: 绝对路径示例: 如果不填,则默认为相对路径: {inputName}_transcode_{definition}.{format}。示例值:{inputName}_transcode_{definition}.{format} |
| SegmentObjectName | String | 否 | 转码后分片文件的输出路径(转码 HLS 时 ts 的路径),只能为相对路径。如果不填,则默认为:{inputName}_transcode_{definition}_{number}.{format}。示例值:{inputName}_transcode_{definition}_{number}.{format} |
| ObjectNumberFormat | NumberFormat | 否 | 转码后输出路径中的{number}变量的规则。注意:此字段可能返回 null,表示取不到有效值。 |
| HeadTailParameter | HeadTailParameter | 否 | 片头片尾参数。 注意:此字段可能返回 null,表示取不到有效值。 |
TranscodeTemplate
转码模板详情
被如下接口引用:DescribeTranscodeTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | String | 转码模板唯一标识。 示例值:0 |
| Container | String | 封装格式,取值:mp4、flv、hls、mp3、flac、ogg。 示例值:mp4 |
| Name | String | 转码模板名称。 示例值:transcode1 |
| Comment | String | 模板描述信息。 示例值:转码模板1 |
| Type | String | 模板类型,取值: 示例值:Custom |
| RemoveVideo | Integer | 是否去除视频数据,取值: 示例值:0 |
| RemoveAudio | Integer | 是否去除音频数据,取值: 示例值:0 |
| VideoTemplate | VideoTemplateInfo | 视频流配置参数,仅当 RemoveVideo 为 0,该字段有效。 |
| AudioTemplate | AudioTemplateInfo | 音频流配置参数,仅当 RemoveAudio 为 0,该字段有效 。 |
| TEHDConfig | TEHDConfig | 极速高清转码参数。 注意:此字段可能返回 null,表示取不到有效值。 |
| ContainerType | String | 封装格式过滤条件,可选值: 示例值:Video |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2023-10-17T14:59:45.123Z |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2023-11-17T14:59:45.123Z |
| EnhanceConfig | EnhanceConfig | 音视频增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| AliasName | String | 转码模板别名称。 注意:此字段可能返回 null,表示取不到有效值。 示例值:mps_transcode1 |
TranslateConfigureInfo
语音翻译任务控制参数
被如下接口引用:CreateAIRecognitionTemplate, DescribeAIRecognitionTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 语音翻译任务开关,可选值: 示例值:ON |
| SourceLanguage | String | 否 | 视频源语言。 示例值:zh |
| DestinationLanguage | String | 否 | 翻译目标语言。 示例值:en |
| SubtitleFormat | String | 否 | 生成的字幕文件格式,填空字符串表示不生成字幕文件,可选值: 注意:此字段可能返回 null,表示取不到有效值。 示例值:vtt |
TranslateConfigureInfoForUpdate
语音翻译任务控制参数
被如下接口引用:ModifyAIRecognitionTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 语音翻译任务开关,可选值: 示例值:ON |
| SourceLanguage | String | 否 | 视频源语言。 示例值:zh |
| DestinationLanguage | String | 否 | 翻译目标语言。 示例值:en |
| SubtitleFormat | String | 否 | 生成的字幕文件格式,填空字符串表示不生成字幕文件,可选值: 示例值:vtt |
UnattachSecurityGroupInOutInfo
安全组解绑输入/输出请求信息。
被如下接口引用:DisassociateSecurityGroup。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FlowId | String | 是 | 该安全组关联的FlowId。 示例值:01963d5435de1eaa814800077080 |
| InOutId | String | 是 | 要解绑的输入/输出ID。 示例值:019527caa7b209dc0f3253a63420 |
| InOutType | String | 是 | 输入/输出类型,可选值: Input:输入 Output:输出。 示例值:input |
| FlowRegion | String | 是 | Flow所在的Region,和input共用。 示例值:ap-shanghai |
UpdateSmartErasePrivacyConfig
智能擦除模板隐私保护配置
被如下接口引用:ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| PrivacyModel | String | 否 | 隐私保护擦除方式。 - blur 模糊 - mosaic 马赛克 示例值:blur |
| PrivacyTargets | Array of String | 否 | 隐私保护目标,(在API Explorer上使用时无需传入数组,添加相应项并填入对应值即可)。 - face 人脸 - plate 车牌 示例值:["face"] |
UpdateSmartEraseSubtitleConfig
智能擦除模板去字幕配置
被如下接口引用:ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| SubtitleEraseMethod | String | 否 | 字幕擦除方式。 自动擦除:通过AI模型自动识别视频中的字幕文本内容,进行无痕化擦除,生成新的视频。但画面干扰、特殊字幕样式可能会带来一定漏擦误擦问题,可以通过指定区域擦除处理。 当使用自动擦除时,若您不指定AutoAreas,将对默认区域(画面中下部)进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。 指定区域擦除:若您的字幕位置较固定,建议您直接指定擦除区域,最大程度减少漏擦的情况。 当您选择指定区域擦除时,请在CustomAreas中至少传入一个指定区域。 - auto 自动擦除 - custom 指定区域擦除 示例值:auto |
| SubtitleModel | String | 否 | 字幕擦除模型。 标准版(推荐):若您的字幕样式标准,通常建议选择该版本,细节无痕化效果更好。 区域版:若您的字幕存在花体、阴影、动效等特殊样式,建议选择区域版,擦除面积更大,但细节效果不如标准版。 - standard 标准模型 - area 区域模型 示例值:standard |
| OcrSwitch | String | 否 | 是否开启OCR字幕提取,默认取OFF。 当且仅当SubtitleEraseMethod取auto时支持开启OCR字幕提取,开启后将识别自动擦除区域内出现时间最长且最稳定的文字区域为字幕区域,对字幕区域中的文字进行提取和擦除。 - ON 开启 - OFF 关闭 示例值:ON |
| SubtitleLang | String | 否 | 字幕语言,用于指导OCR识别,默认取zh_en;仅当OcrSwitch取"ON"时生效。 - zh_en 中英文 - multi 其他 其他具体支持识别如下语言: 中文、英文、日文、韩语、西班牙语、法语、德语、葡萄牙语、越南语、马来语、俄语、意大利语、荷兰语、瑞典语、芬兰语、丹麦语、挪威语、匈牙利语、泰语、印地语、阿拉伯语、印度-孟加拉语、印度-古吉拉特语、印度-卡纳达语 、印度-马拉亚拉姆语 、印度-泰米尔语、印度-泰卢固语、斯洛文尼亚语、波兰语、加泰罗尼亚语、波斯尼亚语、捷克语、爱沙尼亚语、克罗地亚语、旁遮普语、马拉地语、阿塞拜疆语、印尼语、卢森堡语 、立陶宛语、拉脱维亚语、马耳他语、斯洛伐克语、土耳其语、哈萨克语、希腊语、爱尔兰语、白俄罗斯语、高棉语、他加禄语、普什图语、波斯语、塔吉克斯坦语 示例值:zh_en |
| SubtitleFormat | String | 否 | 字幕文件格式,默认取vtt;仅当OcrSwitch取"ON"时生效。 - srt srt格式 - vtt WebVTT格式 示例值:vtt |
| TransSwitch | String | 否 | 是否开启字幕翻译,默认取OFF;仅当OcrSwitch取"ON"时生效。 - ON 开启 - OFF 关闭 示例值:ON |
| TransDstLang | String | 否 | 字幕翻译目标语言,默认取en;仅当TransSwitch取"ON"时生效。 当前支持以下语言: zh:简体中文 en:英语 ja:日语 ko:韩语 fr:法语 es:西班牙语 it:意大利语 de:德语 tr:土耳其语 ru:俄语 pt:葡萄牙语 vi:越南语 id:印度尼西亚语 ms:马来语 th:泰语 ar:阿拉伯语 hi:印地语 示例值:en |
| AutoAreas | Array of EraseArea | 否 | 自动擦除自定义区域。 对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。 注意:当擦除方式选择custom时,此参数将不会生效;修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。 |
| CustomAreas | Array of EraseTimeArea | 否 | 指定擦除自定义区域。 对选定区域,在选定时间段内不进行检测识别直接进行擦除。 注意:修改模板时,清除区域请传入[],不传时将保持模板区域信息不变。 |
UpdateSmartEraseWatermarkConfig
智能擦除模板去水印配置
被如下接口引用:ProcessMedia。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| WatermarkEraseMethod | String | 否 | 水印擦除方式。 自动擦除:通过A模型自动识别视频中的水印,擦除后生成新的视频。适用于动态水印。 当使用自动擦除时,若您不指定AutoAreas,将对视频全屏进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。 指定区域擦除:针对位置较固定的静态水印,建议您直接指定擦除区域。 当您选择指定区域擦除时,请至少传入一个指定区域。 - auto 自动擦除 - custom 指定区域擦除 示例值:auto |
| WatermarkModel | String | 否 | 水印擦除模型。 基础版:效果一般,性价比高,适合动画或背景较干净的视频。 高级版:效果更好,适合短剧等现实风格视频。 - basic 基础版 - advanced 高级版 示例值:basic |
| AutoAreas | Array of EraseArea | 否 | 自动擦除自定义区域。 对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。 注意,当擦除方式为custom时,此参数将不会生效。清除区域请传入[],不传时将保持模板区域信息不变。 |
| CustomAreas | Array of EraseTimeArea | 否 | 指定擦除自定义区域。 对选定区域,在选定时间段内不进行检测识别直接进行擦除。 注意:清除区域请传入[],不传时将保持模板区域信息不变。 |
UrlInputInfo
媒体处理 URL 对象信息。
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateVideoDatabaseEntryTask, DescribeBatchTaskDetail, DescribeMediaMetaData, ParseNotification, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Url | String | 是 | 视频的 URL。 示例值:NULL |
UserDefineAsrTextReviewTemplateInfo
用户自定义语音审核任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 用户自定语音审核任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 用户自定义语音过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义语音关键词素材时需要添加对应标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["自定义语音过滤标签1"] |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:100 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:85 |
UserDefineAsrTextReviewTemplateInfoForUpdate
用户自定义语音审核任务控制参数
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 用户自定语音审核任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 用户自定义语音过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义语音关键词素材时需要添加对应标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["自定义语音过滤标签1"] |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:100 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:85 |
UserDefineConfigureInfo
用户自定义审核任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FaceReviewInfo | UserDefineFaceReviewTemplateInfo | 否 | 用户自定义人物审核控制参数。 |
| AsrReviewInfo | UserDefineAsrTextReviewTemplateInfo | 否 | 用户自定义语音审核控制参数。 |
| OcrReviewInfo | UserDefineOcrTextReviewTemplateInfo | 否 | 用户自定义文本审核控制参数。 |
UserDefineConfigureInfoForUpdate
用户自定义审核任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FaceReviewInfo | UserDefineFaceReviewTemplateInfoForUpdate | 是 | 用户自定义人物审核控制参数。 |
| AsrReviewInfo | UserDefineAsrTextReviewTemplateInfoForUpdate | 是 | 用户自定义语音审核控制参数。 |
| OcrReviewInfo | UserDefineOcrTextReviewTemplateInfoForUpdate | 是 | 用户自定义文本审核控制参数。 |
UserDefineFaceReviewTemplateInfo
用户自定义人物审核任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 用户自定义人物审核任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 用户自定义人物过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义人物库的时,需要添加对应人物标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["自定义人物过滤标签1"] |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 97 分。取值范围:0~100。 示例值:100 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 95 分。取值范围:0~100。 示例值:85 |
UserDefineFaceReviewTemplateInfoForUpdate
用户自定义人物审核任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 用户自定义人物审核任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 用户自定义人物过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义人物库的时,需要添加对应人物标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["自定义人物过滤标签1"] |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:100 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:85 |
UserDefineOcrTextReviewTemplateInfo
用户自定义文本审核任务控制参数
被如下接口引用:CreateContentReviewTemplate, DescribeContentReviewTemplates。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 是 | 用户自定文本审核任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 用户自定义文本过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义文本关键词素材时需要添加对应标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["自定义文本过滤标签1"] |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 示例值:100 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 示例值:85 |
UserDefineOcrTextReviewTemplateInfoForUpdate
用户自定义文本审核任务控制参数。
被如下接口引用:ModifyContentReviewTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 用户自定文本审核任务开关,可选值: 示例值:ON |
| LabelSet | Array of String | 否 | 用户自定义文本过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义文本关键词素材时需要添加对应标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 示例值:["entertainment", "sport"] |
| BlockConfidence | Integer | 否 | 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 示例值:90 |
| ReviewConfidence | Integer | 否 | 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 示例值:80 |
VODInputInfo
媒体处理 VOD (点播专业版)对象信息。
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateVideoDatabaseEntryTask, DescribeBatchTaskDetail, DescribeMediaMetaData, ParseNotification, ProcessImage, ProcessMedia, RecognizeMediaForZhiXue, WithdrawsWatermark。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Bucket | String | 否 | 媒体处理对象文件所在的 Bucket ID 示例值:a00ehq6ocdmo0exn |
| Region | String | 否 | 媒体处理对象文件所在的 Bucket 所属园区 示例值:ap-chongqing |
| Object | String | 否 | 媒体处理对象文件的输入路径 示例值:/movie/201907/WildAnimal.mov |
| SubAppId | Integer | 否 | 点播专业版应用Id 示例值:220762 |
VODOutputStorage
媒体处理 VOD(点播专业版) 输出对象信息。
被如下接口引用:BatchProcessMedia, CreateMediaEvaluation, CreateSchedule, CreateWorkflow, EditMedia, ModifySchedule, ProcessImage, ProcessLiveStream, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Bucket | String | 否 | 媒体处理生成的文件输出的目标 Bucket ID 示例值:a00ehq6ocdmo0exn |
| Region | String | 否 | 媒体处理生成的文件输出的目标 Bucket 的园区 示例值:ap-chongqing |
| SubAppId | Integer | 否 | 点播专业版应用Id 示例值:220762 |
VideoDBEntryTaskResult
视频检索入库任务的结果
被如下接口引用:DescribeVideoDatabaseEntryTaskDetail。
| 名称 | 类型 | 描述 |
|---|---|---|
| VideoId | String | 入库的视频ID 注意:此字段可能返回 null,表示取不到有效值。 示例值:70f571-****-298377 |
VideoDenoiseConfig
视频降噪配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 类型,可选值: 默认值:weak。 注意:此字段可能返回 null,表示取不到有效值。 示例值:weak |
VideoEnhanceConfig
视频增强配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| FrameRate | FrameRateConfig | 否 | 插帧帧率配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| SuperResolution | SuperResolutionConfig | 否 | 超分配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| Hdr | HdrConfig | 否 | HDR配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| Denoise | VideoDenoiseConfig | 否 | 视频降噪配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| ImageQualityEnhance | ImageQualityEnhanceConfig | 否 | 综合增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| ColorEnhance | ColorEnhanceConfig | 否 | 色彩增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| SharpEnhance | SharpEnhanceConfig | 否 | 细节增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| FaceEnhance | FaceEnhanceConfig | 否 | 人脸增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| LowLightEnhance | LowLightEnhanceConfig | 否 | 低光照增强配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| ScratchRepair | ScratchRepairConfig | 否 | 去划痕配置。 注意:此字段可能返回 null,表示取不到有效值。 |
| ArtifactRepair | ArtifactRepairConfig | 否 | 去伪影(毛刺)配置。 注意:此字段可能返回 null,表示取不到有效值。 |
VideoTemplateInfo
视频流配置参数
被如下接口引用:CreateAdaptiveDynamicStreamingTemplate, CreateTranscodeTemplate, CreateWorkflow, DescribeTranscodeTemplates, ModifyAdaptiveDynamicStreamingTemplate, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Codec | String | 是 | 视频流的编码格式,可选值: 注意:av1 编码容器目前只支持 mp4 ,webm,mkv。 注意:H.266 编码容器目前只支持 mp4 ,hls,ts,mov。 注意:VP8、VP9编码容器目前只支持webm,mkv。 注意:MPEG2、dnxhd 编码容器目前只支持mxf。 注意:MV-HEVC编码容器目前只支持mp4,hls,mov。其中hls格式只支持mp4分片格式。 示例值:h264 |
| Fps | Integer | 是 | 视频帧率,取值范围: 当FpsDenominator的值为空时,范围:[0, 120],单位:Hz; 当FpsDenominator的值不为空时,Fps/FpsDenominator的范围:[0,120] 当取值为 0,表示帧率和原始视频保持一致。 示例值:0 |
| Bitrate | Integer | 是 | 视频流的码率,取值范围:0 和 [128, 100000],单位:kbps。 当取值为 0,表示视频码率和原始视频保持一致。 示例值:0 |
| ResolutionAdaptive | String | 否 | 分辨率自适应,可选值: 默认值:open。 注意:自适应模式时,Width不能小于Height。 示例值:open |
| Width | Integer | 否 | 视频流宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 注意:Codec为MV-HEVC时可以支持到7680 示例值:0 |
| Height | Integer | 否 | 视频流高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。 默认值:0。 注意:Codec为MV-HEVC时可以支持到7680 示例值:0 |
| Gop | Integer | 否 | 关键帧 I 帧之间的间隔,允许按帧或秒自定义GOP长度,取值范围:0 和 [1, 100000], 当填 0 或不填时,系统将自动设置 gop 长度。 示例值:0 |
| GopUnit | String | 否 | Gop数值单位,可选值: frame:表示帧 second:表示秒 默认值:frame 注意:此字段可能返回 null,表示取不到有效值。 示例值:frame |
| FillType | String | 否 | 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: 默认值:black 。 示例值:black |
| Vcrf | Integer | 否 | 视频的恒定码率控制因子,取值范围为[0, 51],不填表示“自动”。如果没有特殊需求,建议不指定该参数。 当Mode参数设置为VBR时,如果同时配置了Vcrf值,MPS将在VBR模式下处理视频,同时考虑Vcrf和Bitrate参数的设置,以平衡视频质量、码率、转码效率和文件大小。 当Mode参数设置为CRF,Bitrate设置将失效,编码将根据Vcrf值进行。 当Mode参数选择ABR或CBR时,无需配置Vcrf值。 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| HlsTime | Integer | 否 | 分片平均时长,范围:(0-10],单位:秒 不填表示自动,将根据视频的GOP等特征自动选择合适的分片时长。 注意:只能在封装格式hls的情况下使用 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
| SegmentType | Integer | 否 | hls 分片类型,可选值 : 默认值:0 注意:该字段用于普通/极速高清转码设置,对自适应码流不生效,如需给自适应码流配置分片类型,可以使用外层字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| FpsDenominator | Integer | 否 | 帧率分母部分 注意:值必须大于0 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| Stereo3dType | String | 否 | 3D视频拼接方式,仅mv-hevc,3D视频生效,可选值: 计费将按照切分后的分辨率尺寸上报用量及计费; 默认值:side_by_side 注意:此字段可能返回 null,表示取不到有效值。 示例值:side_by_side |
| VideoProfile | String | 否 | Profile,适用于不同场景。 baseline: 只支持I/P帧,并只支持无交错的场景,适用于视频通话、手机视频等场景。 main: 主流Profile,提供I帧、P帧、B帧,并支持无交错模式和交错模式。主要用在主流的音视频消费产品如视频播放器、流媒体传输设备上。 high: 最高编码等级,在Main Profile上添加了8X8的预测,并支持自定义量化。广泛应用在蓝光存储、高清电视等场景。 default:随原视频自动填充。 仅编码标准选择h264时出现该配置, 支持 baseline/main/high,默认为:default 注意:此字段可能返回 null,表示取不到有效值。 示例值:default |
| VideoLevel | String | 否 | 编码器级别,默认为自动("") 若编码标准选择H264: 支持以下选项:"",1 , 1.1 , 1.2 , 1.3 , 2 , 2.1 , 2.2 , 3 , 3.1 , 3.2 , 4 , 4.1 , 4.2 , 5 , 5.1 若编码标准选择H265: 支持以下选项:"",1 , 2 , 2.1 , 3 , 3.1 , 4 , 4.1 , 5 , 5.1 , 5.2 , 6 , 6.1 , 6.2 , 8.5 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| Bframes | Integer | 否 | 参考帧之间的B帧数,默认选自动,支持 0 - 16 注意:不填表示使用自动 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Mode | String | 否 | 码率控制模式:可选值: VBR(Variable Bit Rate):动态比特率,根据视频画面的复杂度动态调整输出的码率,使得画面质量更高,适用于存储场景和对画面质量要求较高的应用。 ABR(Average Bit Rate):平均比特率,尽量保持输出视频的平均码率稳定,但允许短期内的码率波动,适用于需要在保持一定画质的情况下尽量减少整体码率的场景。 CBR(Constant Bit Rate):恒定比特率,指视频编码时输出的码率保持恒定不变,不考虑画面复杂度的变化,适用于对网络带宽要求较为严格的场景,如直播等。 VCRF(Constant Rate Factor):恒定质量因子,通过设定一个质量因子来控制视频质量,实现视频的恒定质量编码,码率会根据内容的复杂度自动调整,适用于希望保持一定画质的场景。 默认选择 VBR 注意:此字段可能返回 null,表示取不到有效值。 示例值:VBR |
| Sar | String | 否 | 显示高宽比,可选值:[1:1,2:1,default] 默认值:default 注意:此字段可能返回 null,表示取不到有效值。 示例值:default |
| NoScenecut | Integer | 否 | 自适应I帧决策,开启后,媒体处理将自动识别视频中不同场景之间的过渡点(通常是视觉上显著不同的帧,比如从一个镜头切换到另一个镜头),在这些点自适应插入关键帧(I帧),从而提高视频的随机访问性和编码效率。可选值: 0:关闭自适应I帧决策 1:使用自适应I帧决策 默认值:0 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| BitDepth | Integer | 否 | 比特位:支持8/10,默认为8 注意:此字段可能返回 null,表示取不到有效值。 示例值:8 |
| RawPts | Integer | 否 | 保持原始时间戳:可选值: 0:表示关闭 1:表示打开 默认是关闭 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Compress | Integer | 否 | 按比例压缩码率,开启后,将根据比例来调整输出视频的码率。填写压缩率后,系统会根据视频源码率自动计算目标输出码率。压缩率范围0-100 不填此值表示不开启,默认不开启 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SegmentSpecificInfo | SegmentSpecificInfo | 否 | 启动时分片时长 注意:此字段可能返回 null,表示取不到有效值。 |
| ScenarioBased | Integer | 否 | 模板是否开启场景化 0:不开启 1:开启 默认值:0 注意:只有此字段值为1时,SceneType和CompressType字段的值才会生效 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SceneType | String | 否 | 视频场景化,可选值: normal:通用转码场景:通用转码压缩场景。 pgc:PGC高清影视:压缩时会注重影视剧的观看体验,根据影视剧特性进行ROI编码,同时保留高质量的视频内容和音频。 materials_video:高清素材:素材资源类场景,对画质要求极高,较多透明画面内容,在压缩的同时接近视觉无损。 ugc:UGC内容:适用于广泛的UGC/短视频场景,针对短视频的特性优化编码码率, 画质提升,提升业务QOS/QOE指标。 e-commerce_video:秀场/电商类:压缩时会强调细节清晰度和ROI区域提升,尤其注重保持人脸区域的画质。 educational_video:教育类:压缩时会强调文字和图像的清晰度和可读性,以便学生更好地理解内容,确保讲解内容清晰传达。 默认值:normal 注意:要使用此值ScenarioBased的值必须为1,否则此值不生效 注意:此字段可能返回 null,表示取不到有效值。 示例值:normal |
| CompressType | String | 否 | 转码策略,可选值: ultra_compress:极致压缩:相比标准压缩,该策略能在保证一定画质的基础上最大限度压缩码率,极大节约带宽和存储成本。 standard_compress:综合最优:平衡压缩率与画质,在保证主观画质没有明显降低的情况下尽可能压缩文件。该策略仅收取音视频极速高清转码费用。 high_compress:码率优先:优先保证降低文件体积大小,可能有一定画质损失。该策略仅收取音视频极速高清转码费用。 low_compress:画质优先:优先保证画质,压缩出来的文件体积可能相对较大。该策略仅收取音视频极速高清转码费用。 默认值:standard_compress 注:若需要在电视上观看视频,不建议使用ultra_compress策略。ultra_compress策略计费标准为极速高清转码 + 音视频增强-去毛刺。 注意:要使用此值ScenarioBased的值必须为1,否则此值不生效 注意:此字段可能返回 null,表示取不到有效值。 示例值:standard_compress |
VideoTemplateInfoForUpdate
视频流配置参数
被如下接口引用:CreateWorkflow, ModifyTranscodeTemplate, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Codec | String | 否 | 视频流的编码格式,可选值: 注意:av1 编码容器目前只支持 mp4 ,webm,mkv。 注意:H.266 编码容器目前只支持 mp4 ,hls,ts,mov。 注意:VP8、VP9编码容器目前只支持webm,mkv。 注意:MPEG2、dnxhd 编码容器目前只支持mxf。 注意:MV-HEVC编码容器目前只支持mp4,hls,mov。其中hls格式只支持mp4分片格式。 注意:此字段可能返回 null,表示取不到有效值。 示例值:h264 |
| Fps | Integer | 否 | 视频帧率,取值范围: 当FpsDenominator的值为空时,范围:[0, 120],单位:Hz; 当FpsDenominator的值不为空时,Fps/FpsDenominator的范围:[0,120] 当取值为 0,表示帧率和原始视频保持一致。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Bitrate | Integer | 否 | 视频流的码率,取值范围:0 和 [128, 100000],单位:kbps。 当取值为 0,表示视频码率和原始视频保持一致。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| ResolutionAdaptive | String | 否 | 分辨率自适应,可选值: 注意:自适应模式时,Width不能小于Height。 注意:此字段可能返回 null,表示取不到有效值。 示例值:open |
| Width | Integer | 否 | 视频流宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。 注意:Codec为MV-HEVC时可以支持到7680 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Height | Integer | 否 | 视频流高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。 注意:Codec为MV-HEVC时可以支持到7680 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Gop | Integer | 否 | 关键帧 I 帧之间的间隔,允许按帧或秒自定义GOP长度,取值范围:0 和 [1, 100000]。 当填 0 时,系统将自动设置 gop 长度。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| GopUnit | String | 否 | Gop数值单位,可选值: frame:表示帧 second:表示秒 默认值:frame 注意:此字段可能返回 null,表示取不到有效值。 示例值:frame |
| FillType | String | 否 | 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: 默认值:black 。 注意:此字段可能返回 null,表示取不到有效值。 示例值:black |
| Vcrf | Integer | 否 | 视频的恒定码率控制因子,取值范围为[0, 51],不填表示“自动”。如果没有特殊需求,建议不指定该参数。 当Mode参数设置为VBR时,如果同时配置了Vcrf值,MPS将在VBR模式下处理视频,同时考虑Vcrf和Bitrate参数的设置,以平衡视频质量、码率、转码效率和文件大小。 当Mode参数设置为CRF,Bitrate设置将失效,编码将根据Vcrf值进行。 当Mode参数选择ABR或CBR时,无需配置Vcrf值。 注意:需要修改为自动时,填100 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| ContentAdaptStream | Integer | 否 | 内容自适应编码。可选值: 默认值: 0. 当开启该参数时,将会自适应生成多个不同分辨率,不同码率的码流, 其中VideoTemplate的宽和高为多个码流中的最大分辨率,VideoTemplate中的码率为多个码流中的最高码率, VideoTemplate中的vcrf为多个码流中的最高质量。 当不设置分辨率、码率和vcrf时, ContentAdaptStream 参数生成的最高分辨率为视频源的分辨率,视频质量为接近vmaf95分。 若要开启该参数或了解计费细节, 请联系您的腾讯云商务。 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| HlsTime | Integer | 否 | 分片平均时长,取值范围:(0-10],单位:秒 默认值:10 注意:只在封装格式HLS时使用 注意:此字段可能返回 null,表示取不到有效值。 示例值:10 |
| SegmentType | Integer | 否 | hls 分片类型,可选值: 默认值:0 注意:该字段用于普通/极速高清转码设置,对自适应码流不生效,如需给自适应码流配置分片类型,可以使用外层字段 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| FpsDenominator | Integer | 否 | 帧率分母部分 注意:值必须大于0 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| Stereo3dType | String | 否 | 3D视频拼接方式,仅mv-hevc,3D视频生效,可选值: 计费将按照切分后的分辨率尺寸上报用量及计费; 默认值:side_by_side 注意:此字段可能返回 null,表示取不到有效值。 示例值:side_by_side |
| VideoProfile | String | 否 | Profile,适用于不同场景。 baseline: 只支持I/P帧,并只支持无交错的场景,适用于视频通话、手机视频等场景。 main: 主流Profile,提供I帧、P帧、B帧,并支持无交错模式和交错模式。主要用在主流的音视频消费产品如视频播放器、流媒体传输设备上。 high: 最高编码等级,在Main Profile上添加了8X8的预测,并支持自定义量化。广泛应用在蓝光存储、高清电视等场景。 default:随原视频自动填充 仅编码标准选择h264时出现该配置,默认为:default 注意:此字段可能返回 null,表示取不到有效值。 示例值:default |
| VideoLevel | String | 否 | 编码器级别,默认为自动("") 若编码标准选择H264: 支持以下选项:"",1 , 1.1 , 1.2 , 1.3 , 2 , 2.1 , 2.2 , 3 , 3.1 , 3.2 , 4 , 4.1 , 4.2 , 5 , 5.1 若编码标准选择H265: 支持以下选项:"",1 , 2 , 2.1 , 3 , 3.1 , 4 , 4.1 , 5 , 5.1 , 5.2 , 6 , 6.1 , 6.2 , 8.5 注意:此字段可能返回 null,表示取不到有效值。 示例值:1 |
| Bframes | Integer | 否 | 最大连续B帧数,默认选自动,支持 0 - 16和-1 注意: -1表示修改为自动值 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Mode | String | 否 | 码率控制模式:可选值: VBR(Variable Bit Rate):动态比特率,根据视频画面的复杂度动态调整输出的码率,使得画面质量更高,适用于存储场景和对画面质量要求较高的应用。 ABR(Average Bit Rate):平均比特率,尽量保持输出视频的平均码率稳定,但允许短期内的码率波动,适用于需要在保持一定画质的情况下尽量减少整体码率的场景。 CBR(Constant Bit Rate):恒定比特率,指视频编码时输出的码率保持恒定不变,不考虑画面复杂度的变化,适用于对网络带宽要求较为严格的场景,如直播等。 VCRF(Constant Rate Factor):恒定质量因子,通过设定一个质量因子来控制视频质量,实现视频的恒定质量编码,码率会根据内容的复杂度自动调整,适用于希望保持一定画质的场景。 默认选择 VBR 注意:此字段可能返回 null,表示取不到有效值。 示例值:VBR |
| Sar | String | 否 | 显示高宽比,可选值:[1:1,2:1,default] 默认值:default 注意:此字段可能返回 null,表示取不到有效值。 示例值:default |
| NoScenecut | Integer | 否 | 自适应I帧决策,开启后,媒体处理将自动识别视频中不同场景之间的过渡点(通常是视觉上显著不同的帧,比如从一个镜头切换到另一个镜头),在这些点自适应插入关键帧(I帧),从而提高视频的随机访问性和编码效率。可选值: 0:关闭自适应I帧决策 1:使用自适应I帧决策 默认值:0 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| BitDepth | Integer | 否 | 比特位:支持8/10,默认为8 注意:此字段可能返回 null,表示取不到有效值。 示例值:8 |
| RawPts | Integer | 否 | 保持原始时间戳:可选值: 0:表示关闭 1:表示打开 默认是关闭 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| Compress | Integer | 否 | 按比例压缩码率,开启后,将根据比例来调整输出视频的码率。填写压缩率后,系统会根据视频源码率自动计算目标输出码率。压缩率范围0-100,可选值:[0-100]和-1 注意:-1表示修改为自动 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SegmentSpecificInfo | SegmentSpecificInfo | 否 | 启动时分片时长 注意:此字段可能返回 null,表示取不到有效值。 |
| ScenarioBased | Integer | 否 | 模板是否开启场景化 0:不开启 1:开启 默认值:0 注意:只有此字段值为1时,SceneType和CompressType字段的值才会生效 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
| SceneType | String | 否 | 视频场景化,可选值: normal:通用转码场景:通用转码压缩场景 pgc:PGC高清影视:压缩时会注重影视剧的观看体验,根据影视剧特性进行ROI编码,同时保留高质量的视频内容和音频。 materials_video:高清素材:素材资源类场景,对画质要求极高,较多透明画面内容,在压缩的同时接近视觉无损。 ugc:UGC内容:适用于广泛的UGC/短视频场景,针对短视频的特性优化编码码率, 画质提升,提升业务QOS/QOE指标。 e-commerce_video:秀场/电商类:压缩时会强调细节清晰度和ROI区域提升,尤其注重保持人脸区域的画质。 educational_video:教育类:压缩时会强调文字和图像的清晰度和可读性,以便学生更好地理解内容,确保讲解内容清晰传达。 默认值:normal 注意:要使用此值ScenarioBased的值必须为1,否则此值不生效 注意:此字段可能返回 null,表示取不到有效值。 示例值:normal |
| CompressType | String | 否 | 转码策略,可选值: ultra_compress:极致压缩:相比标准压缩,该策略能在保证一定画质的基础上最大限度压缩码率,极大节约带宽和存储成本。 standard_compress:综合最优:平衡压缩率与画质,在保证主观画质没有明显降低的情况下尽可能压缩文件。该策略仅收取音视频极速高清转码费用。 high_compress:码率优先:优先保证降低文件体积大小,可能有一定画质损失。该策略仅收取音视频极速高清转码费用。 low_compress:画质优先:优先保证画质,压缩出来的文件体积可能相对较大。该策略仅收取音视频极速高清转码费用。 默认值:standard_compress 注:若需要在电视上观看视频,不建议使用ultra_compress策略。ultra_compress策略计费标准为极速高清转码 + 音视频增强-去毛刺。 注意:要使用此值ScenarioBased的值必须为1,否则此值不生效 注意:此字段可能返回 null,表示取不到有效值。 示例值:standard_compress |
VolumeBalanceConfig
音量均衡配置
被如下接口引用:CreateTranscodeTemplate, ModifyTranscodeTemplate。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Switch | String | 否 | 能力配置开关,可选值: 默认值:ON。 示例值:ON |
| Type | String | 否 | 类型,可选值: 默认值:loudNorm。 注意:此字段可能返回 null,表示取不到有效值。 示例值:loudNorm |
WatermarkInput
媒体处理任务中的水印参数类型
被如下接口引用:CreateWorkflow, ProcessMedia, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Definition | Integer | 是 | 水印模板 ID。 示例值:NULL |
| RawParameter | RawWatermarkParameter | 否 | 水印自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定水印参数。 水印自定义参数不支持截图打水印。 示例值:NULL |
| TextContent | String | 否 | 文字内容,长度不超过100个字符。仅当水印类型为文字水印时填写。 文字水印不支持截图打水印。 示例值:NULL |
| SvgContent | String | 否 | SVG 内容。长度不超过 2000000 个字符。仅当水印类型为 SVG 水印时填写。 SVG 水印不支持截图打水印。 示例值:NULL |
| StartTimeOffset | Float | 否 | 水印的起始时间偏移,单位:秒。不填或填0,表示水印从画面出现时开始显现。 注:只用于视频场景,截图不支持。 示例值:NULL |
| EndTimeOffset | Float | 否 | 水印的结束时间偏移,单位:秒。 注:只用于视频场景,截图不支持。 示例值:NULL |
WatermarkTemplate
水印模板详情
被如下接口引用:DescribeWatermarkTemplates。
| 名称 | 类型 | 描述 |
|---|---|---|
| Definition | Integer | 水印模板唯一标识。 示例值:222400 |
| Type | String | 水印类型,取值: 示例值:image |
| Name | String | 水印模板名称。 示例值:水印模板 |
| Comment | String | 模板描述信息。 示例值:水印模板 |
| XPos | String | 水印图片原点距离视频图像原点的水平位置。 示例值:5% |
| YPos | String | 水印图片原点距离视频图像原点的垂直位置。 示例值:5% |
| ImageTemplate | ImageWatermarkTemplate | 图片水印模板,仅当 Type 为 image,该字段有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| TextTemplate | TextWatermarkTemplateInput | 文字水印模板,仅当 Type 为 text,该字段有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| SvgTemplate | SvgWatermarkInput | SVG 水印模板,当 Type 为 svg,该字段有效。 注意:此字段可能返回 null,表示取不到有效值。 |
| CreateTime | String | 模板创建时间,使用 ISO 日期格式。 示例值:2024-04-30T16:40:14+08:00 |
| UpdateTime | String | 模板最后修改时间,使用 ISO 日期格式。 示例值:2024-04-30T16:40:14+08:00 |
| CoordinateOrigin | String | 原点位置,可选值: 示例值:TopLeft |
WordResult
字词信息。
被如下接口引用:DescribeBatchTaskDetail, DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| Word | String | 字词文本。 示例值:腾讯云 |
| Start | Float | 字词起始时间戳,单位秒。 示例值:3.204 |
| End | Float | 字词结束时间戳,单位秒。 示例值:5.404 |
| Trans | String | 翻译文本 示例值:Tencent Cloud |
WorkflowInfo
工作流信息详情。
被如下接口引用:DescribeWorkflows。
| 名称 | 类型 | 描述 |
|---|---|---|
| WorkflowId | Integer | 工作流 ID。 示例值:NULL |
| WorkflowName | String | 工作流名称。 示例值:NULL |
| Status | String | 工作流状态,取值范围: 示例值:NULL |
| Trigger | WorkflowTrigger | 工作流绑定的输入规则,当上传视频命中该规则到该对象时即触发工作流。 示例值:NULL |
| OutputStorage | TaskOutputStorage | 媒体处理的文件输出存储位置。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| MediaProcessTask | MediaProcessTaskInput | 媒体处理类型任务参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| AiContentReviewTask | AiContentReviewTaskInput | 视频内容审核类型任务参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| AiAnalysisTask | AiAnalysisTaskInput | 视频内容分析类型任务参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| AiRecognitionTask | AiRecognitionTaskInput | 视频内容识别类型任务参数。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| TaskNotifyConfig | TaskNotifyConfig | 任务的事件通知信息,不填代表不获取事件通知。 注意:此字段可能返回 null,表示取不到有效值。 示例值:NULL |
| TaskPriority | Integer | 任务流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。 示例值:NULL |
| OutputDir | String | 媒体处理生成的文件输出的目标目录,如/movie/201907/。示例值:NULL |
| CreateTime | String | 工作流创建时间,使用 ISO 日期格式。 示例值:NULL |
| UpdateTime | String | 工作流最后修改时间,使用 ISO 日期格式。 示例值:NULL |
WorkflowTask
媒体处理任务信息
被如下接口引用:DescribeTaskDetail, ParseNotification。
| 名称 | 类型 | 描述 |
|---|---|---|
| TaskId | String | 媒体处理任务 ID。 示例值:2xxxx-asdews |
| Status | String | 任务流状态,取值: 示例值:PROCESSING |
| ErrCode | Integer | 源异常时返回非0错误码,返回0 时请使用各个具体任务的 ErrCode。 示例值:0 |
| Message | String | 源异常时返回对应异常Message,否则请使用各个具体任务的 Message。 示例值:SUCCESS |
| InputInfo | MediaInputInfo | 媒体处理的目标文件信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| MetaData | MediaMetaData | 原始视频的元信息。 注意:此字段可能返回 null,表示取不到有效值。 |
| MediaProcessResultSet | Array of MediaProcessTaskResult | 媒体处理任务的执行状态与结果。 |
| AiContentReviewResultSet | Array of AiContentReviewResult | 视频内容审核任务的执行状态与结果。 |
| AiAnalysisResultSet | Array of AiAnalysisResult | 视频内容分析任务的执行状态与结果。 |
| AiRecognitionResultSet | Array of AiRecognitionResult | 视频内容识别任务的执行状态与结果。 |
| AiQualityControlTaskResult | ScheduleQualityControlTaskResult | 媒体质检任务的执行状态与结果。 注意:此字段可能返回 null,表示取不到有效值。 |
| SmartSubtitlesTaskResult | Array of SmartSubtitlesResult | 智能字幕任务的执行结果 注意:此字段可能返回 null,表示取不到有效值。 |
| SmartEraseTaskResult | SmartEraseTaskResult | 智能擦除任务的执行结果 注意:此字段可能返回 null,表示取不到有效值。 |
WorkflowTrigger
输入规则,当上传视频命中该规则时,即触发工作流。
被如下接口引用:CreateSchedule, CreateWorkflow, DescribeSchedules, DescribeWorkflows, ModifySchedule, ResetWorkflow。
| 名称 | 类型 | 必选 | 描述 |
|---|---|---|---|
| Type | String | 是 | 触发器的类型,可选值: 示例值:CosFileUpload |
| CosFileUploadTrigger | CosFileUploadTrigger | 否 | 当 Type 为 CosFileUpload 时必填且有效,为 COS 触发规则。 注意:此字段可能返回 null,表示取不到有效值。 |
| AwsS3FileUploadTrigger | AwsS3FileUploadTrigger | 否 | 当 Type 为 AwsS3FileUpload 时必填且有效,为 AWS S3 触发规则。 注意:目前AWS的S3、对应触发队列SQS、回调队列SQS的秘钥需要一致。 注意:此字段可能返回 null,表示取不到有效值。 |
