;
/**
* 唯一请求 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;
}
/**
* AIGC 生视频任务信息
*/
export interface AigcVideoTask {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 任务状态,取值:
PROCESSING:处理中;FINISH:已完成。
*/
Status?: string;
/**
* 错误码。源异常时返回非0错误码,返回0时请使用各个具体任务的 ErrCode。
*/
ErrCode?: number;
/**
* 扩展错误码。
枚举值:
- RequestLimitExceeded: 调用超出并发限制。
- InvalidParameter.VoilationContent: 输入 prompt 违反内容安全策略。
- InvalidParameterValue: 参数错误。
- FailedOperation: 模型任务堆积。
- InternalError: 内部错误。
*/
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;
}
/**
* 对视频截图做封面任务输入参数类型
*/
export interface CoverBySnapshotTaskInput {
/**
* 指定时间点截图模板 ID。
*/
Definition: number;
/**
* 截图方式。包含:
Time:依照时间点截图
Percent:依照百分比截图
*/
PositionType: string;
/**
* 截图位置:
对于依照时间点截图,该值表示指定视频第几秒的截图作为封面
对于依照百分比截图,该值表示使用视频百分之多少的截图作为封面
*/
PositionValue: number;
/**
* 水印列表,支持多张图片或文字水印,最大可支持 10 张。
*/
WatermarkSet?: Array;
}
/**
* 视频拆条识别任务控制参数
*/
export interface SegmentConfigureInfoForUpdate {
/**
* 视频拆条识别任务开关,可选值:
ON:开启智能视频拆条识别任务;
OFF:关闭智能视频拆条识别任务。
*/
Switch?: 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;
}
/**
* ModifyProcessImageAsyncTemplate返回参数结构体
*/
export interface ModifyProcessImageAsyncTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 用户自定义音视频审核任务控制参数
*/
export interface UserDefineConfigureInfo {
/**
* 用户自定义人物音视频审核控制参数。
*/
FaceReviewInfo?: UserDefineFaceReviewTemplateInfo;
/**
* 用户自定义语音音视频审核控制参数。
*/
AsrReviewInfo?: UserDefineAsrTextReviewTemplateInfo;
/**
* 用户自定义文本音视频审核控制参数。
*/
OcrReviewInfo?: UserDefineOcrTextReviewTemplateInfo;
}
/**
* 视频画面噪点检测的控制参数。
*/
export interface NoiseConfigureInfoForUpdate {
/**
* 视频画面噪点检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch?: string;
}
/**
* 直播录制信息
*/
export interface LiveRecordInfo {
/**
* 直播录制域名
*/
Domain?: string;
/**
* 直播录制Path
*/
Path?: string;
/**
* 直播录制流 ID。
*/
StreamId?: string;
/**
* 录制起始时间,使用 ISO 日期格式。
*/
RecordStartTime?: string;
/**
* 录制结束时间,使用 ISO 日期格式。
*/
RecordEndTime?: string;
}
/**
* 视频拆条片段。
*/
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 AiAnalysisTaskFrameTagOutput {
/**
* 视频按帧标签列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 SegmentSetFileUrl 对应的文件中获取。
*/
SegmentSet: Array;
/**
* 视频按帧标签列表文件 URL。文件的内容为 JSON,数据结构与 SegmentSet 字段一致。 (文件不会永久存储,到达SegmentSetFileUrlExpireTime 时间点后文件将被删除)。
*/
SegmentSetFileUrl: string;
/**
* 视频按帧标签列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
SegmentSetFileUrlExpireTime: string;
}
/**
* CreateEnhanceMediaTemplate返回参数结构体
*/
export interface CreateEnhanceMediaTemplateResponse {
/**
* 音画质重生模板 ID。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 媒资智能知识库信息
*/
export interface KnowledgeBasesInfo {
/**
* 当前媒资当导入的知识库列表
*/
Bases?: 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 {
/**
* 点播[应用](/document/product/266/14574) 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;
}
/**
* DeleteBlindWatermarkTemplate返回参数结构体
*/
export interface DeleteBlindWatermarkTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
}
/**
* 自适应码流任务信息。
*/
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;
}
/**
* 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;
}
/**
* 媒体轨道的片段信息
*/
export interface MediaTrackItem {
/**
* 片段类型。取值有:
Video:视频片段。
Audio:音频片段。
Sticker:贴图片段。
Transition:转场。
Empty:空白片段。
*/
Type: string;
/**
* 视频片段,当 Type = Video 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
VideoItem?: VideoTrackItem;
/**
* 音频片段,当 Type = Audio 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
AudioItem?: AudioTrackItem;
/**
* 贴图片段,当 Type = Sticker 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
StickerItem?: StickerTrackItem;
/**
* 转场,当 Type = Transition 时有效。
注意:此字段可能返回 null,表示取不到有效值。
*/
TransitionItem?: MediaTransitionItem;
/**
* 空白片段,当 Type = Empty 时有效。空片段用于时间轴的占位。如需要两个音频片段之间有一段时间的静音,可以用 EmptyTrackItem 来进行占位。
使用 EmptyTrackItem 进行占位,来定位某个Item。
注意:此字段可能返回 null,表示取不到有效值。
*/
EmptyItem?: EmptyTrackItem;
}
/**
* 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;
}
/**
* 自定义音色信息。
*/
export interface CustomVoiceInfo {
/**
* 音色 ID。
*/
VoiceId?: string;
/**
* 音色信息。
*/
VoiceInfo?: string;
}
/**
* ModifyEnhanceMediaTemplate返回参数结构体
*/
export interface ModifyEnhanceMediaTemplateResponse {
/**
* 唯一请求 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;
}
/**
* 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:海螺;
Jimeng:即梦;
Hunyuan:混元;
Mingmou:明眸;
GV;
OS;
PixVerse;
*/
ModelName: string;
/**
* 模型版本。取值:
当 ModelName 是 Hailuo,可选值为 02、2.3、2.3-fast;
当 ModelName 是 Kling,可选值为 1.6、2.0、2.1、2.5、2.6、O1、3.0、3.0-Omni;
当 ModelName 是 Jimeng,可选值为 3.0pro;
当 ModelName 是 Vidu,可选值为 q2、q2-pro、q2-turbo、q3、q3-pro、q3-turbo;
当 ModelName 是 GV,可选值为 3.1、3.1-fast;
当 ModelName 是 OS,可选值为 2.0;
当 ModelName 是 Hunyuan,可选值为 1.5;
当 ModelName 是 Mingmou,可选值为 1.0;
当 ModelName 是 PixVerse,可选值为 v5.6、v6、c1;
*/
ModelVersion: string;
/**
* 用于描述模型在生成视频时要使用的资源文件,分为首尾帧模式、参考图、视频参考、视频编辑等模式。
首尾帧视频生成:首帧图片只支持一张图片,图片的Usage字段为FirstFrame,LastFrameFileId 或者 LastFrameUrl 表示尾帧。可以单独传首帧,不能单独传尾帧。首尾帧生成会参考图片比例。
参考图片生成:可传入单张图片或者多张,图片的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;
/**
* 输入文件的区域信息。当文件url是国外地址时候,可选Oversea。默认Mainland。
*/
InputRegion?: string;
/**
* 场景类型。取值如下:
当 ModelName 为 Kling 时: motion_control 表示动作控制; avatar_i2v 表示数字人; lip_sync 表示对口型;当 ModelName 为 Vidu 时: template_effect 表示特效模板;其他 ModelName 暂不支持。
*/
SceneType?: string;
/**
* 模型随机种子。
*/
Seed?: number;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,音画质重生完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
/**
* 保留字段,特殊用途时使用。
可用于传入模型特殊参数、分镜prompt等
*/
ExtInfo?: string;
}
/**
* 自适应码流任务多语言音频流输入参数。
*/
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;
}
/**
* 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;
}
/**
* 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 日期格式](https://cloud.tencent.com/document/product/266/11732#iso-.E6.97.A5.E6.9C.9F.E6.A0.BC.E5.BC.8F)。
*/
StartTime: string;
/**
* 结束时间需大于起始时间;使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#iso-.E6.97.A5.E6.9C.9F.E6.A0.BC.E5.BC.8F)。
*/
EndTime: string;
/**
* 点播[应用](/document/product/266/14574) 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;
}
/**
* 对视频截雪碧图任务输入参数类型
*/
export interface ImageSpriteTaskInput {
/**
* 雪碧图模板 ID。
*/
Definition: number;
}
/**
* 物体识别任务控制参数
*/
export interface ObjectConfigureInfoForUpdate {
/**
* 物体识别任务开关,可选值:
ON:开启智能物体识别任务;
OFF:关闭智能物体识别任务。
*/
Switch?: string;
/**
* 物体库选择,可选值:
Default:使用默认物体库;
UserDefine:使用用户自定义物体库。
All:同时使用默认物体库和用户自定义物体库。
*/
ObjectLibrary?: string;
}
/**
* DeleteMedia请求参数结构体
*/
export interface DeleteMediaRequest {
/**
* 媒体文件的唯一标识。
*/
FileId: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 指定本次需要删除的部分。默认值为 "[]", 表示删除媒体及其对应的全部视频处理文件。
*/
DeleteParts?: Array;
}
/**
* 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;
}
/**
* 图片水印模板
*/
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;
}
/**
* 日志推送目标。
*/
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;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 裁剪的开始偏移时间,单位秒。默认 0,即从视频开头开始裁剪。负数表示距离视频结束多少秒开始裁剪。例如 -10 表示从倒数第 10 秒开始裁剪。
*/
StartTimeOffset?: number;
/**
* 裁剪的结束偏移时间,单位秒。默认 0,即裁剪到视频尾部。负数表示距离视频结束多少秒结束裁剪。例如 -10 表示到倒数第 10 秒结束裁剪。
*/
EndTimeOffset?: number;
/**
* 是否固化。0 不固化,1 固化。默认不固化。
*/
IsPersistence?: number;
/**
* 剪辑固化后的视频存储过期时间。格式参照 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。填“9999-12-31T23:59:59Z”表示永不过期。过期后该媒体文件及其相关资源(转码结果、雪碧图等)将被永久删除。仅 IsPersistence 为 1 时有效,默认剪辑固化的视频永不过期。
*/
ExpireTime?: string;
/**
* 剪辑固化后的视频点播任务流处理,详见[上传指定任务流](https://cloud.tencent.com/document/product/266/9759)。仅 IsPersistence 为 1 时有效。
*/
Procedure?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 [创建分类](/document/product/266/7812) 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
仅 IsPersistence 为 1 时有效。
*/
ClassId?: number;
/**
* 来源上下文,用于透传用户请求信息,[上传完成回调](/document/product/266/7830) 将返回该字段值,最长 250 个字符。仅 IsPersistence 为 1 时有效。
*/
SourceContext?: string;
/**
* 会话上下文,用于透传用户请求信息,当指定 Procedure 参数后,[任务流状态变更回调](/document/product/266/9636) 将返回该字段值,最长 1000 个字符。仅 IsPersistence 为 1 时有效。
*/
SessionContext?: string;
/**
* 该字段已废弃。
* @deprecated
*/
Precision?: string;
/**
* 输出视频类型,取值有:hls: 输出 hls 文件。默认取值 hls。
*/
OutputMediaType?: string;
/**
* 保留字段,特殊用途时使用。 示例值:""
*/
ExtInfo?: string;
}
/**
* 指定删除点播视频时的删除内容
*/
export interface MediaDeleteItem {
/**
* 所指定的删除部分。如果未填写该字段则参数无效。可选值有:
OriginalFiles(删除原文件,删除后无法发起转码、微信发布等任何视频处理操作);
TranscodeFiles(删除转码文件);
AdaptiveDynamicStreamingFiles(删除转自适应码流文件);
WechatPublishFiles(删除微信发布文件);
WechatMiniProgramPublishFiles(删除微信小程序发布文件)。
注意: 取值为OriginalFiles时,文件上传时携带的封面文件会被删除;
取值为TranscodeFiles时,媒体处理产生的封面文件会被删除。
*/
Type: string;
/**
* 删除由Type参数指定的种类下的视频模板号,模板定义参见[转码模板](https://cloud.tencent.com/document/product/266/33478#.3Cspan-id-.3D-.22zm.22-.3E.3C.2Fspan.3E.E8.BD.AC.E7.A0.81.E6.A8.A1.E6.9D.BF)。
默认值为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;
}
/**
* 语音关键词识别控制参数。
*/
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;
}
/**
* 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;
}
/**
* 极速高清参数配置。
*/
export interface TEHDConfig {
/**
* 极速高清类型,可选值:TEHD-100 表示极速高清-100; OFF 表示关闭极速高清。不填表示 OFF。
*/
Type: string;
/**
* 视频码率上限,当 Type 指定了极速高清类型时有效。
不填或填0表示由云点播自动设置码率上限。
*/
MaxVideoBitrate?: number;
}
/**
* 图片处理配置。
*/
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;
}
/**
* 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;
}
/**
* AIGC 场景化生图任务的输出媒体文件配置。
*/
export interface SceneAigcImageOutputConfig {
/**
* 存储模式
枚举值:
- Temporary: 临时存储,生成的视频文件不会存储到云点播,可在事件通知中获取到临时访问的 URL,有效期 7 天
- Permanent: 永久存储,生成的视频文件将存储到云点播,可在事件通知中获取到 FileId
默认值:Temporary
*/
StorageMode?: string;
/**
* 输出文件名,最长 64 个字符。缺省由系统指定生成文件名。
*/
MediaName?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 输出文件的过期时间,超过该时间文件将被删除,默认为永久不过期,格式按照 ISO 8601标准表示,详见 ISO 日期格式说明。
*/
ExpireTime?: string;
/**
* 指定所生成图片的宽高比。输入格式为 W:H。
本字段在以下场景有效:
- 生商品图场景,可选值为:1:1、3:2、2:3、3:4、4:3、4:5、5:4、16:9、9:16、21:9
- AI扩图场景。可选值为:1:1、3:2、2:3、3:4、4:3、4:5、5:4、9:16、16:9、21:9,可以配合 ImageWidth 和 ImageHeight 使用,规则如下:
- 仅指定 AspectRatio 时,根据原图输入进行自适应调整。
- 指定 AspectRatio 和 ImageWidth 时,ImageHeight 由两者计算得出,反亦是如此。
- 当AspectRatio、ImageWidth、ImageHeight 同时指定的时候,优先使用ImageWidth、ImageHeight。
*/
AspectRatio?: string;
/**
* 输出图片编码格式参数。仅AI换衣场景有效。
*/
EncodeConfig?: ImageSceneAigcEncodeConfig;
/**
* 输出图像宽度,仅AI扩图场景有效。
*/
ImageWidth?: number;
/**
* 输出图像高度,仅AI扩图场景有效。
*/
ImageHeight?: number;
/**
* 输出分辨率。仅change_clothes、change_clothes_under场景有效。可选值:1K、2K、4K。
*/
Resolution?: string;
}
/**
* 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;
}
/**
* DeleteAigcApiToken返回参数结构体
*/
export interface DeleteAigcApiTokenResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自适应码流任务的输入参数。
*/
export interface ComplexAdaptiveDynamicStreamingTaskInput {
/**
* 自适应码流参数。
*/
StreamPara: ComplexAdaptiveDynamicStreamingTaskStreamPara;
}
/**
* 排序依据
*/
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 {
/**
* 点播[应用](/document/product/266/14574) ID。
*/
SubAppId: number;
/**
* MPS 模板类型。根据需要查询的 MPS 模板的类型对结果进行过滤。取值:
Transcode: 查询转码模板列表。
AIAnalysis: 创建智能分析模板。
SmartSubtitle: 创建智能字幕模板。
SmartErase: 创建智能擦除模板。
*/
TemplateType: string;
/**
* MPS 查询模板参数。该参数用于透传至媒体处理服务(MPS),从云点播侧查询 MPS 任务模板列表。目前仅支持通过此方式查询以下任务类型的模板:
1. 音视频增强:仅支持填写“[获取转码模板列表](https://cloud.tencent.com/document/product/862/37593)”接口中的 Definitions、Type、Name、Offset 和 Limit 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
2. 智能分析:仅支持填写“[获取智能分析模板列表](https://cloud.tencent.com/document/product/862/40247)”接口中的 Definitions、Type、Name、Offset 和 Limit 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
3. 智能字幕:仅支持填写“[获取智能字幕模板列表](https://cloud.tencent.com/document/product/862/117002)”接口中的 Definitions、Type、Name、Offset 和 Limit 几个参数的内容。目前仅支持在模板中配置以上参数,其他参数无需填写,若包含其它参数,系统将自动忽略。
4. 智能擦除:仅支持填写“[获取智能擦除模板列表](https://cloud.tencent.com/document/product/862/123733)”接口中的 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;
}
/**
* DescribeDrmKeyProviderInfo请求参数结构体
*/
export interface DescribeDrmKeyProviderInfoRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* ModifyDefaultStorageRegion返回参数结构体
*/
export interface ModifyDefaultStorageRegionResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 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;
}
/**
* ModifyJustInTimeTranscodeTemplate返回参数结构体
*/
export interface ModifyJustInTimeTranscodeTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: 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;
}
/**
* 视频转码播放信息(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;
}
/**
* 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 ComposeMediaTaskInput {
/**
* 输入的媒体轨道列表,包括视频、音频、图片等素材组成的多个轨道信息。
*/
Tracks: Array;
/**
* 制作视频文件时使用的画布。
注意:此字段可能返回 null,表示取不到有效值。
*/
Canvas: Canvas;
/**
* 输出的媒体文件信息。
*/
Output: ComposeMediaOutput;
}
/**
* ModifyQualityInspectTemplate请求参数结构体
*/
export interface ModifyQualityInspectTemplateRequest {
/**
* 模板 ID。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 截帧间隔,单位为秒,最小值为 1。
*/
ScreenshotInterval?: number;
/**
* 视频画面抖动重影检测的控制参数。
*/
JitterConfigure?: JitterConfigureInfoForUpdate;
/**
* 视频画面模糊检测的控制参数。
*/
BlurConfigure?: BlurConfigureInfoForUpdate;
/**
* 视频画面低光、过曝检测的控制参数。
*/
AbnormalLightingConfigure?: AbnormalLightingConfigureInfoForUpdate;
/**
* 视频画面花屏检测的控制参数。
*/
CrashScreenConfigure?: CrashScreenConfigureInfoForUpdate;
/**
* 视频画面黑边、白边、黑屏、白屏检测的控制参数。
*/
BlackWhiteEdgeConfigure?: BlackWhiteEdgeConfigureInfoForUpdate;
/**
* 视频画面噪点检测的控制参数。
*/
NoiseConfigure?: NoiseConfigureInfoForUpdate;
/**
* 视频画面马赛克检测的控制参数。
*/
MosaicConfigure?: MosaicConfigureInfoForUpdate;
/**
* 视频画面二维码检测的控制参数。
*/
QRCodeConfigure?: QRCodeConfigureInfoForUpdate;
/**
* 音频(静音、低音、爆音)检测的控制参数。
*/
VoiceConfigure?: VoiceConfigureInfoForUpdate;
/**
* 视频画面质量评价的控制参数。
*/
QualityEvaluationConfigure?: QualityEvaluationConfigureInfoForUpdate;
}
/**
* 场景化 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;
}
/**
* 基于签名的 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;
}
/**
* 播放器配置详情
*/
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 日期格式](https://cloud.tencent.com/document/product/266/11732#iso-.E6.97.A5.E6.9C.9F.E6.A0.BC.E5.BC.8F)。
*/
CreateTime?: string;
/**
* 播放器配置最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#iso-.E6.97.A5.E6.9C.9F.E6.A0.BC.E5.BC.8F)。
*/
UpdateTime?: string;
/**
* 播放时使用的域名。值为 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;
/**
* 模板描述信息。
*/
Comment?: string;
}
/**
* 自适应码流任务信息。
*/
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;
/**
* 图片处理参数。
*/
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;
}
/**
* 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 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;
}
/**
* 智能分析结果
*/
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;
}
/**
* ModifyEventConfig请求参数结构体
*/
export interface ModifyEventConfigRequest {
/**
* 点播[应用](/document/product/266/14574) 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 回调通知](https://cloud.tencent.com/document/product/266/33779) 接收方式时,用于接收 3.0 格式回调的地址。
注意:如果带 NotificationUrl 参数且值为空字符串时将会清空 3.0 格式回调地址。
*/
NotificationUrl?: string;
/**
* 是否接收 [视频上传完成](https://cloud.tencent.com/document/product/266/7830) 事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
*/
UploadMediaCompleteEventSwitch?: string;
/**
* 是否接收 [视频删除完成](https://cloud.tencent.com/document/product/266/13434) 事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
*/
DeleteMediaCompleteEventSwitch?: string;
/**
* 是否接收剪辑固化完成事件通知, 默认 "OFF" 为忽略该事件通知,"ON" 为接收事件通知。
*/
PersistenceCompleteEventSwitch?: string;
}
/**
* 媒体处理任务中的数字水印参数类型
*/
export interface BlindWatermarkInput {
/**
* 数字水印模板ID
*/
Definition: number;
}
/**
* DescribeBlindWatermarkTemplates返回参数结构体
*/
export interface DescribeBlindWatermarkTemplatesResponse {
/**
* 符合过滤条件的记录总数。
*/
TotalCount?: number;
/**
* 数字水印模板详情列表。
*/
BlindWatermarkTemplateSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AttachMediaSubtitles返回参数结构体
*/
export interface AttachMediaSubtitlesResponse {
/**
* 唯一请求 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;
}
/**
* 片头片尾模板详情
*/
export interface HeadTailTemplate {
/**
* 片头片尾模板号。
*/
Definition?: number;
/**
* 模板名,最大支持 64 个字符。
*/
Name?: string;
/**
* 模板描述,最大支持 256 个字符。
*/
Comment?: string;
/**
* 片头候选列表。使用时会选择跟正片分辨率最贴近的一个使用,当存在相同的候选时,选择第一个使用,最大支持 5 个。
*/
HeadCandidateSet?: Array;
/**
* 片尾候选列表。使用时会选择跟正片分辨率最贴近的一个使用,当存在相同的候选时,选择第一个使用,最大支持 5 个。
*/
TailCandidateSet?: Array;
/**
* 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊;
white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充;
black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
默认值:stretch 。
*/
FillType?: string;
/**
* 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
/**
* 模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
UpdateTime?: 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;
/**
* 模板创建时间,使用 [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 DomainDetailInfo {
/**
* 域名名称。
*/
Domain?: string;
/**
* 加速地区信息。
*/
AccelerateAreaInfos?: Array;
/**
* 部署状态,取值有:
Online:上线;
Deploying:部署中;
Locked: 锁定中,出现该状态时,无法对该域名进行部署变更。
*/
DeployStatus?: string;
/**
* HTTPS 配置信息。
*/
HTTPSConfig?: DomainHTTPSConfig;
/**
* [Key 防盗链](https://cloud.tencent.com/document/product/266/14047)配置信息。
*/
UrlSignatureAuthPolicy?: UrlSignatureAuthPolicy;
/**
* [Referer 防盗链](https://cloud.tencent.com/document/product/266/14046)配置信息。
*/
RefererAuthPolicy?: RefererAuthPolicy;
/**
* 域名添加到腾讯云点播系统中的时间。
格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#iso-.E6.97.A5.E6.9C.9F.E6.A0.BC.E5.BC.8F)。
*/
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;
/**
* 视频在本次检索中的得分,得分越高和检索值越相似,取值范围[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;
}
/**
* 音视频审核 Asr 文字的嫌疑片段
*/
export interface MediaContentReviewAsrTextSegmentItem {
/**
* 嫌疑片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 嫌疑片段结束的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 嫌疑片段置信度。
*/
Confidence?: number;
/**
* 嫌疑片段音视频审核的结果建议,取值范围:
pass。
review。
block。
*/
Suggestion?: string;
/**
* 嫌疑关键词列表。
*/
KeywordSet?: Array;
}
/**
* DescribeEventConfig返回参数结构体
*/
export interface DescribeEventConfigResponse {
/**
* 接收事件通知的方式。"PUSH" 为 [普通回调](https://cloud.tencent.com/document/product/266/33779#.E6.99.AE.E9.80.9A.E5.9B.9E.E8.B0.83),"PULL" 为 [可靠回调](https://cloud.tencent.com/document/product/266/33779#.E5.8F.AF.E9.9D.A0.E5.9B.9E.E8.B0.83)。
*/
Mode?: string;
/**
* 采用 [普通回调](https://cloud.tencent.com/document/product/266/33779#.E6.99.AE.E9.80.9A.E5.9B.9E.E8.B0.83) 模式时,用于接收 V3 版本事件通知的地址。
*/
NotificationUrl?: string;
/**
* 是否接收 [视频上传完成](https://cloud.tencent.com/document/product/266/7830) 事件通知,"OFF" 为忽略该事件通知,"ON" 为接收事件通知。
*/
UploadMediaCompleteEventSwitch?: string;
/**
* 是否接收 [视频删除完成](https://cloud.tencent.com/document/product/266/13434) 事件通知,"OFF" 为忽略该事件通知,"ON" 为接收事件通知。
*/
DeleteMediaCompleteEventSwitch?: string;
/**
* 是否接收剪辑固化完成事件通知,"OFF" 为忽略该事件通知,"ON" 为接收事件通知。
*/
PersistenceCompleteEventSwitch?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DescribeCdnLogs返回参数结构体
*/
export interface DescribeCdnLogsResponse {
/**
* 日志下载链接总数量。
*/
TotalCount?: number;
/**
* 海外CDN节点的日志下载列表。如果域名没有开启海外加速,忽略该参数。
*/
OverseaCdnLogs?: Array;
/**
* 国内CDN节点的日志下载列表。
*/
DomesticCdnLogs?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音视频审核涉及令人不适宜信息的嫌疑片段
*/
export interface MediaContentReviewPoliticalSegmentItem {
/**
* 嫌疑片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 嫌疑片段结束的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 嫌疑片段分数。
*/
Confidence?: number;
/**
* 嫌疑片段涉及令人不适宜的信息的结果建议,取值范围:
pass。
review。
block。
*/
Suggestion?: string;
/**
* 涉及令人不适宜的信息、违规图标名字。
*/
Name?: string;
/**
* 嫌疑片段涉及令人不适宜的信息的结果标签。音视频审核模板[画面涉及令人不适宜的信息的任务控制参数](https://cloud.tencent.com/document/api/266/31773#PoliticalImgReviewTemplateInfo)里 LabelSet 参数与此参数取值范围的对应关系:
violation_photo:
violation_photo:违规图标。
politician:
nation_politician:国家领导人;
province_politician: 省部级领导人;
bureau_politician:厅局级领导人;
county_politician:县处级领导人;
rural_politician:乡科级领导人;
sensitive_politician:违规相关人物;
foreign_politician:国外领导人。
entertainment:
sensitive_entertainment:违规娱乐人物。
sport:
sensitive_sport:违规体育人物。
entrepreneur:
sensitive_entrepreneur:违规商业人物。
scholar:
sensitive_scholar:违规教育学者。
celebrity:
sensitive_celebrity:违规知名人物;
historical_celebrity:历史知名人物。
military:
sensitive_military:违规相关人物。
*/
Label?: string;
/**
* 嫌疑图片 URL (图片不会永久存储,到达
PicUrlExpireTime 时间点后图片将被删除)。
*/
Url?: string;
/**
* 涉及令人不适宜的信息、违规图标出现的区域坐标 (像素级),[x1, y1, x2, y2],即左上角坐标、右下角坐标。
*/
AreaCoordSet?: Array;
/**
* 该字段已废弃,请使用 PicUrlExpireTime。
* @deprecated
*/
PicUrlExpireTimeStamp?: number;
/**
* 嫌疑图片 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
PicUrlExpireTime?: string;
}
/**
* AIGC 生视频任务的输出信息。
*/
export interface AigcVideoTaskOutput {
/**
* AIGC 生视频任务的输出文件信息。
*/
FileInfos?: Array;
}
/**
* DeletePersonSample返回参数结构体
*/
export interface DeletePersonSampleResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* AI 生成商品360度展示视频参数配置
*/
export interface ProductShowcaseConfig {
/**
* 镜头运动方式。支持的值:AutoMatch(自动匹配)、ZoomIn(推进)、ZoomOut(拉远)、GlideRight(右移)、GlideLeft(左移)、CraneDown(下降)
*/
CameraMovement?: string;
}
/**
* CreateAigcSubject请求参数结构体
*/
export interface CreateAigcSubjectRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 主体名称。
*/
SubjectName?: string;
/**
* 主体图片,至少上传 1 张主体图片。* 注1:支持传入图片URL(确保可访问);* 注2:最多支持输入 3 张图;* 注3:图片支持 png、jpeg、jpg、webp格式;* 注4:图片比例需要小于 1:4 或者 4:1 ;* 注5:图片大小不超过 50 MB;
*/
SubjectImages?: Array;
/**
* 视频参考支持上传 1 个主体视频
- 注1:仅参考生viduq2-pro模型支持使用视频主体
- 注2:最多支持上传 1个5秒 的视频
- 注3:视频支持 mp4、avi、mov格式
- 注4:视频像素不能小于 128*128,且比例需要小于1:4或者4:1,且大小不超过100M。
*/
SubjectVideos?: Array;
/**
* 主体音色Id,该信息仅在创建音视频直出任务时使用
- 注1:不传音色id 生成音视频直出任务时,系统会自动推荐音色
- 注2:q2-pro不支持使用音色id
*/
VoiceId?: string;
/**
* 用于去重的识别码,如果三天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 来源上下文,用于透传用户请求信息,任务完成回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 任务的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。
*/
TasksPriority?: number;
}
/**
* CreateSnapshotByTimeOffsetTemplate返回参数结构体
*/
export interface CreateSnapshotByTimeOffsetTemplateResponse {
/**
* 时间点截图模板唯一标识。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音频(静音、低音、爆音)检测的控制参数。
*/
export interface VoiceConfigureInfoForUpdate {
/**
* 音频(静音、低音、爆音)检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch?: string;
}
/**
* ModifyContentReviewTemplate请求参数结构体
*/
export interface ModifyContentReviewTemplateRequest {
/**
* 内容审核模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 内容审核模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 内容审核模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 令人不安全的信息的控制参数。
*/
TerrorismConfigure?: TerrorismConfigureInfoForUpdate;
/**
* 令人反感的信息的控制参数。
*/
PornConfigure?: PornConfigureInfoForUpdate;
/**
* 令人不适宜的信息控制参数。
*/
PoliticalConfigure?: PoliticalConfigureInfoForUpdate;
/**
* 违禁控制参数。违禁内容包括:
谩骂;
涉毒违法。
*/
ProhibitedConfigure?: ProhibitedConfigureInfoForUpdate;
/**
* 用户自定义内容审核控制参数。
*/
UserDefineConfigure?: UserDefineConfigureInfoForUpdate;
/**
* 截帧间隔,单位为秒,最小值为 0.5 秒。
*/
ScreenshotInterval?: number;
/**
* 审核结果是否进入审核墙(对审核结果进行人工识别)的开关。
ON:是;
OFF:否。
*/
ReviewWallSwitch?: string;
}
/**
* 雪碧图模板详情
*/
export interface ImageSpriteTemplate {
/**
* 雪碧图模板唯一标识。
*/
Definition?: number;
/**
* 模板类型,取值范围:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
/**
* 雪碧图模板名称。
*/
Name?: 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;
/**
* 采样类型。
*/
SampleType?: string;
/**
* 采样间隔。
*/
SampleInterval?: number;
/**
* 雪碧图中小图的行数。
*/
RowCount?: number;
/**
* 雪碧图中小图的列数。
*/
ColumnCount?: 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;
/**
* 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
默认值:black 。
*/
FillType?: string;
/**
* 模板描述信息。
*/
Comment?: string;
/**
* 图片格式。
*/
Format?: string;
}
/**
* DeleteReviewTemplate请求参数结构体
*/
export interface DeleteReviewTemplateRequest {
/**
* 审核模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* CreateLLMComprehendTemplate请求参数结构体
*/
export interface CreateLLMComprehendTemplateRequest {
/**
* 解析级别,可选值为:
*/
Level: string;
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 大模型解析模板名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 大模型解析模板描述信息,长度限制:256 个字符。
*/
Comment?: string;
/**
* 分段摘要解析配置
*/
Summary?: LLMComprehendSummary;
/**
* 文本转录解析配置
*/
Asr?: LLMComprehendAsr;
/**
* 人脸识别配置
*/
FaceRecognition?: LLMComprehendFaceRecognition;
}
/**
* 智能封面结果信息
*/
export interface AiAnalysisTaskCoverOutput {
/**
* 智能封面列表。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 CoverSetFileUrl 对应的文件中获取。
*/
CoverSet: Array;
/**
* 智能封面列表文件 URL。文件的内容为 JSON,数据结构与 CoverSet 字段一致。 (文件不会永久存储,到达 CoverSetFileUrlExpireTime 时间点后文件将被删除)。
*/
CoverSetFileUrl: string;
/**
* 智能封面列表文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CoverSetFileUrlExpireTime: string;
}
/**
* 音视频审核任务类型
*/
export interface AiContentReviewTaskInput {
/**
* 音视频审核模板 ID。
*/
Definition: number;
}
/**
* CreateAdaptiveDynamicStreamingTemplate返回参数结构体
*/
export interface CreateAdaptiveDynamicStreamingTemplateResponse {
/**
* 自适应转码模板唯一标识。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteSampleSnapshotTemplate请求参数结构体
*/
export interface DeleteSampleSnapshotTemplateRequest {
/**
* 采样截图模板唯一标识。
*/
Definition: number;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
}
/**
* AI 视频智能分析输入参数类型
*/
export interface AiAnalysisTaskInput {
/**
* 视频内容分析模板 ID。
*/
Definition: number;
}
/**
* 智能标签结果信息
*/
export interface MediaAiAnalysisTagItem {
/**
* 标签名称。
*/
Tag?: string;
/**
* 标签的可信度,取值范围是 0 到 100。
*/
Confidence?: number;
}
/**
* DescribeStorageData返回参数结构体
*/
export interface DescribeStorageDataResponse {
/**
* 当前媒体总量。
*/
MediaCount?: number;
/**
* 当前总存储量,单位是字节。
*/
TotalStorage?: number;
/**
* 当前标准存储量,单位是字节。
*/
StandardStorage?: number;
/**
* 当前低频存储量,单位是字节。
*/
InfrequentStorage?: number;
/**
* 当前归档存储量,单位是字节。
*/
ArchiveStorage?: number;
/**
* 当前深度归档存储量,单位是字节。
*/
DeepArchiveStorage?: number;
/**
* 各计费区域的存储用量。
*/
StorageStat?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 文本全文识别片段。
*/
export interface AiRecognitionTaskOcrFullTextSegmentTextItem {
/**
* 识别片段置信度。取值:0~100。
*/
Confidence?: number;
/**
* 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。
*/
AreaCoordSet?: Array;
/**
* 识别文本。
*/
Text?: string;
}
/**
* 图片处理模板, 最多支持三次操作。例如:裁剪-缩略-裁剪。
*/
export interface ImageProcessingTemplate {
/**
* 图片处理模板唯一标识。
*/
Definition?: number;
/**
* 模板类型,取值范围:
Preset:系统预置模板;
Custom:用户自定义模板。
*/
Type?: string;
/**
* 图片处理模板名称。
*/
Name?: string;
/**
* 模板描述信息。
*/
Comment?: string;
/**
* 图片处理操作数组,操作将以数组顺序执行。
长度限制:3。
*/
Operations?: Array;
/**
* 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
}
/**
* 视频拆条任务识别控制参数
*/
export interface SegmentConfigureInfo {
/**
* 视频拆条识别任务开关,可选值:
ON:开启智能视频拆条识别任务;
OFF:关闭智能视频拆条识别任务。
*/
Switch: string;
}
/**
* ProcessMediaByMPS请求参数结构体
*/
export interface ProcessMediaByMPSRequest {
/**
* 媒体文件 ID,即该文件在云点播上的全局唯一标识符,在上传成功后由云点播后台分配。可以在 视频上传完成事件通知 或 云点播控制台 获取该字段。
*/
FileId: string;
/**
* 点播应用 ID。
*/
SubAppId: number;
/**
* 该参数用于透传至媒体处理服务(MPS),以便从云点播侧发起 MPS 视频处理任务。
视频处理参数详情请参考:MPS 发起媒体处理。
填写说明:
- 目前仅需要配置 MPS “发起媒体处理”接口中任务配置相关的参数,如 AiAnalysisTask 与 MediaProcessTask,其他参数无需填写。若包含其它参数,系统将自动忽略;
- 当前仅支持通过此方式发起智能擦除及音视频增强任务。若配置了其他任务类型的相关参数,系统将自动忽略这些参数;
- 音视频增强任务目前不支持使用预置模板发起,可通过 CreateMPSTemplate 接口创建自定义模板。
*/
MPSProcessMediaParams: string;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* 去划痕控制信息
*/
export interface ScratchRepairInfo {
/**
* 去划痕控制开关,可选值:
ON:开启去划痕;
OFF:关闭去划痕。
*/
Switch: string;
/**
* 去划痕强度,仅当去划痕控制开关为 ON 时有效,取值范围:0.0~1.0。
默认:0.0。
*/
Intensity?: number;
/**
* 去划痕类型,仅当去划痕控制开关为 ON 时有效,可选值:
normal:正常去划痕;
默认值:normal。
*/
Type?: string;
}
/**
* 创建自定义音色回调输入信息。
*/
export interface CreateAigcCustomVoiceInput {
/**
* 音色名称。
*/
VoiceName?: string;
/**
* 音色数据文件获取链接。
*/
VoiceUrl?: string;
/**
* 历史作品 ID,可通过引用历史作品提供音频素材。
*/
VideoId?: string;
}
/**
* 图片异步处理任务的输出。
*/
export interface ProcessImageAsyncOutput {
/**
* 图片异步处理任务的输出文件信息。
*/
FileInfo?: ProcessImageAsyncOutputFileInfo;
/**
* 图片理解结果。
*/
OutputText?: string;
}
/**
* 对视频按指定时间点截图任务输入参数类型
*/
export interface SnapshotByTimeOffsetTaskInput {
/**
* 指定时间点截图模板 ID。
*/
Definition: number;
/**
* 截图时间点列表,时间点支持 s、% 两种格式:
当字符串以 s 结尾,表示时间点单位为秒,如 3.5s 表示时间点为第3.5秒;
当字符串以 % 结尾,表示时间点为视频时长的百分比大小,如10%表示时间点为视频前第10%的时间。
*/
ExtTimeOffsetSet?: Array;
/**
* 截图时间点列表,单位为毫秒。此参数已不再建议使用,建议您使用 ExtTimeOffsetSet 参数。
*/
TimeOffsetSet?: Array;
/**
* 水印列表,支持多张图片或文字水印,最大可支持 10 张。
*/
WatermarkSet?: Array;
}
/**
* Referer 防盗链配置
*/
export interface RefererAuthPolicy {
/**
* [Referer 防盗链](https://cloud.tencent.com/document/product/266/14046)设置状态,可选值:
Enabled: 启用;
Disabled: 禁用。
*/
Status: string;
/**
* Referer 校验类型,可选值:
Black:黑名单方式校验。HTTP 请求携带了 Referers 列表中的某个 Referer 将被拒绝访问。
White:白名单方式校验。HTTP 请求携带了 Referers 列表中的 Referer 时才允许访问。
当 Status 取值为 Enabled 时,AuthType 必须赋值。
*/
AuthType?: string;
/**
* 用于校验的 Referer 列表,最大支持 400 个 Referer。当 Status 取值为 Enabled 时, Referers 不能为空数组。Referer 的格式参考域名的格式。
*/
Referers?: Array;
/**
* 是否允许空 Referer 访问本域名,可选值:
Yes: 是。
No: 否。
当 Status 取值为 Enabled 时,BlankRefererAllowed 必须赋值。
*/
BlankRefererAllowed?: string;
}
/**
* ProcessMediaByMPS返回参数结构体
*/
export interface ProcessMediaByMPSResponse {
/**
* 任务 ID。
*/
TaskId?: string;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 物体识别结果片段。
*/
export interface AiRecognitionTaskObjectSegmentItem {
/**
* 识别片段起始的偏移时间,单位:秒。
*/
StartTimeOffset?: number;
/**
* 识别片段终止的偏移时间,单位:秒。
*/
EndTimeOffset?: number;
/**
* 识别片段置信度。取值:0~100。
*/
Confidence?: number;
/**
* 识别结果的区域坐标。数组包含 4 个元素 [x1,y1,x2,y2],依次表示区域左上点、右下点的横纵坐标。
*/
AreaCoordSet?: Array;
}
/**
* CreateCLSTopic请求参数结构体
*/
export interface CreateCLSTopicRequest {
/**
* 日志集所属的地域,取值有: ap-guangzhou:广州; ap-beijing:北京; ap-chengdu:成都; ap-chongqing:重庆; ap-nanjing:南京; ap-shanghai:上海; ap-singapore:新加坡。
*/
CLSRegion: string;
/**
* 日志主题名。
*/
TopicName: string;
/**
* 日志集 ID。
*/
LogsetId: string;
}
/**
* Ocr 文字涉及令人反感的信息
*/
export interface AiReviewPornOcrTaskOutput {
/**
* 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;
}
/**
* ApplyUpload请求参数结构体
*/
export interface ApplyUploadRequest {
/**
* 媒体类型,可选值请参考 [上传能力综述](/document/product/266/9760#.E6.96.87.E4.BB.B6.E7.B1.BB.E5.9E.8B)。
*/
MediaType: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 媒体名称。
*/
MediaName?: string;
/**
* 封面类型,可选值请参考 [上传能力综述](/document/product/266/9760#.E6.96.87.E4.BB.B6.E7.B1.BB.E5.9E.8B)。
*/
CoverType?: string;
/**
* 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 [创建任务流模板](/document/product/266/33819) 并为模板命名。
*/
Procedure?: string;
/**
* 媒体文件过期时间,格式按照 ISO 8601 标准表示,详见 [ISO 日期格式说明](/document/product/266/11732#iso-.E6.97.A5.E6.9C.9F.E6.A0.BC.E5.BC.8F)。
*/
ExpireTime?: string;
/**
* 指定上传园区,仅适用于对上传地域有特殊需求的用户。
*/
StorageRegion?: string;
/**
* 分类ID,用于对媒体进行分类管理,可通过 [创建分类](/document/product/266/7812) 接口,创建分类,获得分类 ID。
默认值:0,表示其他分类。
*/
ClassId?: number;
/**
* 来源上下文,用于透传用户请求信息,[上传完成回调](/document/product/266/7830) 将返回该字段值,最长 250 个字符。
*/
SourceContext?: string;
/**
* 会话上下文,用于透传用户请求信息,当指定 Procedure 参数后,[任务流状态变更回调](/document/product/266/9636) 将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
/**
* 媒体存储路径,以/开头。
只有[FileID + Path 模式](https://cloud.tencent.com/document/product/266/126825)的子应用可以指定存储路径。
*/
MediaStoragePath?: string;
}
/**
* CreateSampleSnapshotTemplate返回参数结构体
*/
export interface CreateSampleSnapshotTemplateResponse {
/**
* 采样截图模板唯一标识。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 智能精彩片段任务输入类型
*/
export interface AiAnalysisTaskHighlightInput {
/**
* 视频智能精彩片段模板 ID。
*/
Definition?: number;
}
/**
* DeleteContentReviewTemplate返回参数结构体
*/
export interface DeleteContentReviewTemplateResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 人脸识别输出文件信息
*/
export interface FaceRecognitionOutputFileInfo {
/**
* 人脸识别输出文件类型
枚举值:
- Output: 任务生成的结果输出,文件对应人脸识别任务返回中的结果,以 JSON 格式生成文件。
*/
FileType?: string;
/**
* 人脸识别输出文件的URL
*/
Url?: string;
}
/**
* 点播媒体文件基础信息
*/
export interface MediaBasicInfo {
/**
* 媒体文件名称。
*/
Name?: string;
/**
* 媒体文件描述。
*/
Description?: string;
/**
* 媒体文件的创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
CreateTime?: string;
/**
* 媒体文件的最近更新时间(如修改视频属性、发起视频处理等会触发更新媒体文件信息的操作),使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
UpdateTime?: string;
/**
* 媒体文件的过期时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。过期后该媒体文件及其相关资源(转码结果、雪碧图等)将被永久删除。“9999-12-31T23:59:59Z”表示永不过期。
*/
ExpireTime?: string;
/**
* 媒体文件的分类 ID。
*/
ClassId?: number;
/**
* 媒体文件的分类名称。
*/
ClassName?: string;
/**
* 媒体文件的分类路径,分类间以“-”分隔,如“新的一级分类 - 新的二级分类”。
*/
ClassPath?: string;
/**
* 媒体文件的封面图片地址。
*/
CoverUrl?: string;
/**
* 媒体文件的封装格式,例如 mp4、flv 等。
*/
Type?: string;
/**
* 原始媒体文件的 URL 地址。
*/
MediaUrl?: string;
/**
* 该媒体文件的来源信息。
注意:此字段可能返回 null,表示取不到有效值。
*/
SourceInfo?: MediaSourceData;
/**
* 媒体文件存储地区,如 ap-chongqing,参见[地域列表](https://cloud.tencent.com/document/product/266/9760#.E5.B7.B2.E6.94.AF.E6.8C.81.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8)。
*/
StorageRegion?: string;
/**
* 媒体的存储路径。
*/
StoragePath?: string;
/**
* 媒体文件的标签信息。
*/
TagSet?: Array;
/**
* 直播录制文件的唯一标识。
*/
Vid?: string;
/**
* 文件类型:
Video: 视频文件
Audio: 音频文件
Image: 图片文件
*/
Category?: string;
/**
* 文件状态:Normal:正常,Forbidden:封禁。
*/
Status?: string;
/**
* 媒体文件的存储类别:
STANDARD:标准存储。
STANDARD_IA:低频存储。
ARCHIVE:归档存储。
DEEP_ARCHIVE:深度归档存储。
*/
StorageClass?: string;
}
/**
* 音视频审核 Asr 文字涉及令人不适宜的信息、违规任务输入参数类型
*/
export interface AiReviewPoliticalAsrTaskInput {
/**
* 鉴别涉及令人不适宜信息的模板 ID。
*/
Definition?: number;
}
/**
* 提取盲水印输入信息
*/
export interface ExtractBlindWatermarkInputInfo {
/**
* 提取数字水印输入类型,可选值:FILEID:文件媒资ID;URL:文件url;
*/
Type: string;
/**
* 需要提取的文件媒资ID
*/
FileId?: string;
/**
* 需要提取的视频文件url
*/
Url?: string;
}
/**
* CreateQualityInspectTemplate请求参数结构体
*/
export interface CreateQualityInspectTemplateRequest {
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 音画质检测模板名称。
*/
Name?: string;
/**
* 音画质检测模板描述。
*/
Comment?: string;
/**
* 截帧间隔,单位为秒,最小值为 1。当不填时,默认截帧间隔为 1 秒。
*/
ScreenshotInterval?: number;
/**
* 视频画面抖动重影检测的控制参数。
*/
JitterConfigure?: JitterConfigureInfo;
/**
* 视频画面模糊检测的控制参数。
*/
BlurConfigure?: BlurConfigureInfo;
/**
* 视频画面低光、过曝检测的控制参数。
*/
AbnormalLightingConfigure?: AbnormalLightingConfigureInfo;
/**
* 视频画面花屏检测的控制参数。
*/
CrashScreenConfigure?: CrashScreenConfigureInfo;
/**
* 视频画面黑边、白边、黑屏、白屏检测的控制参数。
*/
BlackWhiteEdgeConfigure?: BlackWhiteEdgeConfigureInfo;
/**
* 视频画面噪点检测的控制参数。
*/
NoiseConfigure?: NoiseConfigureInfo;
/**
* 视频画面马赛克检测的控制参数。
*/
MosaicConfigure?: MosaicConfigureInfo;
/**
* 视频画面二维码检测的控制参数。
*/
QRCodeConfigure?: QRCodeConfigureInfo;
/**
* 音频(静音、低音、爆音)检测的控制参数。
*/
VoiceConfigure?: VoiceConfigureInfo;
/**
* 视频画面质量评价的控制参数。
*/
QualityEvaluationConfigure?: QualityEvaluationConfigureInfo;
}
/**
* ProcessMediaByProcedure请求参数结构体
*/
export interface ProcessMediaByProcedureRequest {
/**
* [任务流](https://cloud.tencent.com/document/product/266/33475#.E4.BB.BB.E5.8A.A1.E6.B5.81)名称。
*/
ProcedureName: string;
/**
* 媒体文件 ID。
FileId和MediaStoragePath必须提供其中一个。
*/
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;
/**
* 任务流的优先级,数值越大优先级越高,取值范围是-10到10,不填代表0。
*/
TasksPriority?: number;
/**
* 任务流状态变更通知模式,可取值有 Finish,Change 和 None,不填代表 Finish。
*/
TasksNotifyMode?: string;
/**
* 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长 1000 个字符。
*/
SessionContext?: string;
/**
* 用于去重的识别码,如果 7 天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长 50 个字符,不带或者带空字符串表示不做去重。
*/
SessionId?: string;
/**
* 保留字段,特殊用途时使用。
*/
ExtInfo?: string;
}
/**
* 画质重生输出的视频信息
*/
export interface RebuildMediaTargetVideoStream {
/**
* 视频流的编码格式,可选值:
libx264:H.264 编码;
libx265:H.265 编码;
av1:AOMedia Video 1 编码。
默认视频流的编码格式为 H.264 编码。
*/
Codec?: string;
/**
* 视频流的码率,取值范围:0 和 [128, 35000],单位:kbps。
当取值为 0,表示由云点播自动设置码率。
*/
Bitrate?: number;
/**
* 视频帧率,取值范围:[0, 100],单位:Hz。 当取值为 0,表示帧率和原始视频保持一致。
*/
Fps?: 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;
/**
* 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式:
stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;
black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。
默认值:stretch 。
*/
FillType?: string;
/**
* 关键帧 I 帧之间的间隔,取值范围:0 和 [1, 100000],单位:帧数。
当填 0 或不填时,系统将自动设置 gop 长度。
*/
Gop?: number;
}
/**
* 音频(静音、低音、爆音)检测的控制参数。
*/
export interface VoiceConfigureInfo {
/**
* 音频(静音、低音、爆音)检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch: string;
}
/**
* SetCLSPushTarget返回参数结构体
*/
export interface SetCLSPushTargetResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频剪辑任务信息,该结构仅用于对 2017 版[视频剪辑](https://cloud.tencent.com/document/product/266/10156)接口发起的任务。
*/
export interface ClipTask2017 {
/**
* 视频剪辑任务 ID。
*/
TaskId?: string;
/**
* 视频剪辑任务源文件 ID。
*/
SrcFileId?: string;
/**
* 视频剪辑输出的文件信息。
*/
FileInfo?: ClipFileInfo2017;
}
/**
* 转码模板详情
*/
export interface TranscodeTemplate {
/**
* 转码模板唯一标识。
*/
Definition?: string;
/**
* 封装格式,取值:mp4、flv、hls、mp3、flac、ogg。
*/
Container?: string;
/**
* 转码模板名称。
*/
Name?: string;
/**
* 模板描述信息。
*/
Comment?: string;
/**
* 模板类型,取值:
Preset:系统预置模板;Custom:用户自定义模板。
*/
Type?: string;
/**
* 是否去除视频数据,取值:
0:保留;1:去除。
*/
RemoveVideo?: number;
/**
* 是否去除音频数据,取值:
0:保留;1:去除。
*/
RemoveAudio?: number;
/**
* 视频流配置参数,仅当 RemoveVideo 为 0,该字段有效。
*/
VideoTemplate?: VideoTemplateInfo;
/**
* 音频流配置参数,仅当 RemoveAudio 为 0,该字段有效 。
*/
AudioTemplate?: AudioTemplateInfo;
/**
* 极速高清转码参数。
注意:此字段可能返回 null,表示取不到有效值。
*/
TEHDConfig?: TEHDConfig;
/**
* 音视频增强配置。
注意:此字段可能返回 null,表示取不到有效值。
*/
EnhanceConfig?: EnhanceConfig;
/**
* 封装格式过滤条件,可选值:
Video:视频格式,可以同时包含视频流和音频流的封装格式;PureAudio:纯音频格式,只能包含音频流的封装格式板。
*/
ContainerType?: string;
/**
* 模板创建时间,使用 ISO 日期格式。
*/
CreateTime?: string;
/**
* 模板最后修改时间,使用 ISO 日期格式。
*/
UpdateTime?: string;
/**
* 切片类型,仅当 Container 为 hls 时有效。
*/
SegmentType?: string;
/**
* 扩展参数。
*/
StdExtInfo?: string;
}
/**
* DescribeCDNUsageData请求参数结构体
*/
export interface DescribeCDNUsageDataRequest {
/**
* 起始日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
StartTime: string;
/**
* 结束日期,需大于开始日期,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
EndTime: string;
/**
* CDN 统计数据类型,有效值:
Flux:流量,单位为 byte。
Bandwidth:带宽,单位为 bps。
*/
DataType: string;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 用量数据的时间粒度,单位:分钟,取值有:
5:5 分钟粒度,返回指定查询时间内5分钟粒度的明细数据。
60:小时粒度,返回指定查询时间内1小时粒度的数据。
1440:天粒度,返回指定查询时间内1天粒度的数据。
默认值为1440,返回天粒度的数据。
*/
DataInterval?: number;
/**
* 域名列表。一次最多查询20个域名的用量数据。可以指定多个域名,查询这些域名叠加的用量数据。默认返回所有域名叠加的用量数据。
*/
DomainNames?: Array;
}
/**
* 即时转码模板详情。
*/
export interface JustInTimeTranscodeTemplate {
/**
* 模板类型。
*/
Type?: string;
/**
* 模板名。
*/
Name?: string;
/**
* 模板描述。
*/
Comment?: string;
/**
* 视频参数配置。
*/
VideoConfigure?: VideoConfigureInfo;
/**
* 水印参数配置。
*/
WatermarkConfigure?: WatermarkConfigureData;
}
/**
* 任务统计数据,包括任务数和用量。
*/
export interface TaskStatDataItem {
/**
* 数据所在时间区间的开始时间,使用 [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;
/**
* 任务用量。
*/
Usage?: number;
}
/**
* 文本鉴别涉及令人反感的信息的任务控制参数
*/
export interface PornOcrReviewTemplateInfo {
/**
* 文本鉴别涉及令人反感的信息的任务开关,可选值:
ON:开启文本鉴别涉及令人反感的信息的任务;
OFF:关闭文本鉴别涉及令人反感的信息的任务。
*/
Switch: string;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* DescribeLLMComprehendTemplates请求参数结构体
*/
export interface DescribeLLMComprehendTemplatesRequest {
/**
* 点播应用 ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 大模型解析模板唯一标识过滤条件,数组长度最大值:100。
*/
Definitions?: Array;
/**
* 分页偏移量,默认值:0。
*/
Offset?: number;
/**
* 返回记录条数,默认值:10,最大值:100。
*/
Limit?: number;
}
/**
* 音视频审核 Asr 文字涉及令人不适宜信息、违规任务结果类型
*/
export interface AiReviewTaskPoliticalAsrResult {
/**
* 任务状态,有 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?: AiReviewPoliticalAsrTaskInput;
/**
* 音视频审核 Asr 文字涉及令人不适宜信息的任务输出。
*/
Output?: AiReviewPoliticalAsrTaskOutput;
/**
* 音视频审核 Asr 文字涉及令人不适宜信息的任务进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* CreateProcessImageAsyncTemplate返回参数结构体
*/
export interface CreateProcessImageAsyncTemplateResponse {
/**
* 图片异步处理模板唯一标识。
*/
Definition?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* TRTC伴生录制信息。
*/
export interface TrtcRecordInfo {
/**
* TRTC 应用 ID。
*/
SdkAppId?: number;
/**
* TRTC 房间 ID。
*/
RoomId?: string;
/**
* 录制任务 ID。
*/
TaskId?: string;
/**
* 参与录制的用户 ID 列表。
*/
UserIds?: Array;
}
/**
* DescribeReviewDetails请求参数结构体
*/
export interface DescribeReviewDetailsRequest {
/**
* 起始日期。使用 [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;
}
/**
* ModifySubAppIdInfo返回参数结构体
*/
export interface ModifySubAppIdInfoResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 音视频审核 Asr 文字鉴违禁任务输入参数类型
*/
export interface AiReviewProhibitedAsrTaskInput {
/**
* 鉴违禁模板 ID。
*/
Definition?: number;
}
/**
* DeleteCLSTopic请求参数结构体
*/
export interface DeleteCLSTopicRequest {
/**
* 日志集所属的地域,取值有: ap-guangzhou:广州; ap-beijing:北京; ap-chengdu:成都; ap-chongqing:重庆; ap-nanjing:南京; ap-shanghai:上海; ap-singapore:新加坡。
*/
CLSRegion?: string;
/**
* 日志主题 ID。
*/
TopicId?: string;
}
/**
* ParseStreamingManifest返回参数结构体
*/
export interface ParseStreamingManifestResponse {
/**
* 分片文件列表。
*/
MediaSegmentSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ListFiles返回参数结构体
*/
export interface ListFilesResponse {
/**
* 响应条目是否被截断。
*/
IsTruncated?: boolean;
/**
* 仅当响应条目有截断(IsTruncated 为 true)才会返回该节点,该节点的值为当前响应条目中的最后一个对象键,当需要继续请求后续条目时,将该节点的值作为下一次请求的 marker 参数传入。
*/
NextMarker?: string;
/**
* 从 prefix 或从头(如未指定 prefix)到首个 delimiter 之间相同的部分,定义为 Common Prefix。仅当请求中指定了 delimiter 参数才有可能返回该节点。
*/
CommonPrefixes?: Array;
/**
* 对象条目。
*/
Contents?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateRoundPlay请求参数结构体
*/
export interface CreateRoundPlayRequest {
/**
* 启播时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。
*/
StartTime: string;
/**
* 轮播列表。
数组长度限制:100。
*/
RoundPlaylist: Array;
/**
* 点播[应用](/document/product/266/14574) ID。从2023年12月25日起开通点播的客户,如访问点播应用中的资源(无论是默认应用还是新创建的应用),必须将该字段填写为应用 ID。
*/
SubAppId?: number;
/**
* 轮播播单名称,长度限制:64 个字符。
*/
Name?: string;
/**
* 轮播播单描述信息,长度限制:256 个字符。
*/
Desc?: string;
/**
* 播放模式,可选值:
Loop:循环播放播单;
Linear:单次播放,播单播放完停止播放。
默认值:Loop。
*/
PlayBackMode?: string;
/**
* 播单唯一标识 ID,长度限制为64个字符,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)和连字符(-)。如果存在相同 RoundPlayId 的播单,返回 InvalidParameterValue.RoundPlayAlreadyExists 错误。默认取值为空,表示由系统分配。
*/
RoundPlayId?: string;
/**
* 过期时间,格式按照 ISO 8601标准表示,详见 [ISO 日期格式说明](https://cloud.tencent.com/document/product/266/11732#52)。过期后的播单将停止播放,“9999-12-31T23:59:59+08:00”表示不过期。默认值:9999-12-31T23:59:59+08:00。
*/
ExpiredTime?: string;
}
/**
* 提取视频转码数字水印任务配置
*/
export interface ExtractBlindWatermarkTaskConfig {
/**
* 当提取数字水印类型为blind-abseq时有效,用于指定输入视频的切片时长,单位:毫秒。
如果不填默认切片时长为5秒。
*/
SegmentDuration: number;
}
/**
* 图片编码格式参数
*/
export interface ImageEncodeConfig {
/**
* 图片格式,取值范围:JPEG、PNG、BMP、WebP,缺省为原图格式。不支持动画。
*/
Format?: string;
/**
* 图片的相对质量,取值范围:1 - 100,数值以原图质量为标准,缺省为原图质量。
*/
Quality?: number;
}
/**
* 音视频审核涉及令人反感的信息的任务结果类型
*/
export interface AiReviewTaskPornResult {
/**
* 任务状态,有 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?: AiReviewPornTaskInput;
/**
* 音视频审核涉及令人反感的信息的任务输出。
*/
Output?: AiReviewPornTaskOutput;
/**
* 音视频审核涉及令人反感的信息的任务进度,取值范围 [0-100] 。
*/
Progress?: number;
}
/**
* 智能物体识别输出。
*/
export interface AiRecognitionTaskObjectResultOutput {
/**
* 智能物体识别结果集。
注意 :该列表最多仅展示前 100 个元素。如希望获得完整结果,请从 ResultSetFileUrl 对应的文件中获取。
*/
ResultSet: Array;
/**
* 智能物体识别结果集文件 URL。文件的内容为 JSON,数据结构与 ResultSet 字段一致。 (文件不会永久存储,到达ResultSetFileUrlExpireTime 时间点后文件将被删除)。
*/
ResultSetFileUrl: string;
/**
* 智能物体识别结果集文件 URL 失效时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/266/11732#I)。
*/
ResultSetFileUrlExpireTime: string;
}
/**
* DescribeMediaPlayStatDetails请求参数结构体
*/
export interface DescribeMediaPlayStatDetailsRequest {
/**
* 媒体文件 ID。
*/
FileId: string;
/**
* 起始时间,使用 [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;
/**
* 统计时间粒度,有效值:
Hour:以小时为粒度。
Day:以天为粒度。
默认按时间跨度决定,小于1天以小时为粒度,大于等于1天则以天为粒度。
*/
Interval?: string;
}
/**
* Asr 文字涉违禁信息
*/
export interface AiReviewProhibitedAsrTaskOutput {
/**
* 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;
}
/**
* CreateClass返回参数结构体
*/
export interface CreateClassResponse {
/**
* 分类 ID
*/
ClassId?: number;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* DeleteSuperPlayerConfig返回参数结构体
*/
export interface DeleteSuperPlayerConfigResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 视频画面花屏检测的控制参数。
*/
export interface CrashScreenConfigureInfoForUpdate {
/**
* 视频画面花屏检测开关,可选值:
ON:开启;
OFF:关闭。
*/
Switch?: string;
}
/**
* DescribeSampleSnapshotTemplates请求参数结构体
*/
export interface DescribeSampleSnapshotTemplatesRequest {
/**
* 点播[应用](/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 CoverConfigureInfoForUpdate {
/**
* 智能封面任务开关,可选值:
ON:开启智能封面任务;
OFF:关闭智能封面任务。
*/
Switch?: string;
}
/**
* AIGC 固定主体输入信息。
*/
export interface AigcVideoTaskInputSubjectInfo {
/**
* 固定主体Id。
*/
Id?: string;
/**
* 固定名称。
- Vidu主体必选,可在 prompt 中加入 [@name] 使用。如 name 为小明时,prompt 中描述为 [@小明] 。
- Kling主体可选。
*/
Name?: string;
/**
* 仅Vidu有效。音色ID用来决定视频中的声音音色,为空时系统会自动推荐。
*/
VoiceId?: string;
/**
* 仅Vidu有效。临时主体图片,最多3张图片
注1:支持传入图片URL(确保可访问);
注2:图片支持 png、jpeg、jpg、webp格式;
注3:图片像素不能小于 128*128,且比例需要小于1:4或者4:1。
*/
ImageUrls?: Array;
/**
* 仅Vidu有效。临时主体视频,最多1个5秒视频注1:仅参考生viduq2-pro模型支持使用视频主体;注2:最多支持上传 1个5秒 的视频;注3:视频支持 mp4、avi、mov格式;注4:视频像素不能小于 128*128,且比例需要小于1:4或者4:1;
*/
VideoUrls?: Array;
}
/**
* 智能分类任务结果类型
*/
export interface AiAnalysisTaskClassificationResult {
/**
* 任务状态,有 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?: AiAnalysisTaskClassificationInput;
/**
* 智能分类任务输出。
*/
Output?: AiAnalysisTaskClassificationOutput;
/**
* 智能分类任务进度,取值范围 [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 PoliticalImgReviewTemplateInfoForUpdate {
/**
* 画面鉴别涉及令人不适宜的信息的任务开关,可选值:
ON:开启画面鉴别涉及令人不适宜的信息的任务;
OFF:关闭画面鉴别涉及令人不适宜的信息的任务。
*/
Switch?: string;
/**
* 画面鉴别涉及令人不适宜的信息的过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为:
violation_photo:违规图标;
politician:相关人物;
entertainment:娱乐人物;
sport:体育人物;
entrepreneur:商业人物;
scholar:教育学者;
celebrity:知名人物;
military:相关人物。
*/
LabelSet?: Array;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* 用户自定义文本音视频审核任务控制参数
*/
export interface UserDefineOcrTextReviewTemplateInfo {
/**
* 用户自定文本音视频审核任务开关,可选值:
ON:开启自定义文本音视频审核任务;
OFF:关闭自定义文本音视频审核任务。
*/
Switch: string;
/**
* 用户自定义文本过滤标签,音视频审核结果包含选择的标签则返回结果,如果过滤标签为空,则音视频审核结果全部返回。如果要使用标签过滤功能,添加自定义文本关键词素材时需要添加对应标签。
标签个数最多 10 个,每个标签长度最多 16 个字符。
*/
LabelSet?: Array;
/**
* 判定涉嫌违规的分数阈值,当审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。
*/
BlockConfidence?: number;
/**
* 判定需人工复核是否违规的分数阈值,当审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。
*/
ReviewConfidence?: number;
}
/**
* DescribeVodDomains返回参数结构体
*/
export interface DescribeVodDomainsResponse {
/**
* 域名总数量。
*/
TotalCount?: number;
/**
* 域名信息列表。
*/
DomainSet?: Array;
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* 自适应转码流参数模板
*/
export interface AdaptiveStreamTemplate {
/**
*