/**
* ProcessMedia请求参数结构体
*/
export interface ProcessMediaRequest {
/**
*
媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。
FileId和MediaStoragePath必须提供其中一个。
*/
FileId?: string;
/**
* 媒体的存储路径。
只有FileID + Path 模式的子应用可以通过MediaStoragePath发起任务。
FileId和MediaStoragePath必须提供其中一个。
*/
MediaStoragePath?: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 视频处理类型任务参数。
*/
MediaProcessTask?: MediaProcessTaskInput;
/**
* 音视频内容审核类型任务参数 *。
* 不建议使用,推荐使用 音视频审核(ReviewAudioVideo) 或 图片审核(ReviewImage)。
*/
AiContentReviewTask?: AiContentReviewTaskInput;
/**
* 音视频内容分析类型任务参数。
*/
AiAnalysisTask?: AiAnalysisTaskInput;
/**
* 音视频内容识别类型任务参数。
*/
AiRecognitionTask?: AiRecognitionTaskInput;
/**
* 任务流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 任务流状态变更通知模式,可取值有 Finish,Change 和 None,不填代表 Finish。
*/
TasksNotifyMode?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
/**
* FileID为空时有效,拉取Url生成新媒资产生新FileID,媒体处理产物将作为新媒资的附属产物。
注意:新媒资会产生存储费用
*/
Url?: string;
/**
* 媒体处理转码结果输出为独立媒资, 开启该选项会使产物输出为独立媒资,生成全新FileID,目前仅支持TranscodeTask转码任务输出为独立媒资。
枚举值:
默认值:OFF
注意:新媒资会产生存储费用,转码任务中片头片尾、溯源水印等暂不支持开启该选项。
*/
OutputAsIndependentMedia?: string;
}
/**
* 画布信息。制作视频时,如果源素材(视频或者图片)不能填满输出的视频窗口,将用设置的画布进行背景绘制。
*/
export interface Canvas {
/**
* 背景颜色,取值有:
Black:黑色背景
White:白色背景
默认值:Black。
*/
Color?: string;
/**
* 画布宽度,即输出视频的宽度,取值范围:0~ 3840,单位:px。
默认值:0,表示和第一个视频轨的第一个视频片段的视频宽度一致。
*/
Width?: number;
/**
* 画布高度,即输出视频的高度(或长边),取值范围:0~ 3840,单位:px。
默认值:0,表示和第一个视频轨的第一个视频片段的视频高度一致。
*/
Height?: number;
}
/**
* ModifySampleSnapshotTemplate返回参数结构体
*/
export interface ModifySampleSnapshotTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AIGC 生视频任务的输出媒体文件配置。
*/
export interface AigcVideoOutputConfig {
/**
* 存储模式
枚举值:
- Temporary: 临时存储,生成的视频文件不会存储到云点播,可在事件通知中获取到临时访问的 URL,有效期 7 天
- Permanent: 永久存储,生成的视频文件将存储到云点播,可在事件通知中获取到 FileId
默认值:Temporary
*/
StorageMode?: string;
/**
* 输出媒体文件名,最长 64 个字符。缺省由系统指定生成文件名。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
ExpireTime?: string;
/**
* 生成视频的时长,单位:秒。
当 ModelName 是 Kling,可选值为3-15,默认为 5;当 ModelName 是 Hailuo,可选值为 6、10,默认为 6;当版本是H3时,可选值为4-15秒(整数)当 ModelName 是 Vidu,可指定1-10;当 ModelName 是 GV,可选值为 8,默认为 8;当 ModelName 是 OS,可选值为 4、8、12,默认为 8;当 ModelName 是 PixVerse,可指定1-15,默认为5;
*/
Duration?: number;
/**
* 生成视频的分辨率。
当 ModelName 是 Kling,可选值为 720P、1080P,默认为 720P;当 ModelName 是 Hailuo,可选值为 768P、1080P,默认为 768P;当版本是H3时,可选值为768P、1080P、2K、4K;当 ModelName 是 Vidu,可选值为 720P、1080P,默认为 720P;当 ModelName 是 GV,可选值为 720P、1080P,默认为 720P;当 ModelName 是 OS,可选值为 720P;当 ModelName 是 PixVerse,可选值为 540p、720p、1080p、2k、4k,默认为720p;
*/
Resolution?: string;
/**
* 指定所生成视频的宽高比。
当 ModelName 是 Kling,当文生视频时,则可选值为 16:9、9:16、 1:1,默认为16:9;当 ModelName 是 Vidu,当文生视频时和使用参考图片生成时,则可选值为 16:9、9:16、4:3、3:4、1:1,其中仅版本q2支持4:3、3:4当 ModelName 是 GV,则可选值为 16:9、9:16,默认为 16:9;当 ModelName 是 OS,当文生视频时,则可选值为 16:9、9:16,默认为 16:9;当 ModelName 是 Hailuo,版本是H3,文生视频、参考生可选值21:9, 16:9, 4:3, 1:1, 3:4, 9:16,图生视频(即首尾帧视频)分辨率和图片一致。当 ModelName 是PixVerse,则可选值为 16:9,4:3,1:1,3:4,9:16,2:3,3:2,21:9;
*/
AspectRatio?: string;
/**
* 是否生成音频。支持的模型包括 GV、OS、Vidu、Jimeng、Kling。
枚举值:
默认值:Disabled
*/
AudioGeneration?: string;
/**
* 是否允许人物或人脸生成。取值有:
AllowAdult:允许生成成人; Disallowed:禁止在图片中包含人物或人脸;
*/
PersonGeneration?: string;
/**
* 是否开启输入内容的合规性检查。取值有:
Enabled:开启; Disabled:关闭;
*/
InputComplianceCheck?: string;
/**
* 是否开启输出内容的合规性检查。取值有:
Enabled:开启; Disabled:关闭;
*/
OutputComplianceCheck?: string;
/**
* 是否启用视频增强。取值有:
Enabled:开启; Disabled:关闭;
说明:- 对于选择的分辨率超过模型可生成分辨率时,默认会启用增强。
- 对于模型可以直出的分辨率,也可以主动选择模型直出低分辨率,使用增强获得指定分辨率。
*/
EnhanceSwitch?: string;
/**
* 是否开启错峰。取值有:
Enabled:开启; Disabled:关闭;
*/
OffPeak?: string;
/**
* 是否开启vidu智能插帧。取值有:
Enabled:开启; Disabled:关闭;
*/
FrameInterpolate?: string;
/**
* 是否开启图标水印。取值有:
Enabled:开启; Disabled:关闭;
*/
LogoAdd?: string;
/**
* 是否为生成的视频添加背景音乐。
枚举值:
- Enabled: 系统将从预设 BGM 库中自动挑选合适的音乐并添加。
- Disabled: 不添加BGM。
默认值:Disabled
*/
EnableBGM?: string;
}
/**
* CreateAigcVideoRedrawTask请求参数结构体
*/
export interface CreateAigcVideoRedrawTaskRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* AIGC 视频转绘任务的输入视频的文件信息。输入视频时长需短于 90 秒,大小在2GB内。
*/
FileInfo?: AigcVideoRedrawTaskInputFileInfo;
/**
* AIGC 视频转绘任务参数信息。
*/
TaskInfo?: AigcVideoRedrawTaskInfo;
/**
* AIGC 视频转绘任务的输出媒体文件配置。
*/
OutputConfig?: AigcVideoRedrawOutputConfig;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* 图片编码格式参数。
*/
export interface ImageSceneAigcEncodeConfig {
/**
* 图片格式,取值范围:JPEG、PNG,缺省为原图格式。不支持动画。
*/
Format?: string;
/**
* 图片的相对质量,取值范围:1 - 100,数值以原图质量为标准,缺省为原图质量。
*/
Quality?: number;
}
/**
* 域名推送 CLS 目标。
*/
export interface DomainCLSTargetInfo {
/**
* 域名。
*/
Domain?: string;
/**
* 中国大陆地区的日志推送目标。
*/
ChineseMainlandCLSTargetInfo?: AreaCLSTargetInfo;
/**
* 中国大陆以外地区的日志推送目标。
*/
OutsideChineseMainlandCLSTargetInfo?: AreaCLSTargetInfo;
}
/**
* 截图输出信息(2017 版)
*/
export interface SnapshotByTimeOffset2017 {
/**
* 错误码
0:成功;
其他值:失败。
*/
ErrCode?: number;
/**
* 截图的具体时间点,单位:毫秒。
*/
TimeOffset?: number;
/**
* 截图输出文件地址。
*/
Url?: string;
}
/**
* CreateStorageRegion请求参数结构体
*/
export interface CreateStorageRegionRequest {
/**
* 待开通的存储地域,必须是系统支持的地域。
取值参考:已支持地域列表
*/
StorageRegion: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 语音全文识别片段。
*/
export interface AiRecognitionTaskAsrFullTextSegmentItem {
/**
* 识别片段置信度。取值:0~100。
*/
Confidence?: number;
/**
* 识别片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 识别片段终止的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 识别文本。
*/
Text?: string;
}
/**
* 获取文件属性任务信息
*/
export interface DescribeFileAttributesTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,0 表示成功,其他值表示失败:
40000:输入参数不合法,请检查输入参数;
60000:源文件错误(如视频数据损坏),请确认源文件是否正常;
70000:内部服务错误,建议重试。
*/
ErrCode?: number;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 媒体文件 ID。
*/
FileId?: string;
/**
* 获取媒体文件属性任务的输出。
注意:此字段可能返回 null,表示取不到有效值。
*/
Output?: DescribeFileAttributesTaskOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* ExtractBlindWatermark请求参数结构体
*/
export interface ExtractBlindWatermarkRequest {
/**
* 数字水印类型,可选值:blind-basic:基础版权数字水印;blind-trace:溯源ab序列水印;
*/
Type: string;
/**
* 媒体处理的文件输入信息。
*/
InputInfo: ExtractBlindWatermarkInputInfo;
/**
* 添加水印时的点播应用 ID。注意不管是传入FILEID还是URL,都必须与添加水印时的SubAppId吻合才能提取到水印。
*/
SubAppId: number;
/**
* 提取数字水印任务配置
*/
ExtractBlindWatermarkConfig?: ExtractBlindWatermarkTaskConfig;
/**
* 标识来源上下文,用于透传用户请求信息,在 ExtractBlindWatermarkComplete 回调和任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
}
/**
* 音视频审核任务的输入。
*/
export interface ReviewAudioVideoTaskInput {
/**
* 媒体文件 ID。
*/
FileId?: string;
/**
* 音视频审核模板 ID。
*/
Definition?: number;
/**
* 审核的内容,可选值:
Media:原始音视频;
Cover:封面。
*/
ReviewContents?: Array;
}
/**
* DescribeAllClass请求参数结构体
*/
export interface DescribeAllClassRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* AIGC 生图任务的输出。
*/
export interface AigcImageTaskOutput {
/**
* AIGC 生图任务的输出文件信息。
*/
FileInfos?: Array;
}
/**
* CreateAigcVideoRedrawTask返回参数结构体
*/
export interface CreateAigcVideoRedrawTaskResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeRoundPlays请求参数结构体
*/
export interface DescribeRoundPlaysRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 过滤条件:轮播播单标识,数组长度限制:100。
*/
RoundPlayIds?: Array;
/**
* 过滤条件,轮播播单状态,可选值: Enabled:启动状态; Disabled:停止状态。
*/
Status?: string;
/**
* 过滤条件:轮播播单创建时间。
*/
CreateTime?: TimeRange;
/**
* 过滤条件:轮播播单更新时间。
*/
UpdateTime?: TimeRange;
/**
* 翻页标识,分批拉取时使用:当单次请求无法拉取所有数据,接口将会返回 ScrollToken,下一次请求携带该 Token,将会从下一条记录开始获取。
*/
ScrollToken?: string;
/**
* 分页偏移量,默认值:0。已经废弃,请根据 ScrollToken 参数进行分批次查询。
* @deprecated
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
}
/**
* 审核信息。
*/
export interface ReviewInfo {
/**
* 审核模板 ID。
*/
Definition?: number;
/**
* 审核的结果建议,取值范围:
pass:建议通过;
review:建议复审;
block:建议封禁。
*/
Suggestion?: string;
/**
* 审核类型,当 Suggestion 为 review 或 block 时有效,格式为:Form.Label。
Form 表示违禁的形式,取值范围:
Image:画面上的人物或图标;
OCR:画面上的文字;
ASR:语音中的文字;
Voice:声音。
Label 表示违禁的标签,取值范围:
Porn:色情;
Terror:暴力;
Polity:不适宜的信息;
Ad:广告;
Illegal:违法;
Abuse:谩骂;
Moan:娇喘。
*/
TypeSet?: Array;
/**
* 审核时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ReviewTime?: string;
}
/**
* WeChatMiniProgramPublish请求参数结构体
*/
export interface WeChatMiniProgramPublishRequest {
/**
* 媒体文件 ID。
*/
FileId: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 发布视频所对应的转码模板 ID,为 0 代表原始视频。支持的视频格式:
当 SourceDefinition 为 0 时,视频格式支持 MP4、3GP 格式;
当 SourceDefinition 大于 0 时,视频格式支持 MP4、3GP 及 M3U8 格式。不填默认值为 0。
*/
SourceDefinition?: number;
}
/**
* 智能分类任务输入类型
*/
export interface AiAnalysisTaskClassificationInput {
/**
* 视频智能分类模板 ID。
*/
Definition?: number;
}
/**
* SVG水印模板输入参数
*/
export interface SvgWatermarkInput {
/**
* 水印的宽度,支持 px,%,W%,H%,S%,L% 六种格式:
当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素;当填 0px 且
Height 不为 0px 时,表示水印的宽度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的宽度取原始 SVG 图像的宽度;
当字符串以 W% 结尾,表示水印 Width 为视频宽度的百分比大小,如 10W% 表示 Width 为视频宽度的 10%;
当字符串以 H% 结尾,表示水印 Width 为视频高度的百分比大小,如 10H% 表示 Width 为视频高度的 10%;
当字符串以 S% 结尾,表示水印 Width 为视频短边的百分比大小,如 10S% 表示 Width 为视频短边的 10%;
当字符串以 L% 结尾,表示水印 Width 为视频长边的百分比大小,如 10L% 表示 Width 为视频长边的 10%;
当字符串以 % 结尾时,含义同 W%。
默认值为 10W%。
*/
Width?: string;
/**
* 水印的高度,支持 px,W%,H%,S%,L% 六种格式:
当字符串以 px 结尾,表示水印 Height 单位为像素,如 100px 表示 Height 为 100 像素;当填 0px 且
Width 不为 0px 时,表示水印的高度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的高度取原始 SVG 图像的高度;
当字符串以 W% 结尾,表示水印 Height 为视频宽度的百分比大小,如 10W% 表示 Height 为视频宽度的 10%;
当字符串以 H% 结尾,表示水印 Height 为视频高度的百分比大小,如 10H% 表示 Height 为视频高度的 10%;
当字符串以 S% 结尾,表示水印 Height 为视频短边的百分比大小,如 10S% 表示 Height 为视频短边的 10%;
当字符串以 L% 结尾,表示水印 Height 为视频长边的百分比大小,如 10L% 表示 Height 为视频长边的 10%;
当字符串以 % 结尾时,含义同 H%。
默认值为 0px。
*/
Height?: string;
}
/**
* CreateTranscodeTemplate请求参数结构体
*/
export interface CreateTranscodeTemplateRequest {
/**
* 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a、wav。其中,mp3、flac、ogg、m4a、wav 为纯音频文件。
*/
Container: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 转码模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 是否去除视频数据,可选值:
0:保留1:去除默认值:0。
*/
RemoveVideo?: number;
/**
* 是否去除音频数据,可选值:
0:保留1:去除默认值:0。
*/
RemoveAudio?: number;
/**
* 视频流配置参数,当 RemoveVideo 为 0,该字段必填。
*/
VideoTemplate?: VideoTemplateInfo;
/**
* 音频流配置参数,当 RemoveAudio 为 0,该字段必填。
*/
AudioTemplate?: AudioTemplateInfo;
/**
* 极速高清转码参数。
*/
TEHDConfig?: TEHDConfig;
/**
* 音视频增强配置。
*/
EnhanceConfig?: EnhanceConfig;
/**
* 切片类型,当 Container 为 hls 时有效,可选值:
ts:ts 切片;fmp4:fmp4 切片。默认值:ts。
*/
SegmentType?: string;
/**
* 扩展参数。
*/
StdExtInfo?: string;
}
/**
* MPS字幕压制模块配置
*/
export interface MPSSubtitleEmbedConfig {
/**
* 字体类型,支持:
hei.ttf:黑体song.ttf:宋体kai.ttf(推荐)或 simkai.ttf:楷体msyh.ttf:微软雅黑msyhbd.ttf:微软雅黑加粗hkjgt.ttf:华康金刚体dhttx.ttf:典黑体特细xqgdzt.ttf:喜鹊古字典体qpcyt.ttf:巧拼超圆体arial.ttf:仅支持英文dinalternate.ttf:DIN Alternate Boldhelveticalt.ttf:Helveticahelveticains.ttf:Helvetica Inserattrajanpro.ttf:TrajanPro-Boldkorean.ttf:韩语japanese.ttf:日语thai.ttf:泰语roboto.ttf:Robotonotosans.ttf:NotoSansnotosansthai.ttf:泰语NotoSansThaisarabun.ttf:泰语Sarabunkanit.ttf:泰语Kanitcharmonman.ttf:泰语Charmonmannotonaskharabic.ttf:阿拉伯语NotoNaskhArabicnotosansdevanagari.ttf:印度语NotoSansDevanagarinotosanstc.ttf:粤语思源黑体NotoSansTCnotosanskr.ttf:韩语NotoSansKRgothica1.ttf:韩语GothicA1nanummyeongjo.ttf:韩语NanumMyeongjonotosansjp.ttf:日语NotoSansJPnotoserifjp.ttf:日语NotoSerifJPshipporimincho.ttf:日语ShipporiMincho默认:hei.ttf 黑体。
注意:楷体推荐使用kai.ttf填了FontPath时FontPath优先
*/
FontType?: string;
/**
* 自定义字体文件url地址
*/
FontPath?: string;
/**
* 字体大小,不指定则以字幕文件中为准。支持像素和百分比格式:
- 像素:Npx,N范围:(0,4096]。
- 百分百:N%,N范围:(0,100];例如10%表示字幕字体大小=10%*源视频高度。
不填且字幕文件无设置时,默认源视频高度的5%。
*/
FontSize?: number;
/**
* FontSize单位, 0 像素,1百分比,默认为0,像素
*/
FontSizeUnit?: number;
/**
* 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。
*/
FontColor?: string;
/**
* 文字透明度,取值范围:(0, 1]
0:完全透明1:完全不透明默认值:1。
*/
FontAlpha?: number;
/**
* 字幕x轴坐标位置,指定此参数会忽略字幕文件自带坐标;支持像素和百分比格式:
- 像素:Npx,N范围:[-4096,4096]。
- 百分百:N%,N范围:[-100,100];例如10%表示字幕x坐标=10%*源视频宽度。
默认值:0px。
注意:坐标轴原点在源视频中轴线底部,字幕基准点在字幕中轴线底部,参考下图:

*/
PosX?: number;
/**
* PosX单位, 0 像素,1百分比,默认为0,像素
*/
PosXUnit?: number;
/**
* 字幕y轴坐标位置,指定此参数会忽略字幕文件自带坐标;支持像素和百分比格式:
- 像素:Npx,N范围:[0,4096]。
- 百分百:N%,N范围:[0,100];例如10%表示字幕y坐标=10%*源视频高度。
默认值:源视频高度*4%。
注意:坐标轴原点在源视频中轴线底部,字幕基准点在字幕中轴线底部,参考下图:

*/
PosY?: number;
/**
* PosY单位, 0 像素,1百分比,默认为0,像素
*/
PosYUnit?: number;
/**
* 背景配置
*/
SubtitleBoardConfig?: MPSSubtitleBoardConfig;
/**
* 排列配置
*/
SubtitleLayoutConfig?: MPSSubtitleLayoutConfig;
/**
* 文字描边配置
*/
SubtitleOutlineConfig?: MPSSubtitleOutlineConfig;
/**
* 文字阴影配置
*/
SubtitleShadowConfig?: MPSSubtitleShadowConfig;
/**
* 源视频尺寸的宽,单位像素值
*/
SampleWidth?: number;
/**
* 源视频尺寸的高,单位像素值
*/
SampleHeight?: number;
}
/**
* 音频轨道上的音频片段信息。
*/
export interface AudioTrackItem {
/**
* 音频片段的媒体素材来源,可以是:
点播的媒体文件 ID;
其他媒体文件的下载 URL。
注意:当使用其他媒体文件的下载 URL 作为素材来源,且开启了访问控制(如防盗链)时,需要在 URL 携带访问控制参数(如防盗链签名)。
*/
SourceMedia: string;
/**
* 音频片段取自素材文件的起始时间,单位为秒。0 表示从素材开始位置截取。默认为0。
*/
SourceMediaStartTime?: number;
/**
* 音频片段的时长,单位为秒。默认和素材本身长度一致,表示截取全部素材。
*/
Duration?: number;
/**
* 音频片段目标时长,单位为秒。
当 TargetDuration 不填或填0时,表示目标时长和 Duration 一致;
当 TargetDuration 取大于0的值时,将对音频片段做快进或慢放等处理,使得输出片段的时长等于 TargetDuration。
*/
TargetDuration?: number;
/**
* 对音频片段进行的操作,如音量调节等。
*/
AudioOperations?: Array;
}
/**
* 智能精彩片段信息
*/
export interface MediaAiAnalysisHighlightItem {
/**
* 智能精彩集锦地址。
*/
HighlightUrl?: string;
/**
* 智能精彩集锦封面地址。
*/
CovImgUrl?: string;
/**
* 智能精彩集锦的可信度,取值范围是 0 到 100。
*/
Confidence?: number;
/**
* 智能精彩集锦持续时间。
单位:秒
*/
Duration?: number;
/**
* 智能精彩集锦子片段列表,精彩集锦片段由这些子片段拼接生成。
*/
SegmentSet?: Array;
}
/**
* ProcessMediaByProcedure请求参数结构体
*/
export interface ProcessMediaByProcedureRequest {
/**
* 任务流名称。
*/
ProcedureName: string;
/**
* 媒体文件 ID。
FileId和MediaStoragePath必须提供其中一个。
*/
FileId?: string;
/**
* 媒体的存储路径。
只有FileID + Path 模式的子应用可以通过MediaStoragePath发起任务。
FileId和MediaStoragePath必须提供其中一个。
*/
MediaStoragePath?: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 任务流的优先级,数值越大优先级越高,取值范围是-10到10,不填代表0。
*/
TasksPriority?: number;
/**
* 任务流状态变更通知模式,可取值有 Finish,Change 和 None,不填代表 Finish。
*/
TasksNotifyMode?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于去重的识别码,如果 7 天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* DescribeAnimatedGraphicsTemplates请求参数结构体
*/
export interface DescribeAnimatedGraphicsTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 转动图模板唯一标识过滤条件,数组长度限制:100。
*/
Definitions?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
/**
* 模板类型过滤条件,可选值:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
}
/**
* LiveRealTimeClip返回参数结构体
*/
export interface LiveRealTimeClipResponse {
/**
* 剪辑后的视频播放 URL。
*/
Url?: string;
/**
* 剪辑固化后的视频的媒体文件的唯一标识。
*/
FileId?: string;
/**
* 剪辑固化后的视频任务流 ID。
*/
VodTaskId?: string;
/**
* 剪辑后的视频元信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaData?: MediaMetaData;
/**
* 剪辑后的视频片段信息。
*/
SegmentSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音视频审核 Asr 文字鉴违禁任务结果类型
*/
export interface AiReviewTaskProhibitedAsrResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 音视频审核 Asr 文字鉴违禁任务输入。
*/
Input?: AiReviewProhibitedAsrTaskInput;
/**
* 音视频审核 Asr 文字鉴违禁任务输出。
*/
Output?: AiReviewProhibitedAsrTaskOutput;
/**
* 音视频审核 Asr 文字鉴违禁任务进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* 转自适应码流模板详情
*/
export interface AdaptiveDynamicStreamingTemplate {
/**
* 转自适应码流模板唯一标识。
*/
Definition?: number;
/**
* 模板类型,取值范围:
Preset:系统预置模板;Custom:用户自定义模板。
*/
Type?: string;
/**
* 转自适应码流模板名称。
*/
Name?: string;
/**
* 转自适应码流模板描述信息。
*/
Comment?: string;
/**
* 自适应转码格式,取值范围:
HLS。
*/
Format?: string;
/**
* DRM 类型,取值范围:
SimpleAESWidevineFairPlayWidevine+FairPlay如果取值为空字符串,代表不对视频做 DRM 保护。
*/
DrmType?: string;
/**
* DRM 的密钥提供商,取值范围:
SDMC:华曦达;VOD:云点播。默认值为 VOD 。华曦达服务后续逐步下线,请使用VOD DRM加密服务。
*/
DrmKeyProvider?: string;
/**
* DRM的加密类型,取值范围:{"cbcs", "cenc"}
*/
DrmEncryptType?: string;
/**
* 自适应转码输入流参数信息,最多输入10路流。
*/
StreamInfos?: Array;
/**
* 是否禁止视频低码率转高码率,取值范围:
0:否,1:是。
*/
DisableHigherVideoBitrate?: number;
/**
* 是否禁止视频分辨率转高分辨率,取值范围:
0:否,1:是。
*/
DisableHigherVideoResolution?: number;
/**
* 模板创建时间,使用 ISO 日期格式。
*/
CreateTime?: string;
/**
* 模板最后修改时间,使用 ISO 日期格式。
*/
UpdateTime?: string;
/**
* 切片类型。
ts: HLS,内部映射为ts-segment
fmp4: HLS/DASH,HLS情况下内部映射为mp4-mp4-segment,DASH情况下内部映射为mp4-mp4-byterange
ts-segment:HLS+TS 切片
ts-byterange:HLS+TS byte range
mp4-segment:HLS+MP4 切片
mp4-byterange:HLS+MP4 byte range
ts-packed-audio:HLS+TS+Packed Audio 切片
mp4-packed-audio:HLS+MP4+Packed Audio 切片
ts-ts-segment:HLS+TS+TS 切片
ts-ts-byterange:HLS+TS+TS byte range
mp4-mp4-segment:HLS+MP4+MP4 切片
mp4-mp4-byterange:HLS/DASH+MP4+MP4 byte range
ts-packed-audio-byterange:HLS+TS+Packed Audio byte range
mp4-packed-audio-byterange:HLS+MP4+Packed Audio byte range
默认值:ts-segment 注:自适应码流的分片格式以此字段为准。DASH格式下SegmentType只能为mp4-mp4-byterange。
*/
SegmentType?: string;
/**
* 切片平均时长
单位:秒
默认值:6
转自适应码流使用SegmentDuration设置分片时长,而非HlsTime字段.
*/
SegmentDuration?: number;
}
/**
* 语音合成任务输入。
*/
export interface TextToSpeechAsyncInput {
/**
* 音色ID
*/
VoiceId?: string;
/**
* 语音合成文本
*/
Text?: string;
/**
* 语音合成语言
*/
LanguageBoost?: string;
/**
* 扩展参数,json字符串
*/
ExtParam?: string;
}
/**
* DeleteJustInTimeTranscodeTemplate请求参数结构体
*/
export interface DeleteJustInTimeTranscodeTemplateRequest {
/**
* 模板名字。
*/
Name: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* DeleteAnimatedGraphicsTemplate返回参数结构体
*/
export interface DeleteAnimatedGraphicsTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音视频审核 Ocr 文字鉴违禁任务结果类型
*/
export interface AiReviewTaskProhibitedOcrResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 音视频审核 Ocr 文字鉴违禁任务输入。
*/
Input?: AiReviewProhibitedOcrTaskInput;
/**
* 音视频审核 Ocr 文字鉴违禁任务输出。
*/
Output?: AiReviewProhibitedOcrTaskOutput;
/**
* 音视频审核 Ocr 文字鉴违禁任务进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* 语音违禁任务控制参数
*/
export interface ProhibitedAsrReviewTemplateInfo {
/**
* 语音违禁任务开关,可选值:
ON:开启语音违禁任务;
OFF:关闭语音违禁任务。
*/
Switch: string;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* 语音全文识别结果。
*/
export interface AiRecognitionTaskAsrFullTextResultOutput {
/**
* 语音全文识别片段列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet?: Array;
/**
* 语音全文识别片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl?: string;
/**
* 语音全文识别片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime?: string;
/**
* 生成的字幕列表,对应 [语音全文识别任务控制参数](https://cloud.tencent.com/document/api/266/31773#AsrFullTextConfigureInfo) SubtitleFormats。
*/
SubtitleSet?: Array;
/**
* 生成的字幕文件 Url,对应 [语音全文识别任务控制参数](https://cloud.tencent.com/document/api/266/31773#AsrFullTextConfigureInfo) SubtitleFormat。
*/
SubtitleUrl?: string;
}
/**
* Ocr 文字涉违禁信息
*/
export interface AiReviewProhibitedOcrTaskOutput {
/**
* Ocr 文字涉违禁评分,分值为0到100。
*/
Confidence?: number;
/**
* Ocr 文字涉违禁结果建议,取值范围:
pass。
review。
block。
*/
Suggestion?: string;
/**
* Ocr 文字有涉违禁嫌疑的视频片段列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet?: Array;
/**
* Ocr 文字有涉违禁嫌疑的视频片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl?: string;
/**
* Ocr 文字有涉违禁嫌疑的视频片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime?: string;
}
/**
* DescribeAigcFaceInfo请求参数结构体
*/
export interface DescribeAigcFaceInfoRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 需要获取人脸信息的输入视频信息,最多包含一个文件。
*/
FileInfos?: Array;
}
/**
* 视频画面噪点检测的控制参数。
*/
export interface NoiseConfigureInfo {
/**
* 视频画面噪点检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
}
/**
* DescribeAigcFaceInfoAsync返回参数结构体
*/
export interface DescribeAigcFaceInfoAsyncResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ManageTask返回参数结构体
*/
export interface ManageTaskResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateImageProcessingTemplate请求参数结构体
*/
export interface CreateImageProcessingTemplateRequest {
/**
* 图片处理操作数组,操作将以其在数组中的顺序执行。
长度限制:10。
*/
Operations: Array;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 图片处理模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
}
/**
* ModifyDefaultStorageRegion请求参数结构体
*/
export interface ModifyDefaultStorageRegionRequest {
/**
* 默认的存储地域,必须是已经开通的地域(通过 DescribeStorageRegions 接口查询)。
*/
StorageRegion: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* ModifyEventConfig返回参数结构体
*/
export interface ModifyEventConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteLLMComprehendTemplate请求参数结构体
*/
export interface DeleteLLMComprehendTemplateRequest {
/**
* 大模型理解模板的唯一标识
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* AIGC 混元 3D 任务的输出媒体文件配置。
*/
export interface AigcHunyuan3DOutputConfig {
/**
* 存储模式。取值有:
Temporary:临时存储;默认值:Temporary
*/
StorageMode?: string;
}
/**
* 音画质检测任务的输出。
*/
export interface QualityInspectTaskOutput {
/**
* 媒体文件是否无音频轨,取值范围:
0:否,即有音频轨;1:是,即无音频轨。
*/
NoAudio?: number;
/**
* 媒体文件是否无视频轨,取值范围:
0:否,即有视频轨;1:是,即无视频轨。
*/
NoVideo?: number;
/**
* 视频画面质量评分,取值范围:[0, 100]。
*/
QualityEvaluationScore?: number;
/**
* 音画质检测出的异常项列表。
*/
QualityInspectResultSet?: Array;
/**
* 视频无参考质量评分,MOS分数。
*/
QualityEvaluationMeanOpinionScore?: number;
/**
* 视频美学评分,范围:[0,100]。
*/
AestheticEvaluationScore?: number;
/**
* 格式诊断检出异常项。
*/
ContainerDiagnoseResultSet?: Array;
/**
* LLM 大模型 AIGC 质量检测结果。
*/
LLMDetectionReport?: QualityInspectLLMDetectionReport;
}
/**
* 音画质重生任务的输入。
*/
export interface QualityEnhanceTaskInput {
/**
* 媒体文件 ID。
*/
FileId?: string;
/**
* 音画质重生模板 ID。
*/
Definition?: number;
}
/**
* 语音合成任务输出。
*/
export interface TextToSpeechAsyncOutput {
/**
* 合成音频结果URL
*/
AudioUrl?: string;
/**
* 使用的音色ID
*/
VoiceId?: string;
/**
* 扩展信息
*/
ExtInfo?: string;
/**
* 合成音频结果FileId
*/
FileId?: string;
}
/**
* CreateAigcAdvancedCustomElement请求参数结构体
*/
export interface CreateAigcAdvancedCustomElementRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 主体名称,不能超过20个字符。
*/
ElementName?: string;
/**
* 主体描述,不能超过100个字符。
*/
ElementDescription?: string;
/**
* 主体参考方式。通过视频定制的主体和通过图片定制的主体的可用范围不同。
枚举值:
- video_refer: 视频角色主体,此时将参考element_video_list定义主体外表。
- image_refer: 多图主体,此时将参考element_image_list定义主体外表。
*/
ReferenceType?: string;
/**
* 主体音色,可绑定音色库中已有音色。
- 当前参数为空时,当前主体不绑定音色。
- 仅视频定制的主体支持绑定音色。
*/
ElementVoiceId?: string;
/**
* 主体参考视频,可通过视频设定主体及其细节。
*/
ElementVideoList?: string;
/**
* 主体参考图,可通过多张图片设定主体及其细节。
- 包括正面参考图和其他角度或特写参考图,其中:
- 至少包括1张正面参考图,由frontal_image参数定义。
- 需包括1~3张其他参考图,需与正面参考图有差异,由image_url参数定义。
- 用key:value承载,如下:
{ "frontal_image":"image_url_0", "refer_images":[ { "image_url":"image_url_1" }, { "image_url":"image_url_2" }, { "image_url":"image_url_3" } ]}
*/
ElementImageList?: string;
/**
* 为主体配置标签,一个主体可以配置多个标签。
[ { "tag_id": "o_101" }, { "tag_id": "o_102" }]
*/
TagList?: string;
/**
* 若已开通海外自定义主体库,可传入True使用海外自定义主体库。
枚举值:
- True: 使用海外自定义主体库。
- False: 不使用海外自定义主体库。
*/
DisableModeration?: string;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
}
/**
* 人脸识别的媒体信息
*/
export interface FaceRecognitionInfo {
/**
* 人脸识别任务列表
*/
FaceRecognitionTasks?: Array;
}
/**
* 画质重生目标参数
*/
export interface RebuildMediaTargetInfo {
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。
*/
MediaName?: string;
/**
* 描述信息,最长 128 个字符。缺省描述信息为空。
*/
Description?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 [创建分类](/document/product/266/7812) 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ExpireTime?: string;
/**
* 输出文件封装格式,可选值:mp4、flv、hls。默认mp4。
*/
Container?: string;
/**
* 输出的视频信息。
*/
VideoStream?: RebuildMediaTargetVideoStream;
/**
* 输出的音频信息。
*/
AudioStream?: RebuildMediaTargetAudioStream;
/**
* 是否去除视频数据,可选值:
0:保留
1:去除
默认值:0。
*/
RemoveVideo?: number;
/**
* 是否去除音频数据,可选值:
0:保留
1:去除
默认值:0。
*/
RemoveAudio?: number;
}
/**
* ModifySampleSnapshotTemplate请求参数结构体
*/
export interface ModifySampleSnapshotTemplateRequest {
/**
* 采样截图模板唯一标识。
*/
Definition: number;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 采样截图模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 截图宽度(或长边)的最大值,取值范围:0 和 [32, 4096],单位:px。
当 Width、Height 均为 0,则分辨率同源;当 Width 为 0,Height 非 0,则 Width 按比例缩放;当 Width 非 0,Height 为 0,则 Height 按比例缩放;当 Width、Height 均非 0,则分辨率按用户指定。默认值:0。
*/
Width?: number;
/**
* 截图高度(或短边)的最大值,取值范围:0 和 [32, 4096],单位:px。
当 Width、Height 均为 0,则分辨率同源;当 Width 为 0,Height 非 0,则 Width 按比例缩放;当 Width 非 0,Height 为 0,则 Height 按比例缩放;当 Width、Height 均非 0,则分辨率按用户指定。默认值:0。
*/
Height?: number;
/**
* 分辨率自适应,可选值:
open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。默认值:open。
*/
ResolutionAdaptive?: string;
/**
* 采样截图类型,取值:
Percent:按百分比。Time:按时间间隔。
*/
SampleType?: string;
/**
* 采样间隔。
当 SampleType 为 Percent 时,指定采样间隔的百分比。当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。
*/
SampleInterval?: number;
/**
* 图片格式,取值为 jpg、png 和 webp。默认为 jpg。
*/
Format?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊。默认值:black 。
*/
FillType?: string;
}
/**
* 音视频审核 Ocr 文字涉及令人不适宜信息的任务输入参数类型
*/
export interface AiReviewPoliticalOcrTaskInput {
/**
* 鉴别涉及令人不适宜信息的模板 ID。
*/
Definition?: number;
}
/**
* ModifyJustInTimeTranscodeTemplate请求参数结构体
*/
export interface ModifyJustInTimeTranscodeTemplateRequest {
/**
* 模板名字。
*/
Name: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 视频参数配置。
*/
VideoConfigure?: VideoConfigureInfoForUpdate;
/**
* 水印参数配置。
*/
WatermarkConfigure?: WatermarkConfigureInfoForUpdate;
/**
* 模板描述,长度限制256个字符。
*/
Comment?: string;
}
/**
* DescribePrepaidProducts请求参数结构体
*/
export type DescribePrepaidProductsRequest = null;
/**
* ManageTask请求参数结构体
*/
export interface ManageTaskRequest {
/**
* 视频处理的任务 ID。
*/
TaskId: string;
/**
* 操作类型,取值范围:
Abort:终止任务。只能终止已发起且状态为等待中(WAITING)的任务。
*/
OperationType: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 音视频增强配置
*/
export interface EnhanceConfig {
/**
* 视频增强配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
VideoEnhance?: VideoEnhanceConfig;
/**
* 音频增强配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
AudioEnhance?: AudioEnhanceConfig;
}
/**
* 要处理的源视频信息,视频名称、视频自定义 ID。
*/
export interface MediaInputInfo {
/**
* 视频 URL。
*/
Url: string;
/**
* 视频名称。
*/
Name?: string;
/**
* 视频自定义 ID。
*/
Id?: string;
}
/**
* MPS压制字幕模板
*/
export interface MPSEmbedSubtitleTemplate {
/**
* 字幕压制模板名称
长度限制:64 个字符。
*/
Name?: string;
/**
* 字幕压制模板描述信息
长度限制:256 个字符。
*/
Comment?: string;
/**
* 字幕压制相关配置
*/
SubtitleEmbedConfig?: MPSSubtitleEmbedConfig;
}
/**
* 视频截取雪碧图任务,该结构仅用于对 2017 版[截取雪碧图](https://cloud.tencent.com/document/product/266/8101)接口发起的任务。
*/
export interface CreateImageSpriteTask2017 {
/**
* 截图雪碧图任务 ID。
*/
TaskId?: string;
/**
* 错误码
0:成功;
其他值:失败。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 截取雪碧图文件 ID。
*/
FileId?: string;
/**
* 雪碧图规格,参见[雪碧图截图模板](https://cloud.tencent.com/document/product/266/33480#.E9.9B.AA.E7.A2.A7.E5.9B.BE.E6.A8.A1.E6.9D.BF)。
*/
Definition?: number;
/**
* 雪碧图小图总数量。
*/
TotalCount?: number;
/**
* 截取雪碧图输出的地址。
*/
ImageSpriteUrlSet?: Array;
/**
* 雪碧图子图位置与时间关系 WebVtt 文件地址。
*/
WebVttUrl?: string;
}
/**
* DescribeImageReviewUsageData返回参数结构体
*/
export interface DescribeImageReviewUsageDataResponse {
/**
* 图片审核次数统计数据,展示查询时间范围内的图片审核次数的概览数据。
*/
ImageReviewUsageDataSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 临时凭证
*/
export interface TempCertificate {
/**
* 临时安全证书 Id。
*/
SecretId?: string;
/**
* 临时安全证书 Key。
*/
SecretKey?: string;
/**
* Token 值。
*/
Token?: string;
/**
* 证书无效的时间,返回 Unix 时间戳,精确到秒。
*/
ExpiredTime?: number;
}
/**
* RebuildMedia请求参数结构体
*/
export interface RebuildMediaRequest {
/**
* 媒体文件 ID。
*/
FileId: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 起始偏移时间,单位:秒,不填表示从视频开始截取。
*/
StartTimeOffset?: number;
/**
* 结束偏移时间,单位:秒,不填表示截取到视频末尾。
*/
EndTimeOffset?: number;
/**
* 画质修复控制参数。
*/
RepairInfo?: RepairInfo;
/**
* 智能插帧控制参数。
*/
VideoFrameInterpolationInfo?: VideoFrameInterpolationInfo;
/**
* 画面超分控制参数。
*/
SuperResolutionInfo?: SuperResolutionInfo;
/**
* 高动态范围类型控制参数。
*/
HDRInfo?: HDRInfo;
/**
* 视频降噪控制参数。
*/
VideoDenoiseInfo?: VideoDenoiseInfo;
/**
* 音频降噪控制参数。
*/
AudioDenoiseInfo?: AudioDenoiseInfo;
/**
* 色彩增强控制参数。
*/
ColorInfo?: ColorEnhanceInfo;
/**
* 细节增强控制参数。
*/
SharpInfo?: SharpEnhanceInfo;
/**
* 人脸增强控制参数。
*/
FaceInfo?: FaceEnhanceInfo;
/**
* 低光照控制参数。
*/
LowLightInfo?: LowLightEnhanceInfo;
/**
* 去划痕控制参数。
*/
ScratchRepairInfo?: ScratchRepairInfo;
/**
* 去伪影(毛刺)控制参数。
*/
ArtifactRepairInfo?: ArtifactRepairInfo;
/**
* 音画质重生输出目标参数。
*/
TargetInfo?: RebuildMediaTargetInfo;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* 智能擦除模板去水印配置
*/
export interface MPSSmartEraseWatermarkConfig {
/**
* 水印擦除方式。 自动擦除:通过A模型自动识别视频中的水印,擦除后生成新的视频。适用于动态水印。 当使用自动擦除时,若您不指定AutoAreas,将对视频全屏进行自动擦除;若指定AutoAreas,将改为对您指定的区域进行自动擦除。 指定区域擦除:针对位置较固定的静态水印,建议您直接指定擦除区域。 当您选择指定区域擦除时,请至少传入一个指定区域。 - auto 自动擦除 - custom 指定区域擦除
*/
WatermarkEraseMethod: string;
/**
* 水印擦除模型。 基础版:效果一般,性价比高,适合动画或背景较干净的视频。 高级版:效果更好,适合短剧等现实风格视频。 - basic 基础版 - advanced 高级版
*/
WatermarkModel: string;
/**
* 自动擦除自定义区域。 对选定区域,利用AI模型自动检测其中存在的擦除目标并擦除。 注意,当擦除方式为custom时,此参数将不会生效。清除区域请传入[],不传时将保持模板区域信息不变。
*/
AutoAreas?: Array;
/**
* 指定擦除自定义区域。 对选定区域,在选定时间段内不进行检测识别直接进行擦除。 注意:清除区域请传入[],不传时将保持模板区域信息不变。
*/
CustomAreas?: Array;
}
/**
* 大模型解析分段摘要解析配置
*/
export interface LLMComprehendSummary {
/**
* 分段摘要任务开关,可选值:
- ON:开启分段摘要任务;
- OFF:关闭分段摘要任
*/
Switch: string;
/**
* 扩展参数,其值为序列化的 json字符串。可参考[扩展参数说明](/document/product/862/104493#note)
*/
ExtendedParameter?: string;
}
/**
* DescribeDefaultDistributionConfig请求参数结构体
*/
export interface DescribeDefaultDistributionConfigRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 音视频审核 Ocr 文字涉及令人不适宜信息、违规任务结果类型
*/
export interface AiReviewTaskPoliticalOcrResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 音视频审核 Ocr 文字涉及令人不适宜信息的任务输入。
*/
Input?: AiReviewPoliticalOcrTaskInput;
/**
* 音视频审核 Ocr 文字涉及令人不适宜信息的任务输出。
*/
Output?: AiReviewPoliticalOcrTaskOutput;
/**
* 音视频审核 Ocr 文字涉及令人不适宜信息的任务进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* 视频配音任务输入。
*/
export interface VideoDubbingAsyncInput {
/**
* 输入视频Url
*/
InputUrl?: string;
/**
* 输入视频FileId
*/
InputFileId?: string;
/**
* 视频源语言,默认zh
*/
SrcLanguage?: string;
/**
* 视频目标语言,默认en
*/
DstLanguage?: string;
/**
* 配音模型
*/
Model?: string;
}
/**
* 音画质重生任务
*/
export interface QualityEnhanceTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务流状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 错误码,0 表示成功,其他值表示失败:
40000:输入参数不合法,请检查输入参数;
60000:源文件错误(如视频数据损坏),请确认源文件是否正常;
70000:内部服务错误,建议重试。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 音画质重生任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 音画质重生任务的输入。
*/
Input?: QualityEnhanceTaskInput;
/**
* 音画质重生任务的输出。
*/
Output?: QualityEnhanceTaskOutput;
/**
* 音画质重生输出视频的元信息。
*/
MetaData?: MediaMetaData;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* AI 样本管理,关键词输出信息。
*/
export interface AiSampleWord {
/**
* 关键词。
*/
Keyword?: string;
/**
* 关键词标签。
*/
TagSet?: Array;
/**
* 关键词应用场景。
*/
UsageSet?: Array;
/**
* 创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
/**
* 最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
UpdateTime?: string;
}
/**
* 自定义视频转码参数。
*/
export interface OverrideTranscodeParameter {
/**
* 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a、wav。其中,mp3、flac、ogg、m4a、wav 为纯音频文件。
*/
Container?: string;
/**
* 是否去除视频数据,取值:
0:保留;<\li>
1:去除。<\li>
*/
RemoveVideo?: number;
/**
* 是否去除音频数据,取值:
0:保留;<\li>
1:去除。<\li>
*/
RemoveAudio?: number;
/**
* 视频流配置参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
VideoTemplate?: VideoTemplateInfoForUpdate;
/**
* 音频流配置参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
AudioTemplate?: AudioTemplateInfoForUpdate;
/**
* 极速高清转码配置参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
TEHDConfig?: TEHDConfigForUpdate;
}
/**
* 文本鉴别涉及令人不适宜的信息的任务控制参数
*/
export interface PoliticalOcrReviewTemplateInfo {
/**
* 文本鉴别涉及令人不适宜的信息的任务开关,可选值:
ON:开启文本鉴别涉及令人不适宜的信息的任务;
OFF:关闭文本鉴别涉及令人不适宜的信息的任务。
*/
Switch: string;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* CreateImageSpriteTemplate请求参数结构体
*/
export interface CreateImageSpriteTemplateRequest {
/**
* 采样类型,取值:
Percent:按百分比。
Time:按时间间隔。
*/
SampleType: string;
/**
* 采样间隔。
当 SampleType 为 Percent 时,指定采样间隔的百分比。
当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。
*/
SampleInterval: number;
/**
* 雪碧图中小图的行数。
注意:小图的行数会影响最终大图的高度,大图的高度最大为15000像素,其中大图的高度为小图行数与小图高度的乘积。
*/
RowCount: number;
/**
* 雪碧图中小图的列数。
注意:小图的列数会影响最终大图的宽度,大图的宽度最大为15000像素,其中大图的宽度为小图列数与小图宽度的乘积。
*/
ColumnCount: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 雪碧图模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁”或者“拉长”;black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。默认值:black 。
*/
FillType?: string;
/**
* 雪碧图中小图的宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。当 Width、Height 均为 0,则分辨率同源;当 Width 为 0,Height 非 0,则 Width 按比例缩放;当 Width 非 0,Height 为 0,则 Height 按比例缩放;当 Width、Height 均非 0,则分辨率按用户指定。默认值:0。注意:小图的宽度会影响最终大图的宽度,大图的宽度最大为15000像素,其中大图的宽度为小图列数与小图宽度的乘积。
*/
Width?: number;
/**
* 雪碧图中小图的高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。当 Width、Height 均为 0,则分辨率同源;当 Width 为 0,Height 非 0,则 Width 按比例缩放;当 Width 非 0,Height 为 0,则 Height 按比例缩放;当 Width、Height 均非 0,则分辨率按用户指定。默认值:0。注意:小图的高度会影响最终大图的高度,大图的高度最大为15000像素,其中大图的高度为小图行数与小图高度的乘积。
*/
Height?: number;
/**
* 分辨率自适应,可选值:
open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。
默认值:open。
*/
ResolutionAdaptive?: string;
/**
* 图片格式,取值:
jpg:jpg 格式;
png:png 格式;
webp:webp 格式。
默认值:jpg。
*/
Format?: string;
}
/**
* 参考音频信息。
*/
export interface AigcAudioReferenceAudioInfo {
/**
* 可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。说明:1. 推荐使用小于7M的图片;2. 图片格式的取值为:jpeg,jpg, png, webp。
*/
Type?: string;
/**
* 音频文件的媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。当 Type 取值为 File 时,本参数有效。
*/
FileId?: string;
/**
* 音频文件 URL,需要外网可访问。当 Type 取值为 Url 时,本参数有效。
*/
Url?: string;
}
/**
* 指定时间点截图信息
*/
export interface MediaSnapshotByTimePicInfoItem {
/**
* 该张截图对应视频文件中的时间偏移,单位为毫秒。
*/
TimeOffset?: number;
/**
* 该张截图的 URL 地址。
*/
Url?: string;
/**
* 截图如果被打上了水印,被打水印的模板 ID 列表。
*/
WaterMarkDefinition?: Array;
}
/**
* DeleteProcessImageAsyncTemplate返回参数结构体
*/
export interface DeleteProcessImageAsyncTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用户自定义人物音视频审核任务控制参数
*/
export interface UserDefineFaceReviewTemplateInfo {
/**
* 用户自定义人物音视频审核任务开关,可选值:
ON:开启自定义人物音视频审核任务;
OFF:关闭自定义人物音视频审核任务。
*/
Switch: string;
/**
* 用户自定义人物过滤标签,音视频审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义人物库的时,需要添加对应人物标签。
标签个数最多 10 个,每个标签长度最多 16 个字符。
*/
LabelSet?: Array;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 97 分。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 95 分。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* RefreshUrlCache请求参数结构体
*/
export interface RefreshUrlCacheRequest {
/**
* 刷新的 URL 列表,单次最多指定20个 URL。
*/
Urls: Array;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* AIGC场景化生图任务输入文件信息
*/
export interface SceneAigcVideoTaskInputFileInfo {
/**
* 输入的视频文件类型。取值有: File:点播媒体文件; Url:可访问的 URL;
*/
Type?: string;
/**
* 图片文件的媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 [视频上传完成事件通知](/document/product/266/7830) 或 [云点播控制台](https://console.cloud.tencent.com/vod/media) 获取该字段。当 Type 取值为 File 时,本参数有效。
说明:
1. 推荐使用小于7M的图片;
2. 图片格式的取值为:jpeg,jpg, png, webp。
*/
FileId?: string;
/**
* 可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。
说明:
1. 推荐使用小于7M的图片;
2. 图片格式的取值为:jpeg,jpg, png, webp。
*/
Url?: string;
}
/**
* 人脸识别任务控制参数
*/
export interface FaceConfigureInfoForUpdate {
/**
* 人脸识别任务开关,可选值:
ON:开启智能人脸识别任务;
OFF:关闭智能人脸识别任务。
*/
Switch?: string;
/**
* 人脸识别过滤分数,当识别结果达到该分数以上,返回识别结果。取值范围:0-100。
*/
Score?: number;
/**
* 默认人物过滤标签,指定需要返回的默认人物的标签。如果未填或者为空,则全部默认人物结果都返回。标签可选值:
entertainment:娱乐明星;
sport:体育明星;
politician:相关人物。
*/
DefaultLibraryLabelSet?: Array;
/**
* 用户自定义人物过滤标签,指定需要返回的用户自定义人物的标签。如果未填或者为空,则全部自定义人物结果都返回。
标签个数最多 100 个,每个标签长度最多 16 个字符。
*/
UserDefineLibraryLabelSet?: Array;
/**
* 人物库选择,可选值:
Default:使用默认人物库;
UserDefine:使用用户自定义人物库。
All:同时使用默认人物库和用户自定义人物库。
*/
FaceLibrary?: string;
}
/**
* DescribeAIAnalysisTemplates请求参数结构体
*/
export interface DescribeAIAnalysisTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 音视频内容分析模板唯一标识过滤条件,数组长度最大值:100。
*/
Definitions?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
}
/**
* 音视频审核模板详情
*/
export interface ContentReviewTemplateItem {
/**
* 音视频审核模板唯一标识。
*/
Definition?: number;
/**
* 音视频审核模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 音视频审核模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 鉴别涉及令人反感的信息的控制参数。
*/
PornConfigure?: PornConfigureInfo;
/**
* 鉴别涉及令人不安全的信息的控制参数。
*/
TerrorismConfigure?: TerrorismConfigureInfo;
/**
* 鉴别涉及令人不适宜的信息的控制参数。
*/
PoliticalConfigure?: PoliticalConfigureInfo;
/**
* 违禁控制参数。违禁内容包括:
谩骂;
涉毒违法。
*/
ProhibitedConfigure?: ProhibitedConfigureInfo;
/**
* 用户自定义音视频审核控制参数。
*/
UserDefineConfigure?: UserDefineConfigureInfo;
/**
* 音视频审核结果是否进入音视频审核墙(对音视频审核结果进行人工复核)的开关。
ON:是;
OFF:否。
*/
ReviewWallSwitch?: string;
/**
* 截帧间隔,单位为秒。当不填时,默认截帧间隔为 1 秒,最小值为 0.5 秒。
*/
ScreenshotInterval?: number;
/**
* 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
/**
* 模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
UpdateTime?: string;
}
/**
* AIGC 生图任务的输出文件信息。
*/
export interface AigcImageTaskOutputFileInfo {
/**
* 存储模式。取值有:
Permanent:永久存储; Temporary:临时存储;
*/
StorageMode?: string;
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。当 StorageMode 为 Permanent 时有效。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。当 StorageMode 为 Permanent 时有效。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
ExpireTime?: string;
/**
* 文件类型,例如 png、jpg 等。
*/
FileType?: string;
/**
* 媒体文件播放地址。
*/
FileUrl?: string;
/**
* 媒体文件 ID。当 StorageMode 为 Permanent 时有效。
*/
FileId?: string;
/**
* 输出图片的元信息。
*/
MetaData?: MediaMetaData;
}
/**
* 任务概要信息
*/
export interface TaskSimpleInfo {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态。取值:WAITING(等待中)、PROCESSING(处理中)、FINISH(已完成)、ABORTED(已终止)。
*/
Status?: string;
/**
* 视频 ID。
*/
FileId?: string;
/**
* 任务类型,取值:
Procedure:视频处理任务;
EditMedia:视频编辑任务;
ReduceMediaBitrate:降码率任务;
WechatDistribute:微信发布任务;
ReviewAudioVideo:音视频审核任务。
兼容 2017 版的任务类型:
Transcode:视频转码任务;
SnapshotByTimeOffset:视频截图任务;
Concat:视频拼接任务;
Clip:视频剪辑任务;
ImageSprites:截取雪碧图任务。
*/
TaskType?: string;
/**
* 任务创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
/**
* 任务开始执行时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。若任务尚未开始,该字段为空。
*/
BeginProcessTime?: string;
/**
* 任务结束时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。若任务尚未完成,该字段为空。
*/
FinishTime?: string;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息。
*/
SessionContext?: string;
}
/**
* DeleteAIRecognitionTemplate返回参数结构体
*/
export interface DeleteAIRecognitionTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频增强配置。
*/
export interface VideoEnhanceConfig {
/**
* 增强场景配置,可选值:
common(通用),通用增强参数,适用于各种视频类型的基础优化参数,提升整体画质。
AIGC,整体分辨率提升,利用AI技术提升视频整体分辨率,增强画面清晰度。
short_play(短剧),增强面部与字幕细节,突出人物面部表情细节和字幕清晰度,提升观剧体验。
short_video(短视频),优化复杂多样的画质问题,针对短视频的复杂场景,优化画质,解决多种视觉问题。
game(游戏视频),修复运动模糊,提升细节,重点提升游戏细节清晰度,恢复运动模糊区域,使游戏画面内容更清晰,更丰富。
HD_movie_series(超高清影视剧),获得超高清流畅效果,针对广电/OTT超高清视频的诉求,生成4K 60fps HDR的超高清标准视频。支持广电场景格式标准要求。
LQ_material(低清素材/老片修复),整体分辨率提升,针对老旧视频由于拍摄年代较久存在的分辨率不足、模糊失真、划痕损伤和色温等问题进行专门优化。
lecture(秀场/电商/大会/讲座),美化提升面部效果,针对秀场/电商/大会/讲座等存在人物进行讲解的场景,进行人脸区域、噪声消除、毛刺处理的专门优化。
填空字符串代表不使用增强场景
*/
EnhanceScenarioType?: string;
/**
* 超分配置。源分辨率高于目标分辨率时不对视频做处理。注意与大模型增强不可同时开启。
注意:此字段可能返回 null,表示取不到有效值。
*/
SuperResolution?: SuperResolutionInfo;
/**
* HDR配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
Hdr?: HDRInfo;
/**
* 视频降噪配置。注意与大模型增强不可同时开启。
注意:此字段可能返回 null,表示取不到有效值。
*/
Denoise?: VideoDenoiseInfo;
/**
* 综合增强配置。注意大模型、综合增强、去毛刺三项里最多配置一项
注意:此字段可能返回 null,表示取不到有效值。
*/
ImageQualityEnhance?: ImageQualityEnhanceInfo;
/**
* 色彩增强配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
ColorEnhance?: ColorEnhanceInfo;
/**
* 低光照增强配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
LowLightEnhance?: LowLightEnhanceInfo;
/**
* 去划痕配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
ScratchRepair?: ScratchRepairInfo;
/**
* 去伪影(毛刺)配置。注意大模型、综合增强、去毛刺三项里最多配置一项。
注意:此字段可能返回 null,表示取不到有效值。
*/
ArtifactRepair?: ArtifactRepairInfo;
/**
* 大模型增强配置。注意大模型、综合增强、去毛刺三项里最多配置一项。且不可与超分、降噪同时开启。
注意:此字段可能返回 null,表示取不到有效值。
*/
DiffusionEnhance?: DiffusionEnhanceInfo;
/**
* 插帧帧率配置,支持分数。注意与FrameRate二选一。源帧率大于等于目标帧率时能力不会生效。
注意:此字段可能返回 null,表示取不到有效值。
*/
FrameRateWithDen?: FrameRateWithDenInfo;
}
/**
* DeleteContentReviewTemplate请求参数结构体
*/
export interface DeleteContentReviewTemplateRequest {
/**
* 内容审核模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* CreateAigcSubject返回参数结构体
*/
export interface CreateAigcSubjectResponse {
/**
* 任务ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音视频审核涉及令人不适宜信息的任务输入参数类型
*/
export interface AiReviewPoliticalTaskInput {
/**
* 鉴别涉及令人不适宜信息的模板 ID。
*/
Definition?: number;
}
/**
* VerifyDomainRecord返回参数结构体
*/
export interface VerifyDomainRecordResponse {
/**
* 是否验证成功。
*/
Result?: boolean;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音频操作
*/
export interface AudioTransform {
/**
* 音频操作类型,取值有:
Volume:音量调节。
*/
Type: string;
/**
* 音量调节参数, 当 Type = Volume 时有效。
*/
VolumeParam?: AudioVolumeParam;
}
/**
* 视频转码任务信息,该结构仅用于对 2017 版[视频转码](https://cloud.tencent.com/document/product/266/7822)接口发起的任务。
*/
export interface TranscodeTask2017 {
/**
* 转码任务 ID。
*/
TaskId?: string;
/**
* 错误码
0:成功;
其他值:失败。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 被转码文件 ID。
*/
FileId?: string;
/**
* 被转码文件名称。
*/
FileName?: string;
/**
* 视频时长,单位:秒。
*/
Duration?: number;
/**
* 封面地址。
*/
CoverUrl?: string;
/**
* 视频转码后生成的播放信息。
*/
PlayInfoSet?: Array;
}
/**
* DescribeCurrentPlaylist返回参数结构体
*/
export interface DescribeCurrentPlaylistResponse {
/**
* 当前播放列表信息。
*/
CurrentPlaylist?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySuperPlayerConfig请求参数结构体
*/
export interface ModifySuperPlayerConfigRequest {
/**
* 播放器配置名称。
*/
Name: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 播放的音视频类型,可选值:
AdaptiveDynamicStream:自适应码流输出;
Transcode:转码输出;
Original:原始音视频。
*/
AudioVideoType?: string;
/**
* 播放 DRM 保护的自适应码流开关:
ON:开启,表示仅播放 DRM 保护的自适应码流输出;
OFF:关闭,表示播放未加密的自适应码流输出。
*/
DrmSwitch?: string;
/**
* 允许输出的未加密的自适应码流模板 ID。
*/
AdaptiveDynamicStreamingDefinition?: number;
/**
* 允许输出的 DRM 自适应码流模板内容。
*/
DrmStreamingsInfo?: DrmStreamingsInfoForUpdate;
/**
* 允许输出的转码模板 ID。
*/
TranscodeDefinition?: number;
/**
* 允许输出的雪碧图模板 ID。
*/
ImageSpriteDefinition?: number;
/**
* 播放器对于不同分辨率的子流展示名字。
*/
ResolutionNames?: Array;
/**
* 播放时使用的域名。填 Default 表示使用[默认分发配置](https://cloud.tencent.com/document/product/266/33373)中的域名。
*/
Domain?: string;
/**
* 播放时使用的 Scheme。取值范围:
Default:使用[默认分发配置](https://cloud.tencent.com/document/product/266/33373)中的 Scheme;
HTTP;
HTTPS。
*/
Scheme?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
}
/**
* ResetProcedureTemplate请求参数结构体
*/
export interface ResetProcedureTemplateRequest {
/**
* 任务流名字
*/
Name: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 视频处理类型任务参数。
*/
MediaProcessTask?: MediaProcessTaskInput;
/**
* AI 智能内容审核类型任务参数 *。
*:该参数用于发起旧版审核,不建议使用。推荐使用 ReviewAudioVideoTask 参数发起审核。
*/
AiContentReviewTask?: AiContentReviewTaskInput;
/**
* AI 智能内容分析类型任务参数。
*/
AiAnalysisTask?: AiAnalysisTaskInput;
/**
* AI 内容识别类型任务参数。
*/
AiRecognitionTaskSet?: Array;
/**
* 该参数已不推荐使用,建议使用 AiRecognitionTaskSet。
* @deprecated
*/
AiRecognitionTask?: AiRecognitionTaskInput;
/**
* 音视频审核类型任务参数。
*/
ReviewAudioVideoTask?: ProcedureReviewAudioVideoTaskInput;
/**
* 导入智能媒资知识库任务参数。
*/
ImportMediaKnowledgeTaskSet?: Array;
}
/**
* 图片Ocr 文字鉴别信息的任务结果类型
*/
export interface ContentReviewOcrResult {
/**
* Ocr 文字鉴别结果的评分,分值为0到100。
*/
Confidence?: number;
/**
* Ocr 文字鉴别的结果建议,取值范围:
pass;
review;
block。
*/
Suggestion?: string;
/**
* Ocr 文字鉴别的嫌疑关键词列表。
*/
KeywordSet?: Array;
/**
* Ocr 文字鉴别的嫌疑文字出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
*/
AreaCoordSet?: Array;
}
/**
* ComposeMedia返回参数结构体
*/
export interface ComposeMediaResponse {
/**
* 制作媒体文件的任务 ID,可以通过该 ID 查询制作任务(任务类型为 MakeMedia)的状态。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音色设计任务。
*/
export interface VideoDubbingAsyncTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码,0 表示成功,其他值表示失败:
40000:输入参数不合法,请检查输入参数;60000:源文件错误(如视频数据损坏),请确认源文件是否正常;70000:内部服务错误,建议重试。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 视频处理类错误码 列表。
*/
ErrCodeExt?: string;
/**
* 视频配音任务输入信息。
*/
Input?: VideoDubbingAsyncInput;
/**
* 视频配音任务输出信息。
*/
Output?: VideoDubbingAsyncOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 拉取上传进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* 轮播任务信息
*/
export interface RoundPlayInfo {
/**
* 轮播播单标识。
*/
RoundPlayId?: string;
/**
* 启播时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。
*/
StartTime?: string;
/**
* 轮播列表。
*/
RoundPlaylist?: Array;
/**
* 轮播播单名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 轮播播单描述信息,长度限制:256 个字符。
*/
Desc?: string;
/**
* 播放状态,可选值:
Enabled:启动状态;
Disabled:停止状态。
默认值:Enabled。
*/
Status?: string;
/**
* 播放模式,可选值:
Loop:循环播放播单;
Linear:单次播放,播单播放完停止播放。
默认值:Loop。
*/
PlayBackMode?: string;
/**
* 轮播播放地址。
*/
Url?: string;
/**
* 创建时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。
*/
CreateTime?: string;
/**
* 更新时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。
*/
UpdateTime?: string;
/**
* 过期时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52),过期后将停止播单的播放。“9999-12-31T23:59:59+08:00”表示永不过期。
*/
ExpiredTime?: string;
}
/**
* CloneVoiceSync请求参数结构体
*/
export interface CloneVoiceSyncRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: string;
/**
* 克隆音频base64编码。
*/
AudioData?: string;
/**
* 克隆音频Url,AudioData为空时有效
*/
AudioUrl?: string;
/**
* 克隆文件FileID,AudioData及AudioUrl为空时有效
*/
AudioFileId?: string;
/**
* 语言增强,如 "zh" "en" "auto",默认 "auto"
*/
LanguageBoost?: string;
/**
* 同步音色克隆拓展参数。ExtParam 支持的字段:
text (string):试听合成文本,最大 1000 字符;非空时必须同时传 tts_model,克隆成功后返回试听音频 DemoAudio。 model (string):克隆模型,缺省 minimax-voice-clone。 tts_model (string):合成试听音频用的模型,可选 minimax-speech-2.8-hd、minimax-speech-2.8-turbo、minimax-speech-2.6-hd、minimax-speech-2.6-turbo、minimax-speech-02-hd、minimax-speech-02-turbo;text 非空时必填。 text_lang (string):试听文本语言。 voice_profile (object):音色画像,可选字段: name (string):音色名称。 description (string):音色描述。 gender (string):性别,可选 male / female / unknown。 age (string):年龄段,可选 child / teenager / youth / middle_aged / senior / unknown。 languages (string[]):支持语言,如 ["zh", "en"]。 labels (string[]):音色标签,如 ["磁性"]。 scenes (string[]):适用场景,如 ["解说"]。
*/
ExtParam?: string;
}
/**
* 人脸身份信息。
*/
export interface AigcFaceIdentityInfo {
/**
* 视频中的人脸 ID。同一个人脸在视频中间隔超过1s时会视作不同 ID。
*/
FaceId?: string;
/**
* 从视频中截取的人脸示意图。
*/
FaceImage?: string;
/**
* 该人脸可对口型区间的起点时间,可作为对口型最佳开始时间。单位:毫秒。
*/
StartTime?: number;
/**
* 该人脸可对口型区间的终点时间;注:此结果存在毫秒级误差,会长于实际区间终点。单位:毫秒。
*/
EndTime?: number;
}
/**
* DeleteMPSTemplate请求参数结构体
*/
export interface DeleteMPSTemplateRequest {
/**
* 点播应用 ID。
*/
SubAppId: number;
/**
* 需要删除的 MPS 模板的类型。取值:
AIAnalysis: 创建智能分析模板。SmartSubtitle: 创建智能字幕模板。SmartErase: 创建智能擦除模板。EmbedSubtitle: 字幕压制模板。
*/
TemplateType: string;
/**
* MPS 任务模板唯一标识。
*/
Definition: number;
}
/**
* DRM 自适应码流播放信息修改对象
*/
export interface DrmStreamingsInfoForUpdate {
/**
* 保护类型为 SimpleAES 的转自适应码流模板 ID。
*/
SimpleAesDefinition?: number;
/**
* 保护类型为 Widevine 的转自适应码流模板 ID。
*/
WidevineDefinition?: number;
/**
* 保护类型为 FairPlay 的转自适应码流模板 ID。
*/
FairPlayDefinition?: number;
}
/**
* 智能分类任务控制参数
*/
export interface ClassificationConfigureInfo {
/**
* 智能分类任务开关,可选值:
ON:开启智能分类任务;
OFF:关闭智能分类任务。
*/
Switch: string;
}
/**
* 视频画面低光、过曝检测的控制参数。
*/
export interface AbnormalLightingConfigureInfoForUpdate {
/**
* 视频画面低光、过曝检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch?: string;
}
/**
* AIGC 混元 3D 的参考图片信息。
*/
export interface AigcHunyuan3DReferenceImageInfo {
/**
* 输入的文件类型。取值有:
File:点播文件; Url:可访问的 Url;
*/
Type?: string;
/**
* 文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。当 Type 取值为 File 时,本参数有效。说明:图片格式的取值为:支持 jpg、jpeg、png、bmp、webp。
*/
FileId?: string;
/**
* 可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。说明:图片格式的取值为:支持 jpg、jpeg、png、bmp、webp。
*/
Url?: string;
}
/**
* ModifyWordSample返回参数结构体
*/
export interface ModifyWordSampleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音频流配置参数
*/
export interface AudioTemplateInfoForUpdate {
/**
* 音频流的编码格式。
当外层参数 Container 为 mp3 时,可选值为:
libmp3lame。当外层参数 Container 为 ogg 或 flac 时,可选值为:flac。当外层参数 Container 为 m4a 时,可选值为:libfdk_aac;libmp3lame;ac3。当外层参数 Container 为 mp4 或 flv 时,可选值为:libfdk_aac:更适合 mp4;libmp3lame:更适合 flv;mp2。当外层参数 Container 为 hls 时,可选值为:libfdk_aac。当外层参数 Format 为 HLS 或 MPEG-DASH 时,可选值为:libfdk_aac。当外层参数 Container 为 wav 时,可选值为:pcm16。
*/
Codec?: string;
/**
* 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。 当取值为 0,表示由云点播自动设置码率。
*/
Bitrate?: number;
/**
* 音频流的采样率,可选值:
16000,仅当 Codec 为 pcm16 时可选。320004410048000单位:Hz。
*/
SampleRate?: number;
/**
* 音频通道,可选值:
1:单通道2:双通道6:立体声0:音频声道数和原始音频保持一致当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为立体声。
*/
AudioChannel?: number;
/**
* 指定输出要保留的音频轨道。默认是全部保留源的。
仅当在参数 OverrideParameter 中指定时生效,其他情况下不生效。
*/
StreamSelects?: Array;
}
/**
* DescribeDailyMediaPlayStat返回参数结构体
*/
export interface DescribeDailyMediaPlayStatResponse {
/**
* 播放统计数据。
*/
DailyPlayStatInfoSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自定义音色信息。
*/
export interface CustomVoiceInfo {
/**
* 音色 ID。
*/
VoiceId?: string;
/**
* 音色信息。
*/
VoiceInfo?: string;
}
/**
* 大模型增强配置。
*/
export interface DiffusionEnhanceInfo {
/**
* 大模型增强开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
/**
* 强度类型,仅当大模型增强控制开关为 ON 时有效,可选值:
weak:弱;
normal:正常;
strong:强。
默认值:normal。
*/
Type?: string;
}
/**
* 创建 AIGC 声音复刻任务信息。
*/
export interface CreateAigcAudioCloneTask {
/**
* 任务ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 扩展错误码。空字符串表示成功,其它值表示失败。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* AIGC 音频复刻任务的输入信息。
*/
Input?: CreateAigcAudioCloneInput;
/**
* AIGC 音频复刻任务的输出信息。
*/
Output?: CreateAigcAudioCloneOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* 任务流模板音视频审核输入参数类型。
*/
export interface ProcedureReviewAudioVideoTaskInput {
/**
* 审核模板。
*/
Definition: number;
/**
* 审核的内容,可选值:
Media:原始音视频;
Cover:封面。
不填或填空数组时,默认为审核 Media。
*/
ReviewContents?: Array;
}
/**
* 语音识别片段。
*/
export interface AiRecognitionTaskAsrWordsSegmentItem {
/**
* 识别片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 识别片段终止的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 识别片段置信度。取值:0~100。
*/
Confidence?: number;
}
/**
* CreateAigcAdvancedCustomElement返回参数结构体
*/
export interface CreateAigcAdvancedCustomElementResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 文字水印模板
*/
export interface TextWatermarkTemplateInput {
/**
* 字体类型,目前可以支持两种:
simkai.ttf:可以支持中文和英文;
arial.ttf:仅支持英文。
*/
FontType: string;
/**
* 字体大小,格式:Npx,N 为数值。
*/
FontSize: string;
/**
* 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。
*/
FontColor: string;
/**
* 文字透明度,取值范围:(0, 1]
0:完全透明
1:完全不透明
默认值:1。
*/
FontAlpha: number;
}
/**
* 转场操作
*/
export interface TransitionOpertion {
/**
* 转场类型,取值有:
- 图像的转场操作,用于两个视频片段图像间的转场处理:
- ImageFadeInFadeOut:图像淡入淡出。
- BowTieHorizontal:水平蝴蝶结。
- BowTieVertical:垂直蝴蝶结。
- ButterflyWaveScrawler:晃动。
- Cannabisleaf:枫叶。
- Circle:弧形收放。
- CircleCrop:圆环聚拢。
- Circleopen:椭圆聚拢。
- Crosswarp:横向翘曲。
- Cube:立方体。
- DoomScreenTransition:幕布。
- Doorway:门廊。
- Dreamy:波浪。
- DreamyZoom:水平聚拢。
- FilmBurn:火烧云。
- GlitchMemories:抖动。
- Heart:心形。
- InvertedPageCurl:翻页。
- Luma:腐蚀。
- Mosaic:九宫格。
- Pinwheel:风车。
- PolarFunction:椭圆扩散。
- PolkaDotsCurtain:弧形扩散。
- Radial:雷达扫描
- RotateScaleFade:上下收放。
- Squeeze:上下聚拢。
- Swap:放大切换。
- Swirl:螺旋。
- UndulatingBurnOutSwirl:水流蔓延。
- Windowblinds:百叶窗。
- WipeDown:向下收起。
- WipeLeft:向左收起。
- WipeRight:向右收起。
- WipeUp:向上收起。
- ZoomInCircles:水波纹。
- 音频的转场操作,用于两个音频片段间的转场处理:
- AudioFadeInFadeOut:声音淡入淡出。
*/
Type: string;
}
/**
* 视频拆条识别任务控制参数
*/
export interface SegmentConfigureInfoForUpdate {
/**
* 视频拆条识别任务开关,可选值:
ON:开启智能视频拆条识别任务;
OFF:关闭智能视频拆条识别任务。
*/
Switch?: string;
}
/**
* 用户自定义语音审核任务控制参数
*/
export interface UserDefineAsrTextReviewTemplateInfoForUpdate {
/**
* 用户自定语音审核任务开关,可选值:
ON:开启自定义语音审核任务;
OFF:关闭自定义语音审核任务。
*/
Switch?: string;
/**
* 用户自定义语音过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义语音关键词素材时需要添加对应标签。
标签个数最多 10 个,每个标签长度最多 16 个字符。
*/
LabelSet?: Array;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* 视频画面质量评价的控制参数。
*/
export interface QualityEvaluationConfigureInfoForUpdate {
/**
* 视频画面质量评价开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch?: string;
/**
* 视频画面质量评价过滤阈值,结果只返回低于该值的时间段。
*/
Score?: number;
}
/**
* 视频内容识别输入参数类型
*/
export interface AiRecognitionTaskInput {
/**
* 视频智能识别模板 ID 。
*/
Definition: number;
}
/**
* 即时转码视频模板更新配置。
*/
export interface VideoConfigureInfoForUpdate {
/**
* 视频流宽度(或长边)的最大值,取值范围:0 和 [128, 1920],单位:px。
当 Width、Height 均为 0,则分辨率同源;
当 Width 为 0,Height 非 0,则 Width 按比例缩放;
当 Width 非 0,Height 为 0,则 Height 按比例缩放;
当 Width、Height 均非 0,则分辨率按用户指定。
默认值:0。
*/
Width?: number;
/**
* 视频流高度(或短边)的最大值,取值范围:0 和 [128, 1920],单位:px。
当 Width、Height 均为 0,则分辨率同源;
当 Width 为 0,Height 非 0,则 Width 按比例缩放;
当 Width 非 0,Height 为 0,则 Height 按比例缩放;
当 Width、Height 均非 0,则分辨率按用户指定。
默认值:0。
*/
Height?: number;
/**
* 分辨率自适应,可选值:
open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。
默认值:open。
*/
ResolutionAdaptive?: string;
/**
* 视频流的码率,取值范围:0 和 [128, 10000],单位:kbps。
当取值为 0,表示由云点播自动设置码率。
*/
Bitrate?: number;
}
/**
* 音视频审核任务的输出。
*/
export interface ReviewAudioVideoTaskOutput {
/**
* 音视频内容审核的结果建议,取值范围:
pass:建议通过;
review:建议复审;
block:建议封禁。
*/
Suggestion?: string;
/**
* 当 Suggestion 为 review 或 block 时有效,表示音视频最可能的违规的标签,取值范围:
Porn:色情;
Terror:暴力;
Polity:不适宜的信息;
Ad:广告;
Illegal:违法;
Abuse:谩骂;
Moan:娇喘。
*/
Label?: string;
/**
* 当 Suggestion 为 review 或 block 时有效,表示音视频最可能的违禁的形式,取值范围:
Image:画面上的人物或图标;
OCR:画面上的文字;
ASR:语音中的文字;
Voice:声音。
*/
Form?: string;
/**
* 有违规信息的嫌疑的视频片段列表。
注意 :该列表最多仅展示前 10个 元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet?: Array;
/**
* 涉及违规信息的嫌疑的视频片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl?: string;
/**
* 涉及违规信息的嫌疑的视频片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime?: string;
/**
* 封面审核结果。
注意:此字段可能返回 null,表示取不到有效值。
*/
CoverReviewResult?: ReviewImageResult;
}
/**
* 音色更新字段
*/
export interface VoiceUpdateFields {
/**
* 音色名
*/
Name?: string;
/**
* 音色描述
*/
Description?: string;
/**
* 性别
枚举值:
- male: 男
- female: 女
- unknown: 未知
*/
Gender?: string;
/**
* 年龄
枚举值:
- child: 儿童
- teenager: 少年
- youth: 青年
- middle_aged: 中年
- senior: 老年
- unknown: 未知
*/
Age?: string;
/**
* 语言
*/
Languages?: Array;
/**
* 标签
*/
Labels?: Array;
/**
* 场景
*/
Scenes?: Array;
/**
* 试听音频
*/
AudioUrl?: string;
}
/**
* 音频流配置参数
*/
export interface AudioTemplateInfo {
/**
* 音频流的编码格式。
当外层参数 Container 为 mp3 时,可选值为:
libmp3lame。
当外层参数 Container 为 ogg 或 flac 时,可选值为:
flac。
当外层参数 Container 为 m4a 时,可选值为:
libfdk_aac;
libmp3lame;
ac3。
当外层参数 Container 为 mp4 或 flv 时,可选值为:
libfdk_aac:更适合 mp4;
libmp3lame:更适合 flv;
mp2。
当外层参数 Container 为 hls 时,可选值为:
libfdk_aac。
当外层参数 Format 为 HLS 或 MPEG-DASH 时,可选值为:
libfdk_aac。
当外层参数 Container 为 wav 时,可选值为:
pcm16。
*/
Codec: string;
/**
* 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。
当取值为 0,表示由云点播自动设置码率。
*/
Bitrate: number;
/**
* 音频流的采样率,可选值:
16000,仅当 Codec 为 pcm16 时可选。
32000
44100
48000
单位:Hz。
*/
SampleRate: number;
/**
* 音频通道,可选值:
1:单通道
2:双通道
6:立体声
0:音频声道数和原始音频保持一致
当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为立体声。
默认值:2。
*/
AudioChannel?: number;
}
/**
* DeleteAigcAdvancedCustomElement请求参数结构体
*/
export interface DeleteAigcAdvancedCustomElementRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* AIGC 高级自定义主体的 ID
*/
ElementId: string;
}
/**
* 智能封面任务控制参数
*/
export interface CoverConfigureInfo {
/**
* 智能封面任务开关,可选值:
ON:开启智能封面任务;
OFF:关闭智能封面任务。
*/
Switch: string;
}
/**
* DescribeClientUploadAccelerationUsageData返回参数结构体
*/
export interface DescribeClientUploadAccelerationUsageDataResponse {
/**
* 客户端上传加速统计数据。
*/
ClientUploadAccelerationUsageDataSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRebuildMediaTemplate请求参数结构体
*/
export interface ModifyRebuildMediaTemplateRequest {
/**
* 视频重生模板号。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: string;
/**
* 视频重生模板名称。
*/
Name?: string;
/**
* 视频重生模板描述。
*/
Comment?: string;
/**
* 视频重生视频控制信息。
*/
RebuildVideoInfo?: RebuildVideoInfo;
/**
* 视频重生音频控制信息。
*/
RebuildAudioInfo?: RebuildAudioInfo;
/**
* 输出目标视频控制信息。
*/
TargetVideoInfo?: RebuildMediaTargetVideoStream;
/**
* 输出目标音频控制信息。
*/
TargetAudioInfo?: RebuildMediaTargetAudioStream;
/**
* 输出文件封装格式,可选值:mp4、flv、hls。
*/
Container?: string;
/**
* 是否去除视频数据,可选值:
0:保留
1:去除
*/
RemoveVideo?: number;
/**
* 是否去除音频数据,可选值:
0:保留
1:去除
*/
RemoveAudio?: number;
}
/**
* ComposeMedia请求参数结构体
*/
export interface ComposeMediaRequest {
/**
* 输入的媒体轨道列表,包括视频、音频、图片等素材组成的多个轨道信息,其中:输入的多个轨道在时间轴上和输出媒体文件的时间轴对齐;时间轴上相同时间点的各个轨道的素材进行重叠,视频或者图片按轨道顺序进行图像的叠加,轨道顺序高的素材叠加在上面,音频素材进行混音;视频、音频、图片,每一种类型的轨道最多支持 10 个。所有类型的轨道上放置的媒体片段数量总和最多支持 500 个。
*/
Tracks: Array;
/**
* 输出的媒体文件信息。
*/
Output: ComposeMediaOutput;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 制作视频文件时使用的画布。
*/
Canvas?: Canvas;
/**
* 标识来源上下文,用于透传用户请求信息,在ComposeMediaComplete回调将返回该字段值,最长 1000个字符。
*/
SessionContext?: string;
/**
* 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
}
/**
* DescribeCLSTopics请求参数结构体
*/
export interface DescribeCLSTopicsRequest {
/**
* 日志集所属的地域,取值有: ap-guangzhou:广州; ap-beijing:北京; ap-chengdu:成都; ap-chongqing:重庆; ap-nanjing:南京; ap-shanghai:上海; ap-singapore:新加坡。
*/
CLSRegion: string;
/**
* 日志主题所属日志集 ID。
*/
LogsetId: string;
/**
* 日志主题 ID 列表。如果不填,表示查询所有的日志主题。
*/
TopicIds?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:20,最大值:100。
*/
Limit?: number;
}
/**
* 视频内容识别模板详情
*/
export interface AIRecognitionTemplateItem {
/**
* 视频内容识别模板唯一标识。
*/
Definition?: number;
/**
* 视频内容识别模板名称。
*/
Name?: string;
/**
* 视频内容识别模板描述信息。
*/
Comment?: string;
/**
* 模板类型,取值:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
/**
* 头尾识别控制参数。
*/
HeadTailConfigure?: HeadTailConfigureInfo;
/**
* 拆条识别控制参数。
*/
SegmentConfigure?: SegmentConfigureInfo;
/**
* 人脸识别控制参数。
*/
FaceConfigure?: FaceConfigureInfo;
/**
* 文本全文识别控制参数。
*/
OcrFullTextConfigure?: OcrFullTextConfigureInfo;
/**
* 文本关键词识别控制参数。
*/
OcrWordsConfigure?: OcrWordsConfigureInfo;
/**
* 语音全文识别控制参数。
注意:本参数已不再维护,推荐使用 AsrTranslateConfigure 参数发起语音翻译识别(当 DstLanguage 不填或填空字符串时,则不进行翻译,计费项和语音全文识别一致)。
*/
AsrFullTextConfigure?: AsrFullTextConfigureInfo;
/**
* 语音关键词识别控制参数。
*/
AsrWordsConfigure?: AsrWordsConfigureInfo;
/**
* 语音翻译识别控制参数。
*/
AsrTranslateConfigure?: AsrTranslateConfigureInfo;
/**
* 物体识别控制参数。
*/
ObjectConfigure?: ObjectConfigureInfo;
/**
* 截图时间间隔,单位:秒。
*/
ScreenshotInterval?: number;
/**
* 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
/**
* 模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
UpdateTime?: string;
}
/**
* 音视频审核 Asr 文字涉及令人反感的信息的任务输入参数类型
*/
export interface AiReviewPornAsrTaskInput {
/**
* 鉴别涉及令人反感的信息的模板 ID。
*/
Definition?: number;
}
/**
* 人脸识别结果。
*/
export interface AiRecognitionTaskFaceResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 人脸识别任务输入信息。
*/
Input?: AiRecognitionTaskFaceResultInput;
/**
* 人脸识别任务输出信息。
*/
Output?: AiRecognitionTaskFaceResultOutput;
/**
* 人脸识别任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 人脸识别任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 人脸识别任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* CreateAigcCustomElement返回参数结构体
*/
export interface CreateAigcCustomElementResponse {
/**
* 主体ID。需自行记录下返回的主体ID。
*/
ElementId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAdaptiveDynamicStreamingTemplate请求参数结构体
*/
export interface CreateAdaptiveDynamicStreamingTemplateRequest {
/**
* 自适应转码格式,取值范围:
HLS;MPEG-DASH。
*/
Format: string;
/**
* 自适应转码输出子流参数信息,最多输出10路子流。
注意:各个子流的帧率必须保持一致;如果不一致,采用第一个子流的帧率作为输出帧率。
*/
StreamInfos: Array;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* DRM 方案类型,取值范围:
SimpleAESWidevineFairPlayWidevine+FairPlay默认值为空字符串,如果取值为空字符串,代表不对视频做 DRM 保护。
*/
DrmType?: string;
/**
* DRM 的密钥提供商,取值范围:
SDMC:华曦达;VOD:云点播。默认为 VOD 。华曦达服务后续逐步下线,请使用VOD DRM加密服务。
*/
DrmKeyProvider?: string;
/**
* 加密方式,可选值:
cbcs:Widevine,FairPlay,WideVine+FairPlay支持;
cenc:Widevine支持;
若不填
FairPlay 默认cbcs;
Widevine 默认cenc;
WideVine+FairPlay默认cbcs;
*/
DrmEncryptType?: string;
/**
* 是否禁止视频低码率转高码率,取值范围:
0:否,1:是。默认为否。
*/
DisableHigherVideoBitrate?: number;
/**
* 是否禁止视频分辨率转高分辨率,取值范围:
0:否,1:是。默认为否。
*/
DisableHigherVideoResolution?: number;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 分片类型,可选值:
ts: HLS,内部映射为ts-segment
mp4: HLS/DASH,HLS情况下内部映射为mp4-mp4-segment,DASH情况下内部映射为mp4-mp4-byterange
ts-segment:HLS+TS 切片
ts-byterange:HLS+TS byte range
mp4-segment:HLS+MP4 切片
mp4-byterange:HLS+MP4 byte range
ts-packed-audio:HLS+TS+Packed Audio 切片
mp4-packed-audio:HLS+MP4+Packed Audio 切片
ts-ts-segment:HLS+TS+TS 切片
ts-ts-byterange:HLS+TS+TS byte range
mp4-mp4-segment:HLS+MP4+MP4 切片
mp4-mp4-byterange:HLS/DASH+MP4+MP4 byte range
ts-packed-audio-byterange:HLS+TS+Packed Audio byte range
mp4-packed-audio-byterange:HLS+MP4+Packed Audio byte range
默认值:ts-segment 注:自适应码流的分片格式以此字段为准。DASH格式下SegmentType只能为mp4-mp4-byterange。
FairPlay:只能用于HLS,切片格式只能是mp4或mp4-mp4-segment Widevine:可以用于HLS和DASH,HLS下切片格式只能是mp4或mp4-mp4-segment,DASH下切片格式只能是mp4或mp4-mp4-byterange
Widevine+FairPlay: 只能用于HLS,切片格式只能是mp4或mp4-mp4-segment
*/
SegmentType?: string;
/**
* 切片时长。
取值范围:[1, 10]
单位:秒
默认值:6
*/
SegmentDuration?: number;
}
/**
* PushUrlCache返回参数结构体
*/
export interface PushUrlCacheResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 对视频做采样截图任务结果类型
*/
export interface MediaProcessTaskSampleSnapshotResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 对视频做采样截图任务输入。
*/
Input?: SampleSnapshotTaskInput;
/**
* 对视频做采样截图任务输出。
注意:此字段可能返回 null,表示取不到有效值。
*/
Output?: MediaSampleSnapshotItem;
/**
* 对视频做采样截图任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 采样截图任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 采样截图任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* DescribeDailyMediaPlayStat请求参数结构体
*/
export interface DescribeDailyMediaPlayStatRequest {
/**
* 媒体文件 ID 。
*/
FileId: string;
/**
* 起始日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。该参数仅日期部分有效。
*/
StartDate: string;
/**
* 结束日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。该参数仅日期部分有效。
*/
EndDate: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 画面鉴别涉及令人不安全的信息的任务控制参数。
*/
export interface TerrorismImgReviewTemplateInfoForUpdate {
/**
* 画面鉴别涉及令人不安全的信息的任务开关,可选值:
ON:开启画面鉴别涉及令人不安全的信息的任务;
OFF:关闭画面鉴别涉及令人不安全的信息的任务。
*/
Switch?: string;
/**
* 画面鉴别涉及令人不安全的信息的过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为:
guns:武器枪支;
crowd:人群聚集;
bloody:血腥画面;
police:警察部队;
banners:暴恐旗帜;
militant:武装分子;
explosion:爆炸火灾;
terrorists:暴恐人物;
scenario:暴恐画面。
*/
LabelSet?: Array;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* 音频美化配置。
*/
export interface AudioBeautifyInfo {
/**
* 音频美化控制开关,可选值:
ON:开启音频美化;
OFF:关闭音频美化。
*/
Switch: string;
/**
* 类型,可多选,可选值:
declick:杂音去除
deesser:齿音压制
默认值:declick。
*/
Types?: Array;
}
/**
* 文本全文识别输出。
*/
export interface AiRecognitionTaskOcrFullTextResultOutput {
/**
* 文本全文识别结果集。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet: Array;
/**
* 文本全文识别结果集文件 URL。文件的内容为 JSON,数据结构与 ResultSet 字段一致。 (文件不会永久存储,到达SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl: string;
/**
* 文本全文识别结果集文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime: string;
}
/**
* ModifyTranscodeTemplate请求参数结构体
*/
export interface ModifyTranscodeTemplateRequest {
/**
* 转码模板唯一标识。
*/
Definition: number;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a、wav。其中,mp3、flac、ogg、m4a、wav 为纯音频文件。
*/
Container?: string;
/**
* 转码模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 是否去除视频数据,可选值:
0:保留1:去除
*/
RemoveVideo?: number;
/**
* 是否去除音频数据,可选值:
0:保留1:去除
*/
RemoveAudio?: number;
/**
* 视频流配置参数。
*/
VideoTemplate?: VideoTemplateInfoForUpdate;
/**
* 音频流配置参数。
*/
AudioTemplate?: AudioTemplateInfoForUpdate;
/**
* 极速高清转码参数。
*/
TEHDConfig?: TEHDConfigForUpdate;
/**
* 音视频增强配置。
*/
EnhanceConfig?: EnhanceConfigForUpdate;
/**
* 切片类型,当 Container 为 hls 时有效,可选值:
ts:ts 切片;fmp4:fmp4 切片。
*/
SegmentType?: string;
/**
* 扩展参数。
*/
StdExtInfo?: string;
}
/**
* ModifyMPSTemplate请求参数结构体
*/
export interface ModifyMPSTemplateRequest {
/**
* 点播应用 ID。
*/
SubAppId: number;
/**
* 需要修改的 MPS 模板的类型。
枚举值:
- AIAnalysis: 智能分析模板
- SmartSubtitle: 智能字幕模板
- SmartErase: 智能擦除模板
- EmbedSubtitle: 字幕压制模板
*/
TemplateType: string;
/**
* MPS 修改模板参数。该参数用于透传至媒体处理服务(MPS),从云点播侧修改用户自定义的 MPS 任务模板。
目前仅支持通过此方式修改以下任务类型的模板:
- 音视频增强:仅支持填写“修改转码模板”接口中的 Name、Comment、RemoveVideo、RemoveAudio、VideoTemplate、AudioTemplate 和 EnhanceConfig 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
- 智能分析:仅支持填写“修改内容分析模板”接口中的Name、Comment、ClassificationConfigure、TagConfigure、CoverConfigure、FrameTagConfigure几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
- 智能字幕:仅支持填写“修改智能字幕模板”接口中的Name、Comment、TranslateSwitch、VideoSrcLanguage、SubtitleFormat、SubtitleType、AsrHotWordsConfigure、TranslateDstLanguage、ProcessType几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
- 智能擦除:仅支持填写“修改智能擦除模板”接口中的Name、Comment、EraseType、EraseSubtitleConfig、EraseWatermarkConfig、ErasePrivacyConfig几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
*/
MPSModifyTemplateParams?: string;
/**
* 智能分析模板参数,MPSModifyTemplateParams为空时有效。
*/
AIAnalysisTemplate?: MPSAIAnalysisTemplateForUpdate;
/**
* 智能字幕模板参数,MPSModifyTemplateParams为空时有效。
*/
SmartSubtitleTemplate?: MPSSmartSubtitleTemplateForUpdate;
/**
* 智能擦除模板参数,MPSModifyTemplateParams为空时有效。
*/
SmartEraseTemplate?: MPSSmartEraseTemplateForUpdate;
/**
* 字幕压制模板参数,MPSModifyTemplateParams为空时有效。
*/
EmbedSubtitleTemplate?: MPSEmbedSubtitleTemplateForUpdate;
}
/**
* MPS 媒体处理任务信息。
*/
export interface ProcessMediaByMPS {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 错误信息。源异常时返回对应异常 Message,否则请使用各个具体任务的 Message。
*/
Message?: string;
/**
* MPS 视频处理任务。
*/
SubTaskSet?: Array;
}
/**
* 编辑视频任务的输入。
*/
export interface EditMediaTaskInput {
/**
* 输入视频的来源类型,可以取的值为 File,Stream 两种。
*/
InputType?: string;
/**
* 输入的视频文件信息,当 InputType 为 File 时,该字段有值。
*/
FileInfoSet?: Array;
/**
* 输入的流信息,当 InputType 为 Stream 时,该字段有值。
*/
StreamInfoSet?: Array;
}
/**
* DescribeImageSpriteTemplates请求参数结构体
*/
export interface DescribeImageSpriteTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 雪碧图模板唯一标识过滤条件,数组长度限制:100。
*/
Definitions?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
/**
* 模板类型过滤条件,可选值:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
}
/**
* DeleteImageProcessingTemplate请求参数结构体
*/
export interface DeleteImageProcessingTemplateRequest {
/**
* 图片处理模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* MPS 任务模板详情。
*/
export interface MPSTemplate {
/**
* MPS 模板的类型。取值:
Transcode: 转码模板。
*/
TaskType?: string;
/**
* MPS 任务模板详情内容。
*/
MPSTemplateInfo?: string;
}
/**
* DescribeDailyPlayStatFileList返回参数结构体
*/
export interface DescribeDailyPlayStatFileListResponse {
/**
* 播放统计文件列表。
*/
PlayStatFileSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CLS日志主题信息。
*/
export interface CLSTopicInfo {
/**
* 日志主题 ID。
*/
TopicId?: string;
/**
* 日志主题名。
*/
TopicName?: string;
/**
* 日志集 ID。
*/
LogsetId?: string;
}
/**
* MPS智能分析模板配置选项
*/
export interface MPSAIAnalysisConfigureInfo {
/**
* 智能分类任务开关,可选值:
ON:开启智能分类任务; OFF:关闭智能分类任务。
*/
Switch?: string;
}
/**
* 视频画面低光、过曝检测的控制参数。
*/
export interface AbnormalLightingConfigureInfo {
/**
* 视频画面低光、过曝检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
}
/**
* 文字水印模板
*/
export interface TextWatermarkTemplateInputForUpdate {
/**
* 字体类型,目前可以支持两种:
simkai.ttf:可以支持中文和英文;
arial.ttf:仅支持英文。
*/
FontType?: string;
/**
* 字体大小,格式:Npx,N 为数值。
*/
FontSize?: string;
/**
* 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。
*/
FontColor?: string;
/**
* 文字透明度,取值范围:(0, 1]
0:完全透明
1:完全不透明
*/
FontAlpha?: number;
}
/**
* SetVodDomainCertificate请求参数结构体
*/
export interface SetVodDomainCertificateRequest {
/**
* 域名。
*/
Domain: string;
/**
* 本次接口调用的操作类型,可选值:
Set:设置域名的 HTTPS 所需证书;
Clear: 清空域名 HTTPS 配置,清空后该域名无法支持 HTTPS 访问。
*/
Operation: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* [腾讯云SSL](/document/product/400/7572) 上传的证书 ID。清空域名 HTTPS 配置时无需填写该字段。
*/
CertID?: string;
}
/**
* DeleteSuperPlayerConfig请求参数结构体
*/
export interface DeleteSuperPlayerConfigRequest {
/**
* 播放器配置名称。
*/
Name: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 音视频审核 Ocr 文字涉及令人不安全的信息的任务输入参数类型
*/
export interface AiReviewTerrorismOcrTaskInput {
/**
* 鉴别涉及令人不安全的信息的模板 ID。
*/
Definition?: number;
}
/**
* 文本关键词识别输入。
*/
export interface AiRecognitionTaskOcrWordsResultInput {
/**
* 文本关键词识别模板 ID。
*/
Definition?: number;
}
/**
* 点播文件指定时间点截图信息
*/
export interface MediaSnapshotByTimeOffsetItem {
/**
* 指定时间点截图规格,参见[指定时间点截图参数模板](https://cloud.tencent.com/document/product/266/33480#.E6.97.B6.E9.97.B4.E7.82.B9.E6.88.AA.E5.9B.BE.E6.A8.A1.E6.9D.BF)。
*/
Definition?: number;
/**
* 同一规格的截图信息集合,每个元素代表一张截图。
*/
PicInfoSet?: Array;
}
/**
* 资源包中包含的资源。
*/
export interface ProductInstanceRecource {
/**
* 资源类型。
Storage:存储资源包。
Traffic:流量资源包。
Transcode:普通转码资源包。
TESHD:极速高清转码资源包。
Review:音视频审核转码资源包。
MediaProcess:媒体处理时长资源包。
*/
ResourceType?: string;
/**
* 资源包额度。
音视频存储资源包,单位为字节。
音视频转码资源包,单位为秒。
音视频审核资源包,单位为秒。
音视频极速高清资源包,单位为秒。
音视频加速资源包,单位为字节。
媒体处理时长资源包,单位为秒。
*/
Amount?: number;
/**
* 资源包余量。
音视频存储资源包,单位为字节。
音视频转码资源包,单位为秒。
音视频审核资源包,单位为秒。
音视频极速高清资源包,单位为秒。
音视频加速资源包,单位为字节。
媒体处理时长资源包,单位为秒。
*/
Left?: number;
}
/**
* 场景化 AIGC 生图任务的输出文件信息。
*/
export interface SceneAigcImageTaskOutputFileInfo {
/**
* 存储模式。取值有: Permanent:永久存储; Temporary:临时存储;
*/
StorageMode?: string;
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。当 StorageMode 为 Permanent 时有效。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 [创建分类](/document/product/266/7812) 接口,创建分类,获得分类 ID。当 StorageMode 为 Permanent 时有效。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ExpireTime?: string;
/**
* 文件类型,例如 mp4、flv 等。
*/
FileType?: string;
/**
* 媒体文件播放地址。
*/
FileUrl?: string;
/**
* 媒体文件 ID。当 StorageMode 为 Permanent 时有效。
*/
FileId?: string;
/**
* 输出视频的元信息。当 StorageMode 为 Permanent 时有效。
*/
MetaData?: MediaMetaData;
}
/**
* ModifyMediaStorageClass返回参数结构体
*/
export interface ModifyMediaStorageClassResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAigcQuota返回参数结构体
*/
export interface CreateAigcQuotaResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeProcedureTemplates请求参数结构体
*/
export interface DescribeProcedureTemplatesRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 任务流模板名字过滤条件,数组长度限制:100。
*/
Names?: Array;
/**
* 任务流模板类型过滤条件,可选值:
Preset:系统预置任务流模板;Custom:用户自定义任务流模板。
*/
Type?: string;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
/**
* 指定字段对返回结果进行生序或者降序Sort.Field 目前只支持 CreateTime 。Sort.Order 为 desc(降序)或者 asc(升序)
入参限制:当前仅支持排序字段为CreateTime
*/
SortBy?: Array;
}
/**
* 音视频审核涉及令人反感的信息的任务输入参数类型
*/
export interface AiReviewPornTaskInput {
/**
* 鉴别涉及令人反感的信息的模板 ID。
*/
Definition: number;
}
/**
* 视频画面抖动重影检测的控制参数。
*/
export interface JitterConfigureInfoForUpdate {
/**
* 视频画面抖动重影检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch?: string;
}
/**
* 语音克隆任务。
*/
export interface CloneVoiceAsyncTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码,0 表示成功,其他值表示失败:
40000:输入参数不合法,请检查输入参数;60000:源文件错误(如视频数据损坏),请确认源文件是否正常;70000:内部服务错误,建议重试。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 视频处理类错误码 列表。
*/
ErrCodeExt?: string;
/**
* 音色克隆任务输入信息。
*/
Input?: CloneVoiceAsyncInput;
/**
* 音色克隆任务输出信息。
*/
Output?: CloneVoiceAsyncOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 拉取上传进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* CreateProcedureTemplate请求参数结构体
*/
export interface CreateProcedureTemplateRequest {
/**
* 任务流名字(支持中文,不超过20个字)。
*/
Name: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 视频处理类型任务参数。
*/
MediaProcessTask?: MediaProcessTaskInput;
/**
* AI 内容审核类型任务参数 *。
*:该参数用于发起旧版审核,不建议使用。推荐使用 ReviewAudioVideoTask 参数发起审核。
*/
AiContentReviewTask?: AiContentReviewTaskInput;
/**
* AI 内容分析类型任务参数。
*/
AiAnalysisTask?: AiAnalysisTaskInput;
/**
* AI 内容识别类型任务参数。
*/
AiRecognitionTaskSet?: Array;
/**
* 该参数已不推荐使用,建议使用 AiRecognitionTaskSet。
* @deprecated
*/
AiRecognitionTask?: AiRecognitionTaskInput;
/**
* 音视频审核类型任务参数。
*/
ReviewAudioVideoTask?: ProcedureReviewAudioVideoTaskInput;
/**
* 导入智能媒资知识库任务参数。
*/
ImportMediaKnowledgeTaskSet?: Array;
}
/**
* 转动图任务结果类型
*/
export interface MediaProcessTaskAnimatedGraphicResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 转动图任务的输入。
*/
Input?: AnimatedGraphicTaskInput;
/**
* 转动图任务的输出。
注意:此字段可能返回 null,表示取不到有效值。
*/
Output?: MediaAnimatedGraphicsItem;
/**
* 转动图任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 转动图任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 转动图任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* DeleteAigcQuota请求参数结构体
*/
export interface DeleteAigcQuotaRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 配额类型
枚举值:
- Image: AIGC 生图任务
- Video: AIGC 生视频任务
- Text: AIGC 生文任务
*/
QuotaType: string;
/**
* 仅当QuotaType=Text时有效,用于选择需要进行配额限制ApiToken
*/
ApiToken?: string;
}
/**
* AIGC 统计数据
*/
export interface AigcUsageDataItem {
/**
* AIGC规格。
取值有:
Qwen2.0Hunyuan3.0_1KHunyuan3.0_2KHunyuan3.0_4KMingmou1.0_1KMingmou1.0_2KMingmou1.0_4KViduQ2_T2i_1080PViduQ2_T2i_2KViduQ2_T2i_4KViduQ2_I2i_1080PViduQ2_I2i_2KViduQ2_I2i_4KViduQ2_Refer2i_1080PViduQ2_Refer2i_2KViduQ2_Refer2i_4KKling2.1_T2i_1K2KKling2.1_T2i_4KKling2.1_Refer2i_1KKling2.1_Refer2i_2KKling2.1_Refer2i_4KVeo3.1StandardVeo3.1FastKling2.0&2.1std_720PKling2.0&2.1pro_1080PKling2.5pro_720PKling2.5pro_1080PKlingO1_720PKlingO1_1080PKlingO1_NoVideo_720PKlingO1_NoVideo_1080PKling2.6Kling2.6SoundKling2.6MotionControl_720PKling2.6MotionControl_1080PKling3.0_720PKling3.0Sound_720PKling3.0CustomVoice_720PKling3.0_1080PKling3.0Sound_1080PKling3.0CustomVoice_1080PKling3.0CustomVoice_2KKling3.0CustomVoice_4KKling3.0MotionControl_720PKling3.0MotionControl_1080PKling3.0MotionControl_2KKling3.0MotionControl_4KKling_Avatar_I2v_720PKling_Avatar_I2v_1080PKling_IdentifyfaceHailuo02&2.3_768PHailuo02&2.3_1080PHailuo2.3fast_768PHailuo2.3fast_1080PViduQ2_720PViduQ2_720P_OffPeakViduQ2_1080PViduQ2_1080P_OffPeakViduQ2_Refer_540PViduQ2_Refer_540P_OffPeakViduQ2_Refer_720PViduQ2_Refer_720P_OffPeakViduQ2_Refer_1080PViduQ2_Refer_1080P_OffPeakViduQ2pro_720PViduQ2pro_720P_OffPeakViduQ2pro_1080PViduQ2pro_1080P_OffPeakViduQ2pro_Refer_720PViduQ2pro_Refer_720P_OffPeakViduQ2pro_Refer_720PViduQ2pro_Refer_720P_OffPeakViduQ2pro_Refer_1080PViduQ2pro_Refer_1080P_OffPeakViduQ2turbo_720PViduQ2turbo_720P_OffPeakViduQ2turbo_1080PViduQ2turbo_1080P_OffPeakViduQ3_Refer_720PViduQ3_Refer_720P_OffPeakViduQ3_Refer_1080PViduQ3_Refer_1080P_OffPeakViduQ3_Refer_2KViduQ3_Refer_2K_OffPeakViduQ3_Refer_4KViduQ3_Refer_4K_OffPeakViduQ3pro_540PViduQ3pro_540P_OffPeakViduQ3pro_720PViduQ3pro_720P_OffPeakViduQ3pro_1080PViduQ3pro_1080P_OffPeakViduQ3turbo_540PViduQ3turbo_540P_OffPeakViduQ3turbo_720PViduQ3turbo_720P_OffPeakViduQ3turbo_1080PViduQ3turbo_1080P_OffPeakViduQ3turbo_2KViduQ3turbo_2K_OffPeakViduQ3turbo_4KViduQ3turbo_4K_OffPeakVidu_TemplateEffectHunyuan1.5_720PHunyuan1.5_1080PMingmou1.0_720PMingmou1.0_1080PImageProductImageImageChangeClothesVideoProductShowcaseImageOutPaintingFaceInfoCustomVoiceSubjectunknown
*/
Specification?: string;
/**
* 用量数据。
*/
DataSet?: Array;
}
/**
* 用于描述 MPS 视频处理任务中的返回文件结果。
*/
export interface MPSOutputFile {
/**
* 文件类型。用于标识 MPS 视频处理任务执行结果中的特定返回文件。
取值:AiAnalysis.DeLogo.Video: 智能擦除任务中产生的擦除后视频文件,默认以原文件类型存储;AiAnalysis.DeLogo.OriginSubtitle: 智能擦除任务中基于画面提取的字幕文件;AiAnalysis.DeLogo.TranslateSubtitle: 智能擦除任务中基于画面提取的字幕翻译文件。MediaProcess.Transcode.Video: 音视频增强任务中增强后的音视频文件,默认以转码文件类型存储。
AiAnalysis.HorizontalToVerticalTask.Video: 横转竖任务中生成的视频文件,默认以智能媒体文件类型存储。
AiAnalysis.VideoRemakeTaskk.Video: 智能去重任务中生成的视频文件,默认以智能媒体文件类型存储。
AiAnalysis.SegmentTask.Video: 智能拆条任务中生成的视频文件,默认以智能媒体文件类型存储。
SmartErase.Video: 智能擦除任务中生成的视频文件,默认以智能媒体文件类型存储。
*/
FileType?: string;
/**
* 存储形式。用于表示该结果文件的存储形式,取值有: Permanent:永久存储; Temporary:临时存储。
*/
StorageMode?: string;
/**
* 媒体文件 ID。当 Type 为 Permanent 时有效,表示该结果文件以视频媒资形式存储在点播平台中,字段值为视频媒资的 FileId。
*/
FileId?: string;
/**
* 结果文件的可下载 Url。
*/
Url?: string;
/**
* 转码规格 ID。当 FileType 等于 MediaProcess.Transcode.Video时有效,取值为0表示原始文件。
*/
Definition?: string;
/**
* 过期时间。当 StorageMode 为 Temporary 时有效,表示 Url 的过期时间,单位为秒。
*/
ExpiredTime?: number;
}
/**
* 视频画面质量评价的控制参数。
*/
export interface QualityEvaluationConfigureInfo {
/**
* 视频画面质量评价检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
/**
* 视频画面质量评价过滤阈值,结果只返回低于该值的时间段,默认值为 60。
*/
Score?: number;
}
/**
* CreatePersonSample请求参数结构体
*/
export interface CreatePersonSampleRequest {
/**
* 素材名称,长度限制:20 个字符。
*/
Name: string;
/**
* 素材应用场景,可选值:
1. Recognition:用于内容识别,等价于 Recognition.Face。
2. Review:用于内容不适宜,等价于 Review.Face。
3. All:包含以上全部,等价于 1+2。
*/
Usages: Array;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 素材描述,长度限制:1024 个字符。
*/
Description?: string;
/**
* 素材图片 [Base64](https://tools.ietf.org/html/rfc4648) 编码后的字符串,仅支持 jpeg、png 图片格式。数组长度限制:5 张图片。
注意:图片必须是单人像五官较清晰的照片,像素不低于 200*200。
*/
FaceContents?: Array;
/**
* 素材标签
数组长度限制:20 个标签;
单个标签长度限制:128 个字符。
*/
Tags?: Array;
}
/**
* 智能去除水印任务信息,仅当 TaskType 为 RemoveWatermark,该字段有值。
*/
export interface RemoveWatermarkTask {
/**
* 任务 ID 。
*/
TaskId?: string;
/**
* 任务流状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败:
40000:输入参数不合法,请检查输入参数;
60000:源文件错误(如视频数据损坏),请确认源文件是否正常;
70000:内部服务错误,建议重试。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 智能去除水印任务的输入。
*/
Input?: RemoveWaterMarkTaskInput;
/**
* 智能去除水印任务的输出。
注意:此字段可能返回 null,表示取不到有效值。
*/
Output?: RemoveWaterMarkTaskOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* 音视频处理任务信息
*/
export interface ProcedureTask {
/**
* 音视频处理任务 ID。
*/
TaskId?: string;
/**
* 任务流状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 已弃用,请使用各个具体任务的 ErrCode。
* @deprecated
*/
ErrCode?: number;
/**
* 已弃用,请使用各个具体任务的 Message。
* @deprecated
*/
Message?: string;
/**
* 媒体文件 ID
若流程由 [ProcessMedia](https://cloud.tencent.com/document/product/266/33427) 发起,该字段表示 [MediaInfo](https://cloud.tencent.com/document/product/266/31773#MediaInfo) 的 FileId;
若流程由 [ProcessMediaByUrl](https://cloud.tencent.com/document/product/266/33426) 发起,该字段表示 [MediaInputInfo](https://cloud.tencent.com/document/product/266/31773#MediaInputInfo) 的 Id。
*/
FileId?: string;
/**
* 媒体文件名称
若流程由 [ProcessMedia](https://cloud.tencent.com/document/product/266/33427) 发起,该字段表示 [MediaInfo](https://cloud.tencent.com/document/product/266/31773#MediaInfo) 的 BasicInfo.Name;
若流程由 [ProcessMediaByUrl](https://cloud.tencent.com/document/product/266/33426) 发起,该字段表示 [MediaInputInfo](https://cloud.tencent.com/document/product/266/31773#MediaInputInfo) 的 Name。
*/
FileName?: string;
/**
* 媒体文件地址
若流程由 [ProcessMedia](https://cloud.tencent.com/document/product/266/33427) 发起,该字段表示 [MediaInfo](https://cloud.tencent.com/document/product/266/31773#MediaInfo) 的 BasicInfo.MediaUrl;
若流程由 [ProcessMediaByUrl](https://cloud.tencent.com/document/product/266/33426) 发起,该字段表示 [MediaInputInfo](https://cloud.tencent.com/document/product/266/31773#MediaInputInfo) 的 Url。
*/
FileUrl?: string;
/**
* 原始音视频的元信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaData?: MediaMetaData;
/**
* 音视频处理任务的执行状态与结果。
*/
MediaProcessResultSet?: Array;
/**
* 音视频审核任务的执行状态与结果。
*/
AiContentReviewResultSet?: Array;
/**
* 音视频内容分析任务的执行状态与结果。
*/
AiAnalysisResultSet?: Array;
/**
* 音视频内容识别任务的执行状态与结果。
*/
AiRecognitionResultSet?: Array;
/**
* 任务流的优先级,取值范围为 [-10, 10]。
*/
TasksPriority?: number;
/**
* 任务流状态变更通知模式。
Finish:只有当任务流全部执行完毕时,才发起一次事件通知;
Change:只要任务流中每个子任务的状态发生变化,都进行事件通知;
None:不接受该任务流回调。
*/
TasksNotifyMode?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 操作者。取值范围:
System: 表示系统触发。
*/
Operator?: string;
/**
* 操作类型。取值范围:
TSC: 表示使用极速高清进行智能降码。
*/
OperationType?: string;
}
/**
* ReviewAudioVideo请求参数结构体
*/
export interface ReviewAudioVideoRequest {
/**
* 媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 [视频上传完成事件通知](/document/product/266/7830) 或 [云点播控制台](https://console.cloud.tencent.com/vod/media) 获取该字段。
*/
FileId?: string;
/**
* 媒体的存储路径。
只有[FileID + Path 模式](https://cloud.tencent.com/document/product/266/126825)的子应用可以通过MediaStoragePath发起任务。
FileId和MediaStoragePath必须提供其中一个。
*/
MediaStoragePath?: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 审核的内容,可选值有:
Media:原始音视频;
Cover:封面。
不填或填空数组时,默认为审核 Media。
*/
ReviewContents?: Array;
/**
* 审核模板 ID,默认值为 10。取值范围:
10:[预置模板](https://cloud.tencent.com/document/product/266/33476#.E9.A2.84.E7.BD.AE.E9.9F.B3.E8.A7.86.E9.A2.91.E5.AE.A1.E6.A0.B8.E6.A8.A1.E6.9D.BF.5B.5D(id.3Averify)),支持检测的违规标签包括色情(Porn)、暴力(Terror)、不适宜的信息(Polity)和娇喘(Moan)。
*/
Definition?: number;
/**
* 任务流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 来源上下文,用于透传用户请求信息,音视频审核完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* 存储地域信息
*/
export interface StorageRegionInfo {
/**
* 存储地域。
*/
Region?: string;
/**
* 存储地域描述信息。
*/
Description?: string;
/**
* 状态,是否开通,取值有:
opened:已经开通。
unopened:未开通。
*/
Status?: string;
/**
* 是否默认的存储地域,true:是;false:否。
*/
IsDefault?: boolean;
/**
* 存储区域,取值有:
Chinese Mainland:中国境内(不包含港澳台)。
Outside Chinese Mainland:中国境外。
*/
Area?: string;
}
/**
* 转场信息
*/
export interface MediaTransitionItem {
/**
* 转场持续时间,单位为秒。进行转场处理的两个媒体片段,第二个片段在轨道上的起始时间会自动进行调整,设置为前面一个片段的结束时间减去转场的持续时间。
*/
Duration: number;
/**
* 转场操作列表。图像转场操作和音频转场操作各自最多支持一个。
* @deprecated
*/
Transitions?: Array;
/**
* 转场操作列表。图像转场操作和音频转场操作各自最多支持一个。
*/
MediaTransitions?: Array;
}
/**
* 智能封面信息
*/
export interface MediaAiAnalysisCoverItem {
/**
* 智能封面地址。
*/
CoverUrl?: string;
/**
* 智能封面的可信度,取值范围是 0 到 100。
*/
Confidence?: number;
}
/**
* 自适应码流任务多语言字幕的输入参数。
*/
export interface ComplexAdaptiveDynamicStreamingTaskSubtitleInput {
/**
* 字幕 ID。该字幕必须归属于自适应码流任务的输入主媒体。
*/
Id: string;
/**
* 是否设置为自适应码流的默认字幕。取值:
YES:设置为默认字幕;
NO:不设置为默认字幕(默认值)。
*/
Default?: string;
}
/**
* 智能标签任务控制参数
*/
export interface TagConfigureInfo {
/**
* 智能标签任务开关,可选值:
ON:开启智能标签任务;
OFF:关闭智能标签任务。
*/
Switch: string;
}
/**
* 细节增强控制
*/
export interface SharpEnhanceInfo {
/**
* 细节增强控制开关,可选值:
ON:开启细节增强;
OFF:关闭细节增强。
*/
Switch: string;
/**
* 细节增强强度,仅当细节增强控制开关为 ON 时有效,取值范围:0.0~1.0。
默认:0.0。
*/
Intensity?: number;
}
/**
* ModifySuperPlayerConfig返回参数结构体
*/
export interface ModifySuperPlayerConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeWordSamples返回参数结构体
*/
export interface DescribeWordSamplesResponse {
/**
* 符合条件的记录总数。
*/
TotalCount?: number;
/**
* 关键词信息。
*/
WordSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAigcFaceInfoAsync请求参数结构体
*/
export interface DescribeAigcFaceInfoAsyncRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 需要获取人脸信息的输入视频信息,最多包含一个文件。
*/
FileInfos?: Array;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
}
/**
* RefreshUrlCache返回参数结构体
*/
export interface RefreshUrlCacheResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频拼接任务信息,该结构仅用于对 2017 版[视频拼接](https://cloud.tencent.com/document/product/266/7821)接口发起的任务。
*/
export interface ConcatTask2017 {
/**
* 视频拼接任务 ID。
*/
TaskId?: string;
/**
* 视频拼接源文件信息。
*/
FileInfoSet?: Array;
}
/**
* 异步获取 AIGC 人脸信息任务。
*/
export interface DescribeAigcFaceInfoAsyncTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 扩展错误码。
参数格式:扩展错误码。
枚举值:
- RequestLimitExceeded: 调用超出并发限制。
- InvalidParameterValue: 参数错误。
- InternalError: 内部错误。
- FailedOperation: 操作失败。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 异步获取 AIGC 人脸信息任务的输入信息。
*/
Input?: DescribeAigcFaceInfoAsyncInput;
/**
* 异步获取 AIGC 人脸信息任务的输出信息。
*/
Output?: DescribeAigcFaceInfoAsyncOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* DeleteAIRecognitionTemplate请求参数结构体
*/
export interface DeleteAIRecognitionTemplateRequest {
/**
* 音视频内容识别模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 文件上传任务信息
*/
export interface FileUploadTask {
/**
* 文件唯一 ID。
*/
FileId?: string;
/**
* 上传完成后生成的媒体文件基础信息。
*/
MediaBasicInfo?: MediaBasicInfo;
/**
* 任务类型为 Procedure 的任务 ID。若视频[上传时指定要执行的任务(procedure)](https://cloud.tencent.com/document/product/266/33475#.E4.BB.BB.E5.8A.A1.E5.8F.91.E8.B5.B7),当该任务流模板指定了 MediaProcessTask、AiAnalysisTask、AiRecognitionTask 中的一个或多个时发起该任务。
*/
ProcedureTaskId?: string;
/**
* 任务类型为 ReviewAudioVideo 的任务 ID。若视频[上传时指定要执行的任务(procedure)](https://cloud.tencent.com/document/product/266/33475#.E4.BB.BB.E5.8A.A1.E5.8F.91.E8.B5.B7),当该任务流模板指定了 ReviewAudioVideoTask 时,发起该任务。
*/
ReviewAudioVideoTaskId?: string;
/**
* 元信息。包括大小、时长、视频流信息、音频流信息等。
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaData?: MediaMetaData;
}
/**
* CreateKnowledgeBase返回参数结构体
*/
export interface CreateKnowledgeBaseResponse {
/**
* 创建成功后的知识库ID。
*/
KnowledgeBaseId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCDNStatDetails返回参数结构体
*/
export interface DescribeCDNStatDetailsResponse {
/**
* 每条数据的时间粒度,单位:分钟。
*/
DataInterval?: number;
/**
* CDN 用量数据。
*/
Data?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AttachMediaSubtitles请求参数结构体
*/
export interface AttachMediaSubtitlesRequest {
/**
* 媒体文件唯一标识。
*/
FileId: string;
/**
* 操作。取值如下:
Attach:关联字幕。
Detach:解除关联字幕。
*/
Operation: string;
/**
* [转自适应码流模板号](https://cloud.tencent.com/document/product/266/34071#zsy)。
*/
AdaptiveDynamicStreamingDefinition: number;
/**
* 字幕的唯一标识。
*/
SubtitleIds: Array;
/**
* 默认字幕的唯一标识。不填则不设置默认字幕。
*/
DefaultSubtitleId?: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 智能封面结果类型
*/
export interface AiAnalysisTaskCoverResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 智能封面任务输入。
*/
Input?: AiAnalysisTaskCoverInput;
/**
* 智能封面任务输出。
*/
Output?: AiAnalysisTaskCoverOutput;
/**
* 智能封面任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 智能封面任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 智能封面任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* 大模型解析人脸识别配置
*/
export interface LLMComprehendFaceRecognitionForUpdate {
/**
* 人脸识别任务开关
枚举值:
- ON: 开启智能人脸识别任务
- OFF: 关闭智能人脸识别任务
默认值:OFF
*/
Switch?: string;
/**
* 人脸识别过滤分数,当识别结果达到该分数以上,返回识别结果
取值范围:[0, 100]
*/
Score?: number;
/**
* 默认人物过滤标签,指定需要返回的默认人物的标签。如果未填或者为空,则全部默认人物结果都返回。
枚举值:
- entertainment: 娱乐明星
- sport: 体育明星
- politician: 政治人物
*/
DefaultLibraryLabelSet?: Array;
/**
* 用户自定义人物过滤标签,指定需要返回的用户自定义人物的标签。如果未填或者为空,则全部自定义人物结果都返回。
入参限制:标签个数最多 100 个,每个标签长度最多 16 个字符。
*/
UserDefineLibraryLabelSet?: Array;
/**
* 人物库选择
枚举值:
- Default: 使用默认人物库
- UserDefine: 使用用户自定义人物库
- All: 同时使用默认人物库和用户自定义人物库
默认值:All
*/
FaceLibrary?: string;
}
/**
* DescribeEventConfig请求参数结构体
*/
export interface DescribeEventConfigRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 音视频审核 Ocr 文字的嫌疑片段
*/
export interface MediaContentReviewOcrTextSegmentItem {
/**
* 嫌疑片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 嫌疑片段结束的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 嫌疑片段置信度。
*/
Confidence?: number;
/**
* 嫌疑片段音视频审核的结果建议,取值范围:
pass。
review。
block。
*/
Suggestion?: string;
/**
* 嫌疑关键词列表。
*/
KeywordSet?: Array;
/**
* 嫌疑文字出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
*/
AreaCoordSet?: Array;
/**
* 嫌疑图片 URL (图片不会永久存储,到达
PicUrlExpireTime 时间点后图片将被删除)。
*/
Url?: string;
/**
* 嫌疑图片 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
PicUrlExpireTime?: string;
}
/**
* 输出的音频流信息
*/
export interface OutputAudioStream {
/**
* 音频流的编码格式,可选值:
libfdk_aac:适合 mp4 文件。
默认值:libfdk_aac。
*/
Codec?: string;
/**
* 音频流的采样率,可选值:
16000
32000
44100
48000
单位:Hz。
默认值:16000。
*/
SampleRate?: number;
/**
* 音频声道数,可选值:
1:单声道 。
2:双声道
默认值:2。
*/
AudioChannel?: number;
/**
* 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。
当取值为 0,将自动设置音频码率。
*/
Bitrate?: number;
}
/**
* ModifyLLMComprehendTemplate返回参数结构体
*/
export interface ModifyLLMComprehendTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 异步获取 AIGC 人脸信息输入。
*/
export interface DescribeAigcFaceInfoAsyncInput {
/**
* 需要获取人脸信息的输入视频信息。
*/
FileInfos?: Array;
}
/**
* 智能分类结果信息
*/
export interface AiAnalysisTaskClassificationOutput {
/**
* 视频智能分类列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 ClassificationSetFileUrl 对应的文件中获取。
*/
ClassificationSet: Array;
/**
* 视频智能分类列表文件 URL。文件的内容为 JSON,数据结构与 ClassificationSet 字段一致。 (文件不会永久存储,到达 ClassificationSetFileUrlExpireTime 时间点后文件将被删除)。
*/
ClassificationSetFileUrl: string;
/**
* 视频智能分类列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ClassificationSetFileUrlExpireTime: string;
}
/**
* CreateKnowledgeBase请求参数结构体
*/
export interface CreateKnowledgeBaseRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 知识库名称。长度限制:1-64个字符。
*/
Name: string;
/**
* 知识库描述。长度限制:最多256个字符。
*/
Description?: string;
}
/**
* 用户自定义语音审核任务控制参数
*/
export interface UserDefineAsrTextReviewTemplateInfo {
/**
* 用户自定语音审核任务开关,可选值:
ON:开启自定义语音审核任务;
OFF:关闭自定义语音审核任务。
*/
Switch: string;
/**
* 用户自定义语音过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义语音关键词素材时需要添加对应标签。
标签个数最多 10 个,每个标签长度最多 16 个字符。
*/
LabelSet?: Array;
/**
* 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* 文件删除任务
*/
export interface FileDeleteTask {
/**
* 删除文件 ID 列表。
*/
FileIdSet?: Array;
/**
* 删除文件结果信息列表。
*/
FileDeleteResultInfo?: Array;
}
/**
* 标签键值。参考[标签](https://cloud.tencent.com/document/product/651)。
*/
export interface ResourceTag {
/**
* 标签键。
*/
TagKey: string;
/**
* 标签值。
*/
TagValue: string;
}
/**
* ImportMediaKnowledge请求参数结构体
*/
export interface ImportMediaKnowledgeRequest {
/**
* 点播应用 ID。
*/
SubAppId: number;
/**
* 媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。
*/
FileId: string;
/**
* 大模型理解模板的唯一标识
*/
Definition?: number;
/**
* 知识库ID列表,留空时将使用默认知识库
*/
KnowledgeBaseIds?: Array;
/**
* 需要导入知识库任务类型,可选值有:
- AiAnalysis.DescriptionTask
- SmartSubtitle.AsrFullTextTask
* @deprecated
*/
ImportTasks?: Array;
}
/**
* 场景化 AIGC 生图配置。
*/
export interface AigcImageSceneInfo {
/**
* AI生图场景类型,可选值:
ai_try_on:AI 换装。product_image:AI 生商品图。outpainting: AI 扩图。
下列 Type 已废弃,后续不再更新:
change_clotheschange_clothes_underchange_clothes_top_wearchange_clothes_bottom_wearchange_clothes_full_wear
*/
Type: string;
/**
* 当 Type 为 ai_try_on 时必填,表示 AI 换装配置参数。
*/
AiTryOnConfig?: AiTryOnConfig;
/**
* 已废弃,请使用AiTryOnConfig。当 Type 下列类型时,则该项为必填,表示AI 换衣生图配置参数:
- change_clothes
- change_clothes_under
*/
ChangeClothesConfig?: ChangeClothesConfig;
/**
* 当 Type 为 product_image 时必填,表示AI 生商品图配置参数。
*/
ProductImageConfig?: ProductImageConfig;
}
/**
* 智能精彩片段结果类型
*/
export interface AiAnalysisTaskHighlightResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 智能精彩片段任务输入。
*/
Input?: AiAnalysisTaskHighlightInput;
/**
* 智能精彩片段任务输出。
*/
Output?: AiAnalysisTaskHighlightOutput;
/**
* 智能精彩片段任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 智能精彩片段任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 智能精彩片段任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* DescribeEnhanceMediaTemplates返回参数结构体
*/
export interface DescribeEnhanceMediaTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 音画质重生模板详情列表。
*/
RebuildMediaTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 播放器配置详情
*/
export interface PlayerConfig {
/**
* 播放器配置名字。
*/
Name?: string;
/**
* 播放器配置类型,取值范围:
Preset:系统预置配置;Custom:用户自定义配置。
*/
Type?: string;
/**
* 播放的音视频类型,可选值有:
AdaptiveDynamicStream:自适应码流输出;Transcode:转码输出;Original:原始音视频。
*/
AudioVideoType?: string;
/**
* 播放 DRM 保护的自适应码流开关:
ON:开启,表示仅播放 DRM 保护的自适应码流输出;OFF:关闭,表示播放未加密的自适应码流输出。
*/
DrmSwitch?: string;
/**
* 允许输出的未加密的自适应码流模板 ID。
*/
AdaptiveDynamicStreamingDefinition?: number;
/**
* 允许输出的 DRM 自适应码流模板内容。
注意:此字段可能返回 null,表示取不到有效值。
*/
DrmStreamingsInfo?: DrmStreamingsInfo;
/**
* 允许输出的转码模板 ID。
*/
TranscodeDefinition?: number;
/**
* 允许输出的雪碧图模板 ID。
*/
ImageSpriteDefinition?: number;
/**
* 播放器对不于不同分辨率的子流展示名字。
*/
ResolutionNameSet?: Array;
/**
* 播放器配置创建时间,使用 ISO 日期格式。
*/
CreateTime?: string;
/**
* 播放器配置最后修改时间,使用 ISO 日期格式。
*/
UpdateTime?: string;
/**
* 播放时使用的域名。值为 Default,表示使用默认分发配置中的域名。
*/
Domain?: string;
/**
* 播放时使用的 Scheme。取值范围:
Default:使用[默认分发配置](https://cloud.tencent.com/document/product/266/33373)中的 Scheme;HTTP;HTTPS。
*/
Scheme?: string;
/**
* 模板描述信息。
*/
Comment?: string;
}
/**
* CreateAigcVideoTask返回参数结构体
*/
export interface CreateAigcVideoTaskResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAdaptiveDynamicStreamingTemplate返回参数结构体
*/
export interface ModifyAdaptiveDynamicStreamingTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateRebuildMediaTemplate返回参数结构体
*/
export interface CreateRebuildMediaTemplateResponse {
/**
* 视频重生模板 ID。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 文本关键词识别输出。
*/
export interface AiRecognitionTaskOcrWordsResultOutput {
/**
* 文本关键词识别结果集。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 ResultSetFileUrl 对应的文件中获取。
*/
ResultSet: Array;
/**
* 文本关键词识别结果集文件 URL。文件的内容为 JSON,数据结构与 ResultSet 字段一致。 (文件不会永久存储,到达ResultSetFileUrlExpireTime 时间点后文件将被删除)。
*/
ResultSetFileUrl: string;
/**
* 文本关键词识别结果集文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ResultSetFileUrlExpireTime: string;
}
/**
* 智能按帧标签结果信息
*/
export interface AiAnalysisTaskFrameTagOutput {
/**
* 视频按帧标签列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet: Array;
/**
* 视频按帧标签列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl: string;
/**
* 视频按帧标签列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime: string;
}
/**
* 图片理解信息。
*/
export interface ImageUnderstandingInfo {
/**
* 图片理解项集合。
*/
ImageUnderstandingSet?: Array;
}
/**
* 音画质检测任务信息。
*/
export interface QualityInspectTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 音画质检测输入音视频的元信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaData?: MediaMetaData;
/**
* 音画质检测任务输入。
*/
Input?: QualityInspectTaskInput;
/**
* 音画质检测任务输出。
*/
Output?: QualityInspectTaskOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,音画质检测完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* 创建主体任务信息。
*/
export interface CreateAigcSubjectTask {
/**
* 任务ID。
*/
TaskId?: string;
/**
* 任务状态。
枚举值:
- PROCESSING: 处理中
- FINISH: 已完成
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 扩展错误码。空字符串表示成功,其它值表示失败。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 创建 AIGC 主体输入信息。
*/
Input?: CreateAigcSubjectInput;
/**
* 创建 AIGC 主体输出信息。
*/
Output?: CreateAigcSubjectOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* 图片模糊处理。
*/
export interface ImageBlur {
/**
* 图片模糊的操作类型。可选模式有:
Gaussian : 高斯模糊。
*/
Type: string;
/**
* 模糊半径,取值范围为1 - 50。当 Type 取值为 Gaussian 时此字段有效。
*/
Radius?: number;
/**
* 正态分布的标准差,必须大于0。当 Type 取值为 Gaussian 时此字段有效。
*/
Sigma?: number;
}
/**
* CreateBlindWatermarkTemplate请求参数结构体
*/
export interface CreateBlindWatermarkTemplateRequest {
/**
* 数字水印类型,可选值:blind-basic:基础版权数字水印;blind-nagra:NAGRA水印;
*/
Type: string;
/**
* 数字水印文字内容,长度不超过64个字符,NAGRA水印类型的模板创建后不支持修改文字内容。
*/
TextContent: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 数字水印模板名称,支持中文、英文、数字、_、-和. 六种格式,长度限制:64 个字符。
*/
Name?: string;
/**
* 数字水印模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
}
/**
* CreateAigcAudioTask返回参数结构体
*/
export interface CreateAigcAudioTaskResponse {
/**
* 任务创建成功后,返回的任务ID。
调用查询接口,轮询获取任务进度及生成结果。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyVodDomainAccelerateConfig请求参数结构体
*/
export interface ModifyVodDomainAccelerateConfigRequest {
/**
* 需要设置加速配置的域名。
*/
Domain: string;
/**
* 区域,可选值:
Chinese Mainland:中国境内(不包含港澳台)。
Outside Chinese Mainland: 中国境外。
Global: 全球范围。
*/
Area: string;
/**
* 开启或者关闭所选区域的域名加速,可选值:
Enabled: 开启。
Disabled:关闭。
开启中国境内加速的域名,需要先[备案域名](/document/product/243/18905)。
*/
Status: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 鉴别涉及令人不适宜的信息的控制参数。
*/
export interface PoliticalConfigureInfoForUpdate {
/**
* 画面鉴别涉及令人不适宜的信息的控制参数。
*/
ImgReviewInfo?: PoliticalImgReviewTemplateInfoForUpdate;
/**
* 语音鉴别涉及令人不适宜的信息的控制参数。
*/
AsrReviewInfo?: PoliticalAsrReviewTemplateInfoForUpdate;
/**
* 文本鉴别涉及令人不适宜的信息的控制参数。
*/
OcrReviewInfo?: PoliticalOcrReviewTemplateInfoForUpdate;
}
/**
* 主体参考信息。
*/
export interface ElementReferInfo {
/**
* 不同角度的主体参考图片URL。
图片格式支持.jpg / .jpeg / .png
图片文件大小不能超过10MB,图片宽高尺寸不小于300px,图片宽高比要在1:2.5 ~ 2.5:1之间。
*/
ImageUrl?: string;
}
/**
* 文本关键词识别控制参数。
*/
export interface OcrWordsConfigureInfoForUpdate {
/**
* 文本关键词识别任务开关,可选值:
ON:开启文本关键词识别任务;
OFF:关闭文本关键词识别任务。
*/
Switch?: string;
/**
* 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。
标签个数最多 10 个,每个标签长度最多 16 个字符。
*/
LabelSet?: Array;
}
/**
* 文件审核信息。
*/
export interface FileReviewInfo {
/**
* 媒体审核信息\*。
\* 只展示通过 [音视频审核(ReviewAudioVideo)](https://cloud.tencent.com/document/api/266/80283) 或 [图片审核(ReviewImage)](https://cloud.tencent.com/document/api/266/73217) 发起的审核结果信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
MediaReviewInfo?: ReviewInfo;
/**
* 媒体封面审核信息\*。
\* 只展示通过 [音视频审核(ReviewAudioVideo)](https://cloud.tencent.com/document/api/266/80283) 或 [图片审核(ReviewImage)](https://cloud.tencent.com/document/api/266/73217) 发起的审核结果信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
CoverReviewInfo?: ReviewInfo;
}
/**
* MPS字幕压制模块字幕排列配置
*/
export interface MPSSubtitleLayoutConfig {
/**
* 字幕排列配置开关,0关闭,1开启,默认0
*/
SubtitleLayoutConfigSwitch?: number;
/**
* 行间距。正整数。 - 代表像素值时, [0, 1000]。 - 代表百分数时,[0, 100]。不填默认0。
*/
LineSpacing?: number;
/**
* LineSpacing单位,0 像素,1百分比,默认为0,像素
*/
LineSpacingUnit?: number;
/**
* 对齐方式,取值:top: 顶部对齐,字幕顶部按位置固定,底部随行数变化。bottom: 底部对齐,字幕底部按位置固定,顶部随行数变化。不填默认底部对齐。
*/
Alignment?: string;
}
/**
* 对视频截图做封面任务输出类型
*/
export interface CoverBySnapshotTaskOutput {
/**
* 封面 URL。
*/
CoverUrl?: string;
}
/**
* 即时转码水印模板更新配置。
*/
export interface WatermarkConfigureInfoForUpdate {
/**
* 是否启用水印。可取值:
ON:表示启用水印;
OFF:表示关闭水印。
*/
Switch?: string;
/**
* 水印图片 Base64 编码后的字符串。支持 jpeg、png 图片格式。
*/
ImageContent?: string;
/**
* 水印的宽度。
字符串以 % 结尾,表示水印 Width 为视频宽度的百分比大小,如 10% 表示 Width 为视频宽度的 10%;
*/
Width?: string;
/**
* 水印的高度。
字符串以 % 结尾,表示水印 Height 为视频高度的百分比大小,如 10% 表示 Height 为视频高度的 10%;
*/
Height?: string;
/**
* 水印原点距离视频图像坐标原点的水平位置。字符串以 % 结尾,表示水印 XPos 为视频宽度指定百分比,如 10% 表示 XPos 为视频宽度的 10%;
*/
XPos?: string;
/**
* 水印原点距离视频图像坐标原点的垂直位置。当字符串以 % 结尾,表示水印 YPos 为视频高度指定百分比,如 10% 表示 YPos 为视频高度的 10%。
*/
YPos?: string;
}
/**
* ModifyQualityInspectTemplate返回参数结构体
*/
export interface ModifyQualityInspectTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AIGC 生音效任务的输入。
*/
export interface AigcAudioTaskInput {
/**
* 模型名称。
*/
ModelName?: string;
/**
* 模型版本。
*/
ModelVersion?: string;
/**
* 场景类型。取值如下:
当 ModelName 为 Kling 时,取值 motion_control 表示动作控制;其他 ModelName 暂不支持。
*/
SceneType?: string;
/**
* 生成视频的提示词。最大支持1000字符,当 FileInfos 为空时,此参数必填。
*/
Prompt?: string;
/**
* 要阻止模型生成视频的提示词。最大支持1000字符。
*/
NegativePrompt?: string;
/**
* 参考音频信息
*/
AudioInfos?: Array;
/**
* 参考视频信息
*/
VideoInfos?: Array;
/**
* 是否自动优化提示词。开启时将自动优化传入的Prompt,以提升生成质量。取值有:
Enabled:开启; Disabled:关闭;
*/
EnhancePrompt?: boolean;
/**
* AIGC 生图输出结果文件输出。
*/
OutputConfig?: AigcAudioOutputConfig;
/**
* 额外参数
*/
AdditionalParameters?: string;
}
/**
* 小程序音视频审核概要元信息
*/
export interface MediaMiniProgramReviewElem {
/**
* 音视频审核类型。
Porn:画面涉及令人反感的信息,
Porn.Ocr:文字涉及令人反感的信息,
Porn.Asr:声音涉及令人反感的信息,
Terrorism:画面涉及令人不安全的信息,
Political:画面涉及令人不适宜的信息,
Political.Ocr:文字涉及令人不适宜的信息,
Political.Asr:声音涉及令人不适宜的信息。
*/
Type?: string;
/**
* 音视频审核意见。
pass:确认正常,
block:确认违规,
review:疑似违规。
*/
Suggestion?: string;
/**
* 音视频审核结果置信度。取值 0~100。
*/
Confidence?: number;
}
/**
* ModifyAdaptiveDynamicStreamingTemplate请求参数结构体
*/
export interface ModifyAdaptiveDynamicStreamingTemplateRequest {
/**
* 自适应转码模板唯一标识。
*/
Definition: number;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 自适应转码格式,取值范围:
HLS;MPEG-DASH。
*/
Format?: string;
/**
* 是否禁止视频低码率转高码率,取值范围:
0:否,1:是。
*/
DisableHigherVideoBitrate?: number;
/**
* 是否禁止视频分辨率转高分辨率,取值范围:
0:否,1:是。
*/
DisableHigherVideoResolution?: number;
/**
* 自适应转码输入流参数信息,最多输入10路流。
注意:各个流的帧率必须保持一致;如果不一致,采用第一个流的帧率作为输出帧率。
*/
StreamInfos?: Array;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 分片类型,可选值:
ts: HLS,内部映射为ts-segment
mp4: HLS/DASH,HLS情况下内部映射为mp4-mp4-segment,DASH情况下内部映射为mp4-mp4-byterange
ts-segment:HLS+TS 切片
ts-byterange:HLS+TS byte range
mp4-segment:HLS+MP4 切片
mp4-byterange:HLS+MP4 byte range
ts-packed-audio:HLS+TS+Packed Audio 切片
mp4-packed-audio:HLS+MP4+Packed Audio 切片
ts-ts-segment:HLS+TS+TS 切片
ts-ts-byterange:HLS+TS+TS byte range
mp4-mp4-segment:HLS+MP4+MP4 切片
mp4-mp4-byterange:HLS/DASH+MP4+MP4 byte range
ts-packed-audio-byterange:HLS+TS+Packed Audio byte range
mp4-packed-audio-byterange:HLS+MP4+Packed Audio byte range
默认值:ts-segment 注:自适应码流的分片格式以此字段为准。DASH格式下SegmentType只能为mp4-mp4-byterange。
FairPlay:只能用于HLS,切片格式只能是mp4或mp4-mp4-segment Widevine:可以用于HLS和DASH,HLS下切片格式只能是mp4或mp4-mp4-segment,DASH下切片格式只能是mp4或mp4-mp4-byterange Widevine+FairPlay: 只能用于HLS,切片格式只能是mp4或mp4-mp4-segment
*/
SegmentType?: string;
/**
* 切片平均时长。
取值范围:[1, 10]
单位:秒
*/
SegmentDuration?: number;
}
/**
* ForbidMediaDistribution请求参数结构体
*/
export interface ForbidMediaDistributionRequest {
/**
* 媒体文件列表,每次最多可提交 20 条。
*/
FileIds: Array;
/**
* forbid:禁播,recover:解禁。
*/
Operation: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* DescribeAIRecognitionTemplates返回参数结构体
*/
export interface DescribeAIRecognitionTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 音视频内容识别模板详情列表。
*/
AIRecognitionTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* MPS智能分析模板输入
*/
export interface MPSAIAnalysisTemplate {
/**
* 视频内容分析模板名称,长度限制:64 个字符。
*/
Name: string;
/**
* 视频内容分析模板描述信息,长度限制:256 个字符。
*/
Comment: string;
/**
* 智能分类任务控制参数。
*/
ClassificationConfigure?: MPSAIAnalysisConfigureInfo;
/**
* 智能标签任务控制参数。
*/
TagConfigure?: MPSAIAnalysisConfigureInfo;
/**
* 智能封面任务控制参数。
*/
CoverConfigure?: MPSAIAnalysisConfigureInfo;
/**
* 智能按帧标签任务控制参数。
*/
FrameTagConfigure?: MPSAIAnalysisConfigureInfo;
/**
* 智能拆条任务控制参数。
*/
SplitConfigure?: MPSAIAnalysisConfigureInfo;
/**
* 智能集锦任务控制参数。
*/
HighlightConfigure?: MPSAIAnalysisConfigureInfo;
/**
* 智能片头片尾任务控制参数。
*/
OpeningAndEndingConfigure?: MPSAIAnalysisConfigureInfo;
}
/**
* EditMedia返回参数结构体
*/
export interface EditMediaResponse {
/**
* 编辑视频的任务 ID,可以通过该 ID 查询编辑任务(任务类型为 EditMedia)的状态。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 异步配音输出参数设置
*/
export interface TextToSpeechAsyncOutputOption {
/**
* 合成结果输出类型
枚举值:
- fileId:生成新的点播fileId
- url:音频url,有效期24小时
*/
Type?: string;
}
/**
* 文本鉴别涉及令人不适宜的信息的任务控制参数。
*/
export interface PoliticalOcrReviewTemplateInfoForUpdate {
/**
* 文本鉴别涉及令人不适宜的信息的任务开关,可选值:
ON:开启文本鉴别涉及令人不适宜的信息的任务;
OFF:关闭文本鉴别涉及令人不适宜的信息的任务。
*/
Switch?: string;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* 视频处理任务的输出媒体文件信息
*/
export interface TaskOutputMediaInfo {
/**
* 媒体文件 ID。
*/
FileId?: string;
/**
* 转拉完成后生成的媒体文件基础信息。
*/
MediaBasicInfo?: MediaBasicInfo;
}
/**
* ProcessMediaByUrl请求参数结构体
*/
export interface ProcessMediaByUrlRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* API 已经不再维护。推荐使用的替代 API 请参考接口描述。
*/
InputInfo?: MediaInputInfo;
/**
* 输出文件 COS 路径信息。
*/
OutputInfo?: MediaOutputInfo;
/**
* 视频内容审核类型任务参数。
*/
AiContentReviewTask?: AiContentReviewTaskInput;
/**
* 视频内容分析类型任务参数。
*/
AiAnalysisTask?: AiAnalysisTaskInput;
/**
* 视频内容识别类型任务参数。
*/
AiRecognitionTask?: AiRecognitionTaskInput;
/**
* 任务流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 任务流状态变更通知模式,可取值有 Finish,Change 和 None,不填代表 Finish。
*/
TasksNotifyMode?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
}
/**
* DescribeDailyMostPlayedStat返回参数结构体
*/
export interface DescribeDailyMostPlayedStatResponse {
/**
* 媒体文件播放统计信息。
*/
DailyPlayStatInfoSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAIRecognitionTemplate返回参数结构体
*/
export interface ModifyAIRecognitionTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频拆条任务配置信息。
*/
export interface SplitMediaTaskConfig {
/**
* 视频拆条起始的偏移时间,单位:秒。
不填或填0,表示转码后的视频从原始视频的起始位置开始;
当数值大于0时(假设为 n),表示转码后的视频从原始视频的第 n 秒位置开始;
当数值小于0时(假设为 -n),表示转码后的视频从原始视频结束 n 秒前的位置开始。
*/
StartTimeOffset?: number;
/**
* 视频拆条结束的偏移时间,单位:秒。
不填或填0,表示转码后的视频持续到原始视频的末尾终止;
当数值大于0时(假设为 n),表示转码后的视频持续到原始视频第 n 秒时终止;
当数值小于0时(假设为 -n),表示转码后的视频持续到原始视频结束 n 秒前终止。
*/
EndTimeOffset?: number;
/**
* [任务流](https://cloud.tencent.com/document/product/266/33475#.E4.BB.BB.E5.8A.A1.E6.B5.81)名称。要对生成的新视频自动执行任务流时填写。
*/
ProcedureName?: string;
/**
* 视频拆条输出信息。
*/
OutputConfig?: SplitMediaOutputConfig;
}
/**
* 极速高清参数配置。
*/
export interface TEHDConfig {
/**
* 极速高清类型,可选值:TEHD-100 表示极速高清-100; OFF 表示关闭极速高清。不填表示 OFF。
*/
Type: string;
/**
* 视频码率上限,当 Type 指定了极速高清类型时有效。
不填或填0表示由云点播自动设置码率上限。
*/
MaxVideoBitrate?: number;
}
/**
* 播放统计文件信息
*/
export interface PlayStatFileInfo {
/**
* 播放统计数据所属日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
Date?: string;
/**
* 播放统计文件的 URL 地址。播放统计文件内容为:
date:播放日期。
file_id:视频文件 ID。
ip_count:去重后的客户端 IP 数。
flux:播放流量,单位:字节。
play_times:总的播放次数。
pc_play_times:PC 端播放次数。
mobile_play_times:移动端播放次数。
iphone_play_times:iPhone 端播放次数。
android_play_times:Android 端播放次数。
host_name 域名。
*/
Url?: string;
}
/**
* ModifyMediaInfo请求参数结构体
*/
export interface ModifyMediaInfoRequest {
/**
* 媒体文件唯一标识。
*/
FileId: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 媒体文件名称,最长 64 个字符。
*/
Name?: string;
/**
* 媒体文件描述,最长 128 个字符。
*/
Description?: string;
/**
* 媒体文件分类 ID。
*/
ClassId?: number;
/**
* 媒体文件过期时间,采用 ISO 日期格式。填“9999-12-31T23:59:59Z”表示永不过期。过期后该媒体文件及其相关资源(转码结果、雪碧图等)将被永久删除。
*/
ExpireTime?: string;
/**
* 视频封面图片文件(如 jpeg, png 等)进行 Base64 编码后的字符串,仅支持 gif、jpeg、png 三种图片格式。
*/
CoverData?: string;
/**
* 新增的一组视频打点信息,如果某个偏移时间已存在打点,则会进行覆盖操作,单个媒体文件最多 100 个打点信息。同一个请求里,AddKeyFrameDescs 的时间偏移参数必须与 DeleteKeyFrameDescs 都不同。
*/
AddKeyFrameDescs?: Array;
/**
* 要删除的一组视频打点信息的时间偏移,单位:秒。同一个请求里,AddKeyFrameDescs 的时间偏移参数必须与 DeleteKeyFrameDescs 都不同。
*/
DeleteKeyFrameDescs?: Array;
/**
* 取值 1 表示清空视频打点信息,其他值无意义。
同一个请求里,ClearKeyFrameDescs 与 AddKeyFrameDescs 不能同时出现。
*/
ClearKeyFrameDescs?: number;
/**
* 新增的一组标签,单个媒体文件最多 16 个标签,单个标签最多 32 个字符。同一个请求里,AddTags 参数必须与 DeleteTags 都不同。
*/
AddTags?: Array;
/**
* 要删除的一组标签。同一个请求里,AddTags 参数必须与 DeleteTags 都不同。
*/
DeleteTags?: Array;
/**
* 取值 1 表示清空媒体文件所有标签,其他值无意义。
同一个请求里,ClearTags 与 AddTags 不能同时出现。
*/
ClearTags?: number;
/**
* 新增一组字幕。单个媒体文件最多 16 个字幕。同一个请求中,AddSubtitles 中指定的字幕 Id 必须与 DeleteSubtitleIds 都不相同。
*/
AddSubtitles?: Array;
/**
* 待删除字幕的唯一标识。同一个请求中,AddSubtitles 中指定的字幕 Id 必须与 DeleteSubtitleIds 都不相同。
*/
DeleteSubtitleIds?: Array;
/**
* 取值 1 表示清空媒体文件所有的字幕信息,其他值无意义。
同一个请求里,ClearSubtitles 与 AddSubtitles不能同时出现。
*/
ClearSubtitles?: number;
/**
* 待出库的知识库ID。
*/
DeleteKnowledgeBases?: Array;
/**
* 取值 1 表示从所有知识库中移除此媒体文件,其他值无意义。
同一个请求里,ClearKnowledgeBases 与 DeleteKnowledgeBases 不能同时出现。
*/
ClearKnowledgeBases?: number;
}
/**
* 对视频转自适应码流任务结果类型
*/
export interface MediaProcessTaskAdaptiveDynamicStreamingResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 转自适应码流任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 对视频转自适应码流任务的输入。
*/
Input?: AdaptiveDynamicStreamingTaskInput;
/**
* 对视频转自适应码流任务的输出。
*/
Output?: AdaptiveDynamicStreamingInfoItem;
/**
* 转自适应码流任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 转自适应码流任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* 插帧帧率配置。
*/
export interface FrameRateWithDenInfo {
/**
* 插帧帧率配置控制开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
/**
* 帧率分子,取值范围:非负数,除以分母后小于100,单位:Hz。 默认值 0。 注意:对于转码,该参数会覆盖 VideoTemplate 内部的 Fps。
*/
FpsNum?: number;
/**
* 帧率分母,取值范围:大于等于1。 默认值 1。
*/
FpsDen?: number;
}
/**
* 大模型解析文本转录解析配置
*/
export interface LLMComprehendAsrForUpdate {
/**
* 文本转录任务开关,可选值:
- ON:开启文本转录任务;
- OFF:关闭文本转录任务。
*/
Switch?: string;
}
/**
* 溯源水印参数
*/
export interface TraceWatermarkInput {
/**
* 溯源水印任务开关,此字段必填,可选值:
ON:开启溯源水印;
OFF:关闭溯源水印。
*/
Switch?: string;
/**
* 该字段已废弃,请勿使用。
* @deprecated
*/
Definition?: number;
}
/**
* ModifyPersonSample请求参数结构体
*/
export interface ModifyPersonSampleRequest {
/**
* 素材 ID。
*/
PersonId: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 名称,长度限制:128 个字符。
*/
Name?: string;
/**
* 描述,长度限制:1024 个字符。
*/
Description?: string;
/**
* 素材应用场景,可选值:
1. Recognition:用于内容识别,等价于 Recognition.Face。
2. Review:用于不适宜的内容识别,等价于 Review.Face。
3. All:用于内容识别、不适宜的内容识别,等价于 1+2。
*/
Usages?: Array;
/**
* 五官操作信息。
*/
FaceOperationInfo?: AiSampleFaceOperation;
/**
* 标签操作信息。
*/
TagOperationInfo?: AiSampleTagOperation;
}
/**
* 音视频审核片段。
*/
export interface ReviewAudioVideoSegmentItem {
/**
* 嫌疑片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 嫌疑片段结束的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 嫌疑片段涉及令人反感的信息的分数。
*/
Confidence?: number;
/**
* 嫌疑片段鉴别涉及违规信息的结果建议,取值范围:
review:疑似违规,建议复审;
block:确认违规,建议封禁。
*/
Suggestion?: string;
/**
* 嫌疑片段最可能的违规的标签,取值范围:
Porn:色情;
Terror:暴力;
Polity:不适宜的信息;
Ad:广告;
Illegal:违法;
Abuse:谩骂;
Moan:娇喘。
*/
Label?: string;
/**
* 违规子标签。
*/
SubLabel?: string;
/**
* 嫌疑片段违禁的形式,取值范围:
Image:画面上的人物或图标;
OCR:画面上的文字;
ASR:语音中的文字;
Voice:声音。
*/
Form?: string;
/**
* 当 Form 为 Image 或 OCR 时有效,表示嫌疑人物、图标或文字出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
*/
AreaCoordSet?: Array;
/**
* 当 Form 为 OCR 或 ASR 时有效,表示识别出来的 OCR 或 ASR 文本内容。
*/
Text?: string;
/**
* 当 Form 为 OCR 或 ASR 时有效,表示嫌疑片段命中的违规关键词列表。
*/
KeywordSet?: Array;
/**
* 嫌疑图片 URL (图片不会永久存储,到达
PicUrlExpireTime 时间点后图片将被删除)。
*/
Url?: string;
/**
* 嫌疑图片 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
PicUrlExpireTime?: string;
}
/**
* 点播文件视频转动图结果信息
*/
export interface MediaAnimatedGraphicsInfo {
/**
* 视频转动图结果信息
*/
AnimatedGraphicsSet: Array;
}
/**
* DescribeSnapshotByTimeOffsetTemplates请求参数结构体
*/
export interface DescribeSnapshotByTimeOffsetTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 指定时间点截图模板唯一标识过滤条件,数组长度限制:100。
*/
Definitions?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
/**
* 模板类型过滤条件,可选值:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
}
/**
* ModifyHeadTailTemplate返回参数结构体
*/
export interface ModifyHeadTailTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音画质检测的LLM 大模型检测发现的单条问题。
*/
export interface QualityInspectLLMDetectionIssue {
/**
* 问题分类标签。
*/
Tag?: string;
/**
* 问题描述。
*/
Description?: string;
/**
* 该问题的质量得分
取值范围:[0, 100]
*/
Score?: number;
/**
* 该问题的判断置信度
取值范围:[0, 100]
*/
Confidence?: number;
/**
* 问题起始时间。
单位:毫秒。
*/
StartTimeMs?: number;
/**
* 问题结束时间。
单位:毫秒。
*/
EndTimeMs?: number;
/**
* 附加数据(JSON 格式),如严重程度等补充信息。
*/
ExtraData?: string;
}
/**
* 预付费商品实例
*/
export interface ProductInstance {
/**
* 预付费商品实例类型,取值有:
StarterPackage:点播新手包。MiniProgramPlugin:点播小程序插件。ResourcePackage:点播资源包。
*/
ProductType?: string;
/**
* 资源包实例起始日期。使用 ISO 日期格式。
*/
StartTime?: string;
/**
* 资源包实例过期日期。使用 ISO 日期格式。
*/
ExpireTime?: string;
/**
* 资源包实例ID。对应每个资源包,系统会分配相应的资源。续费或者升级资源包时,需要带上这个资源ID。
*/
ProductInstanceId?: string;
/**
* 系统最近一次扣除资源包的日期。使用 ISO 日期格式。
*/
LastConsumeDate?: string;
/**
* 资源包绑定 License 状态,取值有:
0:未绑定。1:已绑定。
*/
BindStatus?: number;
/**
* 预付费资源包实例中包含的资源包列表。
* @deprecated
*/
ProductInstanceResourceSet?: Array;
/**
* 预付费资源包实例中包含的资源包列表。
*/
ResourceSet?: Array;
/**
* 资源包实例的状态,取值有:
Effective:生效,可用于计费抵扣。Isolated:隔离,不可用于计费抵扣。
*/
ProductInstanceStatus?: string;
/**
* 资源包实例的可退还状态,取值有:
FullRefund:可全额退款。Denied:不可退款。
*/
RefundStatus?: string;
/**
* 自动续费状态,取值有:
Never:不自动续费。Expire:到期自动续费。ExpireOrUseOut:到期或用完自动续费。NotSupport:不支持。
*/
RenewStatus?: string;
}
/**
* 画质修复控制参数
*/
export interface RepairInfo {
/**
* 画质修复控制开关,可选值:
ON:开启画质修复;
OFF:关闭画质修复。
*/
Switch: string;
/**
* 画质修复类型,仅当画质修复控制开关为 ON 时有效,可选值:
weak:轻画质修复;
normal:正常画质修复;
strong:强画质修复。
默认值:weak。
*/
Type?: string;
}
/**
* CDN 日志信息
*/
export interface CdnLogInfo {
/**
* 日志所属日期, 格式为:yyyy-MM-dd ,如2018-03-01。
*/
Date?: string;
/**
* 日志名称,格式为:日期小时-域名
如 example.com。
*/
Name?: string;
/**
* 日志下载链接,24小时内下载有效。
*/
Url?: string;
/**
* 日志起始时间,使用 ISO 日期格式。
*/
StartTime?: string;
/**
* 日志结束时间,使用 ISO 日期格式。
*/
EndTime?: string;
}
/**
* 降码率任务转码结果类型
*/
export interface ReduceMediaBitrateTranscodeResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 转码任务的输入。
*/
Input?: TranscodeTaskInput;
/**
* 转码任务的输出。
*/
Output?: MediaTranscodeItem;
/**
* 转码进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 转码任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 转码任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* 简单加密加解密密钥对。
*/
export interface SimpleAesEdkPair {
/**
* 加密后的数据密钥。
*/
Edk?: string;
/**
* 数据密钥。返回的数据密钥 DK 为 Base64 编码字符串。
*/
Dk?: string;
}
/**
* 字幕信息。
*/
export interface MediaSubtitleInfo {
/**
* 字幕信息列表。
*/
SubtitleSet: Array;
}
/**
* 语音全文识别的输入。
*/
export interface AiRecognitionTaskAsrFullTextResultInput {
/**
* 语音全文识别模板 ID。
*/
Definition?: number;
}
/**
* DeleteLLMComprehendTemplate返回参数结构体
*/
export interface DeleteLLMComprehendTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 小程序音视频审核信息单元
*/
export interface MediaMiniProgramReviewInfoItem {
/**
* 模板id。小程序视频发布的视频所对应的转码模板ID,为0代表原始视频。
*/
Definition?: number;
/**
* 视频元信息。
*/
MetaData?: MediaMetaData;
/**
* 小程序音视频审核视频播放地址。
*/
Url?: string;
/**
* 小程序视频发布状态:
Pass:成功。
Rejected:未通过。
*/
ReviewResult?: string;
/**
* 小程序音视频审核元素。
*/
ReviewSummary?: Array;
}
/**
* 视频处理任务统计数据。
*/
export interface TaskStatData {
/**
* 任务类型。
Transcoding: 普通转码
Transcoding-TESHD: 极速高清转码
Editing: 视频编辑
Editing-TESHD: 极速高清视频编辑
AdaptiveBitrateStreaming: 自适应码流
ContentAudit: 内容审核
ContentRecognition: 内容识别
RemoveWatermark: 去水印
ExtractTraceWatermark: 提取水印
AddTraceWatermark: 添加水印
RebuildMedia: 音画质重生
QualityInspect: 音画质检测
Transcode: 转码,包含普通转码、极速高清和视频编辑(不推荐使用)
VoiceTranslation: 语音翻译
JITTranscoding: 即时转码
VideoSnapshot: 视频截图
JITEncryption: 即时加密
*/
TaskType?: string;
/**
* 任务数统计数据概览,用量单位为秒。
*/
Summary?: Array;
/**
* 不同规格任务统计数据详情。
转码规格:
Remuxing: 转封装
Audio: 音频转码
Standard.H264.SD: H.264编码方式标清转码
Standard.H264.HD: H.264编码方式高清转码
Standard.H264.FHD: H.264编码方式全高清转码
Standard.H264.2K: H.264编码方式2K转码
Standard.H264.4K: H.264编码方式4K转码
Standard.H265.SD: H.265编码方式标清转码
Standard.H265.HD: H.265编码方式高清转码
Standard.H265.FHD: H.265编码方式全高清转码
Standard.H265.2K: H.265编码方式2K转码
Standard.H265.4K: H.265编码方式4K转码
TESHD-10.H264.SD: H.264编码方式标清极速高清转码
TESHD-10.H264.HD: H.264编码方式高清极速高清转码
TESHD-10.H264.FHD: H.264编码方式全高清极速高清转码
TESHD-10.H264.2K: H.264编码方式2K极速高清转码
TESHD-10.H264.4K: H.264编码方式4K极速高清转码
TESHD-10.H265.SD: H.265编码方式标清极速高清转码
TESHD-10.H265.HD: H.265编码方式高清极速高清转码
TESHD-10.H265.FHD: H.265编码方式全高清极速高清转码
TESHD-10.H265.2K: H.265编码方式2K极速高清转码
TESHD-10.H265.4K: H.265编码方式4K极速高清转码
Edit.Audio: 音频编辑
Edit.H264.SD: H.264编码方式标清视频编辑
Edit.H264.HD: H.264编码方式高清视频编辑
Edit.H264.FHD: H.264编码方式全高清视频编辑
Edit.H264.2K: H.264编码方式2K视频编辑
Edit.H264.4K: H.264编码方式4K视频编辑
Edit.H265.SD: H.265编码方式标清视频编辑
Edit.H265.HD: H.265编码方式高清视频编辑
Edit.H265.FHD: H.265编码方式全高清视频编辑
Edit.H265.2K: H.265编码方式2K视频编辑
Edit.H265.4K: H.265编码方式4K视频编辑
Edit.TESHD-10.H264.SD: H.264编码方式标清极速高清视频编辑
Edit.TESHD-10.H264.HD: H.264编码方式高清极速高清视频编辑
Edit.TESHD-10.H264.FHD: H.264编码方式全高清极速高清视频编辑
Edit.TESHD-10.H264.2K: H.264编码方式2K极速高清视频编辑
Edit.TESHD-10.H264.4K: H.264编码方式4K极速高清视频编辑
Edit.TESHD-10.H265.SD: H.265编码方式标清极速高清视频编辑
Edit.TESHD-10.H265.HD: H.265编码方式高清极速高清视频编辑
Edit.TESHD-10.H265.FHD: H.265编码方式全高清极速高清视频编辑
Edit.TESHD-10.H265.2K: H.265编码方式2K极速高清视频编辑
Edit.TESHD-10.H265.4K: H.265编码方式4K极速高清视频编辑
去水印、音画质重生规格:
480P: 短边 ≤ 480px
720P: 短边 ≤ 720px
1080P: 短边 ≤ 1080px
2K: 短边 ≤ 1440px
4K: 短边 ≤ 2160px
8K: 短边 ≤ 4320px
Audio: 音频
即时转码规格:
JITTranscoding.H264.SD: H.264编码方式标清即时转码
JITTranscoding.H264.HD: H.264编码方式高清即时转码
JITTranscoding.H264.FHD: H.264编码方式全高清即时转码
JITTranscoding.H264.2K: H.264编码方式2K即时转码
JITTranscoding.Audio: 音频即时转码
JITTranscoding.Copy: 转封装即时转码
视频截图规格:
SnapshotByTimeOffset: 时间点截图
SampleSnapshot: 采样截图
ImageSprite: 雪碧图
*/
Details?: Array;
}
/**
* 音色克隆任务输出。
*/
export interface CloneVoiceAsyncOutput {
/**
* 音色ID
*/
VoiceId?: string;
/**
* 试听音频
*/
DemoAudio?: string;
/**
* 扩展信息
*/
ExtInfo?: string;
}
/**
* CreateVodDomain请求参数结构体
*/
export interface CreateVodDomainRequest {
/**
* 需要接入点播的加速域名。注意:不支持填写泛域名。
*/
Domain: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 需要开启 CDN 加速的区域:
Chinese Mainland:中国境内(不包含港澳台)。
Outside Chinese Mainland: 中国境外。
Global: 全球范围。
如果没有设置 AccelerateArea, 点播会根据用户在腾讯云设置的地域信息自动开通中国境内或者中国境外的 CDN 加速。开启中国境内加速的域名,需要先[备案域名](/document/product/243/18905)。
*/
AccelerateArea?: string;
/**
* 域名类型,取值有: VOD:使用 VOD 产品分发的域名; EdgeOne:使用 EdgeOne 产品分发的域名。不填默认取值为 VOD 。
*/
Type?: string;
}
/**
* 文本全文本识别任务控制参数
*/
export interface OcrFullTextConfigureInfoForUpdate {
/**
* 文本全文识别任务开关,可选值:
ON:开启智能文本全文识别任务;
OFF:关闭智能文本全文识别任务。
*/
Switch?: string;
}
/**
* DeleteRoundPlay请求参数结构体
*/
export interface DeleteRoundPlayRequest {
/**
* 轮播播单唯一标识。
*/
RoundPlayId: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 画面超分控制参数
*/
export interface SuperResolutionInfo {
/**
* 画面超分控制开关,可选值:
ON:开启画面超分;
OFF:关闭画面超分。
*/
Switch: string;
/**
* 画面超分类型,仅当画面超分控制开关为 ON 时有效,可选值:
lq:针对低清晰度有较多噪声视频的超分;
hq:针对高清晰度视频超分。
默认值:lq。
*/
Type?: string;
/**
* 超分倍数,可选值:2。
默认值:2。
*/
Size?: number;
}
/**
* 点播文件雪碧图信息
*/
export interface MediaImageSpriteInfo {
/**
* 特定规格的雪碧图信息集合,每个元素代表一套相同规格的雪碧图。
*/
ImageSpriteSet: Array;
}
/**
* EnhanceMediaQuality请求参数结构体
*/
export interface EnhanceMediaQualityRequest {
/**
* 音画质重生模板 ID。
针对典型的使用场景,云点播提供了多个[预置模板](https://cloud.tencent.com/document/product/266/102586#50604b3f-0286-4a10-a3f7-18218116aff7)。
*/
Definition: number;
/**
* 媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 [视频上传完成事件通知](/document/product/266/7830) 或 [云点播控制台](https://console.cloud.tencent.com/vod/media) 获取该字段。
*/
FileId?: string;
/**
* 媒体的存储路径。
只有[FileID + Path 模式](https://cloud.tencent.com/document/product/266/126825)的子应用可以通过MediaStoragePath发起任务。
FileId和MediaStoragePath必须提供其中一个。
*/
MediaStoragePath?: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 音画质重生后的媒体文件配置。
*/
OutputConfig?: EnhanceMediaQualityOutputConfig;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
}
/**
* 提取视频数字水印任务信息
*/
export interface ExtractBlindWatermarkTask {
/**
* 媒体处理任务 ID。
*/
TaskId?: string;
/**
* 任务流状态,取值:
WAITING:等待中;
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 错误码,0 表示成功,其他值表示失败。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 提取数字水印的文件输入信息。
*/
InputInfo?: ExtractBlindWatermarkInputInfo;
/**
* 数字水印类型,可选值:blind-basic:基础版权数字水印; blind-ab:ab版权数字水印;
*/
Type?: string;
/**
* 标记是否检测到水印,如果该参数为true, Result字段将返回水印提取结果,如果该参数为false,Result字段不会返回。
*/
IsDetected?: boolean;
/**
* 提取出的数字水印内容,当没有检测到水印时该字段不会返回。
*/
Result?: string;
/**
* 溯源水印提取出的播放者的 ID,以十六进制表示,共6位。
*/
ResultUV?: string;
/**
* 提取数字水印配置。
*/
ExtractBlindWatermarkConfig?: ExtractBlindWatermarkTaskConfig;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
}
/**
* UpdateAigcApiToken请求参数结构体
*/
export interface UpdateAigcApiTokenRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 要更新Api Key
*/
ApiToken: string;
/**
* Merge(默认,对 ExtInfo JSON 按顶层 key 合并)、Overwrite(直接覆盖)
*/
ActionType?: string;
/**
* token 的扩展信息
*/
ExtInfo?: string;
}
/**
* 音色设计任务。
*/
export interface DesignVoiceAsyncTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码,0 表示成功,其他值表示失败:
40000:输入参数不合法,请检查输入参数;60000:源文件错误(如视频数据损坏),请确认源文件是否正常;70000:内部服务错误,建议重试。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 视频处理类错误码 列表。
*/
ErrCodeExt?: string;
/**
* 音色设计任务输入信息。
*/
Input?: DesignVoiceAsyncInput;
/**
* 音色设计任务输出信息。
*/
Output?: DesignVoiceAsyncOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 拉取上传进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* DescribeImageProcessingTemplates请求参数结构体
*/
export interface DescribeImageProcessingTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 图片处理模板标识列表。长度限制:100。
*/
Definitions?: Array;
/**
* 模板类型过滤条件,可选值:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
}
/**
* 人脸识别结果片段
*/
export interface AiRecognitionTaskFaceSegmentItem {
/**
* 识别片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 识别片段终止的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 识别片段置信度。取值:0~100。
*/
Confidence?: number;
/**
* 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。
*/
AreaCoordSet?: Array;
}
/**
* ProcessMedia返回参数结构体
*/
export interface ProcessMediaResponse {
/**
* 任务 ID
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateWordSamples返回参数结构体
*/
export interface CreateWordSamplesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 智能分类任务控制参数
*/
export interface ClassificationConfigureInfoForUpdate {
/**
* 智能分类任务开关,可选值:
ON:开启智能分类任务;
OFF:关闭智能分类任务。
*/
Switch?: string;
}
/**
* DeleteAdaptiveDynamicStreamingTemplate返回参数结构体
*/
export interface DeleteAdaptiveDynamicStreamingTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AIGC 高级自定义主体信息
*/
export interface AigcAdvancedCustomElementInfo {
/**
* 主体 ID。
*/
Id?: string;
/**
* 主体名字。
*/
Name?: string;
/**
* 主体音色 ID。
*/
VoiceId?: string;
/**
* 主体描述。
*/
Description?: string;
/**
* 主体创建时间。格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
CreateTime?: string;
}
/**
* DescribeKnowledgeBases请求参数结构体
*/
export interface DescribeKnowledgeBasesRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:100,最大值:100。
*/
Limit?: number;
/**
* 按知识库名称精确匹配筛选,不填则返回所有知识库。
*/
Name?: string;
}
/**
* CreateWordSamples请求参数结构体
*/
export interface CreateWordSamplesRequest {
/**
* 关键词应用场景,可选值:
1. Recognition.Ocr:通过光学字符识别技术,进行内容识别;
2. Recognition.Asr:通过音频识别技术,进行内容识别;
3. Review.Ocr:通过光学字符识别技术,进行不适宜内容识别;
4. Review.Asr:通过音频识别技术,进行不适宜内容识别;
可合并简写为:
5. Recognition:通过光学字符识别技术、音频识别技术,进行内容识别,等价于 1+2;
6. Review:通过光学字符识别技术、音频识别技术,进行不适宜内容识别,等价于 3+4;
7. All:通过光学字符识别技术、音频识别技术,进行内容识别、不适宜内容识别,等价于 1+2+3+4。
*/
Usages: Array;
/**
* 关键词,数组长度限制:100。
*/
Words: Array;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 智能按帧标签任务控制参数
*/
export interface FrameTagConfigureInfo {
/**
* 智能按帧标签任务开关,可选值:
ON:开启智能按帧标签任务;
OFF:关闭智能按帧标签任务。
*/
Switch: string;
/**
* 截帧间隔,单位为秒,当不填时,默认截帧间隔为 1 秒,最小值为 0.5 秒。
*/
ScreenshotInterval?: number;
}
/**
* DeleteVodDomain请求参数结构体
*/
export interface DeleteVodDomainRequest {
/**
* 要删除的点播加速域名。
*/
Domain: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 视频画面模糊检测的控制参数。
*/
export interface BlurConfigureInfo {
/**
* 视频画面模糊检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
}
/**
* MPS智能字幕模板输入
*/
export interface MPSSmartSubtitleTemplateForUpdate {
/**
* 智能字幕模板唯一标识
*/
Definition: number;
/**
* 智能字幕模板名称
长度限制:64 个字符。
*/
Name: string;
/**
* 智能字幕模板描述信息
长度限制:256 个字符。
*/
Comment: string;
/**
* 智能字幕字幕语言类型
0: 源语言
1: 翻译语言
2: 源语言+翻译语言
当TranslateSwitch为OFF时仅支持取0
当TranslateSwitch为ON时仅支持取1或2
*/
SubtitleType: number;
/**
* 智能字幕视频源语言
OCR识别仅支持以下语言:
zh_en:中英
multi:其他
ASR识别和纯字幕翻译当前支持以下语言:
auto:自动识别
zh:简体中文
en:英语
ja:日语
ko:韩语
zh-PY:中英粤
zh_medical:中文医疗
vi:越南语
ms:马来语
id:印度尼西亚语
fil:菲律宾语
th:泰语
pt:葡萄牙语
tr:土耳其语
ar:阿拉伯语
es:西班牙语
hi:印地语
fr:法语
de:德语
it:意大利语
zh_dialect:中文方言
zh_en:中英
yue:粤语
ru:俄语
prime_zh:中英方言
af-ZA:南非荷兰语(南非)
sq-AL:阿尔巴尼亚语(阿尔巴尼亚)
am-ET:阿姆哈拉语(埃塞俄比亚)
ar-DZ:阿拉伯语(阿尔及利亚)
ar-BH:阿拉伯语(巴林)
ar-EG:阿拉伯语(埃及)
ar-IQ:阿拉伯语(伊拉克)
ar-IL:阿拉伯语(以色列)
ar-JO:阿拉伯语(约旦)
ar-KW:阿拉伯语(科威特)
ar-LB:阿拉伯语(黎巴嫩)
ar-MR:阿拉伯语(毛里塔尼亚)
ar-MA:阿拉伯语(摩洛哥)
ar-OM:阿拉伯语(阿曼)
ar-QA:阿拉伯语(卡塔尔)
ar-SA:阿拉伯语(沙特阿拉伯)
ar-PS:阿拉伯语(巴勒斯坦国)
ar-SY:阿拉伯语(叙利亚)
ar-TN:阿拉伯语(突尼斯)
ar-AE:阿拉伯语(阿拉伯联合酋长国)
ar-YE:阿拉伯语(也门)
hy-AM:亚美尼亚语(亚美尼亚)
az-AZ:阿塞拜疆语(阿塞拜疆)
eu-ES:巴斯克语(西班牙)
bn-BD:孟加拉语(孟加拉)
bn-IN:孟加拉语(印度)
bs-BA:波斯尼亚语(波斯尼亚和黑塞哥维那)
bg-BG:保加利亚语(保加利亚)
my-MM:缅甸语(缅甸)
ca-ES:加泰罗尼亚语(西班牙)
hr-HR:克罗地亚语(克罗地亚)
cs-CZ:捷克语(捷克共和国)
da-DK:丹麦语(丹麦)
nl-BE:荷兰语(比利时)
nl-NL:荷兰语(荷兰)
en-AU:英语(澳大利亚)
en-CA:英语(加拿大)
en-GH:英语(加纳)
en-HK:英语(中国香港)
en-IN:英语(印度)
en-IE:英语(爱尔兰)
en-KE:英语(肯尼亚)
en-NZ:英语(新西兰)
en-NG:英语(尼日利亚)
en-PK:英语(巴基斯坦)
en-PH:英语(菲律宾)
en-SG:英语(新加坡)
en-ZA:英语(南非)
en-TZ:英语(坦桑尼亚)
en-GB:英语(英国)
en-US:英语(美国)
et-EE:爱沙尼亚语(爱沙尼亚)
fil-PH:菲律宾语(菲律宾)
fi-FI:芬兰语(芬兰)
fr-BE:法语(比利时)
fr-CA:法语(加拿大)
fr-FR:法语(法国)
fr-CH:法语(瑞士)
gl-ES:加利西亚语(西班牙)
ka-GE:格鲁吉亚语(格鲁吉亚)
el-GR:希腊语(希腊)
gu-IN:古吉拉特语(印度)
iw-IL:希伯来语(以色列)
hi-IN:印地语(印度)
hu-HU:匈牙利语(匈牙利)
is-IS:冰岛语(冰岛)
id-ID:印度尼西亚语(印度尼西亚)
it-IT:意大利语(意大利)
it-CH:意大利语(瑞士)
ja-JP:日语(日本)
jv-ID:爪哇语(印度尼西亚)
kn-IN:卡纳达语(印度)
kk-KZ:哈萨克语(哈萨克斯坦)
km-KH:高棉语(柬埔寨)
rw-RW:卢旺达语(卢旺达)
ko-KR:韩语(韩国)
lo-LA:老挝语(老挝)
lv-LV:拉脱维亚语(拉脱维亚)
lt-LT:立陶宛语(立陶宛)
mk-MK:马其顿语(北马其顿)
ms-MY:马来语(马来西亚)
ml-IN:马拉雅拉姆语(印度)
mr-IN:马拉地语(印度)
mn-MN:蒙古语(蒙古)
ne-NP:尼泊尔语(尼泊尔)
no-NO:博克马尔挪威语(挪威)
fa-IR:波斯语(伊朗)
pl-PL:波兰语(波兰)
pt-BR:葡萄牙语(巴西)
pt-PT:葡萄牙语(葡萄牙)
ro-RO:罗马尼亚语(罗马尼亚)
ru-RU:俄语(俄罗斯)
sr-RS:塞尔维亚语(塞尔维亚)
si-LK:僧伽罗语(斯里兰卡)
sk-SK:斯洛伐克语(斯洛伐克)
sl-SI:斯洛文尼亚语(斯洛文尼亚)
st-ZA:南索托语(南非)
es-AR:西班牙语(阿根廷)
es-BO:西班牙语(玻利维亚)
es-CL:西班牙语(智利)
es-CO:西班牙语(哥伦比亚)
es-CR:西班牙语(哥斯达黎加)
es-DO:西班牙语(多米尼加共和国)
es-EC:西班牙语(厄瓜多尔)
es-SV:西班牙语(萨尔瓦多)
es-GT:西班牙语(危地马拉)
es-HN:西班牙语(洪都拉斯)
es-MX:西班牙语(墨西哥)
es-NI:西班牙语(尼加拉瓜)
es-PA:西班牙语(巴拿马)
es-PY:西班牙语(巴拉圭)
es-PE:西班牙语(秘鲁)
es-PR:西班牙语(波多黎各)
es-ES:西班牙语(西班牙)
es-US:西班牙语(美国)
es-UY:西班牙语(乌拉圭)
es-VE:西班牙语(委内瑞拉)
su-ID:巽他语(印度尼西亚)
sw-KE:斯瓦希里语(肯尼亚)
sw-TZ:斯瓦希里语(坦桑尼亚)
sv-SE:瑞典语(瑞典)
ta-IN:泰米尔语(印度)
ta-MY:泰米尔语(马来西亚)
ta-SG:泰米尔语(新加坡)
ta-LK:泰米尔语(斯里兰卡)
te-IN:泰卢固语(印度)
th-TH:泰语(泰国)
ts-ZA:聪加语(南非)
tr-TR:土耳其语(土耳其)
uk-UA:乌克兰语(乌克兰)
ur-IN:乌尔都语(印度)
ur-PK:乌尔都语(巴基斯坦)
uz-UZ:乌兹别克语(乌兹别克斯坦)
ve-ZA:文达语(南非)
vi-VN:越南语(越南)
xh-ZA:科萨语(南非)
zu-ZA:祖鲁语(南非)
*/
VideoSrcLanguage?: string;
/**
* 智能字幕文件格式:
- ASR识别翻译处理类型下:
- vtt: WebVTT 格式字幕
- srt: SRT 格式字幕
- 不填或填空:不生成字幕文件
- 纯字幕翻译处理类型下:
- original:与源文件一致
- vtt: WebVTT 格式字幕
- srt: SRT 格式字幕
- OCR识别翻译处理类型下:
- vtt: WebVTT 格式字幕
- srt: SRT 格式字幕
注意:
- ASR识别方式下,翻译大于等于2种语言时不允许传空或不传;
- 纯字幕翻译方式下,不允许传空或不传
- OCR类型的任务,在开启压制时,允许不传或传空
*/
SubtitleFormat?: string;
/**
* 字幕翻译开关
ON: 开启翻译
OFF: 关闭翻译
注意:纯字幕翻译方式下,不传默认是打开的,不允许传空或OFF;
*/
TranslateSwitch?: string;
/**
* 字幕翻译目标语言
当TranslateSwitch为ON的时候生效,翻译语言列表:
ab:阿布哈兹语
ace:亚齐语
ach:阿乔利语
af:南非荷兰语
ak:契维语(阿坎语)
am:Amharic
ar:阿拉伯语
as:阿萨姆语
ay:艾马拉语
az:阿塞拜疆语
ba:巴什基尔语
ban:巴厘语
bbc:巴塔克托巴语
bem:Bemba
bew:Betawi
bg:保加利亚语
bho:博杰普尔语
bik:Bikol
bm:班巴拉语
bn:孟加拉语
br:布列塔尼语
bs:波斯尼亚语
btx:巴塔克卡罗语
bts:巴塔克西马隆贡语
bua:布里亚特语
ca:加泰罗尼亚语
ceb:宿务语
cgg:Kiga
chm:草原马里语
ckb:库尔德语(索拉尼语)
cnh:哈卡钦语
co:科西嘉语
crh:克里米亚鞑靼语
crs:塞舌尔克里奥尔语
cs:捷克语
cv:楚瓦什语
cy:威尔士语
da:丹麦语
de:德语
din:Dinka
doi:多格来语
dov:敦贝语
dv:第维埃语
dz:宗卡语
ee:Ewe
el:希腊语
en:英语
eo:世界语
es:西班牙语
et:爱沙尼亚语
eu:巴斯克语
fa:波斯语
ff:富拉语
fi:芬兰语
fil:菲律宾语(塔加拉语)
fj:斐济语
fr:法语
fr-CA:法语(加拿大)
fr-FR:法语(法国)
fy:弗里斯兰语
ga:爱尔兰语
gaa:加 (Ga) 语
gd:苏格兰盖尔语
gl:加利西亚语
gn:瓜拉尼语
gom:贡根语
gu:古吉拉特语
gv:马恩岛语
ha:Hausa
haw:夏威夷语
he:希伯来语
hi:印地语
hil:希利盖农语
hmn:苗语
hr:克罗地亚语
hrx:洪斯吕克语
ht:海地克里奥尔语
hu:匈牙利语
hy:亚美尼亚语
id:印度尼西亚语
ig:Igbo
ilo:伊洛果语
is:冰岛语
it:意大利语
iw:希伯来语
ja:日语
jv:爪哇语
ka:格鲁吉亚语
kk:哈萨克语
km:高棉语
kn:卡纳达语
ko:韩语
kri:Krio
ku:库尔德语(库尔曼吉语)
ktu:吉土巴语
ky:吉尔吉斯语
la:拉丁语
lb:卢森堡语
lg:干达语(卢干达语)
li:林堡语
lij:利古里亚语
lmo:伦巴第语
ln:林加拉语
lo:老挝语
lt:立陶宛语
ltg:拉特加莱语
luo:Luo
lus:米佐语
lv:拉脱维亚语
mai:迈蒂利语
mak:马卡萨
mg:马尔加什语
mi:毛利语
min:米南语
mk:马其顿语
ml:马拉雅拉姆语
mn:蒙古语
mr:马拉地语
ms:马来语
mt:马耳他语
my:缅甸语
ne:尼泊尔语
new:尼瓦尔语
nl:荷兰语
no:挪威语
nr:恩德贝莱语(南部)
nso:北索托语(塞佩蒂语)
nus:努尔语
ny:齐切瓦语(尼扬贾语)
oc:奥克斯坦语
om:Oromo
or:奥里亚语
pa:旁遮普语
pag:邦阿西楠语
pam:邦板牙语
pap:Papiamento
pl:波兰语
ps:Pashto
pt:葡萄牙语
pt-BR:葡萄牙语(巴西)
pt-PT:葡萄牙语(葡萄牙)
qu:克丘亚语
ro:罗马尼亚语
rom:罗姆语
rn:Rundi
ru:俄语
rw:卢旺达语
sa:梵语
scn:西西里语
sd:信德语
sg:Sango
shn:掸语
si:僧伽罗语
sk:斯洛伐克语
sl:斯洛文尼亚语
sm:萨摩亚语
sn:修纳语
so:索马里语
sq:阿尔巴尼亚语
sr:塞尔维亚语
ss:斯瓦特语
st:塞索托语
su:巽他语
sv:瑞典语
sw:斯瓦希里语
szl:西里西亚语
ta:泰米尔语
te:泰卢固语
tet:德顿语
tg:塔吉克语
th:泰语
ti:提格里尼亚语
tk:土库曼语
tn:茨瓦纳语
tr:土耳其语
ts:聪加语
tt:鞑靼语
ug:维吾尔语
uk:乌克兰语
ur:乌尔都语
uz:乌兹别克语
vi:越南语
xh:科萨语
yi:意第绪语
yo:约鲁巴语
yua:尤卡坦玛雅语
yue:粤语
zh:简体中文
zh-TW:中文(繁体)
zu:祖鲁语
注意:多语言方式,则使用 / 分割,如:en/ja,表示英语和日语。
*/
TranslateDstLanguage?: string;
/**
* 字幕处理类型:
- 0:ASR识别字幕
- 1:纯字幕翻译
- 2:OCR识别字幕
注意:不传的情况下,默认是ASR方式
*/
ProcessType?: number;
/**
* 字幕OCR提取框选区域配置
*/
SelectingSubtitleAreasConfig?: MPSSelectingSubtitleAreasConfig;
/**
* 压制模板id,只有ProcessType为0或2(任务类型为ASR或OCR)时才允许填写。开启多个翻译语言时,不允许填写。
*/
SubtitleEmbedId?: number;
/**
* 说话人识别开关,可选值:
0:表示不开启说话人识别;
1:表示开启说话人识别。
*/
SpeakerMode?: number;
/**
* 说话人识别输出到字幕文件,可选值:
0:表示不输出到字幕文件;
1:表示输出到vtt字幕文件
注意:使用此参数SpeakerMode的值不能为0。
*/
SpeakerLabel?: number;
}
/**
* UpdateVoice返回参数结构体
*/
export interface UpdateVoiceResponse {
/**
* 更新后的音色信息
*/
Voice?: VoiceInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 语音鉴别涉及令人不适宜的信息的任务控制参数。
*/
export interface PoliticalAsrReviewTemplateInfoForUpdate {
/**
* 语音鉴别涉及令人不适宜的信息的任务开关,可选值:
ON:开启语音鉴别涉及令人不适宜的信息的任务;
OFF:关闭语音鉴别涉及令人不适宜的信息的任务。
*/
Switch?: string;
/**
* 判定涉嫌违规的分数阈值,当音视频审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当音视频审核达到该分数以上,认为需人工复核。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* 微信小程序发布任务类型
*/
export interface WechatMiniProgramPublishTaskInput {
/**
* 发布视频所对应的转码模板 ID,为 0 代表原始视频。
*/
SourceDefinition: number;
}
/**
* SetCLSPushTarget请求参数结构体
*/
export interface SetCLSPushTargetRequest {
/**
* 域名。
*/
Domain: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 要设置的中国大陆地区的日志推送目标。
*/
ChineseMainlandCLSTargetInfo?: AreaCLSTargetInfo;
/**
* 要设置的中国大陆以外地区的日志推送目标。
*/
OutsideChineseMainlandCLSTargetInfo?: AreaCLSTargetInfo;
}
/**
* 大模型解析模板详情。
*/
export interface LLMComprehendTemplateItem {
/**
* 图片异步处理模板唯一标识。
*/
Definition?: number;
/**
* 图片异步处理模板名称。
*/
Name?: string;
/**
* 图片异步处理模板描述信息。
*/
Comment?: string;
/**
* 模板类型
枚举值:
- Preset: 系统预置模板
- Custom: 用户自定义模板
*/
Type?: string;
/**
* 解析级别,可选值为:
*/
Level?: string;
/**
* 分段摘要解析配置
*/
Summary?: LLMComprehendSummary;
/**
* 文本转录解析配置
*/
Asr?: LLMComprehendAsr;
/**
* 人脸识别解析配置
*/
FaceRecognition?: LLMComprehendFaceRecognition;
/**
* 模板创建时间,使用 ISO 日期格式。
*/
CreateTime?: string;
/**
* 模板最后修改时间,使用 ISO 日期格式。
*/
UpdateTime?: string;
}
/**
* AI 样本管理,人脸数据操作。
*/
export interface AiSampleFaceOperation {
/**
* 操作类型,可选值:add(添加)、delete(删除)、reset(重置)。重置操作将清空该人物已有人脸数据,并添加 FaceContents 指定人脸数据。
*/
Type: string;
/**
* 人脸 ID 集合,当 Type为delete 时,该字段必填。
*/
FaceIds?: Array;
/**
* 人脸图片 [Base64](https://tools.ietf.org/html/rfc4648) 编码后的字符串集合,仅支持 jpeg、png 图片格式。
当 Type为add 或 reset 时,该字段必填;
数组长度限制:5 张图片。
注意:图片必须是单人像正面人脸较清晰的照片,像素不低于 200*200。
*/
FaceContents?: Array;
}
/**
* SVG水印模板输入参数
*/
export interface SvgWatermarkInputForUpdate {
/**
* 水印的宽度,支持 px,%,W%,H%,S%,L% 六种格式:
当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素;当填 0px 且
Height 不为 0px 时,表示水印的宽度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的宽度取原始 SVG 图像的宽度;
当字符串以 W% 结尾,表示水印 Width 为视频宽度的百分比大小,如 10W% 表示 Width 为视频宽度的 10%;
当字符串以 H% 结尾,表示水印 Width 为视频高度的百分比大小,如 10H% 表示 Width 为视频高度的 10%;
当字符串以 S% 结尾,表示水印 Width 为视频短边的百分比大小,如 10S% 表示 Width 为视频短边的 10%;
当字符串以 L% 结尾,表示水印 Width 为视频长边的百分比大小,如 10L% 表示 Width 为视频长边的 10%;
当字符串以 % 结尾时,含义同 W%。
默认值为 10W%。
*/
Width?: string;
/**
* 水印的高度,支持 px,%,W%,H%,S%,L% 六种格式:
当字符串以 px 结尾,表示水印 Height 单位为像素,如 100px 表示 Height 为 100 像素;当填 0px 且
Width 不为 0px 时,表示水印的高度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的高度取原始 SVG 图像的高度;
当字符串以 W% 结尾,表示水印 Height 为视频宽度的百分比大小,如 10W% 表示 Height 为视频宽度的 10%;
当字符串以 H% 结尾,表示水印 Height 为视频高度的百分比大小,如 10H% 表示 Height 为视频高度的 10%;
当字符串以 S% 结尾,表示水印 Height 为视频短边的百分比大小,如 10S% 表示 Height 为视频短边的 10%;
当字符串以 L% 结尾,表示水印 Height 为视频长边的百分比大小,如 10L% 表示 Height 为视频长边的 10%;
当字符串以 % 结尾时,含义同 H%。
默认值为 0px。
*/
Height?: string;
/**
* 水印周期配置,用于配置水印周期性地显示与隐藏。
主要使用场景是:为了视频防遮标,在视频多个地方设置水印,这些水印按固定顺序周期性地显示与隐藏。
例如,设置 A、B、C、D 4 个水印分别位于视频的左上角、右上角、右下角、左下角处,视频开始时,{ A 显示 5 秒 -> B 显示 5 秒 -> C 显示 5 秒 -> D 显示 5 秒 } -> A 显示 5 秒 -> B 显示 5 秒 -> ...,任何时刻只显示一处水印。
花括号 {} 表示由 A、B、C、D 4 个水印组成的大周期,可以看出每个大周期持续 20 秒。
可以看出,A、B、C、D 都是周期性地显示 5 秒、隐藏 15 秒,且四者有固定的显示顺序。
此配置项即用来描述单个水印的周期配置。
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
CycleConfig?: WatermarkCycleConfigForUpdate;
}
/**
* 音视频审核 Ocr 文字鉴别涉及令人不安全的信息的任务结果类型
*/
export interface AiReviewTaskTerrorismOcrResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 音视频审核 Ocr 文字涉及令人不安全的信息的任务输入。
*/
Input?: AiReviewTerrorismOcrTaskInput;
/**
* 音视频审核 Ocr 文字涉及令人不安全的信息的任务输出。
*/
Output?: AiReviewTerrorismOcrTaskOutput;
/**
* 音视频审核 Ocr 文字涉及令人不安全的信息的任务进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* DescribeProcessImageAsyncTemplates请求参数结构体
*/
export interface DescribeProcessImageAsyncTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 图片异步处理模板唯一标识过滤条件,数组长度最大值:100。
*/
Definitions?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
}
/**
* AIGC 生图任务的输出媒体文件配置。
*/
export interface AigcImageOutputConfig {
/**
* 存储模式
枚举值:
- Temporary: 临时存储,生成的视频文件不会存储到云点播,可在事件通知中获取到临时访问的 URL,有效期 7 天
- Permanent: 永久存储,生成的视频文件将存储到云点播,可在事件通知中获取到 FileId
默认值:Temporary
*/
StorageMode?: string;
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
ExpireTime?: string;
/**
* 生成图片的分辨率。各模型可选值:
- OG:1K、2K、4K,默认1K;
- GG 2.5:1K、2K、4K,默认1K;
- GG 3.0:1K、2K、4K,默认1K;
- GG 3.1:720P、1K、2K、4K,默认1K;
- Kling 2.1:1k、2k,默认1k;
- Kling 3.0:1k、2k,默认1k;
- Kling 3.0-Omni:1k、2k、4k,默认1k;
- Kling O1:1k、2k、4k,默认1k;
- SI 4.0:1K、2K、4K,默认1K;
- SI 4.5:2K、4K,默认2K;
- SI 5.0-lite:2K、3K,默认2K;
- Vidu q2:1080p、2K、4K,默认1080p;
- Hunyuan 3.0:暂不支持本字段,可通过
ExtInfo字段设置分辨率; - Qwen 0925:暂不支持本字段,可通过
ExtInfo字段设置分辨率;
*/
Resolution?: string;
/**
* 指定所生成图片的宽高比。
- OG:1:1, 3:2, 2:3, 3:4, 4:3, 16:9, 9:16, 21:9, 9:21;
- GG 2.5:1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9;
- GG 3.0:1:1, 2:3, 3:2, 3:4, 4:3, 4:5, 5:4, 9:16, 16:9, 21:9;
- GG 3.1:1:1, 1:4, 1:8, 2:3, 3:2, 3:4, 4:1, 4:3, 4:5, 5:4, 8:1, 9:16, 16:9, 21:9;
- Kling 2.1:16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
- Kling 3.0:16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
- Kling 3.0-Omni:16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9, auto;
- Kling O1:16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9, auto;
- Vidu q2:16:9、9:16、1:1、3:4、4:3、21:9、2:3、3:2;
- SI 4.0:不支持此参数,可通过prompt指定16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
- SI 4.5:不支持此参数,可通过prompt指定16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
- SI 5.0-lite:不支持此参数,可通过prompt指定16:9, 9:16, 1:1, 4:3, 3:4, 3:2, 2:3, 21:9;
- Hunyuan 3.0:不支持;
- Qwen 2.0:不支持;
- Qwen 0925:不支持;
*/
AspectRatio?: string;
/**
* 是否允许人物或人脸生成。取值有:
AllowAdult:允许生成成人; Disallowed:禁止在图片中包含人物或人脸;
*/
PersonGeneration?: string;
/**
* 是否开启输入内容的合规性检查。取值有:
Enabled:开启; Disabled:关闭;
*/
InputComplianceCheck?: string;
/**
* 是否开启输出内容的合规性检查。取值有:
Enabled:开启; Disabled:关闭;
*/
OutputComplianceCheck?: string;
/**
* 生成图片张数。各模型可选值:
其他模型不生效。
*/
OutputImageCount?: number;
/**
* 指定模型输出图片文件格式,若不指定则跟随模型默认值。可选值:
*/
OutputFormat?: string;
/**
* 是否开启图标水印,默认为Disabled。取值有:
*/
LogoAdd?: string;
}
/**
* ProcessImageAsync请求参数结构体
*/
export interface ProcessImageAsyncRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 需要进行图片处理的FileId。不能与Url同时输入。
*/
FileId?: string;
/**
* 需要进行图片处理的Url。不能与FileId同时输入。
*/
Url?: string;
/**
* 需要进行图片处理的Base64,要求图片文件小于4MB。使用 Base64 时,请不要添加任何前缀如 data:image/png;base64,,只需提供 Base64 编码字符串本身。
*/
Base64?: string;
/**
* 图片处理参数。
*/
ImageTaskInput?: ProcessImageAsyncTaskInput;
/**
* 图片处理任务的输出媒体文件配置。
*/
OutputConfig?: ProcessImageAsyncOutputConfig;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* 文本关键识别结果。
*/
export interface AiRecognitionTaskOcrWordsResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 文本关键词识别任务输入信息。
*/
Input?: AiRecognitionTaskOcrWordsResultInput;
/**
* 文本关键词识别任务输出信息。
*/
Output?: AiRecognitionTaskOcrWordsResultOutput;
/**
* 文本关键词识别任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 文本关键词识别任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 文本关键词识别任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* 语音鉴别涉及令人反感的信息的任务控制参数
*/
export interface PornAsrReviewTemplateInfo {
/**
* 语音鉴别涉及令人反感的信息的任务开关,可选值:
ON:开启语音鉴别涉及令人反感的信息的任务;
OFF:关闭语音鉴别涉及令人反感的信息的任务。
*/
Switch: string;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* 视频拆条结果。
*/
export interface AiRecognitionTaskSegmentResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 视频拆条任务输入信息。
*/
Input?: AiRecognitionTaskSegmentResultInput;
/**
* 视频拆条任务输出信息。
*/
Output?: AiRecognitionTaskSegmentResultOutput;
/**
* 视频拆条任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 视频拆条任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 视频拆条任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* CreateAigcImageTask返回参数结构体
*/
export interface CreateAigcImageTaskResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频画面抖动重影检测的控制参数。
*/
export interface JitterConfigureInfo {
/**
* 视频画面抖动重影检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
}
/**
* 字幕信息。
*/
export interface MediaSubtitleItem {
/**
* 字幕的唯一标识。
*/
Id?: string;
/**
* 字幕名字。
*/
Name?: string;
/**
* 字幕语言。常见的取值如下:
zh:中文;
en:英文;
ja:日文;
ko:韩文;
vi:越南语;
ms:马来语;
th:泰语;
pt:葡萄牙语;
tr:土耳其语;
ar:阿拉伯语;
es:西班牙语;
hi:印地语;
fr:法语。
其他取值参考 [RFC5646](https://tools.ietf.org/html/rfc5646)
*/
Language?: string;
/**
* 字幕格式。取值范围如下:
vtt
*/
Format?: string;
/**
* 字幕 URL。
*/
Url?: string;
/**
* 字幕来源,取值范围:
UserUploaded:用户上传;
AIRecognition:AI 识别,通过语音识别或语音翻译生成。
*/
Source?: string;
}
/**
* 音画质检测的控制参数配置。
*/
export interface QualityInspectConfig {
/**
* 检测项名称。
枚举值:
- LowEvaluation: 视频无参考评分(MOS)
- AudioEvaluation: 音频无参考评分(MOS)
- Mosaic: 马赛克检测
- CrashScreen: 花屏检测
- Blur: 模糊检测
- Jitter: 抖动检测
- Noise: 噪点检测
- QRCode: 二维码检测
- BarCode: 条形码检测
- AppletCode: 小程序码检测
- BlackWhiteEdge: 黑白边检测
- SolidColorScreen: 纯色屏检测
- LowLighting: 低光照
- HighLighting: 过曝
- NoVoice: 静音检测
- LowVoice: 低音检测
- HighVoice: 爆音检测
- AudioNoise: 音频噪声检测
- 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轨道
- BodyPoseCheck: 人体姿态异常
- BodyDetailCheck: 人体细节异常
- PhysicRulesCheck: 物理规律违反
- ObjectConsistencyCheck: 物体一致性异常
- FormatCheck: 格式异常
- AudioReverb: 混响程度
- AudioDiscontinuity: 音频不连续
- AudioSpeechQuality: 语音清晰度
- AudioHighLoudness: 响度失真
- AudioLoudnessJitter: 音量变化剧烈
- BackgroundMusic: 存在背景音乐
- NoBackgroundMusic: 不存在背景音乐
- VideoAesthetic: 视频美学评分
- AudioVideoAsync: 音画不同步
- AudioSubtitleAsync: 音频与字幕不同步
*/
Type: string;
/**
* 能力配置开关。
枚举值:
默认值:ON
*/
Switch?: string;
/**
* 采样方式
枚举值:
*/
Sampling?: string;
/**
* 采样间隔时间
单位:毫秒。
*/
IntervalTime?: number;
/**
* 异常持续时间。
单位:毫秒。
*/
Duration?: number;
/**
* 检测项对应的阈值,不同检测项对应阈值不同。
*/
Threshold?: string;
}
/**
* 语音违禁任务控制参数
*/
export interface ProhibitedAsrReviewTemplateInfoForUpdate {
/**
* 语音违禁任务开关,可选值:
ON:开启语音违禁任务;
OFF:关闭语音违禁任务。
*/
Switch?: string;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* MPS字幕压制模块文字描边配置
*/
export interface MPSSubtitleOutlineConfig {
/**
* 文字描边配置开关,0关闭,1开启,默认0
*/
SubtitleOutlineConfigSwitch?: number;
/**
* 描边宽度,默认单位像素,底层默认值为源视频高度的0.3%
*/
OutlineWidth?: number;
/**
* 描边宽度单位,0 像素,1百分比,默认为0,像素
*/
OutlineWidthUnit?: number;
/**
* 描边颜色。6位16进制RGB。不填默认黑色。
*/
OutlineColor?: string;
/**
* 描边透明度。(0,1] 正浮点数。不填默认1,完全不透明
*/
OutlineAlpha?: number;
}
/**
* ModifyAnimatedGraphicsTemplate返回参数结构体
*/
export interface ModifyAnimatedGraphicsTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateSceneAigcImageTask返回参数结构体
*/
export interface CreateSceneAigcImageTaskResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 语音翻译识别片段。
*/
export interface AiRecognitionTaskAsrTranslateSegmentItem {
/**
* 语音翻译识别片段置信度。取值:0~100。
*/
Confidence?: number;
/**
* 语音翻译识别片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 语音翻译识别片段终止的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 识别文本。
*/
Text?: string;
/**
* 翻译文本。
*/
Translation?: string;
}
/**
* DeleteCLSTopic返回参数结构体
*/
export interface DeleteCLSTopicResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AIGC 场景化生视频任务的输出媒体文件配置。
*/
export interface SceneAigcVideoOutputConfig {
/**
* 存储模式。取值有: Permanent:永久存储,生成的图片文件将存储到云点播,可在事件通知中获取到 FileId; Temporary:临时存储,生成的图片文件不会存储到云点播,可在事件通知中获取到临时访问的 URL;
默认值:Temporary
*/
StorageMode?: string;
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 [创建分类](/document/product/266/7812) 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ExpireTime?: string;
/**
* 指定所生成视频的宽高比。输入格式为 W:H。仅生商品图场景有效。可选:16:9、9:16。
*/
AspectRatio?: string;
/**
* 生成视频时长。可选值4、6、8秒
*/
Duration?: number;
}
/**
* LiveRealTimeClip请求参数结构体
*/
export interface LiveRealTimeClipRequest {
/**
* 推流直播码。
*/
StreamId: string;
/**
* 流剪辑的开始时间,格式参照 ISO 日期格式说明。
*/
StartTime: string;
/**
* 流剪辑的结束时间,格式参照 ISO 日期格式说明。
*/
EndTime: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 是否固化。0 不固化,1 固化。默认不固化。
*/
IsPersistence?: number;
/**
* 剪辑固化后的视频存储过期时间。格式参照 ISO 日期格式。填“9999-12-31T23:59:59Z”表示永不过期。过期后该媒体文件及其相关资源(转码结果、雪碧图等)将被永久删除。仅 IsPersistence 为 1 时有效,默认剪辑固化的视频永不过期。
*/
ExpireTime?: string;
/**
* 剪辑固化后的视频点播任务流处理,详见上传指定任务流。仅 IsPersistence 为 1 时有效。
*/
Procedure?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。仅 IsPersistence 为 1 时有效。
*/
ClassId?: number;
/**
* 来源上下文,用于透传用户请求信息,上传完成回调 将返回该字段值,最长 250 个字符。仅 IsPersistence 为 1 时有效。
*/
SourceContext?: string;
/**
* 会话上下文,用于透传用户请求信息,当指定 Procedure 参数后,任务流状态变更回调 将返回该字段值,最长 1000 个字符。仅 IsPersistence 为 1 时有效。
*/
SessionContext?: string;
/**
* 是否需要返回剪辑后的视频元信息。0 不需要,1 需要。默认不需要。
*/
MetaDataRequired?: number;
/**
* 云点播中添加的用于时移播放的域名,必须在云直播已经关联录制模板和开通时移服务。如果本接口的首次调用时间在 2021-01-01T00:00:00Z 之后,则此字段为必选字段。
*/
Host?: string;
/**
* 剪辑的直播流信息:
默认剪辑直播原始流。当StreamInfo中指定的Type为Transcoding,则剪辑TemplateId对应的直播转码流。
*/
StreamInfo?: LiveRealTimeClipStreamInfo;
/**
* 系统保留字段,请勿填写。
*/
ExtInfo?: string;
}
/**
* DeleteAdaptiveDynamicStreamingTemplate请求参数结构体
*/
export interface DeleteAdaptiveDynamicStreamingTemplateRequest {
/**
* 自适应转码模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 文本全文识别片段。
*/
export interface AiRecognitionTaskOcrFullTextSegmentItem {
/**
* 识别片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 识别片段终止的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 识别片段结果集。
*/
TextSet?: Array;
}
/**
* 色彩增强控制参数
*/
export interface ColorEnhanceInfo {
/**
* 色彩增强控制开关
枚举值:
*/
Switch: string;
/**
* 色彩增强类型,仅当色彩增强控制开关为 ON 时有效,可选值:
weak:轻色彩增强;normal:正常色彩增强;strong:强色彩增强。默认值:weak。
*/
Type?: string;
}
/**
* DeleteEnhanceMediaTemplate返回参数结构体
*/
export interface DeleteEnhanceMediaTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 编辑视频的结果文件输出。
*/
export interface EditMediaOutputConfig {
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。
*/
MediaName?: string;
/**
* 输出文件格式,可选值:mp4、hls。默认是 mp4。
*/
Type?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 [创建分类](/document/product/266/7812) 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ExpireTime?: string;
/**
* 输出的视频信息。
*/
VideoStream?: EditMediaVideoStream;
/**
* 极速高清转码参数。
*/
TEHDConfig?: EditMediaTEHDConfig;
}
/**
* ModifyPersonSample返回参数结构体
*/
export interface ModifyPersonSampleResponse {
/**
* 素材信息。
*/
Person?: AiSamplePerson;
/**
* 处理失败的五官信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
FailFaceInfoSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateAigcCustomElement请求参数结构体
*/
export interface CreateAigcCustomElementRequest {
/**
* 主体名称。不能超过20个字符
*/
ElementName: string;
/**
* 主体描述。
不能超过100个字符。
*/
ElementDescription: string;
/**
* 主体正面参考图。
支持传入图片URL(确保可访问)
图片格式支持.jpg / .jpeg / .png
图片文件大小不能超过10MB,图片宽高尺寸不小于300px,图片宽高比要在1:2.5 ~ 2.5:1之间。
*/
ElementFrontalImage: string;
/**
* 主体其他参考列表 可通过上传多张、不同角度的主体参考图来定义主体外观 至少上传1张参考图,至多上传3张参考图。
*/
ElementReferList: Array;
}
/**
* 视频拆条任务信息。
*/
export interface SplitMediaTaskSegmentInfo {
/**
* 视频拆条任务输入信息。
*/
Input?: SplitMediaTaskInput;
/**
* 视频拆条任务输出信息。
*/
Output?: TaskOutputMediaInfo;
/**
* 任务类型为 Procedure 的任务 ID。若发起[视频拆条](https://cloud.tencent.com/document/api/266/51098)任务时,视频拆条任务信息列表指定了任务流模板(ProcedureName),当该任务流模板指定了 MediaProcessTask、AiAnalysisTask、AiRecognitionTask 中的一个或多个时发起该任务。
*/
ProcedureTaskId?: string;
/**
* 任务类型为 ReviewAudioVideo 的任务 ID。若发起[视频拆条](https://cloud.tencent.com/document/api/266/51098)任务时,视频拆条任务信息列表指定了任务流模板(ProcedureName),当该任务流模板指定了 ReviewAudioVideoTask 时,发起该任务。
*/
ReviewAudioVideoTaskId?: string;
}
/**
* 鉴别涉及令人反感的信息的任务控制参数。
*/
export interface PornConfigureInfoForUpdate {
/**
* 画面鉴别涉及令人反感的信息的控制参数。
*/
ImgReviewInfo?: PornImgReviewTemplateInfoForUpdate;
/**
* 语音鉴别涉及令人反感的信息的控制参数。
*/
AsrReviewInfo?: PornAsrReviewTemplateInfoForUpdate;
/**
* 文本鉴别涉及令人反感的信息的控制参数。
*/
OcrReviewInfo?: PornOcrReviewTemplateInfoForUpdate;
}
/**
* Asr 文字涉及令人反感的信息
*/
export interface AiReviewPornAsrTaskOutput {
/**
* Asr 文字涉及令人反感的信息的评分,分值为0到100。
*/
Confidence?: number;
/**
* Asr 文字涉及令人反感的信息的结果建议,取值范围:
pass。
review。
block。
*/
Suggestion?: string;
/**
* Asr 文字有涉及令人反感的信息的嫌疑的视频片段列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet?: Array;
/**
* Asr 文字有涉及令人反感的信息的嫌疑的视频片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl?: string;
/**
* Asr 文字有涉及令人反感的信息的嫌疑的视频片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime?: string;
}
/**
* 音色设计任务输入。
*/
export interface DesignVoiceAsyncInput {
/**
* 音色描述
*/
Prompt?: string;
/**
* 音色信息
*/
VoiceSettings?: VoiceSettings;
/**
* 试听文本
*/
PreviewText?: string;
/**
* 扩展参数,json字符串
*/
ExtParam?: string;
}
/**
* 云点播中存储的文件。
*/
export interface FileContent {
/**
* 对象键。
*/
Key?: string;
/**
* 对象最后修改时间,为 ISO8601格式,例如2019-05-24T10:56:40Z。
*/
LastModified?: string;
/**
* 对象的实体标签(Entity Tag),是对象被创建时标识对象内容的信息标签,可用于检查对象的内容是否发生变化。
*/
ETag?: string;
/**
* 对象大小,单位为Byte。
*/
Size?: number;
/**
* 枚举值请参见[存储类型](https://cloud.tencent.com/document/product/436/33417)文档,例如 STANDARD_IA,ARCHIVE。
*/
StorageClass?: string;
/**
* 此文件对应的媒体文件的唯一标识。
*/
FileId?: string;
/**
* 文件分类: Video: 视频文件 Audio: 音频文件 Image: 图片文件 Other: 其他文件
*/
Category?: string;
/**
* 可选值有:
- OriginalFiles:原文件
- TranscodeFiles:转码文件
- AdaptiveDynamicStreamingFiles:转自适应码流文件
- SubtitleFiles:字幕文件
- SampleSnapshotFiles:采样截图文件
- ImageSpriteFiles:雪碧图截图文件
- SnapshotByTimeOffsetFiles:时间点截图文件
*/
FileType?: string;
/**
* 视频模板号,模板定义参见转码模板。
*/
Definition?: number;
/**
* 字幕ID。
仅当FileType=SubtitleFiles时有值。
*/
SubtitleID?: string;
}
/**
* AIGC 生图任务信息
*/
export interface AigcImageTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 扩展错误码。空字符串表示成功,其它值表示失败。
枚举值:
- RequestLimitExceeded: 模型调用超出并发限制。
- InvalidParameter.VoilationContent: 输入 prompt 违反内容安全策略。
- InvalidParameterValue: 参数错误。
- FailedOperation: 模型任务堆积。
- InternalError: 内部错误。
- InvalidParameter: 非法参数。
- InvalidParameter.MediaFormat: 无效的媒体格式。
- ContentModerationFailed: 内容审核未通过。
- ResourceInsufficient: 资源不足。
- ModelGenerateFailed: 模型生成失败。
- ResourceNotFound: 资源不存在。
- OperationCanceled: 操作已取消。
- TaskTimeout: 任务超时。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* AIGC 生图任务的输入信息。
*/
Input?: AigcImageTaskInput;
/**
* AIGC 生图任务的输出信息。
*/
Output?: AigcImageTaskOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* SimpleHlsClip返回参数结构体
*/
export interface SimpleHlsClipResponse {
/**
* 裁剪后的视频地址。
*/
Url?: string;
/**
* 裁剪后的视频元信息。目前Size,Rotate,VideoDuration,AudioDuration 几个字段暂时缺省,没有真实数据。
*/
MetaData?: MediaMetaData;
/**
* 剪辑固化后的视频的媒体文件的唯一标识。
*/
FileId?: string;
/**
* 剪辑固化后的视频任务流 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AIGC 生视频任务的输出文件信息。
*/
export interface AigcVideoTaskOutputFileInfo {
/**
* 存储模式。取值有:
Permanent:永久存储; Temporary:临时存储;
默认值:Temporary
*/
StorageMode?: string;
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。当 StorageMode 为 Permanent 时有效。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。当 StorageMode 为 Permanent 时有效。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
ExpireTime?: string;
/**
* 文件类型,例如 mp4、flv 等。
*/
FileType?: string;
/**
* 媒体文件播放地址。
*/
FileUrl?: string;
/**
* 文件内容。当 UsageType 为 position_info 时有返回值。
*/
FileContent?: string;
/**
* 媒体文件 ID。当 StorageMode 为 Permanent 时有效。
*/
FileId?: string;
/**
* 输出视频的元信息。
*/
MetaData?: MediaMetaData;
/**
* 文件的用途类型。
枚举值:
- scene_url: 3D 场景文件,FileUrl 字段有返回值。
- point_url: 点云文件,FileUrl 字段有返回值。
- mesh_url: 原始网格模型文,FileUrl 字段有返回值。
- mesh_simplified_url: 简化后的网格模型文件,FileUrl 字段有返回值。
- position_info: 场景空间位置信息,FileContent 字段有返回值。
- image_url: 生成的图片,FileUrl 字段有返回值。
*/
UsageType?: string;
}
/**
* DeleteAIAnalysisTemplate请求参数结构体
*/
export interface DeleteAIAnalysisTemplateRequest {
/**
* 音视频内容分析模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 智能插帧控制参数
*/
export interface VideoFrameInterpolationInfo {
/**
* 智能插帧控制开关,可选值:
ON:开启智能插帧;
OFF:关闭智能插帧。
*/
Switch: string;
/**
* 智能插帧帧率,帧率范围为 (0, 100],仅当智能插帧控制开关为 ON 时有效。默认跟源文件帧率一致。
*/
Fps?: number;
}
/**
* EditMedia请求参数结构体
*/
export interface EditMediaRequest {
/**
* 输入视频的类型,可以取的值为 File,Stream 两种。
*/
InputType: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 输入的视频文件信息,当 InputType 为 File 时必填。
*/
FileInfos?: Array;
/**
* 输入的流信息,当 InputType 为 Stream 时必填。
*/
StreamInfos?: Array;
/**
* 编辑模板 ID,取值有 10,20,不填代表使用 10 模板。
10:拼接时,以分辨率最高的输入为基准;
20:拼接时,以码率最高的输入为基准。
*/
Definition?: number;
/**
* [任务流](https://cloud.tencent.com/document/product/266/33475#.E4.BB.BB.E5.8A.A1.E6.B5.81)名称,如果要对生成的新视频执行任务流时填写。
*/
ProcedureName?: string;
/**
* 编辑后生成的文件配置。
*/
OutputConfig?: EditMediaOutputConfig;
/**
* 标识来源上下文,用于透传用户请求信息,在EditMediaComplete回调和任务流状态变更回调将返回该字段值,最长 1000个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* CreateComplexAdaptiveDynamicStreamingTask请求参数结构体
*/
export interface CreateComplexAdaptiveDynamicStreamingTaskRequest {
/**
* 点播[应用](/document/product/266/14574) ID。
*/
SubAppId: number;
/**
* 主媒体文件的媒体 ID。
*/
FileId: string;
/**
* 自适应码流参数,最大支持8个。
*/
StreamParaSet: Array;
/**
* 片头片尾列表,支持多片头片尾,最大可支持 4 个。如果填写了该字段,AudioSet 和 SubtitleSet 中指定的媒体的起始时间将会自动调整,和主媒体保持同步。
*/
HeadTailSet?: Array;
/**
* 多语言音频流参数,最大支持16个。每个数组元素对应自适应码流中的一条音频流。如果要将主媒体文件中的音频流添加到输出的自适应码流中,那么也需要在此处指定。数组中元素的顺序将决定自适应码流中的音频流顺序。如果输入的媒体文件同时带有视频流和音频流,那么视频流将被忽略。
*/
AudioSet?: Array;
/**
* 多语言字幕参数,最大可支持16个。每个数组元素对应自适应码流中的一条字幕流。数组中元素的顺序将决定自适应码流中的字幕流顺序。
*/
SubtitleSet?: Array;
}
/**
* 语音翻译结果。
*/
export interface AiRecognitionTaskAsrTranslateResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 语音翻译任务输入信息。
*/
Input?: AiRecognitionTaskAsrTranslateResultInput;
/**
* 语音翻译任务输出信息。
*/
Output?: AiRecognitionTaskAsrTranslateResultOutput;
/**
* 语音翻译任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 语音翻译任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 语音翻译任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* DescribeFileAttributes返回参数结构体
*/
export interface DescribeFileAttributesResponse {
/**
* 任务 ID 。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ProcessImageAsync返回参数结构体
*/
export interface ProcessImageAsyncResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* License 请求次数统计数据。
*/
export interface LicenseUsageDataItem {
/**
* 数据所在时间区间的开始时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#52)。如:当时间粒度为天,2018-12-01T00:00:00+08:00,表示2018年12月1日(含)到2018年12月2日(不含)区间。
*/
Time: string;
/**
* License 请求次数。
*/
Count: number;
}
/**
* 图片异步处理配置。
*/
export interface ProcessImageAsyncTask {
/**
* 图片转码输出配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
EncodeConfig?: ImageEncodeConfig;
/**
* 图片增强配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
EnhanceConfig?: ImageEnhanceConfig;
/**
* 图片美颜配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
BeautyConfig?: ImageBeautyConfig;
}
/**
* 画质重生输出的音频信息
*/
export interface RebuildMediaTargetAudioStream {
/**
* 音频流的编码格式。
当外层参数 Container 为 mp3 时,可选值为:
libmp3lame。
当外层参数 Container 为 ogg 或 flac 时,可选值为:
flac。
当外层参数 Container 为 m4a 时,可选值为:
libfdk_aac;
libmp3lame;
ac3。
当外层参数 Container 为 mp4 或 flv 时,可选值为:
libfdk_aac:更适合 mp4;
libmp3lame:更适合 flv;
mp2。
当外层参数 Container 为 hls 时,可选值为:
libfdk_aac。
*/
Codec?: string;
/**
* 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。
当取值为 0,表示由云点播自动设置码率。
*/
Bitrate?: number;
/**
* 音频流的采样率,可选值:
32000
44100
48000
单位:Hz。
*/
SampleRate?: number;
/**
* 音频通道方式,可选值:
1:单通道
2:双通道
6:立体声
当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为立体声。
默认值:2。
*/
AudioChannel?: number;
}
/**
* DescribeBlindWatermarkTemplates请求参数结构体
*/
export interface DescribeBlindWatermarkTemplatesRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 数字水印模板唯一标识过滤条件,数组长度限制:100。
*/
Definitions?: Array;
/**
* 数字水印类型,可选值:blind-basic:基础版权数字水印;blind-nagra:Nagra取证水印;
*/
Type?: string;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数
默认值:10;
最大值:100。
*/
Limit?: number;
}
/**
* 视频拼接源文件信息(2017 版)
*/
export interface ConcatFileInfo2017 {
/**
* 错误码
0:成功;
其他值:失败。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 视频拼接源文件的 ID。
*/
FileId?: string;
/**
* 视频拼接源文件的地址。
*/
FileUrl?: string;
/**
* 视频拼接源文件的格式。
*/
FileType?: string;
}
/**
* 图片智能内容识别任务结果
*/
export interface ContentReviewResult {
/**
* 结果类型,取值范围:
Porn.Image:图片画面中的鉴别令人反感的信息结果;
Terrorism.Image:图片画面中的鉴别令人不安全的信息结果;
Political.Image:图片画面中的鉴别令人不适宜信息结果;
Porn.Ocr:图片 OCR 文字中的鉴别令人反感的信息结果;
Terrorism.Ocr:图片 OCR 文字中的鉴别令人不安全的信息结果;
Political.Ocr:图片 OCR 文字中的鉴别令人不适宜信息结果。
*/
Type?: string;
/**
* 图片画面中的鉴别令人反感的信息结果,当 Type 为 Porn.Image 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
PornImageResult?: PornImageResult;
/**
* 图片画面中的鉴别令人不安全的信息结果,当 Type 为 Terrorism.Image 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
TerrorismImageResult?: TerrorismImageResult;
/**
* 图片画面中的鉴别令人不适宜信息结果,当 Type 为 Political.Image 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
PoliticalImageResult?: PoliticalImageResult;
/**
* 图片 OCR 文字中的鉴别令人反感的信息结果,当 Type 为 Porn.Ocr 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
PornOcrResult?: ContentReviewOcrResult;
/**
* 图片 OCR 中的鉴别令人不安全的信息结果,当 Type 为 Terrorism.Ocr 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
TerrorismOcrResult?: ContentReviewOcrResult;
/**
* 图片 OCR 文字中的鉴别令人不适宜信息结果,当 Type 为 Political.Ocr 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
PoliticalOcrResult?: ContentReviewOcrResult;
}
/**
* DescribeAigcAdvancedCustomElements返回参数结构体
*/
export interface DescribeAigcAdvancedCustomElementsResponse {
/**
* AIGC 高级自定义主体信息。
*/
ElementSet?: Array;
/**
* 记录总数。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 场景化 AIGC 生视频任务信息
*/
export interface SceneAigcVideoTaskInput {
/**
* 场景化生图参数配置。
*/
SceneInfo?: AigcVideoSceneInfo;
/**
* 输入图片列表。
*/
FileInfos?: Array;
/**
* 场景化生图任务的输出媒体文件配置。
*/
OutputConfig?: SceneAigcVideoOutputConfig;
}
/**
* 对视频截雪碧图任务结果类型
*/
export interface MediaProcessTaskImageSpriteResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 对视频截雪碧图任务的输入。
*/
Input?: ImageSpriteTaskInput;
/**
* 对视频截雪碧图任务的输出。
注意:此字段可能返回 null,表示取不到有效值。
*/
Output?: MediaImageSpriteItem;
/**
* 对视频截雪碧图任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 截雪碧图任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 截雪碧图任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* DescribeJustInTimeTranscodeTemplates返回参数结构体
*/
export interface DescribeJustInTimeTranscodeTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 模板详情列表。
*/
JustInTimeTranscodeTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频画面花屏检测的控制参数。
*/
export interface CrashScreenConfigureInfo {
/**
* 视频画面花屏检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
}
/**
* CreateReviewTemplate请求参数结构体
*/
export interface CreateReviewTemplateRequest {
/**
* 需要返回的违规标签列表,可选值为:
Porn:色情;
Terror:暴力;
Polity:不适宜的信息;
Illegal:违法;
Abuse:谩骂;
Ad:广告;
Moan:娇喘。
*/
Labels: Array;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: string;
/**
* 审核模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 审核模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
}
/**
* DescribeMediaInfos返回参数结构体
*/
export interface DescribeMediaInfosResponse {
/**
* 媒体文件信息列表。
*/
MediaInfoSet?: Array;
/**
* 不存在的文件 ID 列表。
*/
NotExistFileIdSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteProcedureTemplate返回参数结构体
*/
export interface DeleteProcedureTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAigcQuota返回参数结构体
*/
export interface ModifyAigcQuotaResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeReviewTemplates返回参数结构体
*/
export interface DescribeReviewTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 审核模板详情列表。
*/
ReviewTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAdaptiveDynamicStreamingTemplates返回参数结构体
*/
export interface DescribeAdaptiveDynamicStreamingTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 转自适应码流模板详情列表。
*/
AdaptiveDynamicStreamingTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 小程序音视频审核信息
*/
export interface MediaMiniProgramReviewInfo {
/**
* 音视频审核信息列表。
*/
MiniProgramReviewList: Array;
}
/**
* ForbidMediaDistribution返回参数结构体
*/
export interface ForbidMediaDistributionResponse {
/**
* 不存在的文件 ID 列表。
*/
NotExistFileIdSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteBlindWatermarkTemplate返回参数结构体
*/
export interface DeleteBlindWatermarkTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExtractBlindWatermark返回参数结构体
*/
export interface ExtractBlindWatermarkResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeBlindWatermarkTemplates返回参数结构体
*/
export interface DescribeBlindWatermarkTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 数字水印模板详情列表。
*/
BlindWatermarkTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAdaptiveDynamicStreamingTemplates请求参数结构体
*/
export interface DescribeAdaptiveDynamicStreamingTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 转自适应码流模板唯一标识过滤条件,数组长度限制:100。
*/
Definitions?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
/**
* 模板类型过滤条件,可选值:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
}
/**
* 创建自定义主体输入。
*/
export interface CreateAigcAdvancedCustomElementInput {
/**
* 主体名称。
*/
ElementName?: string;
/**
* 主体描述。
*/
ElementDescription?: string;
/**
* 主体参考方式。
*/
ReferenceType?: string;
/**
* 主体音色。
*/
ElementVoiceId?: string;
/**
* 主体参考视频。
*/
ElementVideoList?: string;
/**
* 主体参考图。
*/
ElementImageList?: string;
/**
* 主体配置标签。
*/
TagList?: string;
}
/**
* ModifyRoundPlay请求参数结构体
*/
export interface ModifyRoundPlayRequest {
/**
* 轮播播单唯一标识。
*/
RoundPlayId: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 启播时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。
*/
StartTime?: string;
/**
* 轮播列表。
数组长度限制:100。
*/
RoundPlaylist?: Array;
/**
* 轮播播单名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 轮播播单描述信息,长度限制:256 个字符。
*/
Desc?: string;
/**
* 播放状态,可选值:Disabled:停止播放。Enabled:启播时长到达后启动播放。
*/
Status?: string;
/**
* 播放模式,可选值:
Loop:循环播放播单;
Linear:单次播放,播单播放完停止播放。
*/
PlayBackMode?: string;
/**
* 过期时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52),过期后将停止播放。“9999-12-31T23:59:59+08:00”表示不过期。
*/
ExpiredTime?: string;
}
/**
* 图片水印模板输入参数
*/
export interface ImageWatermarkInput {
/**
* 水印图片 [Base64](https://tools.ietf.org/html/rfc4648) 编码后的字符串。支持 jpeg、png、gif 图片格式。
*/
ImageContent: string;
/**
* 水印的宽度。支持 %、px 两种格式:
当字符串以 % 结尾,表示水印 Width 为视频宽度的百分比大小,如 10% 表示 Width 为视频宽度的 10%;
当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素。取值范围为[8, 4096]。
默认值:10%。
*/
Width?: string;
/**
* 水印的高度。支持 %、px 两种格式:
当字符串以 % 结尾,表示水印 Height 为视频高度的百分比大小,如 10% 表示 Height 为视频高度的 10%;
当字符串以 px 结尾,表示水印 Height 单位为像素,如 100px 表示 Height 为 100 像素。取值范围为0或[8, 4096]。
默认值:0px,表示 Height 按照原始水印图片的宽高比缩放。
*/
Height?: string;
/**
* 水印重复类型。使用场景:水印为动态图像。取值范围:
once:动态水印播放完后,不再出现;
repeat_last_frame:水印播放完后,停留在最后一帧;
repeat:水印循环播放,直到视频结束(默认值)。
*/
RepeatType?: string;
/**
* 图片透明度,取值范围:[0, 100]
0:完全不透明
100:完全透明
默认值:0。
*/
Transparency?: number;
}
/**
* ModifyWatermarkTemplate请求参数结构体
*/
export interface ModifyWatermarkTemplateRequest {
/**
* 水印模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 水印模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 原点位置,可选值:
TopLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角;
TopRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;
BottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;
BottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下角。
*/
CoordinateOrigin?: string;
/**
* 水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式:
当字符串以 % 结尾,表示水印 XPos 为视频宽度指定百分比,如 10% 表示 XPos 为视频宽度的 10%;
当字符串以 px 结尾,表示水印 XPos 为指定像素,如 100px 表示 XPos 为 100 像素。
*/
XPos?: string;
/**
* 水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式:
当字符串以 % 结尾,表示水印 YPos 为视频高度指定百分比,如 10% 表示 YPos 为视频高度的 10%;
当字符串以 px 结尾,表示水印 YPos 为指定像素,如 100px 表示 YPos 为 100 像素。
*/
YPos?: string;
/**
* 图片水印模板,该字段仅对图片水印模板有效。
*/
ImageTemplate?: ImageWatermarkInputForUpdate;
/**
* 文字水印模板,该字段仅对文字水印模板有效。
*/
TextTemplate?: TextWatermarkTemplateInputForUpdate;
/**
* SVG 水印模板,该字段仅对 SVG 水印模板有效。
*/
SvgTemplate?: SvgWatermarkInputForUpdate;
}
/**
* 创建 AIGC 声音复刻输入信息。
*/
export interface CreateAigcAudioCloneInput {
/**
* 原音频文件,模型将以此参数中传入的音频音色为示例对音色进行复刻。
*/
AudioFileInfo?: AigcAudioCloneInputFileInfo;
/**
* 自定义的声音ID。
*/
VoiceId?: string;
/**
* 复刻试听参数。
*/
Text?: string;
/**
* 音色复刻示例音频。
*/
PromptAudioFileInfo?: AigcAudioCloneInputFileInfo;
/**
* 示例音频对应的文本内容。
*/
PromptText?: string;
/**
* 透传参数。
*/
Payload?: string;
}
/**
* 语音全文识别任务控制参数
*/
export interface AsrFullTextConfigureInfoForUpdate {
/**
* 语音全文识别任务开关,可选值:
ON:开启智能语音全文识别任务;
OFF:关闭智能语音全文识别任务。
*/
Switch?: string;
/**
* 字幕格式列表操作信息。
*/
SubtitleFormatsOperation?: SubtitleFormatsOperation;
/**
* 生成的字幕文件格式,填空字符串表示不生成字幕文件,可选值:
vtt:生成 WebVTT 字幕文件;
srt:生成 SRT 字幕文件。
注意:此字段已废弃,建议使用 SubtitleFormatsOperation。
* @deprecated
*/
SubtitleFormat?: string;
/**
* 媒体源语言,取值范围:
zh:中文普通话;
en:英语;
ja:日语;
zh-ca:粤语。
*/
SrcLanguage?: string;
/**
* 指定字幕名称,长度限制:64 个字符。该值将用于播放器展示。
*/
SubtitleName?: string;
}
/**
* 视频片头片尾识别结果。
*/
export interface AiRecognitionTaskHeadTailResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 视频片头片尾识别任务输入信息。
*/
Input?: AiRecognitionTaskHeadTailResultInput;
/**
* 视频片头片尾识别任务输出信息。
*/
Output?: AiRecognitionTaskHeadTailResultOutput;
/**
* 视频片头片尾识别任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 视频片头片尾识别任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 视频片头片尾识别任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* 音画质重生音频控制控制信息。
*/
export interface RebuildAudioInfo {
/**
* 音频降噪控制参数。
*/
AudioDenoiseInfo?: AudioDenoiseInfo;
}
/**
* RemoveWatermark返回参数结构体
*/
export interface RemoveWatermarkResponse {
/**
* 任务 ID 。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* MPS智能擦除模板输入
*/
export interface MPSSmartEraseTemplateForUpdate {
/**
* 智能擦除模板唯一标识
*/
Definition: number;
/**
* 智能擦除模板名称长度限制:64 个字符。
*/
Name: string;
/**
* 擦除类型
- subtitle 去字幕
- watermark 去水印
- privacy 隐私保护
*/
EraseType: string;
/**
* 智能擦除模板描述信息长度限制:256 个字符。
*/
Comment?: string;
/**
* 字幕擦除配置,EraseType取subtitle或者EraseType不填,对应模板原EraseType为subtitle时生效。
*/
EraseSubtitleConfig?: MPSSmartEraseSubtitleConfig;
/**
* 水印擦除配置,EraseType取watermark或者EraseType不填,对应模板原EraseType为watermark时生效。
*/
EraseWatermarkConfig?: MPSSmartEraseWatermarkConfig;
/**
* 隐私保护配置,EraseType取privacy或者EraseType不填,对应模板原EraseType为privacy时生效。
*/
ErasePrivacyConfig?: MPSSmartErasePrivacyConfig;
/**
* 示例视频或图片的宽,单位像素值
*/
SampleWidth?: number;
/**
* 示例视频或图片的高,单位像素值
*/
SampleHeight?: number;
}
/**
* CreatePersonSample返回参数结构体
*/
export interface CreatePersonSampleResponse {
/**
* 素材信息。
*/
Person?: AiSamplePerson;
/**
* 处理失败的五官定位信息。
*/
FailFaceInfoSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateContentReviewTemplate返回参数结构体
*/
export interface CreateContentReviewTemplateResponse {
/**
* 音视频内容审核模板唯一标识。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyBlindWatermarkTemplate返回参数结构体
*/
export interface ModifyBlindWatermarkTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAnimatedGraphicsTemplate请求参数结构体
*/
export interface ModifyAnimatedGraphicsTemplateRequest {
/**
* 转动图模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 转动图模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 动图宽度(或长边)的最大值,取值范围:0 和 [32, 4096],单位:px。当 Width、Height 均为 0,则分辨率同源;当 Width 为 0,Height 非 0,则 Width 按比例缩放;当 Width 非 0,Height 为 0,则 Height 按比例缩放;当 Width、Height 均非 0,则分辨率按用户指定。默认值:0。
*/
Width?: number;
/**
* 动图高度(或短边)的最大值,取值范围:0 和 [32, 4096],单位:px。当 Width、Height 均为 0,则分辨率同源;当 Width 为 0,Height 非 0,则 Width 按比例缩放;当 Width 非 0,Height 为 0,则 Height 按比例缩放;当 Width、Height 均非 0,则分辨率按用户指定。默认值:0。
*/
Height?: number;
/**
* 分辨率自适应,可选值:
open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。
默认值:open。
*/
ResolutionAdaptive?: string;
/**
* 动图格式,取值为 gif 和 webp。
*/
Format?: string;
/**
* 帧率,取值范围:[1, 30],单位:Hz。
*/
Fps?: number;
/**
* 图片质量,取值范围:[1, 100],默认值为 75。
*/
Quality?: number;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
}
/**
* CreateAigcAudioClone请求参数结构体
*/
export interface CreateAigcAudioCloneRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 原音频文件(需要确保可访问) 模型将以此参数中传入的音频音色为示例对音色进行复刻。
入参限制:注1:音频仅支持格式:mp3、m4a、wav; 注2:上传的音频文件的时长最少应不低于 10 秒,最长应不超过 5 分钟; 注3:上传的音频文件大小需不超过20mb; 注4:音频内容免涉版权,否则会被下架或销毁。
*/
AudioFileInfo: AigcAudioCloneInputFileInfo;
/**
* 自定义的声音ID,示例:"vidu01"。
入参限制:
- 自定义的 voice_id 长度范围[8,256];
- 首字符必须为英文字母;
- 允许数字、字母、横线、下划线;
- 末位字符不可为 -、_
- voice_id 不可与已有 id 重复,否则会报错.
*/
VoiceId: string;
/**
* 复刻试听参数。
参数格式:限制 1000 字符以内,模型将使用复刻后的音色朗读本段文本内容,并返回试听音频链接。 注:试听将根据字符数正常收取语音合成费用。
*/
Text: string;
/**
* 音色复刻示例音频。提供本参数将有助于增强语音合成的音色相似度和稳定性,若使用本参数,需同时上传一小段示例音频。
入参限制:注1:音频仅支持格式:mp3、m4a、wav; 注2:上传的音频文件的时长最少应小于 8 秒; 注3:上传的音频文件大小需不超过20mb。
*/
PromptAudioFileInfo?: AigcAudioCloneInputFileInfo;
/**
* 示例音频对应的文本内容 需确保和音频内容一致,句末需有标点符号做结尾。
*/
PromptText?: string;
/**
* 透传参数。 入参限制:不做任何处理,仅数据传输 注:最多 1048576个字符
*/
Payload?: string;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* 创建 AIGC 音效任务信息。
*/
export interface AigcAudioTask {
/**
* 任务ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 扩展错误码。空字符串表示成功,其它值表示失败。
枚举值:
- RequestLimitExceeded: 调用超出并发限制。
- InvalidParameter.VoilationContent: 输入 prompt 违反内容安全策略。
- InvalidParameterValue: 参数值错误。
- FailedOperation: 模型任务堆积。
- InternalError: 内部错误。
- InvalidParameter: 非法参数。
- InvalidParameter.MediaFormat: 无效的媒体格式。
- ContentModerationFailed: 内容审核未通过。
- ResourceInsufficient: 资源不足。
- ModelGenerateFailed: 模型生成失败。
- ResourceNotFound: 资源不存在。
- OperationCanceled: 操作已取消。
- TaskTimeout: 任务超时。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* AIGC 音频任务的输入信息。
*/
Input?: AigcAudioTaskInput;
/**
* AIGC 音频任务的输出信息。
*/
Output?: AigcAudioTaskOutput;
}
/**
* 采样截图信息
*/
export interface MediaSampleSnapshotItem {
/**
* 采样截图规格 ID,参见[采样截图参数模板](https://cloud.tencent.com/document/product/266/33480#.E9.87.87.E6.A0.B7.E6.88.AA.E5.9B.BE.E6.A8.A1.E6.9D.BF)。
*/
Definition?: number;
/**
* 采样方式,取值范围:
Percent:根据百分比间隔采样。
Time:根据时间间隔采样。
*/
SampleType?: string;
/**
* 采样间隔
当 SampleType 为 Percent 时,该值表示多少百分比一张图。
当 SampleType 为 Time 时,该值表示多少时间间隔一张图,单位秒, 第一张图均为视频首帧。
*/
Interval?: number;
/**
* 生成的截图 url 列表。
*/
ImageUrlSet?: Array;
/**
* 截图如果被打上了水印,被打水印的模板 ID 列表。
*/
WaterMarkDefinition?: Array;
}
/**
* 智能标签任务控制参数
*/
export interface TagConfigureInfoForUpdate {
/**
* 智能标签任务开关,可选值:
ON:开启智能标签任务;
OFF:关闭智能标签任务。
*/
Switch?: string;
}
/**
* DeleteWordSamples请求参数结构体
*/
export interface DeleteWordSamplesRequest {
/**
* 关键词,数组长度限制:100 个词。
*/
Keywords: Array;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* FastEditMedia返回参数结构体
*/
export interface FastEditMediaResponse {
/**
* 快速编辑后的视频的媒体文件的唯一标识。
*/
FileId?: string;
/**
* 快速编辑后的媒体播放地址。
*/
Url?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 空的轨道片段,用来进行时间轴的占位。如需要两个音频片段之间有一段时间的静音,可以用 EmptyTrackItem 来进行占位。
*/
export interface EmptyTrackItem {
/**
* 持续时间,单位为秒。
*/
Duration: number;
}
/**
* AIGC 音效任务的输出信息。
*/
export interface AigcAudioTaskOutput {
/**
* 输出音频信息
*/
AudioInfos?: Array;
/**
* 输出视频信息
*/
VideoInfos?: Array;
}
/**
* AIGC 生视频任务输入的图片文件信息。
*/
export interface AigcVideoTaskInputFileInfo {
/**
* 输入的视频文件类型。取值有:
File:点播媒体文件; Url:可访问的 Url; Base64:图片或视频转换的Base64字符串;
*/
Type?: string;
/**
* 文件分类。取值为:
- Image: 图片;
- Video: 视频;
- Audio: 音频;
*/
Category?: string;
/**
* 媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。当 Type 取值为 File 时,本参数有效。说明:
- 推荐使用小于10M的图片;
- 图片格式的取值为:jpeg,jpg, png。
*/
FileId?: string;
/**
* 可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。
说明:
- 推荐使用小于10M的图片;
- 图片格式的取值为:jpeg,jpg, png。
*/
Url?: string;
/**
* 可访问的文件 Base64。当 Type 取值为 Base64 时,本参数有效。说明:
- 所有文件的文件大小总和不能超过7MB,避免转为 Base64 后超出云API的10MB包大小上限;
- 图片格式应为:jpeg,jpg, png, webp。
- 视频格式应为:mp4, mov, avi。
- 不要有data:image/jpeg;base64,之类的前缀。
*/
Base64?: string;
/**
* 参考类型,GV、Kling、PixVerse模型适用。
注意:
当使用 GV 模型时,可作为参考方式,可选值:asset 表示素材、style 表示风格;
当使用 Kling 模型以及 Category 为 Video 时,可区分参考视频类型,feature 表示特征参考视频,base 表示待编辑视频;
当使用 PixVerse 模型时,可用于多图(主体)参考生模式,可选值:subject 表示主体、background 表示背景;
*/
ReferenceType?: string;
/**
* 用法:Vidu主体Id。
Vidu主体Id:prompt可以通过 @主体Id 的方式使用。当 Category 为 Image 时有效。
*/
ObjectId?: string;
/**
* 适用于 Vidu-q2 模型。
当全部图片携带主体 Id 时,可针对主体设置音色 Id。 当 Category 为 Image 时有效。音色列表:https://shengshu.feishu.cn/sheets/EgFvs6DShhiEBStmjzccr5gonOg
*/
VoiceId?: string;
/**
* 是否保留视频原声。当 Category 为 Video 时有效。取值如下:
Enabled:保留Disabled:不保留
*/
KeepOriginalSound?: string;
/**
* 用于区分输入图像用于首(尾)帧生视频、图生视频或参考生视频。可选值:
- FirstFrame:用于首(尾)帧生视频的首帧 或 图生视频;
- Reference:用于参考生视频;
- LastFrame:用于首(尾)帧生视频的尾帧;
注意,默认是FirstFrame
*/
Usage?: string;
/**
* 仅 PixVerse 模型的多图(主体)参考生模式生效,针对图片指定名字, 用来更精准效果。用法:当本字段值为“小猫”,在 Prompt 中使用 @小猫 精确描述场景。@Text 后必须有空格,如 @小猫 跑步。Prompt 中引用的名称必须与本字段完全一致。
*/
Text?: string;
}
/**
* 贴图轨上的贴图信息。
*/
export interface StickerTrackItem {
/**
* 贴图片段的媒体素材来源,可以是:
点播的媒体文件 ID;
其他媒体文件的下载 URL。
注意:当使用其他媒体文件的下载 URL 作为素材来源,且开启了访问控制(如防盗链)时,需要在 URL 携带访问控制参数(如防盗链签名)。
*/
SourceMedia: string;
/**
* 贴图的持续时间,单位为秒。
*/
Duration: number;
/**
* 贴图在轨道上的起始时间,单位为秒。
*/
StartTime?: number;
/**
* 原点位置,取值有:
Center:坐标原点为中心位置,如画布中心。
默认值:Center。
*/
CoordinateOrigin?: string;
/**
* 贴图原点距离画布原点的水平位置。支持 %、px 两种格式:
当字符串以 % 结尾,表示贴图 XPos 为画布宽度指定百分比的位置,如 10% 表示 XPos 为画布宽度的 10%。当字符串以 px 结尾,表示贴图 XPos 单位为像素,如 100px 表示 XPos 为 100 像素。
默认值:0px。
*/
XPos?: string;
/**
* 贴图原点距离画布原点的垂直位置。支持 %、px 两种格式:
当字符串以 % 结尾,表示贴图 YPos 为画布高度指定百分比的位置,如 10% 表示 YPos 为画布高度的 10%。
当字符串以 px 结尾,表示贴图 YPos 单位为像素,如 100px 表示 YPos 为 100 像素。
默认值:0px。
*/
YPos?: string;
/**
* 贴图的宽度。支持 %、px 两种格式:
当字符串以 % 结尾,表示贴图 Width 为画布宽度的百分比大小,如 10% 表示 Width 为画布宽度的 10%。
当字符串以 px 结尾,表示贴图 Width 单位为像素,如 100px 表示 Width 为 100 像素。
当 Width、Height 均为空,则 Width 和 Height 取贴图素材本身的 Width、Height。
当 Width 为空0,Height 非空,则 Width 按比例缩放
当 Width 非空,Height 为空,则 Height 按比例缩放。
*/
Width?: string;
/**
* 贴图的高度。支持 %、px 两种格式:
当字符串以 % 结尾,表示贴图 Height 为画布高度的百分比大小,如 10% 表示 Height 为画布高度的 10%。
当字符串以 px 结尾,表示贴图 Height 单位为像素,如 100px 表示 Hieght 为 100 像素。
当 Width、Height 均为空,则 Width 和 Height 取贴图素材本身的 Width、Height。
当 Width 为空,Height 非空,则 Width 按比例缩放
当 Width 非空,Height 为空,则 Height 按比例缩放。
*/
Height?: string;
/**
* 对贴图进行的操作,如图像旋转等。
*/
ImageOperations?: Array;
}
/**
* DescribeDrmDataKey返回参数结构体
*/
export interface DescribeDrmDataKeyResponse {
/**
* 密钥列表,包含加密的数据密钥。
*/
KeyList?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAigcAdvancedCustomElements请求参数结构体
*/
export interface DescribeAigcAdvancedCustomElementsRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 分页返回的起始偏移量。将返回第 Offset 到第 Offset+Limit-1 条。
默认值:0
Offset 必须是 Limit 的整数倍。
*/
Offset?: number;
/**
* 分页返回的记录条数。
取值范围:[1, 300]
默认值:10
Offset 必须是 Limit 的整数倍。
*/
Limit?: number;
}
/**
* 降码率任务信息
*/
export interface ReduceMediaBitrateTask {
/**
* 视频处理任务 ID。
*/
TaskId?: string;
/**
* 任务流状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 媒体文件 ID。
*/
FileId?: string;
/**
* 媒体文件名称。
*/
FileName?: string;
/**
* 媒体文件地址。
*/
FileUrl?: string;
/**
* 原始视频的元信息。
*/
MetaData?: MediaMetaData;
/**
* 降码率任务执行状态与结果。
*/
MediaProcessResultSet?: Array;
/**
* 任务流的优先级,取值范围为 [-10, 10]。
*/
TasksPriority?: number;
/**
* 任务流状态变更通知模式。
Finish:只有当任务流全部执行完毕时,才发起一次事件通知;
None:不接受该任务流回调。
*/
TasksNotifyMode?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
}
/**
* DescribeMediaPlayStatDetails返回参数结构体
*/
export interface DescribeMediaPlayStatDetailsResponse {
/**
* 播放统计数据。
*/
PlayStatInfoSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频流配置参数
*/
export interface VideoTemplateInfo {
/**
* 视频流的编码格式,可选值:
libx264:H.264 编码;libx265:H.265 编码;av1:AOMedia Video 1 编码;H.266:H.266 编码。注意: av1,H.266 编码容器目前只支持 mp4 ; H.266 目前只支持恒定 CRF 码率控制方式。
*/
Codec: string;
/**
* 视频帧率,取值范围:[0, 100],单位:Hz。
当取值为 0,表示帧率和原始视频保持一致。
*/
Fps: number;
/**
* 视频流的码率,取值范围:0 和 [128, 100000],单位:kbps。
当取值为 0,表示由云点播自动设置码率。
*/
Bitrate: number;
/**
* 分辨率自适应,可选值:
open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。默认值:open。
*/
ResolutionAdaptive?: string;
/**
* 视频流宽度(或长边)的最大值,取值范围:0 和 [128, 8192],单位:px。
当 Width、Height 均为 0,则分辨率同源;当 Width 为 0,Height 非 0,则 Width 按比例缩放;当 Width 非 0,Height 为 0,则 Height 按比例缩放;当 Width、Height 均非 0,则分辨率按用户指定。默认值:0。
*/
Width?: number;
/**
* 视频流高度(或短边)的最大值,取值范围:0 和 [128, 8192],单位:px。
当 Width、Height 均为 0,则分辨率同源;当 Width 为 0,Height 非 0,则 Width 按比例缩放;当 Width 非 0,Height 为 0,则 Height 按比例缩放;当 Width、Height 均非 0,则分辨率按用户指定。默认值:0。
*/
Height?: number;
/**
* 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊填充。默认值:black 。
*/
FillType?: string;
/**
* 视频恒定码率控制因子,取值范围为[1, 51]。
注意:
如果指定该参数,将使用 CRF 的码率控制方式做转码(视频码率将不再生效);当指定视频流编码格式为 H.266 时,该字段必填,推荐值为 28;如果没有特殊需求,不建议指定该参数。
*/
Vcrf?: number;
/**
* 关键帧 I 帧之间的间隔,取值范围:0 和 [1, 100000],单位:帧数。
当填 0 或不填时,系统将自动设置 gop 长度。
*/
Gop?: number;
/**
* Gop数值单位。
枚举值:
- frame: 表示帧数。
- second: 表示秒数。
默认值:frame
*/
GopUnit?: string;
/**
* 当原始视频为 HDR(High Dynamic Range)时,转码输出是否依然保持 HDR。取值范围:
ON: 如果原始文件是 HDR,则转码输出保持 HDR;否则转码输出为 SDR (Standard Dynamic Range)。OFF: 无论原始文件是 HDR 还是 SDR,转码输出均为 SDR。默认值:OFF。
*/
PreserveHDRSwitch?: string;
/**
* 编码标签,仅当视频流的编码格式为 H.265 编码时有效,可选值:
hvc1 表示 hvc1 标签;hev1 表示 hev1 标签。 默认值:hvc1。
*/
CodecTag?: string;
/**
* 码率控制模式。
枚举值:
- VBR: Variable Bit Rate,动态比特率,根据视频画面的复杂度动态调整输出的码率,使得画面质量更高,适用于存储场景和对画面质量要求较高的应用。
- ABR: Average Bit Rate,平均比特率,尽量保持输出视频的平均码率稳定,但允许短期内的码率波动,适用于需要在保持一定画质的情况下尽量减少整体码率的场景。
- CBR: Constant Bit Rate,恒定比特率,指视频编码时输出的码率保持恒定不变,不考虑画面复杂度的变化,适用于对网络带宽要求较为严格的场景,如直播等。
- VCRF: 恒定质量因子,通过设定一个质量因子来控制视频质量,实现视频的恒定质量编码,码率会根据内容的复杂度自动调整,适用于希望保持一定画质的场景。
默认值:VBR
*/
Mode?: string;
/**
* 参考帧之间的B帧数,默认为自动。
取值范围:[0, 16]
*/
Bframes?: number;
/**
* 分片平均时长。0或不填表示自动,将根据视频的 GOP 等特征自动选择合适的分片时长。
取值范围:[0, 10]
单位:秒
只支持转码模板,暂不支持自适应码流模板。
*/
HlsTime?: number;
/**
* 视频编码标准中对允许使用哪些编码工具或特性的一组预定义组合,适用于不同场景。
枚举值:
- baseline: 只支持I/P帧,并只支持无交错的场景,适用于视频通话、手机视频等场景。
- main: 主流 Profile,提供I帧、P帧、B帧,并支持无交错模式和交错模式。主要用在主流的音视频消费产品如视频播放器、流媒体传输设备上。
- high: 最高编码等级,在Main Profile上添加了8X8的预测,并支持自定义量化。广泛应用在蓝光存储、高清电视等场景。
- default: 随原视频自动填充。
默认值:default
仅 Codec 为 libx264 时该配置项有效。
*/
VideoProfile?: string;
}
/**
* AIGC 生视频任务信息
*/
export interface AigcVideoTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 扩展错误码。
枚举值:
- RequestLimitExceeded: 调用超出并发限制。
- InvalidParameter.VoilationContent: 输入 prompt 违反内容安全策略。
- InvalidParameterValue: 参数值错误。
- FailedOperation: 模型任务堆积。
- InternalError: 内部错误。
- InvalidParameter: 非法参数。
- InvalidParameter.MediaFormat: 无效的媒体格式。
- ContentModerationFailed: 内容审核未通过。
- ResourceInsufficient: 资源不足。
- ModelGenerateFailed: 模型生成失败。
- ResourceNotFound: 资源不存在。
- OperationCanceled: 操作已取消。
- TaskTimeout: 任务超时。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* AIGC 生视频任务的输入信息。
*/
Input?: AigcVideoTaskInput;
/**
* AIGC 生视频任务的输出信息。
*/
Output?: AigcVideoTaskOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* 文本鉴别涉及令人反感的信息的任务控制参数。
*/
export interface PornOcrReviewTemplateInfoForUpdate {
/**
* 文本鉴别涉及令人反感的信息的任务开关,可选值:
ON:开启文本鉴别涉及令人反感的信息的任务;
OFF:关闭文本鉴别涉及令人反感的信息的任务。
*/
Switch?: string;
/**
* 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* 音视频审核 Ocr 文字涉及令人反感的信息的任务结果类型
*/
export interface AiReviewTaskPornOcrResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 音视频审核 Ocr 文字涉及令人反感的信息的任务输入。
*/
Input?: AiReviewPornOcrTaskInput;
/**
* Ocr 文字音视频审核涉及令人反感的信息的任务输出。
*/
Output?: AiReviewPornOcrTaskOutput;
/**
* Ocr 文字音视频审核涉及令人反感的信息的任务进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* ModifyContentReviewTemplate返回参数结构体
*/
export interface ModifyContentReviewTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeWatermarkTemplates请求参数结构体
*/
export interface DescribeWatermarkTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 水印类型过滤条件,可选值:
image:图片水印;
text:文字水印;
svg:SVG 水印。
*/
Type?: string;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 水印模板唯一标识过滤条件,数组长度限制:100。
*/
Definitions?: Array;
/**
* 返回记录条数
默认值:10;
最大值:100。
*/
Limit?: number;
}
/**
* 去伪影(毛刺)控制信息
*/
export interface ArtifactRepairInfo {
/**
* 去伪影(毛刺)控制开关,可选值:
ON:开启去伪影(毛刺);
OFF:关闭去伪影(毛刺)。
*/
Switch: string;
/**
* 去伪影(毛刺)类型,仅当去伪影(毛刺)控制开关为 ON 时有效,可选值:
weak:轻去伪影(毛刺);
strong:强去伪影(毛刺)。
默认值:weak。
*/
Type?: string;
}
/**
* CreateAigcAudioTask请求参数结构体
*/
export interface CreateAigcAudioTaskRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 模型名称。
*/
ModelName?: string;
/**
* 指定模型特定版本号。默认使用系统当前所支持的模型稳定版本。
*/
ModelVersion?: string;
/**
* 指定场景,目前支持sfx(音效)、music(音乐)。
*/
SceneType?: string;
/**
* 生成音频的描述
*/
Prompt?: string;
/**
* 参考视频信息
*/
VideoInfos?: Array;
/**
* 传入参考音频信息。
比如传入音频生成音乐时需要传入。
*/
AudioInfos?: Array;
/**
* 输出参数
*/
OutputConfig?: AigcAudioOutputConfig;
/**
* 用于传入一些模型需要的特殊场景参数,Json格式序列化成字符串。
示例:
{"camera_control":{"type":"simple"}}
*/
AdditionalParameters?: string;
}
/**
* 对视频截图做封面任务输入参数类型
*/
export interface CoverBySnapshotTaskInput {
/**
* 指定时间点截图模板 ID。
*/
Definition: number;
/**
* 截图方式。包含:
Time:依照时间点截图
Percent:依照百分比截图
*/
PositionType: string;
/**
* 截图位置:
对于依照时间点截图,该值表示指定视频第几秒的截图作为封面
对于依照百分比截图,该值表示使用视频百分之多少的截图作为封面
*/
PositionValue: number;
/**
* 水印列表,支持多张图片或文字水印,最大可支持 10 张。
*/
WatermarkSet?: Array;
}
/**
* DescribeMediaProcessUsageData请求参数结构体
*/
export interface DescribeMediaProcessUsageDataRequest {
/**
* 起始日期。使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#52)。
*/
StartTime: string;
/**
* 结束日期,需大于等于起始日期。使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#52)。
*/
EndTime: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 查询视频处理任务类型,目前支持的任务类型包括:
Transcoding: 普通转码
Transcoding-TESHD: 极速高清转码
Editing: 视频编辑
Editing-TESHD: 极速高清视频编辑
AdaptiveBitrateStreaming: 自适应码流
ContentAudit: 内容审核
ContentRecognition: 内容识别
RemoveWatermark: 去除水印
ExtractTraceWatermark: 提取水印
AddTraceWatermark: 添加水印
RebuildMedia: 音画质重生
QualityInspect: 音画质检测
VideoHighlight: 视频智能集锦
VideoTag: 视频智能标签
VideoClassification: 视频智能分类
VideoCover: 视频智能封面
VideoSegment: 视频智能拆条
VideoProduce: 视频制作
MediaCast: 媒体转推
Transcode: 转码,包含普通转码、极速高清和视频编辑(不推荐使用)
VoiceTranslation: 语音翻译
JITTranscoding: 即时转码
VideoSnapshot: 视频截图
JITEncryption: 即时加密
MediaEnhancement: 音视频增强
ImageCompression: 图片压缩
ImageEnhancement: 图片增强
ImageSuperResolution: 图片超分
ImageAdvanceCompression: 图片高级压缩
ImageUnderstanding: 图片理解
AddTraceWatermark: 添加溯源水印
AddBlindWatermark: 添加盲水印
AddNagraWatermark: 添加NAGRA数字水印
ExtractTraceWatermark: 提取溯源水印
ExtractBlindWatermark: 提取盲水印
ExtractNagraWatermark: 提取NAGRA数字水印
*/
Type?: string;
}
/**
* 音画质重生任务的输入。
*/
export interface RebuildMediaTaskInput {
/**
* 媒体文件 ID。
*/
FileId?: string;
/**
* 起始偏移时间,单位:秒,不填表示从视频开始截取。
*/
StartTimeOffset?: number;
/**
* 结束偏移时间,单位:秒,不填表示截取到视频末尾。
*/
EndTimeOffset?: number;
/**
* 音画质重生模板号。
*/
Definition?: number;
/**
* 画质修复控制参数。
*/
RepairInfo?: RepairInfo;
/**
* 智能插帧控制参数。
*/
VideoFrameInterpolationInfo?: VideoFrameInterpolationInfo;
/**
* 画面超分控制参数。
*/
SuperResolutionInfo?: SuperResolutionInfo;
/**
* 高动态范围类型控制参数。
*/
HDRInfo?: HDRInfo;
/**
* 视频降噪控制参数。
*/
VideoDenoiseInfo?: VideoDenoiseInfo;
/**
* 音频降噪控制参数。
*/
AudioDenoiseInfo?: AudioDenoiseInfo;
/**
* 色彩增强控制参数。
*/
ColorInfo?: ColorEnhanceInfo;
/**
* 细节增强控制参数。
*/
SharpInfo?: SharpEnhanceInfo;
/**
* 人脸增强控制参数。
*/
FaceInfo?: FaceEnhanceInfo;
/**
* 低光照控制参数。
*/
LowLightInfo?: LowLightEnhanceInfo;
/**
* 去划痕控制参数。
*/
ScratchRepairInfo?: ScratchRepairInfo;
/**
* 去伪影(毛刺)控制参数。
*/
ArtifactRepairInfo?: ArtifactRepairInfo;
/**
* 音画质重生输出目标参数。
*/
TargetInfo?: RebuildMediaTargetInfo;
}
/**
* TextToSpeechSync请求参数结构体
*/
export interface TextToSpeechSyncRequest {
/**
* 合成文本,语音合成时必填,文本长度不超过2000字节
*/
Text: string;
/**
* 音色Id,指定音色合成时填写,支持系统音色和设计、克隆音色。
*/
VoiceId: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: string;
/**
* 语言增强,如 "zh" "en" "auto",默认 "auto"
*/
LanguageBoost?: string;
/**
* 输出相关参数
可以指定输出形式等。默认输出音频URL。
*/
Output?: TextToSpeechSyncOutputOption;
/**
* 同步语音合成拓展参数。ExtParam 支持的字段:
model (string):合成模型,可选 minimax-speech-2.8-hd、minimax-speech-2.8-turbo、minimax-speech-2.6-hd、minimax-speech-2.6-turbo、minimax-speech-02-hd、minimax-speech-02-turbo;默认 minimax-speech-2.8-hd。 voice_setting (object):音色微调,可选字段: speed (float):语速,[0.5, 2.0],默认 1.0。 vol (float):音量,(0, 10],默认 1.0。 pitch (int):音调,[-12, 12],默认 0。 emotion (string):情绪,可选 happy / sad / angry / fearful / disgusted / surprised / calm / fluent / whisper。
audio_setting (object):音频输出参数,可选字段: sample_rate (int):采样率,可选 8000 / 16000 / 22050 / 24000 / 32000 / 44100,默认 16000。 format (string):音频格式,可选 mp3 / wav,默认 wav。 duration (float):目标时长(秒)。 cut_silence (bool):是否裁剪静音段。
*/
ExtParam?: string;
}
/**
* AIGC 混元 3D 任务的输出信息。
*/
export interface AigcHunyuan3DTaskOutput {
/**
* AIGC 混元 3D 任务的输出文件信息。
*/
FileInfos?: Array;
}
/**
* 用户自定义音视频审核任务控制参数
*/
export interface UserDefineConfigureInfo {
/**
* 用户自定义人物音视频审核控制参数。
*/
FaceReviewInfo?: UserDefineFaceReviewTemplateInfo;
/**
* 用户自定义语音音视频审核控制参数。
*/
AsrReviewInfo?: UserDefineAsrTextReviewTemplateInfo;
/**
* 用户自定义文本音视频审核控制参数。
*/
OcrReviewInfo?: UserDefineOcrTextReviewTemplateInfo;
}
/**
* 音画质检测的LLM大模型AIGC质量检测结果。
*/
export interface QualityInspectLLMDetectionReport {
/**
* 检测结果数量。
*/
ResultCount?: number;
/**
* 各检测项结果列表。
*/
ResultSet?: Array;
}
/**
* 视频画面噪点检测的控制参数。
*/
export interface NoiseConfigureInfoForUpdate {
/**
* 视频画面噪点检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch?: string;
}
/**
* 直播录制信息
*/
export interface LiveRecordInfo {
/**
* 直播录制域名
*/
Domain?: string;
/**
* 直播录制Path
*/
Path?: string;
/**
* 直播录制流 ID。
*/
StreamId?: string;
/**
* 录制起始时间,使用 ISO 日期格式。
*/
RecordStartTime?: string;
/**
* 录制结束时间,使用 ISO 日期格式。
*/
RecordEndTime?: string;
}
/**
* DescribeAigcQuotas请求参数结构体
*/
export interface DescribeAigcQuotasRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 配额类型
枚举值:
- Image: AIGC 生图任务
- Video: AIGC 生视频任务
- Text: AIGC 生文任务
*/
QuotaType: string;
/**
* 仅当QuotaType=Text时有效,用于选择需要进行配额限制ApiToken
*/
ApiToken?: string;
/**
* 分页返回的记录条数,将返回第 Offset 到第 Offset+Limit-1 条。
取值范围:[1, 100]
默认值:10
*/
Limit?: number;
/**
* 分页返回的起始偏移量,默认值:0。将返回第 Offset 到第 Offset+Limit-1 条。
默认值:0
*/
Offset?: number;
}
/**
* 视频拆条片段。
*/
export interface AiRecognitionTaskSegmentSegmentItem {
/**
* 文件 ID。仅当处理的是点播文件并且拆条生成的子片段为点播文件时有效。
*/
FileId?: string;
/**
* 视频拆条片段 Url。
*/
SegmentUrl?: string;
/**
* 拆条片段置信度。取值:0~100。
*/
Confidence?: number;
/**
* 拆条片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 拆条片段终止的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 拆条封面图片 Url。
*/
CovImgUrl?: string;
/**
* 特殊字段,请忽略。
*/
SpecialInfo?: string;
}
/**
* 取回视频任务信息
*/
export interface RestoreMediaTask {
/**
* 文件ID。
*/
FileId?: string;
/**
* 文件原始存储类型。
*/
OriginalStorageClass?: string;
/**
* 文件目标存储类型。对于临时取回,目标存储类型与原始存储类型相同。
*/
TargetStorageClass?: string;
/**
* 取回模式,取值:
Expedited:极速模式
Standard:标准模式
Bulk:批量模式
*/
RestoreTier?: string;
/**
* 临时取回副本有效期,单位:天。对于永久取回,取值为0。
*/
RestoreDay?: number;
/**
* 该字段已废弃。
* @deprecated
*/
Status?: number;
/**
* 该字段已废弃。
* @deprecated
*/
Message?: string;
}
/**
* 音视频审核 Ocr 文字涉及令人反感的信息的任务输入参数类型
*/
export interface AiReviewPornOcrTaskInput {
/**
* 鉴别涉及令人反感的信息的模板 ID。
*/
Definition?: number;
}
/**
* 文本关键词识别控制参数。
*/
export interface OcrWordsConfigureInfo {
/**
* 文本关键词识别任务开关,可选值:
ON:开启文本关键词识别任务;
OFF:关闭文本关键词识别任务。
*/
Switch: string;
/**
* 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。
标签个数最多 10 个,每个标签长度最多 16 个字符。
*/
LabelSet?: Array;
}
/**
* CreateSuperPlayerConfig返回参数结构体
*/
export interface CreateSuperPlayerConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 输出的媒体文件信息。
*/
export interface ComposeMediaOutput {
/**
* 文件名称,最长 64 个字符。
*/
FileName: string;
/**
* 描述信息,最长 128 个字符。
*/
Description?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 [创建分类](/document/product/266/7812) 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ExpireTime?: string;
/**
* 封装格式,可选值:mp4、mp3。其中,mp3 为纯音频文件。
*/
Container?: string;
/**
* 输出的视频信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
VideoStream?: OutputVideoStream;
/**
* 输出的音频信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
AudioStream?: OutputAudioStream;
/**
* 是否去除视频数据,可选值:
0:保留
1:去除
默认值:0。
*/
RemoveVideo?: number;
/**
* 是否去除音频数据,可选值:
0:保留
1:去除
默认值:0。
*/
RemoveAudio?: number;
}
/**
* AIGC 混元 3D 任务的输入。
*/
export interface AigcHunyuan3DTaskInput {
/**
* 生成 3D 的参考图片信息。
*/
ImageInfos?: Array;
/**
* 用于生成 3D 模型的多视角图片信息。
数组长度必须在2-8之间,且必须包含 front 视角。
*/
MultiViewImageInfos?: Array;
/**
* 生成 3D 模型的提示词。
*/
Prompt?: string;
/**
* 生成类型。
枚举值:
- Normal: 生成完整 3D 资产(几何 + 纹理);
- Geometry: 只生成几何体(无纹理,输出速度更快);
- Texture: 只生成纹理(需要填写 MeshInfos)
*/
GenerateType?: string;
/**
* 用于生成 3D 模型的参考 3D 模型。
*/
MeshInfos?: Array;
/**
* 是否开启输出 PBR 材质。
枚举值:
- Enabled: 开启;
- Disabled: 关闭。
*/
EnablePBR?: string;
/**
* 面片数。仅 GenerateType 取值为 Normal 和 Geometry 时生效。
*/
FaceCount?: number;
/**
* 是否保留 UV 展开。
枚举值:
- Enabled: 保留;
- Disabled: 不保留。
*/
KeepUV?: string;
/**
* 结果格式。除默认返回的 obj 和 glb 外,附加输出的一种格式。
枚举值:
*/
ResultFormat?: string;
/**
* 随机种子,同一 Seed 输入下结果可复现。
*/
Seed?: number;
/**
* 风格控制词。
*/
Style?: string;
/**
* 任务的输出媒体文件配置。
*/
OutputConfig?: AigcHunyuan3DOutputConfig;
}
/**
* CreateEnhanceMediaTemplate返回参数结构体
*/
export interface CreateEnhanceMediaTemplateResponse {
/**
* 音画质重生模板 ID。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 媒资智能知识库信息
*/
export interface KnowledgeBasesInfo {
/**
* 当前媒资当导入的知识库列表
*/
Bases?: Array;
/**
* 知识库中媒体分析信息
*/
KnowledgeAnalysisInfos?: Array;
/**
* 当前媒资当导入的知识库列表,以及使用的解析模板等详细信息
*/
KnowledgeBaseDetails?: Array;
}
/**
* DeleteReviewTemplate返回参数结构体
*/
export interface DeleteReviewTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DNS解析验证信息
*/
export interface DNSVerifyInfo {
/**
* 子解析。
*/
SubDomain?: string;
/**
* 解析值。
*/
Record?: string;
/**
* 解析类型。
*/
RecordType?: string;
}
/**
* 视频转动图结果信息
*/
export interface MediaAnimatedGraphicsItem {
/**
* 转动图的文件地址。
*/
Url?: string;
/**
* 转动图模板 ID,参见[转动图参数模板](https://cloud.tencent.com/document/product/266/33481#.3Cspan-id-.3D-.22zdt.22.3E.3C.2Fspan.3E.E8.BD.AC.E5.8A.A8.E5.9B.BE.E6.A8.A1.E6.9D.BF)。
*/
Definition?: number;
/**
* 动图格式,如 gif。
*/
Container?: string;
/**
* 动图的高度,单位:px。
*/
Height?: number;
/**
* 动图的宽度,单位:px。
*/
Width?: number;
/**
* 动图码率,单位:bps。
*/
Bitrate?: number;
/**
* 动图大小,单位:字节。
*/
Size?: number;
/**
* 动图的md5值。
*/
Md5?: string;
/**
* 动图在视频中的起始时间偏移,单位:秒。
*/
StartTimeOffset?: number;
/**
* 动图在视频中的结束时间偏移,单位:秒。
*/
EndTimeOffset?: number;
}
/**
* 语音翻译的输入。
*/
export interface AiRecognitionTaskAsrTranslateResultInput {
/**
* 语音翻译模板 ID。
*/
Definition?: number;
}
/**
* 全景录制信息
*/
export interface WebPageRecordInfo {
/**
* 全景录制地址。
*/
RecordUrl?: string;
/**
* 全景录制任务 ID。
*/
RecordTaskId?: string;
}
/**
* DescribeCDNUsageData返回参数结构体
*/
export interface DescribeCDNUsageDataResponse {
/**
* 时间粒度,单位:分钟。
*/
DataInterval?: number;
/**
* CDN 统计数据。
*/
Data?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 场景化 AIGC 生成视频任务的输出。
*/
export interface SceneAigcVideoTaskOutput {
/**
* AIGC 生视频任务的输出文件信息。
*/
FileInfos?: Array;
}
/**
* ModifyWordSample请求参数结构体
*/
export interface ModifyWordSampleRequest {
/**
* 关键词,长度限制:128 个字符。
*/
Keyword: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 关键词应用场景,可选值:
1. Recognition.Ocr:通过光学字符识别技术,进行内容识别;
2. Recognition.Asr:通过音频识别技术,进行内容识别;
3. Review.Ocr:通过光学字符识别技术,进行不适宜的内容识别;
4. Review.Asr:通过音频识别技术,进行不适宜的内容识别;
可合并简写为:
5. Recognition:通过光学字符识别技术、音频识别技术,进行内容识别,等价于 1+2;
6. Review:通过光学字符识别技术、音频识别技术,进行不适宜的内容识别,等价于 3+4;
7. All:包含以上全部,等价于 1+2+3+4。
*/
Usages?: Array;
/**
* 标签操作信息。
*/
TagOperationInfo?: AiSampleTagOperation;
}
/**
* 编辑视频任务信息
*/
export interface EditMediaTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务流状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 错误码,0 表示成功,其他值表示失败:
40000:输入参数不合法,请检查输入参数;
60000:源文件错误(如视频数据损坏),请确认源文件是否正常;
70000:内部服务错误,建议重试。
*/
ErrCode?: number;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 编辑视频任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 视频编辑任务的输入。
*/
Input?: EditMediaTaskInput;
/**
* 视频编辑任务的输出。
*/
Output?: EditMediaTaskOutput;
/**
* 输出视频的元信息。
*/
MetaData?: MediaMetaData;
/**
* 任务类型为 Procedure 的任务 ID。若发起[编辑视频](https://cloud.tencent.com/document/api/266/34783)任务时指定了任务流模板(ProcedureName),当该任务流模板指定了 MediaProcessTask、AiAnalysisTask、AiRecognitionTask 中的一个或多个时发起该任务。
*/
ProcedureTaskId?: string;
/**
* 任务类型为 ReviewAudioVideo 的任务 ID。若发起[编辑视频](https://cloud.tencent.com/document/api/266/34783)任务时指定了任务流模板(ProcedureName),当该任务流模板指定了 ReviewAudioVideoTask 时,发起该任务。
*/
ReviewAudioVideoTaskId?: string;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* CreateJustInTimeTranscodeTemplate返回参数结构体
*/
export interface CreateJustInTimeTranscodeTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 即时转码水印模板配置。
*/
export interface WatermarkConfigureData {
/**
* 是否启用水印。可取值:
ON:表示启用水印;
OFF:表示关闭水印。
*/
Switch?: string;
/**
* 水印 Url。
*/
Url?: string;
/**
* 水印的宽度。
字符串以 % 结尾,表示水印 Width 为视频宽度的百分比大小,如 10% 表示 Width 为视频宽度的 10%;
*/
Width?: string;
/**
* 水印的高度。
字符串以 % 结尾,表示水印 Height 为视频高度的百分比大小,如 10% 表示 Height 为视频高度的 10%;
*/
Height?: string;
/**
* 水印原点距离视频图像坐标原点的水平位置。字符串以 % 结尾,表示水印 XPos 为视频宽度指定百分比,如 10% 表示 XPos 为视频宽度的 10%;
*/
XPos?: string;
/**
* 水印原点距离视频图像坐标原点的垂直位置。当字符串以 % 结尾,表示水印 YPos 为视频高度指定百分比,如 10% 表示 YPos 为视频高度的 10%。
*/
YPos?: string;
}
/**
* DeleteMedia返回参数结构体
*/
export interface DeleteMediaResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifySnapshotByTimeOffsetTemplate返回参数结构体
*/
export interface ModifySnapshotByTimeOffsetTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteHeadTailTemplate请求参数结构体
*/
export interface DeleteHeadTailTemplateRequest {
/**
* 片头片尾模板号。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 大模型解析人脸识别配置
*/
export interface LLMComprehendFaceRecognition {
/**
* 人脸识别任务开关
枚举值:
- ON: 开启智能人脸识别任务
- OFF: 关闭智能人脸识别任务
默认值:OFF
*/
Switch: string;
/**
* 人脸识别过滤分数,当识别结果达到该分数以上,返回识别结果
取值范围:[0, 100]
默认值:95
*/
Score?: number;
/**
* 默认人物过滤标签,指定需要返回的默认人物的标签。如果未填或者为空,则全部默认人物结果都返回。
枚举值:
- entertainment: 娱乐明星
- sport: 体育明星
- politician: 政治人物
*/
DefaultLibraryLabelSet?: Array;
/**
* 用户自定义人物过滤标签,指定需要返回的用户自定义人物的标签。如果未填或者为空,则全部自定义人物结果都返回。
入参限制:标签个数最多 100 个,每个标签长度最多 16 个字符。
*/
UserDefineLibraryLabelSet?: Array;
/**
* 人物库选择
枚举值:
- Default: 使用默认人物库
- UserDefine: 使用用户自定义人物库
- All: 同时使用默认人物库和用户自定义人物库
默认值:All
*/
FaceLibrary?: string;
}
/**
* 智能标签结果类型
*/
export interface AiAnalysisTaskTagResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 智能标签任务输入。
*/
Input?: AiAnalysisTaskTagInput;
/**
* 智能标签任务输出。
*/
Output?: AiAnalysisTaskTagOutput;
/**
* 智能标签任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 智能标签任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 智能标签任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* SearchMedia返回参数结构体
*/
export interface SearchMediaResponse {
/**
* 符合搜索条件的记录总数。
最大值:5000。当命中记录数超过5000时,该字段将返回 5000,而非实际命中总数。
*/
TotalCount?: number;
/**
* 媒体文件信息列表。
*/
MediaInfoSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyAIAnalysisTemplate返回参数结构体
*/
export interface ModifyAIAnalysisTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeAigcApiTokens请求参数结构体
*/
export interface DescribeAigcApiTokensRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 智能去除水印任务的输出。
*/
export interface RemoveWaterMarkTaskOutput {
/**
* 媒体文件 ID。
*/
FileId?: string;
/**
* 文件类型,例如 mp4、mp3 等。
*/
FileType?: string;
/**
* 媒体文件播放地址。
*/
FileUrl?: string;
/**
* 文件名称,最长 64 个字符。
*/
MediaName?: string;
/**
* 元信息。包括大小、时长、视频流信息、音频流信息等。
*/
MetaData?: MediaMetaData;
}
/**
* ModifyMediaStorageClass请求参数结构体
*/
export interface ModifyMediaStorageClassRequest {
/**
* 媒体文件唯一标识列表,最大长度:100。
*/
FileIds: Array;
/**
* 目标存储类型。可选值有:
STANDARD:标准存储。
STANDARD_IA:低频存储。
ARCHIVE:归档存储。
DEEP_ARCHIVE:深度归档存储。
*/
StorageClass: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 取回模式。当文件的存储类型从归档或深度归档转换为标准存储时,需要指定取回(也称为解冻)操作的模式,具体说明请参考[数据取回及取回模式](https://cloud.tencent.com/document/product/266/56196#retake)。
当媒体文件目前的存储类型为归档存储时,有以下取值:
Expedited:极速模式。
Standard:标准模式。
Bulk:批量模式。
当媒体文件目前的存储类型为深度归档存储时,有以下取值:
Standard:标准模式。
Bulk:批量模式。
*/
RestoreTier?: string;
}
/**
* 智能标签结果信息
*/
export interface AiAnalysisTaskTagOutput {
/**
* 视频智能标签列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 TagSetFileUrl 对应的文件中获取。
*/
TagSet: Array;
/**
* 视频智能标签列表文件 URL。文件的内容为 JSON,数据结构与 TagSet 字段一致。 (文件不会永久存储,到达 TagSetFileUrlExpireTime 时间点后文件将被删除)。
*/
TagSetFileUrl: string;
/**
* 视频智能标签列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
TagSetFileUrlExpireTime: string;
}
/**
* 视频画面马赛克检测的控制参数。
*/
export interface MosaicConfigureInfo {
/**
* 视频画面马赛克检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
}
/**
* DescribeTranscodeTemplates返回参数结构体
*/
export interface DescribeTranscodeTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 转码模板详情列表。
*/
TranscodeTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 智能精彩片段结果信息
*/
export interface AiAnalysisTaskHighlightOutput {
/**
* 视频智能精彩片段列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 HighlightSetFileUrl 对应的文件中获取。
*/
HighlightSet: Array;
/**
* 视频智能精彩片段列表文件 URL。文件的内容为 JSON,数据结构与 HighlightSet 字段一致。 (文件不会永久存储,到达 HighlightSetFileUrlExpireTime 时间点后文件将被删除)。
*/
HighlightSetFileUrl: string;
/**
* 视频智能精彩片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
HighlightSetFileUrlExpireTime: string;
}
/**
* DescribeRebuildMediaTemplates请求参数结构体
*/
export interface DescribeRebuildMediaTemplatesRequest {
/**
* 视频重生模板列表。
*/
Definitions?: Array;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 模板类型过滤条件,可选值:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
}
/**
* 图片审核片段。
*/
export interface ReviewImageSegmentItem {
/**
* 嫌疑片段涉及令人反感的信息的分数。
*/
Confidence?: number;
/**
* 嫌疑片段鉴别涉及违规信息的结果建议,取值范围:
review:疑似违规,建议复审;
block:确认违规,建议封禁。
*/
Suggestion?: string;
/**
* 嫌疑片段最可能的违规的标签,取值范围:
Porn:色情;
Terror:暴力;
Polity:不适宜的信息;
Ad:广告;
Illegal:违法;
Abuse:谩骂。
*/
Label?: string;
/**
* 违规子标签。
*/
SubLabel?: string;
/**
* 嫌疑片段违禁的形式,取值范围:
Image:画面上的人物或图标;
OCR:画面上的文字。
*/
Form?: string;
/**
* 嫌疑人物、图标或文字出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
*/
AreaCoordSet?: Array;
/**
* 当 Form 为 OCR 时有效,表示识别出来的 OCR 文本内容。
*/
Text?: string;
/**
* 当 Form 为 OCR 时有效,表示嫌疑片段命中的违规关键词列表。
*/
KeywordSet?: Array;
}
/**
* CreateCLSTopic返回参数结构体
*/
export interface CreateCLSTopicResponse {
/**
* 日志主题 ID。
*/
TopicId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateRoundPlay返回参数结构体
*/
export interface CreateRoundPlayResponse {
/**
* 轮播播单唯一标识。
*/
RoundPlayId?: string;
/**
* 轮播播放地址。
*/
Url?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 字幕信息输入参数。
*/
export interface MediaSubtitleInput {
/**
* 字幕名字,长度限制:64 个字符。
*/
Name: string;
/**
* 字幕语言。常见的取值如下:
zh:中文;
en:英文;
ja:日文;
ko:韩文;
vi:越南语;
ms:马来语;
th:泰语;
pt:葡萄牙语;
tr:土耳其语;
ar:阿拉伯语;
es:西班牙语;
hi:印地语;
fr:法语。
其他取值参考 [RFC5646](https://tools.ietf.org/html/rfc5646)
*/
Language: string;
/**
* 字幕格式。取值范围如下:
vtt
*/
Format: string;
/**
* 字幕内容,进行 [Base64](https://tools.ietf.org/html/rfc4648) 编码后的字符串。
*/
Content: string;
/**
* 字幕的唯一标识。长度不能超过16个字符,可以使用大小写字母、数字、下划线(_)或横杠(-)。不能与媒体文件中现有字幕的唯一标识重复。
*/
Id?: string;
}
/**
* 文件验证信息
*/
export interface FileVerifyInfo {
/**
* 文件验证 URL 指引。
*/
FileVerifyUrl?: string;
/**
* 文件校验域名列表。
*/
FileVerifyDomains?: Array;
/**
* 文件校验文件名。
*/
FileVerifyName?: string;
}
/**
* 人脸增强控制
*/
export interface FaceEnhanceInfo {
/**
* 人脸增强控制开关,可选值:
ON:开启人脸增强;
OFF:关闭人脸增强。
*/
Switch: string;
/**
* 人脸增强强度,仅当人脸增强控制开关为 ON 时有效,取值范围:0.0~1.0。
默认:0.0。
*/
Intensity?: number;
}
/**
* 图片画面审核涉及令人反感的信息的任务结果类型
*/
export interface PornImageResult {
/**
* 鉴别涉及令人反感的信息的评分,分值为0到100。
*/
Confidence?: number;
/**
* 鉴别涉及令人反感的信息的结果建议,取值范围:
pass;
review;
block。
*/
Suggestion?: string;
/**
* 鉴别涉及令人反感的信息的结果标签,取值范围:
porn:色情;
sexy:性感;
vulgar:低俗;
intimacy:亲密行为。
*/
Label?: string;
}
/**
* ProcessImage返回参数结构体
*/
export interface ProcessImageResponse {
/**
* 图片内容智能识别任务结果。
*/
ContentReviewResultSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ProcessImage请求参数结构体
*/
export interface ProcessImageRequest {
/**
* 媒体文件 ID,即该文件在云点播上的全局唯一标识符。本接口要求媒体文件必须是图片格式。
*/
FileId: string;
/**
* 操作类型。现在仅支持填 ContentReview,表示内容智能识别。
*/
Operation: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 图片内容智能识别参数,当 Operation 为 ContentReview 时该字段有效。
*/
ContentReviewInput?: ImageContentReviewInput;
}
/**
* 智能擦除,擦除区域坐标配置。
区域由左上角与右下角点的坐标确定。
坐标原点为画面左上角,坐标点可使用像素值或百分比单位指定。
对自动擦除区域:
当单位为%时,坐标范围为[0,1];
当单位为px时,X值范围为 [0,视频画面宽度],Y值范围为 [0,视频画面高度]
对指定擦除区域:
当单位为%时,坐标范围为[0,1);
当单位为px时,X值范围为 [0,视频画面宽度],Y值范围为 [0,视频画面高度]
*/
export interface MPSEraseArea {
/**
* 区域左上角X坐标。 如当Unit取1即使用百分比单位时,0.05表示区域左上角离整个画面左上角的横向距离为画面宽度的5%。
*/
LeftTopX: number;
/**
* 区域左上角Y坐标。 如当Unit取1即使用百分比单位时,0.1表示区域左上角离整个画面左上角的纵向距离为画面高度的10%。
*/
LeftTopY: number;
/**
* 区域右下角X坐标。 如当Unit取1即使用百分比单位时,0.75表示区域右下角离整个画面左上角的横向距离为画面宽度的75%。
*/
RightBottomX: number;
/**
* 区域右下角Y坐标。 如当Unit取1即使用百分比单位时,0.9表示区域右下角离整个画面左上角的纵向距离为画面高度的90%。
*/
RightBottomY: number;
/**
* 坐标单位 - 1 百分比 - 2 像素值
*/
Unit: number;
}
/**
* 自适应码流任务信息。
*/
export interface ComplexAdaptiveDynamicStreamingTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 自适应码流任务的执行状态与结果,每个元素对应一个自适应码流模板。
*/
ComplexAdaptiveDynamicStreamingTaskResultSet?: Array;
}
/**
* ModifyMediaInfo返回参数结构体
*/
export interface ModifyMediaInfoResponse {
/**
* 新的视频封面 URL。
- 注意:仅当请求携带 CoverData 时此返回值有效。 *
*/
CoverUrl?: string;
/**
* 新增的字幕信息。
*/
AddedSubtitleSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeLLMComprehendTemplates返回参数结构体
*/
export interface DescribeLLMComprehendTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 大模型解析模板详情列表。
*/
LLMComprehendTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyReviewTemplate请求参数结构体
*/
export interface ModifyReviewTemplateRequest {
/**
* 审核模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 审核模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 审核模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 需要返回的违规标签列表,可选值为:
Porn:色情;
Terror:暴力;
Polity:不适宜的信息;
Illegal:违法;
Abuse:谩骂;
Ad:广告;
Moan:娇喘。
注意:不填表示不更新。
*/
Labels?: Array;
}
/**
* CreateBlindWatermarkTemplate返回参数结构体
*/
export interface CreateBlindWatermarkTemplateResponse {
/**
* 数字水印模板唯一标识。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 文本全文识别结果。
*/
export interface AiRecognitionTaskOcrFullTextResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 文本全文识别任务输入信息。
*/
Input?: AiRecognitionTaskOcrFullTextResultInput;
/**
* 文本全文识别任务输出信息。
*/
Output?: AiRecognitionTaskOcrFullTextResultOutput;
/**
* 文本全文识别任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 文本全文识别任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 文本全文识别任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* DescribeCLSTopics返回参数结构体
*/
export interface DescribeCLSTopicsResponse {
/**
* 日志主题总数量。
*/
TotalCount?: number;
/**
* 日志主题列表。
*/
Topics?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频拆条的结果文件输出。
*/
export interface SplitMediaOutputConfig {
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。
*/
MediaName?: string;
/**
* 输出文件格式,可选值:mp4、hls。默认是 mp4。
*/
Type?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 [创建分类](/document/product/266/7812) 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ExpireTime?: string;
}
/**
* ModifyProcessImageAsyncTemplate返回参数结构体
*/
export interface ModifyProcessImageAsyncTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* MPS 具体子任务查询结果类型。
*/
export interface MPSSubTaskResult {
/**
* 任务类型。MPS 的 WorkflowTask 结构中的具体子任务类型。取值:
MediaProcess.Transcode:音视频转码任务。
AiAnalysis.DeLogo:智能擦除任务。
AiAnalysis.ClassificationTask:智能分类任务。
AiAnalysis.CoverTask:智能封面任务。
AiAnalysis.TagTask:智能标签任务。
AiAnalysis.FrameTagTask:智能按帧标签任务。
AiAnalysis.HighlightTask:智能高光任务。
AiAnalysis.SegmentTask:智能拆条任务。
AiAnalysis.HeadTailTask:智能片头片尾任务。
AiAnalysis.DescriptionTask:智能摘要任务。
AiAnalysis.HorizontalToVerticalTask:智能横转竖任务。
AiAnalysis.DubbingTask:智能译制任务。
AiAnalysis.VideoRemakeTask:智能去重任务。
AiAnalysis.VideoComprehensionTask:视频理解任务。
SmartSubtitle.AsrFullTextTask:智能语音全文识别任务。
SmartSubtitle.TransTextTask: 翻译结果。
SmartSubtitle.PureSubtitleTransTask:返回纯字幕文件翻译结果。
SmartSubtitle.OcrFullTextTask:智能文字提取字幕任务。
SmartErase:智能擦除任务。
*/
TaskType?: string;
/**
* 任务状态。有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码。返回0时成功,其他值为失败。
*/
ErrCode?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* MPS 视频处理任务输入。该字段对应 MPS 任务返回中的 Input 结果,以 JSON 格式返回。
*/
Input?: string;
/**
* MPS 视频处理任务输出。
*/
Output?: MPSTaskOutput;
}
/**
* CloneVoiceSync返回参数结构体
*/
export interface CloneVoiceSyncResponse {
/**
* 克隆得到的音色
*/
VoiceId?: string;
/**
* 试听音频
*/
DemoAudio?: string;
/**
* 拓展信息
*/
ExtInfo?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ImportMediaKnowledge返回参数结构体
*/
export interface ImportMediaKnowledgeResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* RestoreMedia返回参数结构体
*/
export interface RestoreMediaResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 图片理解信息项。
*/
export interface ImageUnderstandingItem {
/**
* 模板id。
*/
Definition?: number;
/**
* 任务输出文件。
*/
OutputFile?: Array;
}
/**
* AIGC 混元 3D 任务的输出文件信息。
*/
export interface AigcHunyuan3DTaskOutputFileInfo {
/**
* 存储模式。取值有:
Permanent:永久存储; Temporary:临时存储; 默认值:Temporary
*/
StorageMode?: string;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
ExpireTime?: string;
/**
* 文件类型,例如 OBJ、GLB、FBX 等。
*/
FileType?: string;
/**
* 输出文件地址。
*/
FileUrl?: string;
/**
* 输出文件预览地址。
无文件预览地址时为空。
*/
PreviewFileUrl?: string;
}
/**
* 创建 AIGC 声音复刻输出信息。
*/
export interface CreateAigcAudioCloneOutput {
/**
* 任务ID。
*/
TaskId?: string;
/**
* 处理状态。
*/
State?: string;
/**
* 用户自定义的 voice_id,如果任务失败则不返回。
*/
VoiceId?: string;
/**
* 如果请求体中传入了试听文本 text,那么本参数将以链接形式返回试听音频,否则本参数为空值。
*/
DemoAudio?: string;
/**
* 本次调用时传入的透传参数。
*/
Payload?: string;
/**
* 任务创建时间。
*/
CreatedAt?: string;
}
/**
* ModifyEnhanceMediaTemplate返回参数结构体
*/
export interface ModifyEnhanceMediaTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 知识库媒体分析信息。
*/
export interface KnowledgeAnalysisInfo {
/**
* 大模型解析模板号
*/
Definition?: number;
/**
* 大模型解析结果
*/
AnalysisResults?: Array;
}
/**
* ModifyWatermarkTemplate返回参数结构体
*/
export interface ModifyWatermarkTemplateResponse {
/**
* 图片水印地址,仅当 ImageTemplate.ImageContent 非空,该字段有值。
*/
ImageUrl?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* EnhanceMediaByTemplate返回参数结构体
*/
export interface EnhanceMediaByTemplateResponse {
/**
* 音画质重生的任务 ID,可以通过该 ID 查询音画质重生任务的状态。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateJustInTimeTranscodeTemplate请求参数结构体
*/
export interface CreateJustInTimeTranscodeTemplateRequest {
/**
* 模板名字,长度限制64个字符。
*/
Name: string;
/**
* 视频参数配置。
*/
VideoConfigure: VideoConfigureInfo;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 水印参数配置。
*/
WatermarkConfigure?: WatermarkConfigureInfo;
/**
* 模板描述,长度限制256个字符。
*/
Comment?: string;
}
/**
* CreateAigcVideoTask请求参数结构体
*/
export interface CreateAigcVideoTaskRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 模型名称。取值:
Kling:可灵;
Vidu;
Hailuo:海螺;
Hunyuan:混元;
Mingmou:明眸;
GV;
OS;
PixVerse;
*/
ModelName: string;
/**
* 模型版本。取值:
当 ModelName 是 Hailuo,可选值为 02、2.3、2.3-fast、H3、H3_regen、H3-Max;
当 ModelName 是 Kling,可选值为 1.6、2.0、2.1、2.5、2.6、O1、3.0、3.0-Omni、3.0-turbo、scene;
当 ModelName 是 Vidu,可选值为 q2、q2-pro、q2-turbo、q3、q3-pro、q3-turbo、q3-mix、q3-drama、q3-ad、scene、avatar-q2-pro、avatar-q2-turbo、lip-sync;
当 ModelName 是 GV,可选值为 3.1、3.1-fast、3.1-lite、omni;
当 ModelName 是 OS,可选值为 2.0;
当 ModelName 是 Hunyuan,可选值为 1.5、3d_2.0;
当 ModelName 是 Mingmou,可选值为 1.0;
当 ModelName 是 PixVerse,可选值为 v5.6、v6、c1;
*/
ModelVersion: string;
/**
* 用于描述模型在生成视频时要使用的资源文件,分为首尾帧模式、参考图片/视频/声音生成、视频编辑等模式。
首尾帧视频生成:首帧图片的Usage字段为FirstFrame,尾帧图片的Usage字段为LastFrame,支持各一张,可以单独传首帧,不能单独传尾帧。首尾帧生成会参考图片比例。
参考图片/视频/声音生成:可传入单个或者多个图片/视频/声音作为参考,Usage字段为Reference;参考模式,可以调整生成视频的宽高比例。
视频编辑:Vidu、Kling可输入视频进行编辑。传入视频的同时也可以传入图片,图片的Usage字段为Reference。
注意:
- 图片大小不超过10M。
- 支持的图片格式:jpeg、jpg、png。x0b
- 关于模型某个版本是否支持参考图片/视频/声音、首尾帧、视频编辑等功能,可向我们索取文档或者参考原厂文档信息。
*/
FileInfos?: Array;
/**
* 主体输入信息。
*/
SubjectInfos?: Array;
/**
* 用于作为尾帧画面来生成视频的媒体文件 ID。该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。
- 指定该参数时,须同时通过 FileInfos 指定首帧画面。
- 图片大小需小于10M。
- 图片格式的取值为:jpeg,jpg, png, webp。
*/
LastFrameFileId?: string;
/**
* 用于作为尾帧画面来生成视频的媒体文件 URL。说明:
- 指定该参数时,须同时通过 FileInfos 指定首帧画面。
- 图片大小需小于5M。
- 图片格式的取值为:jpeg,jpg, png, webp。
*/
LastFrameUrl?: string;
/**
* 生成视频的提示词。
当未传入参考文件,没有使用场景类型,ExtInfo不为空,Prompt 为必填。
*/
Prompt?: string;
/**
* 要阻止模型生成视频的提示词。
*/
NegativePrompt?: string;
/**
* 是否自动优化提示词。开启时将自动优化传入的 Prompt,以提升生成质量。取值有:
Enabled:开启; Disabled:关闭;
*/
EnhancePrompt?: string;
/**
* 生视频任务的输出媒体文件配置。
*/
OutputConfig?: AigcVideoOutputConfig;
/**
* 输入文件的区域信息。取值如下:
- 当输入文件存储在海外时:Oversea;
- 当输入文件存储在美西时:OverseaUSWest;
- 当输入文件存储在国内时:Mainland。
默认值:Mainland
*/
InputRegion?: string;
/**
* 场景类型。取值如下:
当 ModelName 为 Kling 时: motion_control 表示动作控制; avatar_i2v 表示数字人; lip_sync 表示对口型;当 ModelName 为 Vidu 时: template_effect 表示特效模板;其他 ModelName 暂不支持。
*/
SceneType?: string;
/**
* 任务流名称,在需要对生成的新视频执行任务流时填写。
*/
Procedure?: string;
/**
* 模型随机种子。
*/
Seed?: number;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 保留字段,特殊用途时使用。
可用于传入模型特殊参数、分镜prompt等
*/
ExtInfo?: string;
}
/**
* AI 样本管理,人脸信息。
*/
export interface AiSampleFaceInfo {
/**
* 人脸图片 ID。
*/
FaceId?: string;
/**
* 人脸图片地址。
*/
Url?: string;
}
/**
* 轮播节目播放信息
*/
export interface RoundPlayFilePlayInfo {
/**
* 播单节目的 ID,由系统分配。
*/
ItemId?: string;
/**
* 媒体文件标识。
*/
FileId?: string;
/**
* 启播时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。
*/
StartPlayTime?: string;
/**
* 播放时长,单位为秒。
*/
Duration?: number;
/**
* 播放进度,单位为秒。
*/
Progress?: number;
}
/**
* 自适应码流任务多语言音频流输入参数。
*/
export interface ComplexAdaptiveDynamicStreamingTaskAudioInput {
/**
* 音频源的媒体 ID。固定取该媒体源文件中的首个音频流,视频流和其它音频流(如有)将被忽略。
*/
FileId: string;
/**
* 输出的自适应码流中的音频流名称,长度限制为16个字符。
*/
Name: string;
/**
* 输出的自适应码流中的音频流语言,长度限制为16个字符。要求符合 RFC5646 规范。
*/
Language: string;
/**
* 是否设置为自适应码流的默认音频。取值:
YES:设置为默认音频;NO:不设置为默认音频(默认值)。
*/
Default?: string;
/**
* 音轨序号,表示选择音频源中的第几个音轨,从0开始计数。默认值为0,表示选择最靠前的音轨。
*/
AudioTrackIdx?: number;
}
/**
* 创建自定义音色回调输出信息。
*/
export interface CreateAigcCustomVoiceOutput {
/**
* 自定义音色列表。
*/
InfoList?: Array;
}
/**
* 音量均衡配置。
*/
export interface AudioVolumeBalanceInfo {
/**
* 音量均衡控制开关,可选值:
ON:开启音量均衡;
OFF:关闭音量均衡。
*/
Switch: string;
/**
* 类型,可选值:
loudNorm:响度标准化
gainControl:减小突变
默认值:loudNorm。
*/
Type?: string;
}
/**
* MPS压制字幕模板
*/
export interface MPSEmbedSubtitleTemplateForUpdate {
/**
* 字幕压制模板唯一标识
*/
Definition: number;
/**
* 字幕压制名称
长度限制:64 个字符。
*/
Name?: string;
/**
* 字幕压制模板描述信息
长度限制:256 个字符。
*/
Comment?: string;
/**
* 字幕压制相关配置
*/
SubtitleEmbedConfig?: MPSSubtitleEmbedConfig;
}
/**
* ModifyBlindWatermarkTemplate请求参数结构体
*/
export interface ModifyBlindWatermarkTemplateRequest {
/**
* 数字水印模板唯一标识。
*/
Definition: number;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 数字水印模板名称,支持 中文、英文、数字、_、-和. 六种格式,长度限制:64 个字符。
*/
Name?: string;
/**
* 数字水印模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 数字水印文字内容,长度不超过64个字符,NAGRA水印类型的模板不支持修改文字内容。
*/
TextContent?: string;
}
/**
* 语音关键词识别输出。
*/
export interface AiRecognitionTaskAsrWordsResultOutput {
/**
* 语音关键词识别结果集。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 ResultSetFileUrl 对应的文件中获取。
*/
ResultSet: Array;
/**
* 语音关键词识别结果集文件 URL。文件的内容为 JSON,数据结构与 ResultSet 字段一致。 (文件不会永久存储,到达ResultSetFileUrlExpireTime 时间点后文件将被删除)。
*/
ResultSetFileUrl: string;
/**
* 语音关键词识别结果集文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ResultSetFileUrlExpireTime: string;
}
/**
* CreateAigcQuota请求参数结构体
*/
export interface CreateAigcQuotaRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 配额类型
枚举值:
- Image: AIGC 生图任务
- Video: AIGC 生视频任务
- Text: AIGC 生文任务
*/
QuotaType: string;
/**
* 任务的配额数。
单位:张/秒/token数。
- 当 QuotaType 为 Image 时,单位为张;
- 当 QuotaType 为 Video 时,单位为秒;
- 当 QuotaType 为 Text 时,单位为 token 数。
*/
QuotaLimit: number;
/**
* 仅当QuotaType=Text时有效,用于选择需要进行配额限制ApiToken
*/
ApiToken?: string;
}
/**
* DescribeHeadTailTemplates请求参数结构体
*/
export interface DescribeHeadTailTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 片头片尾模板号,数组长度限制:100。
*/
Definitions?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
}
/**
* CreateLLMComprehendTemplate返回参数结构体
*/
export interface CreateLLMComprehendTemplateResponse {
/**
* 大模型理解模板的唯一标识
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCdnLogs请求参数结构体
*/
export interface DescribeCdnLogsRequest {
/**
* 域名。
*/
DomainName: string;
/**
* 获取日志起始时间点,使用 ISO 日期格式。
参数格式:YYYY-MM-DDThh:mm:ssZ
*/
StartTime: string;
/**
* 结束时间需大于起始时间;使用 ISO 日期格式。
参数格式:YYYY-MM-DDThh:mm:ssZ
*/
EndTime: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 分页拉取的最大返回结果数。默认值:100;最大值:1000。
*/
Limit?: number;
/**
* 分页拉取的起始偏移量。默认值:0。
*/
Offset?: number;
}
/**
* 视频画面模糊检测的控制参数。
*/
export interface BlurConfigureInfoForUpdate {
/**
* 视频画面模糊检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch?: string;
}
/**
* ProcessMediaByUrl返回参数结构体
*/
export interface ProcessMediaByUrlResponse {
/**
* 任务 ID
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频流配置信息
*/
export interface EditMediaVideoStream {
/**
* 视频流的编码格式,可选值:
libx264:H.264 编码;
libx265:H.265 编码;
av1:AOMedia Video 1 编码;
H.266:H.266 编码。
*/
Codec?: string;
/**
* 视频流的码率,取值范围:0 和 [128, 100000],单位:kbps。
当取值为 0 或不填时,表示由云点播自动设置码率。
*/
Bitrate?: number;
/**
* 分辨率自适应,可选值:
open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。
默认值:open。
*/
ResolutionAdaptive?: string;
/**
* 视频流宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。
当 Width、Height 均为 0,则分辨率取基准分辨率;
当 Width 为 0,Height 非 0,则 Width 按基准分辨率比例缩放;
当 Width 非 0,Height 为 0,则 Height 按基准分辨率比例缩放;
当 Width、Height 均非 0,则分辨率按用户指定。
默认值:0。
*/
Width?: number;
/**
* 视频流高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
当 Width、Height 均为 0,则分辨率取基准分辨率;
当 Width 为 0,Height 非 0,则 Width 按基准分辨率比例缩放;
当 Width 非 0,Height 为 0,则 Height 按基准分辨率比例缩放;
当 Width、Height 均非 0,则分辨率按用户指定。
默认值:0。
*/
Height?: number;
/**
* 视频帧率,取值范围:[0, 100],单位:Hz。
当取值为0,将自动为视频设置帧率。
默认值为 0。
*/
Fps?: number;
}
/**
* 提取溯源水印任务。
*/
export interface ExtractTraceWatermarkTask {
/**
* 任务 ID。
*/
TaskId: string;
/**
* 任务状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status: string;
/**
* 错误码,0 表示成功,其他值表示失败:
40000:输入参数不合法,请检查输入参数;
60000:源文件错误(如视频数据损坏),请确认源文件是否正常;
70000:内部服务错误,建议重试。
*/
ErrCode: number;
/**
* 错误信息。
*/
Message: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt: string;
/**
* 提取溯源水印任务输入信息。
*/
Input: ExtractTraceWatermarkTaskInput;
/**
* 提取溯源水印任务输出信息。
*/
Output: ExtractTraceWatermarkTaskOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext: string;
}
/**
* 视频拆条输出。
*/
export interface AiRecognitionTaskSegmentResultOutput {
/**
* 视频拆条片段列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet: Array;
/**
* 视频拆条片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl: string;
/**
* 视频拆条片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime: string;
}
/**
* TextToSpeechSync返回参数结构体
*/
export interface TextToSpeechSyncResponse {
/**
* 合成音频的base64编码,wav格式。
*/
AudioData?: string;
/**
* 合成音频url,有效期24小时
*/
AudioUrl?: string;
/**
* 扩展信息,json字符串
duration: 结果音频时长,单位秒
*/
ExtInfo?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 对视频截雪碧图任务输入参数类型
*/
export interface ImageSpriteTaskInput {
/**
* 雪碧图模板 ID。
*/
Definition: number;
}
/**
* 智能字幕输入结构体
*/
export interface MPSSmartSubtitlesTaskInput {
/**
* 智能字幕模板 ID。
*/
Definition?: number;
/**
* 智能字幕自定义参数,当 Definition 填 0 时有效。 该参数用于高度定制场景,建议您优先使用 Definition 指定智能字幕参数。
*/
RawParameter?: MPSRawSmartSubtitleParameter;
}
/**
* DeleteContentReviewTemplate返回参数结构体
*/
export interface DeleteContentReviewTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeReviewTemplates请求参数结构体
*/
export interface DescribeReviewTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 审核模板唯一标识过滤条件,数组长度限制:100。
*/
Definitions?: Array;
/**
* 模板类型过滤条件,可选值:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
}
/**
* CreateSuperPlayerConfig请求参数结构体
*/
export interface CreateSuperPlayerConfigRequest {
/**
* 播放器配置名称,长度限制:64 个字符。只允许出现 [0-9a-zA-Z] 及 _- 字符(如 test_ABC-123),同一个用户该名称唯一。
*/
Name: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 播放的音视频类型,可选值:
AdaptiveDynamicStream:自适应码流输出;
Transcode:转码输出;
Original:原始音视频。
默认为 AdaptiveDynamicStream。
*/
AudioVideoType?: string;
/**
* 播放 DRM 保护的自适应码流开关:
ON:开启,表示仅播放 DRM 保护的自适应码流输出;
OFF:关闭,表示播放未加密的自适应码流输出。
默认为 OFF。
当 AudioVideoType 为 AdaptiveDynamicStream 时,此参数有效。
*/
DrmSwitch?: string;
/**
* 允许输出的未加密的自适应码流模板 ID。
当 AudioVideoType 为 AdaptiveDynamicStream 并且 DrmSwitch 为 OFF 时,此参数为必填。
*/
AdaptiveDynamicStreamingDefinition?: number;
/**
* 允许输出的 DRM 自适应码流模板内容。
当 AudioVideoType 为 AdaptiveDynamicStream 并且 DrmSwitch 为 ON 时,此参数为必填。
*/
DrmStreamingsInfo?: DrmStreamingsInfo;
/**
* 允许输出的转码模板 ID。
当 AudioVideoType 为 Transcode 时必填。
*/
TranscodeDefinition?: number;
/**
* 允许输出的雪碧图模板 ID。
*/
ImageSpriteDefinition?: number;
/**
* 播放器对于不同分辨率的子流展示名字,不填或者填空数组则使用默认配置:
MinEdgeLength:240,Name:流畅;
MinEdgeLength:480,Name:标清;
MinEdgeLength:720,Name:高清;
MinEdgeLength:1080,Name:全高清;
MinEdgeLength:1440,Name:2K;
MinEdgeLength:2160,Name:4K;
MinEdgeLength:4320,Name:8K。
*/
ResolutionNames?: Array;
/**
* 播放时使用的域名。不填或者填 Default,表示使用[默认分发配置](https://cloud.tencent.com/document/product/266/33373)中的域名。
*/
Domain?: string;
/**
* 播放时使用的 Scheme。不填或者填 Default,表示使用[默认分发配置](https://cloud.tencent.com/document/product/266/33373)中的 Scheme。其他可选值:
HTTP;
HTTPS。
*/
Scheme?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
}
/**
* DesignVoiceAsync请求参数结构体
*/
export interface DesignVoiceAsyncRequest {
/**
* 音色描述
*/
Prompt: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: string;
/**
* 音色设置
*/
VoiceSettings?: VoiceSettings;
/**
* 试听合成文本,最大 500 字符
*/
PreviewText?: string;
/**
* 扩展参数,json字符串
*/
ExtParam?: string;
/**
* 标识来源上下文,用于透传用户请求信息,在回调和任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
}
/**
* 图片水印模板
*/
export interface ImageWatermarkTemplate {
/**
* 水印图片地址。
*/
ImageUrl: string;
/**
* 水印的宽度。支持 %、px 两种格式:
当字符串以 % 结尾,表示水印 Width 为视频宽度的百分比大小,如 10% 表示 Width 为视频宽度的 10%;
当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素。
*/
Width: string;
/**
* 水印的高度。支持 %、px 两种格式:
当字符串以 % 结尾,表示水印 Height 为视频高度的百分比大小,如 10% 表示 Height 为视频高度的 10%;
当字符串以 px 结尾,表示水印 Height 单位为像素,如 100px 表示 Height 为 100 像素;
0px:表示 Height 按照 Width 对视频宽度的比例缩放。
*/
Height: string;
/**
* 水印重复类型。使用场景:水印为动态图像。取值范围:
once:动态水印播放完后,不再出现;
repeat_last_frame:水印播放完后,停留在最后一帧;
repeat:水印循环播放,直到视频结束。
*/
RepeatType: string;
/**
* 图片透明度,取值范围:[0, 100]
0:完全不透明
100:完全透明。
*/
Transparency: number;
}
/**
* 自定义主体信息
*/
export interface AdvancedElementInfo {
/**
* 主体 ID。
*/
ElementId?: string;
/**
* 主体信息。
*/
ElementInfo?: string;
}
/**
* 语音关键词识别控制参数。
*/
export interface AsrWordsConfigureInfo {
/**
* 语音关键词识别任务开关,可选值:
ON:开启语音关键词识别任务;
OFF:关闭语音关键词识别任务。
*/
Switch: string;
/**
* 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。
标签个数最多 10 个,每个标签长度最多 16 个字符。
*/
LabelSet?: Array;
}
/**
* AIGC 生音效任务的输出媒体文件配置。
*/
export interface AigcAudioOutputConfig {
/**
* 存储模式
枚举值:
- Temporary: 临时存储,生成的视频文件不会存储到云点播,可在事件通知中获取到临时访问的 URL,有效期 7 天
- Permanent: 永久存储,生成的视频文件将存储到云点播,可在事件通知中获取到 FileId
默认值:Temporary
*/
StorageMode?: string;
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
ExpireTime?: string;
/**
* 生成音频的时长。默认不填。
取值范围:[0, 60]
*/
Duration?: number;
/**
* 输出音频格式,默认不填
*/
OutputAudioFormat?: string;
}
/**
* 日志推送目标。
*/
export interface AreaCLSTargetInfo {
/**
* 日志集所属地区:
ap-guangzhou:广州;
ap-beijing:北京;
ap-chengdu:成都;
ap-chongqing:重庆;
ap-nanjing:南京;
ap-shanghai:上海;
ap-singapore:新加坡。
*/
CLSRegion: string;
/**
* 投递的目标主题 ID。
*/
TopicId: string;
/**
* 投递的目标集 ID。
*/
LogsetId: string;
/**
* 日志投递状态。
ON:启用;
OFF:停用。
*/
Switch?: string;
}
/**
* DeleteRebuildMediaTemplate返回参数结构体
*/
export interface DeleteRebuildMediaTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeSubAppIds返回参数结构体
*/
export interface DescribeSubAppIdsResponse {
/**
* 应用信息集合。
*/
SubAppIdInfoSet?: Array;
/**
* 应用总数量。
*/
TotalCount?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* SimpleHlsClip请求参数结构体
*/
export interface SimpleHlsClipRequest {
/**
* 需要裁剪的腾讯云点播 HLS 视频 URL。
*/
Url: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 裁剪的开始偏移时间,单位秒。默认 0,即从视频开头开始裁剪。负数表示距离视频结束多少秒开始裁剪。例如 -10 表示从倒数第 10 秒开始裁剪。
*/
StartTimeOffset?: number;
/**
* 裁剪的结束偏移时间,单位秒。默认 0,即裁剪到视频尾部。负数表示距离视频结束多少秒结束裁剪。例如 -10 表示到倒数第 10 秒结束裁剪。
*/
EndTimeOffset?: number;
/**
* 是否固化。0 不固化,1 固化。默认不固化。
*/
IsPersistence?: number;
/**
* 剪辑固化后的视频存储过期时间。格式参照 ISO 日期格式。填“9999-12-31T23:59:59Z”表示永不过期。过期后该媒体文件及其相关资源(转码结果、雪碧图等)将被永久删除。仅 IsPersistence 为 1 时有效,默认剪辑固化的视频永不过期。
*/
ExpireTime?: string;
/**
* 剪辑固化后的视频点播任务流处理,详见上传指定任务流。仅 IsPersistence 为 1 时有效。
*/
Procedure?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。仅 IsPersistence 为 1 时有效。
*/
ClassId?: number;
/**
* 来源上下文,用于透传用户请求信息,上传完成回调 将返回该字段值,最长 250 个字符。仅 IsPersistence 为 1 时有效。
*/
SourceContext?: string;
/**
* 会话上下文,用于透传用户请求信息,当指定 Procedure 参数后,任务流状态变更回调 将返回该字段值,最长 1000 个字符。仅 IsPersistence 为 1 时有效。
*/
SessionContext?: string;
/**
* 该字段已废弃。
* @deprecated
*/
Precision?: string;
/**
* 输出视频类型,取值有:
hls: 输出 hls 文件。默认取值 hls。
*/
OutputMediaType?: string;
/**
* 保留字段,特殊用途时使用。 示例值:""
*/
ExtInfo?: string;
}
/**
* 指定删除点播视频时的删除内容
*/
export interface MediaDeleteItem {
/**
* 所指定的删除部分。如果未填写该字段则参数无效。可选值有:
OriginalFiles(删除原文件,删除后无法发起转码、微信发布等任何视频处理操作);TranscodeFiles(删除转码文件);AdaptiveDynamicStreamingFiles(删除转自适应码流文件);WechatPublishFiles(删除微信发布文件);WechatMiniProgramPublishFiles(删除微信小程序发布文件)。MpsAiMediaAiAnalysisFiles(删除ProcessMediaByMPS产生的智能分析产物)。MpsAiMediaSmartEraseFiles(删除ProcessMediaByMPS产生的智能擦除产物)。MpsAiMediaSmartSubtitleFiles(删除ProcessMediaByMPS产生的智能字幕产物)。注意: 取值为OriginalFiles时,文件上传时携带的封面文件会被删除;取值为TranscodeFiles时,媒体处理产生的封面文件会被删除。
*/
Type: string;
/**
* 删除由Type参数指定的种类下的视频模板号,模板定义参见转码模板。
默认值为0,表示删除参数Type指定种类下所有的视频。
*/
Definition?: number;
}
/**
* 音视频增强配置
*/
export interface EnhanceConfigForUpdate {
/**
* 视频增强配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
VideoEnhance?: VideoEnhanceConfig;
/**
* 音频增强配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
AudioEnhance?: AudioEnhanceConfig;
}
/**
* 对视频按指定时间点截图任务结果类型
*/
export interface MediaProcessTaskSnapshotByTimeOffsetResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 对视频按指定时间点截图任务输入。
*/
Input?: SnapshotByTimeOffsetTaskInput;
/**
* 对视频按指定时间点截图任务输出。
注意:此字段可能返回 null,表示取不到有效值。
*/
Output?: MediaSnapshotByTimeOffsetItem;
/**
* 对视频按指定时间点截图任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 时间点截图任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 时间点截图任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* 图片画面审核涉及令人不适宜信息的任务结果类型
*/
export interface PoliticalImageResult {
/**
* 鉴别涉及令人不适宜信息的评分,分值为0到100。
*/
Confidence?: number;
/**
* 鉴别涉及令人不适宜信息的结果建议,取值范围:
pass;
review;
block。
*/
Suggestion?: string;
/**
* 涉及令人不适宜的信息、违规图标名字。
*/
Name?: string;
/**
* 涉及令人不适宜的信息、违规图标出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
*/
AreaCoordSet?: Array;
}
/**
* AI 样本管理,人物信息。
*/
export interface AiSamplePerson {
/**
* 人物 ID。
*/
PersonId?: string;
/**
* 人物名称。
*/
Name?: string;
/**
* 人物描述。
*/
Description?: string;
/**
* 人脸信息。
*/
FaceInfoSet?: Array;
/**
* 人物标签。
*/
TagSet?: Array;
/**
* 应用场景。
*/
UsageSet?: Array;
/**
* 创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
/**
* 最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
UpdateTime?: string;
}
/**
* 转自适应码流信息
*/
export interface MediaAdaptiveDynamicStreamingInfo {
/**
* 转自适应码流信息数组。
*/
AdaptiveDynamicStreamingSet: Array;
}
/**
* AIGC 人脸输入文件信息
*/
export interface AigcFaceInputFileInfo {
/**
* 输入的视频文件类型。取值有: File:点播媒体文件; Url:可访问的 Url;
*/
Type?: string;
/**
* 媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 [视频上传完成事件通知](/document/product/266/7830) 或 [云点播控制台](https://console.cloud.tencent.com/vod/media) 获取该字段。当 Type 取值为 File 时,本参数有效。
*/
FileId?: string;
/**
* 可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。
*/
Url?: string;
}
/**
* DescribeDailyPlayStatFileList请求参数结构体
*/
export interface DescribeDailyPlayStatFileListRequest {
/**
* 起始日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
StartTime: string;
/**
* 结束日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
EndTime: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 音视频审核涉及令人不安全的信息的任务结果类型
*/
export interface AiReviewTaskTerrorismResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 音视频审核涉及令人不安全的信息的任务输入。
*/
Input?: AiReviewTerrorismTaskInput;
/**
* 音视频审核涉及令人不安全的信息的任务输出。
*/
Output?: AiReviewTerrorismTaskOutput;
/**
* 音视频审核涉及令人不安全的信息的任务进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* DescribeSuperPlayerConfigs返回参数结构体
*/
export interface DescribeSuperPlayerConfigsResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 播放器配置数组。
*/
PlayerConfigSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* VerifyDomainRecord请求参数结构体
*/
export interface VerifyDomainRecordRequest {
/**
* 需要接入点播的加速域名。
*/
Domain: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2024年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 验证方式:
dns:DNS 解析验证;
fIle:文件验证。
默认值:dns。
*/
VerifyType?: string;
}
/**
* 语音关键词识别控制参数。
*/
export interface AsrWordsConfigureInfoForUpdate {
/**
* 语音关键词识别任务开关,可选值:
ON:开启语音关键词识别任务;
OFF:关闭语音关键词识别任务。
*/
Switch?: string;
/**
* 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。
标签个数最多 10 个,每个标签长度最多 16 个字符。
*/
LabelSet?: Array;
}
/**
* DescribeDailyMostPlayedStat请求参数结构体
*/
export interface DescribeDailyMostPlayedStatRequest {
/**
* 查询日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。该参数仅日期部分有效。
*/
Date: string;
/**
* 域名。查询该域名播放 Top100 的媒体文件的统计数据。默认查询所有域名的播放统计数据。
*/
DomainName?: string;
/**
* Top 数据的统计指标,取值有:
Traffic:播放流量,按播放流量统计 Top100 的数据。
PlayTimes:播放次数,按播放次数统计播放 Top100 的数据。
默认值为Traffic。
*/
Metric?: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 即时剪辑后媒体的片段信息。
*/
export interface LiveRealTimeClipMediaSegmentInfo {
/**
* 片段的起始时间。格式参照 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
*/
StartTime?: string;
/**
* 片段的结束时间。格式参照 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#I)。
*/
EndTime?: string;
}
/**
* ModifyLLMComprehendTemplate请求参数结构体
*/
export interface ModifyLLMComprehendTemplateRequest {
/**
* 大模型理解模板的唯一标识
*/
Definition: number;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 大模型解析模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 大模型解析模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 解析模型,可选值为:
*/
Model?: string;
/**
* 分段摘要解析配置
*/
Summary?: LLMComprehendSummaryForUpdate;
/**
* 文本转录解析配置
*/
Asr?: LLMComprehendAsrForUpdate;
/**
* 人脸识别配置
*/
FaceRecognition?: LLMComprehendFaceRecognitionForUpdate;
}
/**
* ModifyKnowledgeBase请求参数结构体
*/
export interface ModifyKnowledgeBaseRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 要修改的知识库ID。
*/
KnowledgeBaseId: string;
/**
* 新的知识库名称。长度限制:1-64个字符。
*/
Name?: string;
/**
* 新的知识库描述。长度限制:最多256个字符。
*/
Description?: string;
}
/**
* DeleteImageSpriteTemplate返回参数结构体
*/
export interface DeleteImageSpriteTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 低光照增强控制
*/
export interface LowLightEnhanceInfo {
/**
* 低光照增强控制开关,可选值:
ON:开启低光照增强;
OFF:关闭低光照增强。
*/
Switch: string;
/**
* 低光照增强类型,仅当低光照增强控制开关为 ON 时有效,可选值:
normal:正常低光照增强;
默认值:normal。
*/
Type?: string;
}
/**
* DescribeContentReviewTemplates返回参数结构体
*/
export interface DescribeContentReviewTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 内容审核模板详情列表。
*/
ContentReviewTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AI 生商品图参数配置
*/
export interface ProductImageConfig {
/**
* 生成图片背景的提示词。如果此字段缺省则内部会自行生成灵感。
*/
Prompt?: string;
/**
* 要阻止模型生成图片的提示词。
*/
NegativePrompt?: string;
/**
* 关于产品的描述,详细的描述,有助于生成更符合要求的图片。
*/
ProductDesc?: string;
/**
* 特殊要求。如有特殊要求,可通过该字段传入。
*/
MoreRequirement?: string;
/**
* 期望生成的图片张数。不传默认值为1,最大合法值为10。
*/
OutputImageCount?: number;
}
/**
* DeleteAigcQuota返回参数结构体
*/
export interface DeleteAigcQuotaResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 图片处理配置。
*/
export interface ProcessImageAsyncTaskInput {
/**
* 图片异步处理模板ID。
*/
Definition: number;
/**
* 图片异步处理扩展参数。
*/
ExtendedParameter?: ProcessImageAsyncInputExtendedParameter;
}
/**
* 图片审核次数统计数据。
*/
export interface ImageReviewUsageDataItem {
/**
* 数据所在时间区间的开始时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#52)。如:当时间粒度为天,2018-12-01T00:00:00+08:00,表示2018年12月1日(含)到2018年12月2日(不含)区间。
*/
Time: string;
/**
* 次数。
*/
Count: number;
}
/**
* 转动图模板详情。
*/
export interface AnimatedGraphicsTemplate {
/**
* 转动图模板唯一标识。
*/
Definition?: number;
/**
* 模板类型,取值范围:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
/**
* 转动图模板名称。
*/
Name?: string;
/**
* 转动图模板描述信息。
*/
Comment?: string;
/**
* 动图宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。
当 Width、Height 均为 0,则分辨率同源;
当 Width 为 0,Height 非 0,则 Width 按比例缩放;
当 Width 非 0,Height 为 0,则 Height 按比例缩放;
当 Width、Height 均非 0,则分辨率按用户指定。
默认值:0。
*/
Width?: number;
/**
* 动图高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。
当 Width、Height 均为 0,则分辨率同源;
当 Width 为 0,Height 非 0,则 Width 按比例缩放;
当 Width 非 0,Height 为 0,则 Height 按比例缩放;
当 Width、Height 均非 0,则分辨率按用户指定。
默认值:0。
*/
Height?: number;
/**
* 分辨率自适应,可选值:
open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。
默认值:open。
*/
ResolutionAdaptive?: string;
/**
* 动图格式。
*/
Format?: string;
/**
* 帧率。
*/
Fps?: number;
/**
* 图片质量。
*/
Quality?: number;
/**
* 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
/**
* 模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
UpdateTime?: string;
}
/**
* ExtractCopyRightWatermark请求参数结构体
*/
export interface ExtractCopyRightWatermarkRequest {
/**
* 需要提取水印的媒体 URL。
*/
Url: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 标识来源上下文,用于透传用户请求信息,在 ExtractCopyRightWatermarkComplete 回调和任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* 智能擦除,指定擦除区域配置。
对指定时间段内的指定区域直接进行擦除。
当BeginMs和EndMs均取0时对整个视频内的指定区域直接进行擦除。
*/
export interface MPSEraseTimeArea {
/**
* 开始时间,单位:毫秒
*/
BeginMs: number;
/**
* 结束时间,单位:毫秒
*/
EndMs: number;
/**
* 时间段内擦除区域列表
*/
Areas: Array;
}
/**
* MPS 子任务输出返回结果。
*/
export interface MPSTaskOutput {
/**
* 任务返回结果中的文件类型结果。如智能擦除中,擦除后的视频文件将被存入媒资,并在此字段中给出 FileId;基于画面提取的字幕文件 Url 将在此字段中给出。
*/
OutputFiles?: Array;
/**
* 任务返回的结果,该字段对应 MPS 任务返回中的Output结果,以 JSON 格式返回
不同MPS任务输出结果结构不同,具体返回内容参考MPS任务输出结构体
[智能分类结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskClassificationOutput)
[智能封面结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskCoverOutput)
[智能标签结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskTagOutput)
[智能按帧标签分类结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskFrameTagOutput)
[智能高光结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskHighlightOutput)
[智能拆条结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskSegmentOutput)
[智能片头片尾结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskHeadTailOutput)
[智能摘要结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskDescriptionOutput)
[智能横转竖结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskHorizontalToVerticalOutput)
[智能译制结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskDubbingOutput)
[智能视频理解结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskVideoComprehensionOutput)
[智能字幕语音全文识别结果](https://cloud.tencent.com/document/product/862/37615#SmartSubtitleTaskAsrFullTextResultOutput)
[智能字幕翻译结果](https://cloud.tencent.com/document/product/862/37615#SmartSubtitleTaskTransTextResultOutput)
[智能字幕纯字幕文件翻译结果](https://cloud.tencent.com/document/product/862/37615#PureSubtitleTransResultOutput)
[智能字幕文字提取字幕结果](https://cloud.tencent.com/document/product/862/37615#SmartSubtitleTaskTextResultOutput)
*/
OutputText?: string;
}
/**
* DescribeEnhanceMediaTemplates请求参数结构体
*/
export interface DescribeEnhanceMediaTemplatesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 音画质重生模板列表。长度限制:100。
*/
Definitions?: Array;
/**
* 模板类型过滤条件,可选值:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
}
/**
* 播放统计信息。
*/
export interface DailyPlayStatInfo {
/**
* 播放媒体文件的日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
Date?: string;
/**
* 媒体文件ID。
*/
FileId?: string;
/**
* 播放次数。
*/
PlayTimes?: number;
/**
* 播放流量,单位:字节。
*/
Traffic?: number;
}
/**
* 文本鉴别涉及令人不安全的信息的任务控制参数
*/
export interface TerrorismOcrReviewTemplateInfoForUpdate {
/**
* 文本鉴别涉及令人不安全的信息的任务开关,可选值:
ON:开启文本鉴别涉及令人不安全的信息的任务;
OFF:关闭文本鉴别涉及令人不安全的信息的任务。
*/
Switch?: string;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* DescribeEventsState返回参数结构体
*/
export interface DescribeEventsStateResponse {
/**
* 待进行拉取的事件通知数,为近似值,约有3分钟延迟。
注意:不建议使用此字段作为是否拉取事件通知的依据。
*/
CountOfEventsToPull?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 版权水印参数
*/
export interface CopyRightWatermarkInput {
/**
* 版权信息,最大长度为 200 个字符。
*/
Text: string;
}
/**
* 视频片头片尾识别输出。
*/
export interface AiRecognitionTaskHeadTailResultOutput {
/**
* 片头识别置信度。取值:0~100。
*/
HeadConfidence?: number;
/**
* 视频片头的结束时间点,单位:秒。
*/
HeadTimeOffset?: number;
/**
* 片尾识别置信度。取值:0~100。
*/
TailConfidence?: number;
/**
* 视频片尾的开始时间点,单位:秒。
*/
TailTimeOffset?: number;
}
/**
* ModifyImageSpriteTemplate返回参数结构体
*/
export interface ModifyImageSpriteTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音视频审核 Asr 文字的嫌疑片段
*/
export interface MediaContentReviewAsrTextSegmentItem {
/**
* 嫌疑片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 嫌疑片段结束的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 嫌疑片段置信度。
*/
Confidence?: number;
/**
* 嫌疑片段音视频审核的结果建议,取值范围:
pass。
review。
block。
*/
Suggestion?: string;
/**
* 嫌疑关键词列表。
*/
KeywordSet?: Array;
}
/**
* SetVodDomainCertificate返回参数结构体
*/
export interface SetVodDomainCertificateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 提取溯源水印输出信息
*/
export interface ExtractTraceWatermarkTaskOutput {
/**
* 播放者的 ID,以十六进制表示,共6位。
*/
Uv?: string;
/**
* 该字段已废弃。
* @deprecated
*/
Uid?: string;
}
/**
* 对视频截图做封面任务结果类型
*/
export interface MediaProcessTaskCoverBySnapshotResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 对视频截图做封面任务的输入。
*/
Input?: CoverBySnapshotTaskInput;
/**
* 对视频截图做封面任务的输出。
*/
Output?: CoverBySnapshotTaskOutput;
/**
* 对视频截图做封面任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 截图做封面任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 截图做封面任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* CreateWatermarkTemplate请求参数结构体
*/
export interface CreateWatermarkTemplateRequest {
/**
* 水印类型,可选值:
image:图片水印;
text:文字水印;
svg:SVG 水印。
*/
Type: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 水印模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 原点位置,可选值:
TopLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角;
TopRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;
BottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;
BottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下角。
默认值:TopLeft。
*/
CoordinateOrigin?: string;
/**
* 水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式:
当字符串以 % 结尾,表示水印 XPos 为视频宽度指定百分比,如 10% 表示 XPos 为视频宽度的 10%;
当字符串以 px 结尾,表示水印 XPos 为指定像素,如 100px 表示 XPos 为 100 像素。
默认值:0px。
*/
XPos?: string;
/**
* 水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式:
当字符串以 % 结尾,表示水印 YPos 为视频高度指定百分比,如 10% 表示 YPos 为视频高度的 10%;
当字符串以 px 结尾,表示水印 YPos 为指定像素,如 100px 表示 YPos 为 100 像素。
默认值:0px。
*/
YPos?: string;
/**
* 图片水印模板,当 Type 为 image,该字段必填。当 Type 为 text,该字段无效。
*/
ImageTemplate?: ImageWatermarkInput;
/**
* 文字水印模板,当 Type 为 text,该字段必填。当 Type 为 image,该字段无效。
*/
TextTemplate?: TextWatermarkTemplateInput;
/**
* SVG水印模板,当 Type 为 svg,该字段必填。当 Type 为 image 或 text,该字段无效。
*/
SvgTemplate?: SvgWatermarkInput;
}
/**
* 视频画面黑边、白边、黑屏、白屏检测的控制参数。
*/
export interface BlackWhiteEdgeConfigureInfo {
/**
* 视频画面黑边、白边、黑屏、白屏检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
}
/**
* 排序依据
*/
export interface SortBy {
/**
* 排序字段
*/
Field: string;
/**
* 排序方式,可选值:Asc(升序)、Desc(降序)
*/
Order: string;
}
/**
* 超分配置
*/
export interface AdvancedSuperResolutionConfig {
/**
* 能力配置开关,可选值:
ON:开启;
OFF:关闭。
默认值:ON。
*/
Switch?: string;
/**
* 类型,可选值:
standard:通用超分
super:高级超分。
默认值:standard。
*/
Type?: string;
/**
* 输出图片模式,默认percent。
aspect: 超分至指定宽高的较大矩形。
fixed: 超分至固定宽高,强制缩放。
percent: 超分倍率,可以为小数。
*/
Mode?: string;
/**
* 超分倍率,可以为小数。
*/
Percent?: number;
/**
* 目标图片宽度,不能超过4096。
*/
Width?: number;
/**
* 目标图片高度,不能超过4096。
*/
Height?: number;
/**
* 目标图片长边长度,不能超过4096。
注意:当Mode等于aspect或fixed,且未配置Width和Height字段时使用此配置。
*/
LongSide?: number;
/**
* 目标图片短边长度,不能超过4096。
注意:当Mode等于aspect或fixed,且未配置Width和Height字段时使用此配置。
*/
ShortSide?: number;
}
/**
* DescribeMPSTemplates请求参数结构体
*/
export interface DescribeMPSTemplatesRequest {
/**
* 点播应用 ID。
*/
SubAppId: number;
/**
* MPS 模板类型。根据需要查询的 MPS 模板的类型对结果进行过滤。取值:
AIAnalysis: 智能分析模板。SmartSubtitle: 智能字幕模板。SmartErase: 智能擦除模板。EmbedSubtitle: 字幕压制模板。
*/
TemplateType: string;
/**
* MPS 查询模板参数。该参数用于透传至媒体处理服务(MPS),从云点播侧查询 MPS 任务模板列表。目前仅支持通过此方式查询以下任务类型的模板:
- 音视频增强:仅支持填写“获取转码模板列表”接口中的 Definitions、Type、Name、Offset 和 Limit 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
- 智能分析:仅支持填写“获取智能分析模板列表”接口中的 Definitions、Type、Name、Offset 和 Limit 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
- 智能字幕:仅支持填写“获取智能字幕模板列表”接口中的 Definitions、Type、Name、Offset 和 Limit 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
- 智能擦除:仅支持填写“获取智能擦除模板列表”接口中的 Definitions、Type、Name、Offset 和 Limit 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
*/
MPSDescribeTemplateParams?: string;
}
/**
* 数字水印模板详情
*/
export interface BlindWatermarkTemplate {
/**
* 数字水印模板唯一标识。
*/
Definition?: number;
/**
* 数字水印类型,可选值:blind-basic:基础版权数字水印;blind-nagra:NAGRA取证水印;
*/
Type?: string;
/**
* 数字水印模板名称。
*/
Name?: string;
/**
* 数字水印模板文本内容,长度不超过64个字符。
*/
TextContent?: string;
/**
* 数字水印模板描述信息。
*/
Comment?: string;
/**
* 数字水印模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/862/37710#52)。
*/
CreateTime?: string;
/**
* 数字水印模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/862/37710#52)。
*/
UpdateTime?: string;
}
/**
* 鉴别涉及令人不安全的信息的任务控制参数。
*/
export interface TerrorismConfigureInfoForUpdate {
/**
* 画面鉴别涉及令人不安全的信息的任务控制参数。
*/
ImgReviewInfo?: TerrorismImgReviewTemplateInfoForUpdate;
/**
* 文本鉴别涉及令人不安全的信息的任务控制参数。
*/
OcrReviewInfo?: TerrorismOcrReviewTemplateInfoForUpdate;
}
/**
* DescribePersonSamples请求参数结构体
*/
export interface DescribePersonSamplesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 拉取的素材类型,可选值:
UserDefine:用户自定义素材库;
Default:系统默认素材库。
默认值:UserDefine,拉取用户自定义素材库素材。
说明:如果是拉取系统默认素材库,只能使用素材名字或者素材 ID + 素材名字的方式进行拉取,且五官图片只返回一张。
*/
Type?: string;
/**
* 素材 ID,数组长度限制:100。
*/
PersonIds?: Array;
/**
* 素材名称,数组长度限制:20。
*/
Names?: Array;
/**
* 素材标签,数组长度限制:20。
*/
Tags?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:100,最大值:100。
*/
Limit?: number;
}
/**
* DescribeEventsState请求参数结构体
*/
export interface DescribeEventsStateRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 微信小程序发布任务信息
*/
export interface WechatMiniProgramPublishTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
WAITING:等待中;
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 错误码
0:成功;
其他值:失败。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 发布视频文件 ID。
*/
FileId?: string;
/**
* 发布视频所对应的转码模板 ID,为 0 代表原始视频。
*/
SourceDefinition?: number;
/**
* 微信小程序视频发布状态,取值:
Pass:发布成功;
Failed:发布失败;
Rejected:音视频审核未通过。
*/
PublishResult?: string;
}
/**
* 图片异步处理任务信息
*/
export interface ProcessImageAsync {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 图片异步处理任务的输入信息。
*/
Input?: ProcessImageAsyncInput;
/**
* 图片异步处理任务的输出信息。
*/
Output?: ProcessImageAsyncOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* DescribeDrmKeyProviderInfo请求参数结构体
*/
export interface DescribeDrmKeyProviderInfoRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* AIGC 生音效任务的输出文件信息。
*/
export interface AigcAudioTaskOutputFileInfo {
/**
* 存储模式。取值有:
Permanent:永久存储; Temporary:临时存储;
默认值:Temporary
*/
StorageMode?: string;
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。当 StorageMode 为 Permanent 时有效。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。当 StorageMode 为 Permanent 时有效。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
ExpireTime?: string;
/**
* 文件类型,例如 mp4、flv 等。
*/
FileType?: string;
/**
* 媒体文件播放地址。
*/
FileUrl?: string;
/**
* 媒体文件 ID。当 StorageMode 为 Permanent 时有效。
*/
FileId?: string;
/**
* 输出音频的元信息。
*/
MetaData?: MediaMetaData;
/**
* 时长
单位:秒
*/
Duration?: number;
}
/**
* CreateImageProcessingTemplate返回参数结构体
*/
export interface CreateImageProcessingTemplateResponse {
/**
* 图片处理模板唯一标识。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 制作媒体文件任务信息
*/
export interface ComposeMediaTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务流状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 错误码
0:成功;
其他值:失败。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 制作媒体文件任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 制作媒体文件任务的输入。
*/
Input?: ComposeMediaTaskInput;
/**
* 制作媒体文件任务的输出。
*/
Output?: ComposeMediaTaskOutput;
/**
* 输出视频的元信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
MetaData?: MediaMetaData;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* 视频片头片尾识别任务控制参数
*/
export interface HeadTailConfigureInfoForUpdate {
/**
* 视频片头片尾识别任务开关,可选值:
ON:开启智能视频片头片尾识别任务;
OFF:关闭智能视频片头片尾识别任务。
*/
Switch?: string;
}
/**
* 图片缩放处理。
*/
export interface ImageScale {
/**
* 图片缩放的操作类型。可选模式有:
WidthFirst : 指定图片的宽为 Width ,高度等比缩放。
HeightFirst : 指定图片的高为 Height ,宽度等比缩放。
LongEdgeFirst : 指定图片的长边为 LongEdge ,短边等比缩放。
ShortEdgeFirst : 指定图片的短边为 ShortEdge ,长边等比缩放。
Force : 忽略原图宽高比例,指定图片宽度为 Width,高度为 Height ,强行缩放图片,可能导致目标图片变形。
*/
Type: string;
/**
* 输出图片的高度,单位为像素。当 Type 取值为 HeightFirst 或 Force 时此字段有效。
*/
Height?: number;
/**
* 输出图片的宽度,单位为像素。当 Type 取值为 WidthFirst 或 Force 时此字段有效。
*/
Width?: number;
/**
* 输出图片的长边长度,单位为像素。当 Type 取值为 LongEdgeFirst 时此字段有效。
*/
LongEdge?: number;
/**
* 输出图片的短边长度,单位为像素。当 Type 取值为 ShortEdgeFirst 时此字段有效。
*/
ShortEdge?: number;
}
/**
* ModifyEventConfig请求参数结构体
*/
export interface ModifyEventConfigRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 接收事件通知的方式。
PUSH:[HTTP 回调通知](https://cloud.tencent.com/document/product/266/33779);PULL:[基于消息队列的可靠通知](https://cloud.tencent.com/document/product/266/33779)。
*/
Mode?: string;
/**
* 采用 HTTP 回调通知 接收方式时,用于接收 3.0 格式回调的地址。
注意:如果带 NotificationUrl 参数且值为空字符串时将会清空 3.0 格式回调地址。
*/
NotificationUrl?: string;
/**
* 是否接收 视频上传完成 事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
*/
UploadMediaCompleteEventSwitch?: string;
/**
* 是否接收 视频删除完成 事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
*/
DeleteMediaCompleteEventSwitch?: string;
/**
* 是否接收剪辑固化完成事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
*/
PersistenceCompleteEventSwitch?: string;
/**
* 回调密钥,由大小写字母及数字组成,最长32字符。配置后将在回调中发送Sign与T字段,可用于鉴权。
Sign:string类型。事件通知安全签名 Sign = MD5(SignKey + T)。说明:腾讯云把加密 SignKey 和 T 进行字符串拼接后通过 MD5 计算得出 Sign 值,并将其放在通知消息里,您的后台服务器在收到通知消息后可以根据同样的算法确认 Sign 是否正确,进而确认消息是否确实来自腾讯云后台。T:int64类型。过期时间,事件通知签名过期 UNIX 时间戳。来自腾讯云的消息通知默认过期时间是10分钟,如果一条消息通知中的 t 值所指定的时间已经过期,则可以判定这条通知无效,进而可以防止网络重放攻击。T 的格式为十进制 UNIX 时间戳,即从1970年01月01日(UTC/GMT 的午夜)开始所经过的秒数。
*/
SignKey?: string;
}
/**
* ModifyJustInTimeTranscodeTemplate返回参数结构体
*/
export interface ModifyJustInTimeTranscodeTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 图片美颜效果项。
*/
export interface BeautyEffectItem {
/**
* 是否开启美颜。
枚举值:
*/
Switch?: string;
/**
* 美颜项。
*/
Type?: string;
/**
* 美颜强度。
*/
Value?: number;
/**
* 附加资源路径。
*/
ResourcePath?: string;
/**
* 附加信息。
*/
ExtInfo?: string;
}
/**
* 图片智能内容识别任务输入
*/
export interface ImageContentReviewInput {
/**
* 图片智能内容审核模板 ID。当前只支持:
10:所有审核类型均打开。
*/
Definition: number;
}
/**
* 点播文件视频流信息
*/
export interface MediaVideoStreamItem {
/**
* 视频流的码率,单位:bps。
*/
Bitrate?: number;
/**
* 视频流的高度,单位:px。
*/
Height?: number;
/**
* 视频流的宽度,单位:px。
*/
Width?: number;
/**
* 视频流的编码格式,例如 h264。
*/
Codec?: string;
/**
* 帧率,单位:hz。
*/
Fps?: number;
/**
* 编码标签,仅当 Codec 为 hevc 时有效。
*/
CodecTag?: string;
/**
* 画面动态范围信息。
注意:在 2023-01-10T00:00:00Z 后处理的转码文件,此字段有效。
*/
DynamicRangeInfo?: DynamicRangeInfo;
}
/**
* ExecuteFunction返回参数结构体
*/
export interface ExecuteFunctionResponse {
/**
* 处理结果打包后的字符串,具体与后台一同协调。
*/
Result?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频转码播放信息(2017 版)
*/
export interface TranscodePlayInfo2017 {
/**
* 播放地址。
*/
Url?: string;
/**
* 转码规格 ID,参见[转码参数模板](https://cloud.tencent.com/document/product/266/33476)。
*/
Definition?: number;
/**
* 视频流码率平均值与音频流码率平均值之和, 单位:bps。
*/
Bitrate?: number;
/**
* 视频流高度的最大值,单位:px。
*/
Height?: number;
/**
* 视频流宽度的最大值,单位:px。
*/
Width?: number;
}
/**
* 视频拆条任务信息,仅当 TaskType 为 SplitMedia,该字段有值。
*/
export interface SplitMediaTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务流状态,取值:
PROCESSING:处理中;
FINISH:已完成。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 视频拆条任务详细信息列表。
*/
FileInfoSet?: Array;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 视频拆条任务进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* 制作媒体文件任务的输入。
*/
export interface ComposeMediaTaskInput {
/**
* 输入的媒体轨道列表,包括视频、音频、图片等素材组成的多个轨道信息。
*/
Tracks: Array;
/**
* 制作视频文件时使用的画布。
注意:此字段可能返回 null,表示取不到有效值。
*/
Canvas: Canvas;
/**
* 输出的媒体文件信息。
*/
Output: ComposeMediaOutput;
}
/**
* ModifyQualityInspectTemplate请求参数结构体
*/
export interface ModifyQualityInspectTemplateRequest {
/**
* 模板 ID。
*/
Definition: number;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 音画质检测的配置参数。
*/
Configs?: Array;
/**
* 音画质检测的抽检策略。
*/
Strategy?: QualityInspectStrategy;
/**
* (不推荐,使用 Configs 替代)截帧间隔,单位为秒,最小值为 1。
*/
ScreenshotInterval?: number;
/**
* (不推荐,使用 Configs 替代)视频画面抖动重影检测的控制参数。
*/
JitterConfigure?: JitterConfigureInfoForUpdate;
/**
* (不推荐,使用 Configs 替代)视频画面模糊检测的控制参数。
*/
BlurConfigure?: BlurConfigureInfoForUpdate;
/**
* (不推荐,使用 Configs 替代)视频画面低光、过曝检测的控制参数。
*/
AbnormalLightingConfigure?: AbnormalLightingConfigureInfoForUpdate;
/**
* (不推荐,使用 Configs 替代)视频画面花屏检测的控制参数。
*/
CrashScreenConfigure?: CrashScreenConfigureInfoForUpdate;
/**
* (不推荐,使用 Configs 替代)视频画面黑边、白边、黑屏、白屏检测的控制参数。
*/
BlackWhiteEdgeConfigure?: BlackWhiteEdgeConfigureInfoForUpdate;
/**
* (不推荐,使用 Configs 替代)视频画面噪点检测的控制参数。
*/
NoiseConfigure?: NoiseConfigureInfoForUpdate;
/**
* (不推荐,使用 Configs 替代)视频画面马赛克检测的控制参数。
*/
MosaicConfigure?: MosaicConfigureInfoForUpdate;
/**
* (不推荐,使用 Configs 替代)视频画面二维码检测的控制参数。
*/
QRCodeConfigure?: QRCodeConfigureInfoForUpdate;
/**
* (不推荐,使用 Configs 替代)音频(静音、低音、爆音)检测的控制参数。
*/
VoiceConfigure?: VoiceConfigureInfoForUpdate;
/**
* (不推荐,使用 Configs 替代)视频画面质量评价的控制参数。
*/
QualityEvaluationConfigure?: QualityEvaluationConfigureInfoForUpdate;
}
/**
* DesignVoiceAsync返回参数结构体
*/
export interface DesignVoiceAsyncResponse {
/**
* 任务id,查询任务时使用
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 场景化 AIGC 生视频任务信息
*/
export interface SceneAigcVideoTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* AIGC 生视频任务的输入信息。
*/
Input?: SceneAigcVideoTaskInput;
/**
* AIGC 生视频任务的输出信息。
*/
Output?: SceneAigcVideoTaskOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* 图片异步处理扩展参数。
*/
export interface ProcessImageAsyncInputExtendedParameter {
/**
* 输入模型的提示词。
*/
Prompts?: Array;
}
/**
* 转动图任务类型
*/
export interface AnimatedGraphicTaskInput {
/**
* 视频转动图模板 ID
*/
Definition: number;
/**
* 动图在视频中的起始时间偏移,单位为秒。
不填或填0,表示从视频的起始位置开始;
当数值大于0时(假设为 n),表示从视频的第 n 秒位置开始;
当数值小于0时(假设为 -n),表示从视频结束 n 秒前的位置开始。
*/
StartTimeOffset: number;
/**
* 动图在视频中的终止时间偏移,单位为秒。
不填或填0,表示持续到视频的末尾终止;
当数值大于0时(假设为 n),表示持续到视频第 n 秒时终止;
当数值小于0时(假设为 -n),表示持续到视频结束 n 秒前终止。
*/
EndTimeOffset: number;
}
/**
* 视频处理任务中的马赛克参数类型
*/
export interface MosaicInput {
/**
* 原点位置,目前仅支持:
TopLeft:表示坐标原点位于视频图像左上角,马赛克原点为图片或文字的左上角。
默认值:TopLeft。
*/
CoordinateOrigin?: string;
/**
* 马赛克原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式:
当字符串以 % 结尾,表示马赛克 XPos 为视频宽度指定百分比,如 10% 表示 XPos 为视频宽度的 10%;
当字符串以 px 结尾,表示马赛克 XPos 为指定像素,如 100px 表示 XPos 为 100 像素。
默认值:0px。
*/
XPos?: string;
/**
* 马赛克原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式:
当字符串以 % 结尾,表示马赛克 YPos 为视频高度指定百分比,如 10% 表示 YPos 为视频高度的 10%;
当字符串以 px 结尾,表示马赛克 YPos 为指定像素,如 100px 表示 YPos 为 100 像素。
默认值:0px。
*/
YPos?: string;
/**
* 马赛克的宽度。支持 %、px 两种格式:
当字符串以 % 结尾,表示马赛克 Width 为视频宽度的百分比大小,如 10% 表示 Width 为视频宽度的 10%;
当字符串以 px 结尾,表示马赛克 Width 单位为像素,如 100px 表示 Width 为 100 像素。
默认值:10%。
*/
Width?: string;
/**
* 马赛克的高度。支持 %、px 两种格式:
当字符串以 % 结尾,表示马赛克 Height 为视频高度的百分比大小,如 10% 表示 Height 为视频高度的 10%;
当字符串以 px 结尾,表示马赛克 Height 单位为像素,如 100px 表示 Height 为 100 像素。
默认值:10%。
*/
Height?: string;
/**
* 马赛克的起始时间偏移,单位:秒。不填或填0,表示马赛克从画面出现时开始显现。
不填或填0,表示马赛克从画面开始就出现;
当数值大于0时(假设为 n),表示马赛克从画面开始的第 n 秒出现;
当数值小于0时(假设为 -n),表示马赛克从离画面结束 n 秒前开始出现。
*/
StartTimeOffset?: number;
/**
* 马赛克的结束时间偏移,单位:秒。
不填或填0,表示马赛克持续到画面结束;
当数值大于0时(假设为 n),表示马赛克持续到第 n 秒时消失;
当数值小于0时(假设为 -n),表示马赛克持续到离画面结束 n 秒前消失。
*/
EndTimeOffset?: number;
}
/**
* AI 智能分析模板详情
*/
export interface AIAnalysisTemplateItem {
/**
* 智能分析模板唯一标识。
*/
Definition?: number;
/**
* 智能分析模板名称。
*/
Name?: string;
/**
* 智能分析模板描述信息。
*/
Comment?: string;
/**
* 智能分类任务控制参数。
*/
ClassificationConfigure?: ClassificationConfigureInfo;
/**
* 智能标签任务控制参数。
*/
TagConfigure?: TagConfigureInfo;
/**
* 智能封面任务控制参数。
*/
CoverConfigure?: CoverConfigureInfo;
/**
* 智能按帧标签任务控制参数。
*/
FrameTagConfigure?: FrameTagConfigureInfo;
/**
* 智能精彩集锦任务控制参数。
*/
HighlightConfigure?: HighlightsConfigureInfo;
/**
* 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
/**
* 模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
UpdateTime?: string;
}
/**
* 单个物体识别结果。
*/
export interface AiRecognitionTaskObjectResultItem {
/**
* 识别的物体名称。
*/
Name?: string;
/**
* 物体出现的片段列表。
* @deprecated
*/
SegmentSet?: Array;
/**
* 物体出现的片段列表。
*/
RecognitionSegmentSet?: Array;
}
/**
* DeleteImageProcessingTemplate返回参数结构体
*/
export interface DeleteImageProcessingTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AIGC 视频转绘任务的输出文件信息。
*/
export interface AigcVideoRedrawOutputFileInfo {
/**
* 存储模式。取值有:
Permanent:永久存储; Temporary:临时存储;默认值:Temporary
*/
StorageMode?: string;
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。当 StorageMode 为 Permanent 时有效。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。当 StorageMode 为 Permanent 时有效。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
ExpireTime?: string;
/**
* 文件类型,例如 mp4、flv 等。
*/
FileType?: string;
/**
* 媒体文件播放地址。
*/
FileUrl?: string;
/**
* 媒体文件 ID。当 StorageMode 为 Permanent 时有效。
*/
FileId?: string;
/**
* 输出视频的元信息。当 StorageMode 为 Permanent 时有效。
*/
MetaData?: MediaMetaData;
}
/**
* 基于签名的 Key 防盗链信息
*/
export interface UrlSignatureAuthPolicy {
/**
* [Key 防盗链](https://cloud.tencent.com/document/product/266/14047)设置状态,可选值:
Enabled: 启用。
Disabled: 禁用。
*/
Status: string;
/**
* [Key 防盗链](https://cloud.tencent.com/document/product/266/14047)中用于生成签名的密钥。
EncryptedKey 字符串的长度为8~40个字节,不能包含不可见字符。
*/
EncryptedKey?: string;
}
/**
* ModifyVodDomainConfig返回参数结构体
*/
export interface ModifyVodDomainConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 点播文件指定时间点截图信息
*/
export interface MediaSnapshotByTimeOffsetInfo {
/**
* 特定规格的指定时间点截图信息集合。目前每种规格只能有一套截图。
*/
SnapshotByTimeOffsetSet: Array;
}
/**
* 即时转码视频模板配置。
*/
export interface VideoConfigureInfo {
/**
* 视频流宽度(或长边)的最大值,取值范围:0 和 [128, 1920],单位:px。
当 Width、Height 均为 0,则分辨率同源;
当 Width 为 0,Height 非 0,则 Width 按比例缩放;
当 Width 非 0,Height 为 0,则 Height 按比例缩放;
当 Width、Height 均非 0,则分辨率按用户指定。
默认值:0。
*/
Width?: number;
/**
* 视频流高度(或短边)的最大值,取值范围:0 和 [128, 1920],单位:px。
当 Width、Height 均为 0,则分辨率同源;
当 Width 为 0,Height 非 0,则 Width 按比例缩放;
当 Width 非 0,Height 为 0,则 Height 按比例缩放;
当 Width、Height 均非 0,则分辨率按用户指定。
默认值:0。
*/
Height?: number;
/**
* 分辨率自适应,可选值:
open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;
close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。
默认值:open。
*/
ResolutionAdaptive?: string;
/**
* 视频流的码率,取值范围:0 和 [128, 10000],单位:kbps。
当取值为 0,表示由云点播自动设置码率。
*/
Bitrate?: number;
}
/**
* DeleteAIAnalysisTemplate返回参数结构体
*/
export interface DeleteAIAnalysisTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyRebuildMediaTemplate返回参数结构体
*/
export interface ModifyRebuildMediaTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateEnhanceMediaTemplate请求参数结构体
*/
export interface CreateEnhanceMediaTemplateRequest {
/**
* 输出文件封装格式,可选值:mp4、flv、hls。
*/
Container: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 音画质重生模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 音画质重生视频控制控制信息。
*/
RebuildVideoInfo?: RebuildVideoInfo;
/**
* 音画质重生音频控制控制信息。
*/
RebuildAudioInfo?: RebuildAudioInfo;
/**
* 输出目标视频控制信息。
*/
TargetVideoInfo?: RebuildMediaTargetVideoStream;
/**
* 输出目标音频控制信息。
*/
TargetAudioInfo?: RebuildMediaTargetAudioStream;
/**
* 是否去除视频数据,可选值:
0:保留
1:去除
默认值 0。
*/
RemoveVideo?: number;
/**
* 是否去除音频数据,可选值:
0:保留
1:去除
默认值 0。
*/
RemoveAudio?: number;
}
/**
* 视频打点信息
*/
export interface MediaKeyFrameDescItem {
/**
* 打点的视频偏移时间,单位:秒。
*/
TimeOffset: number;
/**
* 打点的内容字符串,限制 1-128 个字符。
*/
Content: string;
}
/**
* 语音翻译识别控制参数
*/
export interface AsrTranslateConfigureInfoForUpdate {
/**
* 语音翻译识别任务开关,可选值:
ON:开启;
OFF:关闭。注意:语音翻译识别任务本身会返回 ASR 全文识别结果,为避免重复收费,因此禁止同时开启语音翻译识别和 ASR 全文识别功能项。
*/
Switch?: string;
/**
* 媒体源语言,取值范围:
zh:中文;
en:英文;
ja:日文;
ko:韩文;
vi:越南语;
ms:马来语;
th:泰语;
pt:葡萄牙语;
tr:土耳其语;
ar:阿拉伯语;
es:西班牙语;
hi:印地语;
fr:法语。
*/
SrcLanguage?: string;
/**
* 翻译目标语言。
若此参数填写空字符串,则表示只进行语音全文识别,不进行翻译(计费项与 AsrFullTextConfigure 语音全文识别一致);
否则,此参数的取值范围分为如下几种情况:
当 SrcLanguage 为 zh(中文)时,取值范围:
en:英文;
ja:日文;
ko:韩文;
fr:法语;
es:西班牙语;
it:意大利语;
de:德语;
tr:土耳其语;
ru:俄语;
pt:葡萄牙语;
vi:越南语;
id:印尼语;
th:泰语;
ms:马来语。
当 SrcLanguage 为 en(英文)时,取值范围:
zh:中文;
ja:日文;
ko:韩文;
fr:法语;
es:西班牙语;
it:意大利语;
de:德语;
tr:土耳其语;
ru:俄语;
pt:葡萄牙语;
vi:越南语;
id:印尼语;
th:泰语;
ms:马来语;
ar:阿拉伯语;
hi:印地语。
当 SrcLanguage 为 ja(日文)时,取值范围:
zh:中文;
en:英文;
ko:韩文。
当 SrcLanguage 为 ko(韩文)时,取值范围:
zh:中文;
en:英文;
ja:日文。
当 SrcLanguage 为 vi(越南语)或 ms(马来语)或 th(泰语)时,取值范围:
zh:中文;
en:英文。
当 SrcLanguage 为 pt(葡萄牙语)时,取值范围:
zh:中文;
en:英文;
fr:法语;
es:西班牙语;
it:意大利语;
de:德语;
tr:土耳其语;
ru:俄语。
当 SrcLanguage 为 tr(土耳其语)时,取值范围:
zh:中文;
en:英文;
fr:法语;
es:西班牙语;
it:意大利语;
de:德语;
ru:俄语;
pt:葡萄牙语。
当 SrcLanguage 为 es(西班牙语)时,取值范围:
zh:中文;
en:英文;
fr:法语;
it:意大利语;
de:德语;
tr:土耳其语;
ru:俄语;
pt:葡萄牙语。
当 SrcLanguage 为 ar(阿拉伯语)或 hi(印地语)时,取值范围:
en:英文。
当 SrcLanguage 为 fr(法语)时,取值范围:
zh:中文;
en:英文;
es:西班牙语;
it:意大利语;
de:德语;
tr:土耳其语;
ru:俄语;
pt:葡萄牙语。
*/
DstLanguage?: string;
/**
* 字幕格式列表操作信息。
*/
SubtitleFormatsOperation?: SubtitleFormatsOperation;
/**
* 指定字幕名称,长度限制:64 个字符。该值将用于播放器展示。
*/
SubtitleName?: string;
}
/**
* 场景化 AIGC 生图任务信息
*/
export interface SceneAigcImageTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 任务进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* AIGC 生图任务的输入信息。
*/
Input?: SceneAigcImageTaskInput;
/**
* AIGC 生图任务的输出信息。
*/
Output?: SceneAigcImageTaskOutput;
/**
* 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
}
/**
* RebuildMediaByTemplate请求参数结构体
*/
export interface RebuildMediaByTemplateRequest {
/**
* 媒体文件 ID。
*/
FileId: string;
/**
* 视频重生模板 ID。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: string;
/**
* 起始偏移时间,单位:秒,不填表示从视频开始截取。
*/
StartTimeOffset?: number;
/**
* 结束偏移时间,单位:秒,不填表示截取到视频末尾。
*/
EndTimeOffset?: number;
/**
* 视频重生后的文件配置。
*/
OutputConfig?: RebuildMediaOutputConfig;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* ModifyVodDomainConfig请求参数结构体
*/
export interface ModifyVodDomainConfigRequest {
/**
* 域名。
*/
Domain: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* [Referer 防盗链](/document/product/266/14046)规则。
*/
RefererAuthPolicy?: RefererAuthPolicy;
/**
* [Key 防盗链](/document/product/266/14047)规则。
*/
UrlSignatureAuthPolicy?: UrlSignatureAuthPolicy;
/**
* QUIC 配置。
*/
QUICConfig?: DomainQUICConfig;
/**
* IP 访问限制规则。
*/
IPFilterPolicy?: IPFilterPolicy;
}
/**
* AI 样本管理,标签操作。
*/
export interface AiSampleTagOperation {
/**
* 操作类型,可选值:add(添加)、delete(删除)、reset(重置)。
*/
Type: string;
/**
* 标签,长度限制:128 个字符。
*/
Tags: Array;
}
/**
* 自适应码流任务的输出结果。
*/
export interface ComplexAdaptiveDynamicStreamingTaskOutput {
/**
* 自适应码流模板 ID。
*/
Definition?: number;
/**
* 自适应码流打包格式。可选值:
HLS;
MPEG-DASH。
*/
Format?: string;
/**
* DRM 方案类型。可选值:
空字符串:无加密;
SimpleAES;
Widevine;
FairPlay。
*/
DrmType?: string;
/**
* 自适应码流的播放地址。
*/
Url?: string;
}
/**
* MPS字幕压制模块文字阴影配置
*/
export interface MPSSubtitleShadowConfig {
/**
* 文字阴影配置开关,0关闭,1开启,默认0
*/
SubtitleShadowConfigSwitch?: number;
/**
* 阴影宽度,默认单位像素,底层默认值为0,无阴影
*/
ShadowWidth?: number;
/**
* 阴影宽度单位, 0 像素,1百分比,默认为0,像素
*/
ShadowWidthUnit?: number;
/**
* 阴影颜色。6位16进制RGB。不填默认黑色(有设置阴影的情况下)
*/
ShadowColor?: string;
/**
* 阴影透明度。(0,1] 正浮点数。不填默认1,完全不透明(有设置阴影的情况下)
*/
ShadowAlpha?: number;
}
/**
* 自适应码流任务信息。
*/
export interface ComplexAdaptiveDynamicStreamingTaskResult {
/**
* 任务状态,取值:
PROCESSING:处理中;
SUCCESS:已完成;
FAIL:失败。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 转码进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 自适应码流任务的输入。
*/
Input?: ComplexAdaptiveDynamicStreamingTaskInput;
/**
* 自适应码流任务的输出。
*/
Output?: ComplexAdaptiveDynamicStreamingTaskOutput;
}
/**
* ConfirmEvents请求参数结构体
*/
export interface ConfirmEventsRequest {
/**
* 事件句柄,即 [拉取事件通知](/document/product/266/33433) 接口输出参数中的 EventSet. EventHandle 字段。
数组长度限制:16。
*/
EventHandles: Array;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* CreateAIRecognitionTemplate返回参数结构体
*/
export interface CreateAIRecognitionTemplateResponse {
/**
* 音视频内容识别模板唯一标识。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 图片异步处理任务信息。
*/
export interface ProcessImageAsyncInput {
/**
* 图片处理的FileId。
*/
FileId?: string;
/**
* 图片URL。
*/
Url?: string;
/**
* 图片处理参数。
*/
ImageTaskInput?: ProcessImageAsyncTaskInput;
/**
* 图片处理任务的输出媒体文件配置。
*/
OutputConfig?: ProcessImageAsyncOutputConfig;
}
/**
* ModifySubAppIdStatus请求参数结构体
*/
export interface ModifySubAppIdStatusRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId: number;
/**
* 应用状态,取值范围:
On:启用。
Off:停用。
Destroyed:销毁。
当前状态如果是 Destoying ,不能进行启用操作,需要等待销毁完成后才能重新启用。
*/
Status: string;
}
/**
* DeleteBlindWatermarkTemplate请求参数结构体
*/
export interface DeleteBlindWatermarkTemplateRequest {
/**
* 数字水印模板唯一标识。
*/
Definition: number;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* CreateSubAppId返回参数结构体
*/
export interface CreateSubAppIdResponse {
/**
* 新创建的应用 ID。
*/
SubAppId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteTranscodeTemplate请求参数结构体
*/
export interface DeleteTranscodeTemplateRequest {
/**
* 转码模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* 暴恐信息
*/
export interface AiReviewTerrorismTaskOutput {
/**
* 视频暴恐评分,分值为0到100。
*/
Confidence: number;
/**
* 暴恐结果建议,取值范围:
pass。
review。
block。
*/
Suggestion: string;
/**
* 视频暴恐结果标签,取值范围:
guns:武器枪支。
crowd:人群聚集。
police:警察部队。
bloody:血腥画面。
banners:暴恐旗帜。
militant:武装分子。
explosion:爆炸火灾。
terrorists:暴恐人物。
scenario:暴恐画面。
*/
Label: string;
/**
* 有暴恐嫌疑的视频片段列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet: Array;
/**
* 暴恐嫌疑的视频片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl: string;
/**
* 暴恐嫌疑的视频片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime: string;
}
/**
* 音频分离配置。
*/
export interface AudioSeparateInfo {
/**
* 音频分离控制开关,可选值:
ON:开启音频分离;
OFF:关闭音频分离。
*/
Switch: string;
/**
* 场景类型,可选值:
normal:人声背景声场景
music:演唱伴奏场景
默认值:normal。
*/
Type?: string;
/**
* 输出音轨,可选值:
vocal:输出人声
background:应用场景为normal时输出背景声,应用场景为music时输出伴奏
默认值:vocal。
*/
Track?: string;
}
/**
* 异步获取 AIGC 人脸信息输出
*/
export interface DescribeAigcFaceInfoAsyncOutput {
/**
* 人脸信息。
*/
FaceInfoSet?: Array;
}
/**
* 音画质检测任务的输入。
*/
export interface QualityInspectTaskInput {
/**
* 媒体文件 ID。
*/
FileId?: string;
/**
* 音画质检测模板 ID。
*/
Definition?: number;
}
/**
* 违禁任务控制参数
*/
export interface ProhibitedConfigureInfo {
/**
* 语音违禁控制参数。
*/
AsrReviewInfo?: ProhibitedAsrReviewTemplateInfo;
/**
* 文本违禁控制参数。
*/
OcrReviewInfo?: ProhibitedOcrReviewTemplateInfo;
}
/**
* DRM 自适应码流播放信息
*/
export interface DrmStreamingsInfo {
/**
* 保护类型为 SimpleAES 的转自适应码流模板 ID。
*/
SimpleAesDefinition?: number;
/**
* 保护类型为 Widevine 的转自适应码流模板 ID。
*/
WidevineDefinition?: number;
/**
* 保护类型为 FairPlay 的转自适应码流模板 ID。
*/
FairPlayDefinition?: number;
}
/**
* SplitMedia请求参数结构体
*/
export interface SplitMediaRequest {
/**
* 视频的 ID。
*/
FileId: string;
/**
* 视频拆条任务信息列表,最多同时支持100个拆条信息。
*/
Segments: Array;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 标识来源上下文,用于透传用户请求信息,在 SplitMediaComplete 回调和任务流状态变更回调将返回该字段值,最长 1000个字符。
*/
SessionContext?: string;
/**
* 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
}
/**
* Ocr 文字涉及令人不安全的信息
*/
export interface AiReviewTerrorismOcrTaskOutput {
/**
* Ocr 文字有涉及令人不安全信息的评分,分值为0到100。
*/
Confidence?: number;
/**
* Ocr 文字有涉及令人不安全信息的结果建议,取值范围:
pass。
review。
block。
*/
Suggestion?: string;
/**
* Ocr 文字有涉及令人不安全信息嫌疑的视频片段列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet?: Array;
/**
* Ocr 文字有涉及令人不安全信息嫌疑的视频片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达 SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl?: string;
/**
* Ocr 文字有涉及令人不安全信息嫌疑的视频片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime?: string;
}
/**
* AIGC 声音复刻输入文件信息
*/
export interface AigcAudioCloneInputFileInfo {
/**
* 输入的视频文件类型。取值有:
File:点播媒体文件; Url:可访问的 Url;
注意:此字段可能返回 null,表示取不到有效值。
*/
Type?: string;
/**
* 媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。当 Type 取值为 File 时,本参数有效。说明:1. 推荐使用小于10M的图片;2. 图片格式的取值为:jpeg,jpg, png。
注意:此字段可能返回 null,表示取不到有效值。
*/
FileId?: string;
/**
* 可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。说明:1. 推荐使用小于10M的图片;2. 图片格式的取值为:jpeg,jpg, png。
注意:此字段可能返回 null,表示取不到有效值。
*/
Url?: string;
}
/**
* 智能分析结果
*/
export interface AiAnalysisResult {
/**
* 任务的类型,可以取的值有:
Classification:智能分类
Cover:智能封面
Tag:智能标签
FrameTag:智能按帧标签
Highlight:智能精彩集锦
*/
Type?: string;
/**
* 视频内容分析智能分类任务的查询结果,当任务类型为 Classification 时有效。
*/
ClassificationTask?: AiAnalysisTaskClassificationResult;
/**
* 视频内容分析智能封面任务的查询结果,当任务类型为 Cover 时有效。
*/
CoverTask?: AiAnalysisTaskCoverResult;
/**
* 视频内容分析智能标签任务的查询结果,当任务类型为 Tag 时有效。
*/
TagTask?: AiAnalysisTaskTagResult;
/**
* 视频内容分析智能按帧标签任务的查询结果,当任务类型为 FrameTag 时有效。
*/
FrameTagTask?: AiAnalysisTaskFrameTagResult;
/**
* 视频内容分析智能精彩集锦任务的查询结果,当任务类型为 Highlight 时有效。
*/
HighlightTask?: AiAnalysisTaskHighlightResult;
}
/**
* 降码率任务转自适应码流结果类型
*/
export interface ReduceMediaBitrateAdaptiveDynamicStreamingResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误信息。
*/
Message?: string;
/**
* 对视频转自适应码流任务的输入。
*/
Input?: AdaptiveDynamicStreamingTaskInput;
/**
* 对视频转自适应码流任务的输出。
*/
Output?: AdaptiveDynamicStreamingInfoItem;
}
/**
* DeleteVoice返回参数结构体
*/
export interface DeleteVoiceResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 媒体处理任务中的数字水印参数类型
*/
export interface BlindWatermarkInput {
/**
* 数字水印模板ID
*/
Definition: number;
}
/**
* 用于生成混元 3D 模型的已有模型信息。
*/
export interface AigcHunyuan3DMeshInfo {
/**
* 输入的文件类型。取值有:
File:点播文件; Url:可访问的 Url;
*/
Type?: string;
/**
* 文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。当 Type 取值为 File 时,本参数有效。说明:图片格式的取值为:支持 glb、obj。
*/
FileId?: string;
/**
* 可访问的文件 URL。当 Type 取值为 Url 时,本参数有效。说明:文件格式的取值为:支持 glb、obj。
*/
Url?: string;
}
/**
* AttachMediaSubtitles返回参数结构体
*/
export interface AttachMediaSubtitlesResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TextToSpeechAsync返回参数结构体
*/
export interface TextToSpeechAsyncResponse {
/**
* 任务ID,使用该ID查询结果
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateDomainVerifyRecord返回参数结构体
*/
export interface CreateDomainVerifyRecordResponse {
/**
* DNS解析信息
*/
DNSVerifyInfo?: DNSVerifyInfo;
/**
* 文件验证信息
*/
FileVerifyInfo?: FileVerifyInfo;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ExtractCopyRightWatermark返回参数结构体
*/
export interface ExtractCopyRightWatermarkResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 点播文件转码信息
*/
export interface MediaTranscodeInfo {
/**
* 各规格的转码信息集合,每个元素代表一个规格的转码结果。
*/
TranscodeSet: Array;
}
/**
* ListFiles请求参数结构体
*/
export interface ListFilesRequest {
/**
* 点播[应用](/document/product/266/14574) ID。
*/
SubAppId: number;
/**
* 对象键匹配前缀,限定响应中只包含指定前缀的对象键。
*/
Prefix?: string;
/**
* 一个字符的分隔符,用于对对象键进行分组。所有对象键中从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分将作为 CommonPrefixes 下的一个 Prefix 节点。被分组的对象键不再出现在后续对象列表中。
*/
Delimiter?: string;
/**
* ys 单次返回最大的条目数量,默认值为100,最小为1,最大为100。
*/
MaxKeys?: number;
/**
* 起始对象键标记
*/
Marker?: string;
/**
* 文件类型。匹配集合中的任意元素: Video: 视频文件 Audio: 音频文件 Image: 图片文件
*/
Categories?: Array;
}
/**
* 播放器子流名字信息
*/
export interface ResolutionNameInfo {
/**
* 视频短边长度,单位:像素。
*/
MinEdgeLength: number;
/**
* 展示名字。
*/
Name: string;
}
/**
* 文本全文本识别任务控制参数
*/
export interface OcrFullTextConfigureInfo {
/**
* 文本全文识别任务开关,可选值:
ON:开启智能文本全文识别任务;
OFF:关闭智能文本全文识别任务。
*/
Switch: string;
}
/**
* 文本关键词识别结果。
*/
export interface AiRecognitionTaskOcrWordsResultItem {
/**
* 文本关键词。
*/
Word?: string;
/**
* 文本关键出现的片段列表。
*/
SegmentSet?: Array;
}
/**
* ParseStreamingManifest请求参数结构体
*/
export interface ParseStreamingManifestRequest {
/**
* 待解析的索引文件内容。
*/
MediaManifestContent: string;
/**
* 视频索引文件格式。默认 m3u8 格式。
m3u8
mpd
*/
ManifestType?: string;
}
/**
* 图片审核结果。
*/
export interface ReviewImageResult {
/**
* 图片审核的结果建议,取值范围:
pass:建议通过;
review:建议复审;
block:建议封禁。
*/
Suggestion?: string;
/**
* 当 Suggestion 为 review 或 block 时有效,表示最可能的违规的标签,取值范围:
Porn:色情;
Terror:暴力;
Polity:不适宜的信息;
Ad:广告;
Illegal:违法;
Abuse:谩骂。
*/
Label?: string;
/**
* 当 Suggestion 为 review 或 block 时有效,表示最可能的违禁的形式,取值范围:
Image:画面上的人物或图标;
OCR:画面上的文字。
*/
Form?: string;
/**
* 有违规信息的嫌疑的视频片段列表。
注意 :该列表最多仅展示前 10个 元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet?: Array;
/**
* 涉及违规信息的嫌疑的视频片段列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl?: string;
/**
* 涉及违规信息的嫌疑的视频片段列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime?: string;
}
/**
* DeleteSampleSnapshotTemplate返回参数结构体
*/
export interface DeleteSampleSnapshotTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 智能标签任务输入类型
*/
export interface AiAnalysisTaskTagInput {
/**
* 视频智能标签模板 ID。
*/
Definition?: number;
}
/**
* CloneVoiceAsync请求参数结构体
*/
export interface CloneVoiceAsyncRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: string;
/**
* 克隆音频base64编码。
*/
AudioData?: string;
/**
* 克隆音频Url,AudioData为空时有效
*/
AudioUrl?: string;
/**
* 克隆文件FileID,AudioData及AudioUrl为空时有效
*/
AudioFileId?: string;
/**
* 语言增强,如 "zh" "en" "auto",默认 "auto"
*/
LanguageBoost?: string;
/**
* 音色克隆拓展参数。ExtParam 支持的字段:
text (string):试听合成文本,最大 1000 字符;非空时必须同时传 tts_model,克隆成功后返回试听音频 DemoAudio。 model (string):克隆模型,缺省 minimax-voice-clone。 tts_model (string):合成试听音频用的模型,可选 minimax-speech-2.8-hd、minimax-speech-2.8-turbo、minimax-speech-2.6-hd、minimax-speech-2.6-turbo、minimax-speech-02-hd、minimax-speech-02-turbo;text 非空时必填。 text_lang (string):试听文本语言。 voice_profile (object):音色画像,可选字段: name (string):音色名称。 description (string):音色描述。 gender (string):性别,可选 male / female / unknown。 age (string):年龄段,可选 child / teenager / youth / middle_aged / senior / unknown。 languages (string[]):支持语言,如 ["zh", "en"]。 labels (string[]):音色标签,如 ["磁性"]。 scenes (string[]):适用场景,如 ["解说"]。
*/
ExtParam?: string;
/**
* 标识来源上下文,用于透传用户请求信息,在回调和任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于任务去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
}
/**
* DescribeStorageDetails返回参数结构体
*/
export interface DescribeStorageDetailsResponse {
/**
* 存储统计数据,每5分钟或每天一条数据。
*/
Data?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* PullEvents返回参数结构体
*/
export interface PullEventsResponse {
/**
* 事件列表。
注意:此字段可能返回 null,表示取不到有效值。
*/
EventSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 转码任务结果类型
*/
export interface MediaProcessTaskTranscodeResult {
/**
* 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。
*/
Status?: string;
/**
* 错误码,空字符串表示成功,其他值表示失败,取值请参考 [视频处理类错误码](https://cloud.tencent.com/document/product/266/50368#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。
*/
ErrCodeExt?: string;
/**
* 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。
*/
ErrCode?: number;
/**
* 错误信息。
*/
Message?: string;
/**
* 转码任务的输入。
*/
Input?: TranscodeTaskInput;
/**
* 转码任务的输出。
注意:此字段可能返回 null,表示取不到有效值。
*/
Output?: MediaTranscodeItem;
/**
* 转码进度,取值范围 [0-100] 。
*/
Progress?: number;
/**
* 转码任务开始执行的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
BeginProcessTime?: string;
/**
* 转码任务执行完毕的时间,采用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
FinishTime?: string;
}
/**
* 物体识别任务输入类型。
*/
export interface AiRecognitionTaskObjectResultInput {
/**
* 物体识别模板 ID。
*/
Definition?: number;
}
/**
* CreateCLSLogset返回参数结构体
*/
export interface CreateCLSLogsetResponse {
/**
* 日志集 ID。
*/
LogsetId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频处理任务类型
*/
export interface MediaProcessTaskInput {
/**
* 视频转码任务列表。
*/
TranscodeTaskSet?: Array;
/**
* 视频转动图任务列表。
*/
AnimatedGraphicTaskSet?: Array;
/**
* 对视频按时间点截图任务列表。
*/
SnapshotByTimeOffsetTaskSet?: Array;
/**
* 对视频采样截图任务列表。
*/
SampleSnapshotTaskSet?: Array;
/**
* 对视频截雪碧图任务列表。
*/
ImageSpriteTaskSet?: Array;
/**
* 对视频截图做封面任务列表。
*/
CoverBySnapshotTaskSet?: Array;
/**
* 对视频转自适应码流任务列表。
*/
AdaptiveDynamicStreamingTaskSet?: Array;
}
/**
* 输出的视频流信息
*/
export interface OutputVideoStream {
/**
* 视频流的编码格式,可选值:
libx264:H.264 编码
默认值:libx264。
*/
Codec?: string;
/**
* 视频帧率,取值范围:[0, 60],单位:Hz。
默认值:0,表示和第一个视频轨的第一个视频片段的视频帧率一致。
*/
Fps?: number;
}
/**
* ModifyDefaultDistributionConfig请求参数结构体
*/
export interface ModifyDefaultDistributionConfigRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 分发域名,取值为点播域名列表里的域名。不填或者填空,表示不修改域名。
*/
Domain?: string;
/**
* 分发协议,取值为 HTTP 或者 HTTPS。
*/
Scheme?: string;
/**
* 播放密钥,由大小写字母(a - Z)或者数字(0 - 9)组成,长度在8 - 20个字符之间。
*/
PlayKey?: string;
}
/**
* 任务流模板详情
*/
export interface ProcedureTemplate {
/**
* 任务流名字。
*/
Name?: string;
/**
* 任务流模板类型,取值范围:
Preset:系统预置任务流模板;Custom:用户自定义任务流模板。
*/
Type?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 视频处理类型任务参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
MediaProcessTask?: MediaProcessTaskInput;
/**
* AI 智能审核类型任务参数 *。
*:该参数用于发起旧版审核,不建议使用。推荐使用 ReviewAudioVideoTask 参数发起审核。
注意:此字段可能返回 null,表示取不到有效值。
*/
AiContentReviewTask?: AiContentReviewTaskInput;
/**
* AI 智能内容分析类型任务参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
AiAnalysisTask?: AiAnalysisTaskInput;
/**
* AI 内容识别类型任务参数。
*/
AiRecognitionTaskSet?: Array;
/**
* 该参数已不推荐使用,建议使用 AiRecognitionTaskSet。
注意:此字段可能返回 null,表示取不到有效值。
* @deprecated
*/
AiRecognitionTask?: AiRecognitionTaskInput;
/**
* 微信小程序发布任务参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
MiniProgramPublishTask?: WechatMiniProgramPublishTaskInput;
/**
* 音视频审核类型任务参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
ReviewAudioVideoTask?: ProcedureReviewAudioVideoTaskInput;
/**
* 导入智能媒资知识库任务参数。
*/
ImportMediaKnowledgeTaskSet?: Array;
/**
* 模板创建时间,使用 ISO 日期格式。
*/
CreateTime?: string;
/**
* 模板最后修改时间,使用 ISO 日期格式。
*/
UpdateTime?: string;
}
/**
* DescribeLicenseUsageData返回参数结构体
*/
export interface DescribeLicenseUsageDataResponse {
/**
* License 查询次数统计数据,展示所查询 License 次数的明细数据。
*/
LicenseUsageDataSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 域名信息
*/
export interface DomainDetailInfo {
/**
* 域名名称。
*/
Domain?: string;
/**
* 加速地区信息。
*/
AccelerateAreaInfos?: Array;
/**
* 部署状态,取值有:
Online:上线;Deploying:部署中;Locked: 锁定中,出现该状态时,无法对该域名进行部署变更。
*/
DeployStatus?: string;
/**
* HTTPS 配置信息。
*/
HTTPSConfig?: DomainHTTPSConfig;
/**
* Key 防盗链配置信息。
*/
UrlSignatureAuthPolicy?: UrlSignatureAuthPolicy;
/**
* Referer 防盗链配置信息。
*/
RefererAuthPolicy?: RefererAuthPolicy;
/**
* 域名添加到腾讯云点播系统中的时间。
格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
CreateTime?: string;
/**
* 域名 QUIC 配置信息。
*/
QUICConfig?: DomainQUICConfig;
/**
* IP 访问限制配置信息。
*/
IPFilterPolicy?: IPFilterPolicy;
/**
* 域名类型,取值有:
VOD:使用 VOD 产品分发的域名; EdgeOne:使用 EdgeOne 产品分发的域名。
*/
Type?: string;
}
/**
* 创建主体输出信息。
*/
export interface CreateAigcSubjectOutput {
/**
* 主体ID。
*/
SubjectId?: string;
/**
* 主体信息。
*/
SubjectInfo?: string;
}
/**
* 语义搜索结果。
*/
export interface SemanticsSearchResult {
/**
* 媒体文件唯一标识 ID。
*/
FileId?: string;
/**
* 智能媒资为当前片段生成的标题
*/
Title?: string;
/**
* 视频在本次检索中的得分,得分越高和检索值越相似,取值范围[0,1]
*/
Score?: number;
/**
* 视频片段的开始时间,单位:秒
*/
StartTimeOffset?: number;
/**
* 视频片段的结束时间,单位:秒
*/
EndTimeOffset?: number;
}
/**
* MPS智能任务
*/
export interface MPSAiMediaTask {
/**
* MPS智能任务的模板 ID
*/
Definition?: number;
/**
* MPS智能任务输出文件集合
*/
OutputFile?: Array;
/**
* MPS智能任务返回的结果,该字段对应 MPS 任务返回中的Output结果,以 JSON 格式返回
不同MPS任务输出结果结构不同,具体返回内容参考MPS任务输出结构体
[智能分类结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskClassificationOutput)
[智能封面结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskCoverOutput)
[智能标签结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskTagOutput)
[智能按帧标签分类结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskFrameTagOutput)
[智能高光结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskHighlightOutput)
[智能拆条结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskSegmentOutput)
[智能片头片尾结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskHeadTailOutput)
[智能摘要结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskDescriptionOutput)
[智能横转竖结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskHorizontalToVerticalOutput)
[智能译制结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskDubbingOutput)
[智能视频理解结果](https://cloud.tencent.com/document/product/862/37615#AiAnalysisTaskVideoComprehensionOutput)
[智能字幕语音全文识别结果](https://cloud.tencent.com/document/product/862/37615#SmartSubtitleTaskAsrFullTextResultOutput)
[智能字幕翻译结果](https://cloud.tencent.com/document/product/862/37615#SmartSubtitleTaskTransTextResultOutput)
[智能字幕纯字幕文件翻译结果](https://cloud.tencent.com/document/product/862/37615#PureSubtitleTransResultOutput)
[智能字幕文字提取字幕结果](https://cloud.tencent.com/document/product/862/37615#SmartSubtitleTaskTextResultOutput)
*/
OutputText?: string;
}
/**
* DescribeImageReviewUsageData请求参数结构体
*/
export interface DescribeImageReviewUsageDataRequest {
/**
* 起始日期。使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#52)。
*/
StartTime: string;
/**
* 结束日期,需大于等于起始日期。使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#52)。
*/
EndTime: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* AI 视频智能分析输入参数类型
*/
export interface MPSAiAnalysisTaskInput {
/**
* 视频内容分析模板 ID。
*/
Definition: number;
/**
* 扩展参数,其值为序列化的 json字符串。注意:此参数为定制需求参数,参考如下: