UNPKG

@nocobase/plugin-verification

Version:

User identity verification management, including SMS, TOTP authenticator, with extensibility.

2,499 lines 416 kB
/** * ModifySnapshotByTimeOffsetTemplate返回参数结构体 */ export interface ModifySnapshotByTimeOffsetTemplateResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifySampleSnapshotTemplate返回参数结构体 */ export interface ModifySampleSnapshotTemplateResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyWatermarkTemplate请求参数结构体 */ export interface ModifyWatermarkTemplateRequest { /** * 水印模板唯一标识。 */ Definition: number; /** * 水印模板名称,长度限制:64 个字符。 */ Name?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 原点位置,可选值: <li>TopLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角;</li> <li>TopRight:表示坐标原点位于视频图像的右上角,水印原点为图片或文字的右上角;</li> <li>BottomLeft:表示坐标原点位于视频图像的左下角,水印原点为图片或文字的左下角;</li> <li>BottomRight:表示坐标原点位于视频图像的右下角,水印原点为图片或文字的右下角。</li> */ CoordinateOrigin?: string; /** * 水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式: <li>当字符串以 % 结尾,表示水印 XPos 为视频宽度指定百分比,如 10% 表示 XPos 为视频宽度的 10%;</li> <li>当字符串以 px 结尾,表示水印 XPos 为指定像素,如 100px 表示 XPos 为 100 像素。</li> */ XPos?: string; /** * 水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式: <li>当字符串以 % 结尾,表示水印 YPos 为视频高度指定百分比,如 10% 表示 YPos 为视频高度的 10%;</li> <li>当字符串以 px 结尾,表示水印 YPos 为指定像素,如 100px 表示 YPos 为 100 像素。</li> */ YPos?: string; /** * 图片水印模板,该字段仅对图片水印模板有效。 */ ImageTemplate?: ImageWatermarkInputForUpdate; /** * 文字水印模板,该字段仅对文字水印模板有效。 */ TextTemplate?: TextWatermarkTemplateInputForUpdate; /** * SVG水印模板,当 Type 为 svg,该字段必填。当 Type 为 image 或 text,该字段无效。 */ SvgTemplate?: SvgWatermarkInputForUpdate; } /** * 查询输入的RTP配置信息。 */ export interface DescribeInputRTPSettings { /** * 是否FEC。 */ FEC: string; /** * 空闲超时时间。 */ IdleTimeout: number; } /** * 语音全文识别片段。 */ export interface AiRecognitionTaskAsrFullTextSegmentItem { /** * 识别片段置信度。取值:0~100。 */ Confidence: number; /** * 识别片段起始的偏移时间,单位:秒。 */ StartTimeOffset: number; /** * 识别片段终止的偏移时间,单位:秒。 */ EndTimeOffset: number; /** * 识别文本。 */ Text: string; } /** * DeleteStreamLinkFlow请求参数结构体 */ export interface DeleteStreamLinkFlowRequest { /** * 传输流Id。 */ FlowId: string; } /** * 插帧帧率配置 */ export interface FrameRateConfig { /** * 能力配置开关,可选值: <li>ON:开启;</li> <li>OFF:关闭。</li> 默认值:ON。 */ Switch?: string; /** * 帧率,取值范围:[0, 100],单位:Hz。 默认值 0。 注意:对于转码,该参数会覆盖 VideoTemplate 内部的 Fps。 注意:此字段可能返回 null,表示取不到有效值。 */ Fps?: number; } /** * 自定义转码的规格参数。用于覆盖模板中对应参数值。 */ export interface OverrideTranscodeParameter { /** * 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a。其中,mp3、flac、ogg、m4a 为纯音频文件。 */ Container?: string; /** * 是否去除视频数据,取值: <li>0:保留;</li> <li>1:去除。</li> */ RemoveVideo?: number; /** * 是否去除音频数据,取值: <li>0:保留;</li> <li>1:去除。</li> */ RemoveAudio?: number; /** * 视频流配置参数。 */ VideoTemplate?: VideoTemplateInfoForUpdate; /** * 音频流配置参数。 */ AudioTemplate?: AudioTemplateInfoForUpdate; /** * 极速高清转码参数。 注意:此字段可能返回 null,表示取不到有效值。 */ TEHDConfig?: TEHDConfigForUpdate; /** * 字幕流配置参数。 注意:此字段可能返回 null,表示取不到有效值。 */ SubtitleTemplate?: SubtitleTemplate; /** * 外挂音轨参数。 注意:此字段可能返回 null,表示取不到有效值。 */ AddonAudioStream?: Array<MediaInputInfo>; /** * 转码扩展字段。 注意:此字段可能返回 null,表示取不到有效值。 */ StdExtInfo?: string; /** * 要插入的字幕文件。 注意:此字段可能返回 null,表示取不到有效值。 */ AddOnSubtitles?: Array<AddOnSubtitle>; } /** * 智能分类任务输入类型 */ export interface AiAnalysisTaskClassificationInput { /** * 视频智能分类模板 ID。 */ Definition: number; } /** * SVG水印模板输入参数 */ export interface SvgWatermarkInput { /** * 水印的宽度,支持 px,%,W%,H%,S%,L% 六种格式: <li>当字符串以 px 结尾,表示水印 Width 单位为像素,如 100px 表示 Width 为 100 像素;当填 0px 且 Height 不为 0px 时,表示水印的宽度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的宽度取原始 SVG 图像的宽度;</li> <li>当字符串以 W% 结尾,表示水印 Width 为视频宽度的百分比大小,如 10W% 表示 Width 为视频宽度的 10%;</li> <li>当字符串以 H% 结尾,表示水印 Width 为视频高度的百分比大小,如 10H% 表示 Width 为视频高度的 10%;</li> <li>当字符串以 S% 结尾,表示水印 Width 为视频短边的百分比大小,如 10S% 表示 Width 为视频短边的 10%;</li> <li>当字符串以 L% 结尾,表示水印 Width 为视频长边的百分比大小,如 10L% 表示 Width 为视频长边的 10%;</li> <li>当字符串以 % 结尾时,含义同 W%。</li> 默认值为 10W%。 */ Width?: string; /** * 水印的高度,支持 px,W%,H%,S%,L% 六种格式: <li>当字符串以 px 结尾,表示水印 Height 单位为像素,如 100px 表示 Height 为 100 像素;当填 0px 且 Width 不为 0px 时,表示水印的高度按原始 SVG 图像等比缩放;当 Width、Height 都填 0px 时,表示水印的高度取原始 SVG 图像的高度;</li> <li>当字符串以 W% 结尾,表示水印 Height 为视频宽度的百分比大小,如 10W% 表示 Height 为视频宽度的 10%;</li> <li>当字符串以 H% 结尾,表示水印 Height 为视频高度的百分比大小,如 10H% 表示 Height 为视频高度的 10%;</li> <li>当字符串以 S% 结尾,表示水印 Height 为视频短边的百分比大小,如 10S% 表示 Height 为视频短边的 10%;</li> <li>当字符串以 L% 结尾,表示水印 Height 为视频长边的百分比大小,如 10L% 表示 Height 为视频长边的 10%;</li> <li>当字符串以 % 结尾时,含义同 H%。</li> 默认值为 0px。 */ Height?: string; } /** * 流的统计数据列表。 */ export interface FlowStatisticsArray { /** * 时间戳。 */ Timestamp: number; /** * 每个会话的统计数据。 */ FlowStatistics: Array<FlowStatistics>; } /** * CreateTranscodeTemplate请求参数结构体 */ export interface CreateTranscodeTemplateRequest { /** * 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a。其中,mp3、flac、ogg、m4a 为纯音频文件。 */ Container: string; /** * 转码模板名称,长度限制:64 个字符。 */ Name?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 是否去除视频数据,可选值: <li>0:保留</li> <li>1:去除</li> 默认值:0。 */ RemoveVideo?: number; /** * 是否去除音频数据,可选值: <li>0:保留</li> <li>1:去除</li> 默认值:0。 */ RemoveAudio?: number; /** * 视频流配置参数,当 RemoveVideo 为 0,该字段必填。 */ VideoTemplate?: VideoTemplateInfo; /** * 音频流配置参数,当 RemoveAudio 为 0,该字段必填。 */ AudioTemplate?: AudioTemplateInfo; /** * 极速高清转码参数。 */ TEHDConfig?: TEHDConfig; /** * 音视频增强配置。 */ EnhanceConfig?: EnhanceConfig; } /** * ProcessLiveStream返回参数结构体 */ export interface ProcessLiveStreamResponse { /** * 任务 ID */ TaskId?: string; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 创建媒体传输流的输出的SRT配置。 */ export interface CreateOutputSRTSettings { /** * 转推的目标地址,当Mode为CALLER时必填,且只能填1组。 */ Destinations: Array<CreateOutputSRTSettingsDestinations>; /** * 转推SRT的流Id,可选大小写字母、数字和特殊字符(.#!:&,=_-),长度为0~512。 */ StreamId?: string; /** * 转推SRT的总延迟,默认0,单位ms,范围为[0, 3000]。 */ Latency?: number; /** * 转推SRT的接收延迟,默认120,单位ms,范围为[0, 3000]。 */ RecvLatency?: number; /** * 转推SRT的对端延迟,默认0,单位ms,范围为[0, 3000]。 */ PeerLatency?: number; /** * 转推SRT的对端空闲超时时间,默认5000,单位ms,范围为[1000, 10000]。 */ PeerIdleTimeout?: number; /** * 转推SRT的加密密钥,默认为空,表示不加密。只可填ascii码值,长度为[10, 79]。 */ Passphrase?: string; /** * 转推SRT的密钥长度,默认为0,可选[0|16|24|32]。 */ PbKeyLen?: number; /** * SRT模式,可选[LISTENER|CALLER],默认为CALLER。 */ Mode?: string; } /** * 智能精彩片段信息 */ export interface MediaAiAnalysisHighlightItem { /** * 智能精彩集锦地址。 */ HighlightPath?: string; /** * 智能精彩集锦封面地址。 */ CovImgPath?: string; /** * 智能精彩集锦的可信度,取值范围是 0 到 100。 */ Confidence?: number; /** * 智能精彩集锦持续时间。 */ Duration?: number; /** * 智能精彩集锦子片段列表。 */ SegmentSet?: Array<HighlightSegmentItem>; } /** * ModifyStreamLinkOutputInfo返回参数结构体 */ export interface ModifyStreamLinkOutputInfoResponse { /** * 修改后的Output配置。 */ Info: DescribeOutput; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAnimatedGraphicsTemplates请求参数结构体 */ export interface DescribeAnimatedGraphicsTemplatesRequest { /** * 转动图模板唯一标识过滤条件,数组长度限制:100。 */ Definitions?: Array<number | bigint>; /** * 分页偏移量,默认值:0。 */ Offset?: number; /** * 返回记录条数,默认值:10,最大值:100。 */ Limit?: number; /** * 模板类型过滤条件,可选值: <li>Preset:系统预置模板;</li> <li>Custom:用户自定义模板。</li> */ Type?: string; } /** * 内容审核 Asr 文字鉴任违禁务结果类型 */ export interface AiReviewTaskProhibitedAsrResult { /** * 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 */ Status?: string; /** * 错误码,空字符串表示成功,其他值表示失败,取值请参考 [媒体处理类错误码](https://cloud.tencent.com/document/product/862/50369#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。 */ ErrCodeExt?: string; /** * 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 内容审核 Asr 文字鉴违禁任务输入。 */ Input?: AiReviewProhibitedAsrTaskInput; /** * 内容审核 Asr 文字鉴违禁任务输出。 注意:此字段可能返回 null,表示取不到有效值。 */ Output?: AiReviewProhibitedAsrTaskOutput; } /** * 转自适应码流模板详情 */ export interface AdaptiveDynamicStreamingTemplate { /** * 转自适应码流模板唯一标识。 */ Definition: number; /** * 模板类型,取值范围: <li>Preset:系统预置模板;</li> <li>Custom:用户自定义模板。</li> */ Type: string; /** * 转自适应码流模板名称。 */ Name: string; /** * 转自适应码流模板描述信息。 */ Comment: string; /** * 转自适应码流格式,取值范围: <li>HLS,</li> <li>MPEG-DASH。</li> */ Format: string; /** * 转自适应码流输入流参数信息,最多输入10路流。 */ StreamInfos: Array<AdaptiveStreamTemplate>; /** * 是否禁止视频低码率转高码率,取值范围: <li>0:否,</li> <li>1:是。</li> */ DisableHigherVideoBitrate: number; /** * 是否禁止视频分辨率转高分辨率,取值范围: <li>0:否,</li> <li>1:是。</li> */ DisableHigherVideoResolution: 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; } /** * 智能描述信息 */ export interface MediaAiAnalysisDescriptionItem { /** * 智能描述。 */ Description?: string; /** * 智能描述的可信度,取值范围是 0 到 100。 */ Confidence?: number; /** * 分段结果。 注意:此字段可能返回 null,表示取不到有效值。 */ Paragraphs?: Array<AiParagraphInfo>; } /** * DeleteAnimatedGraphicsTemplate返回参数结构体 */ export interface DeleteAnimatedGraphicsTemplateResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 内容审核 Ocr 文字鉴任违禁务结果类型 */ export interface AiReviewTaskProhibitedOcrResult { /** * 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 */ Status?: string; /** * 错误码,空字符串表示成功,其他值表示失败,取值请参考 [媒体处理类错误码](https://cloud.tencent.com/document/product/862/50369#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。 */ ErrCodeExt?: string; /** * 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 内容审核 Ocr 文字鉴违禁任务输入。 */ Input?: AiReviewProhibitedOcrTaskInput; /** * 内容审核 Ocr 文字鉴违禁任务输出。 注意:此字段可能返回 null,表示取不到有效值。 */ Output?: AiReviewProhibitedOcrTaskOutput; } /** * 语音全文识别结果。 */ export interface AiRecognitionTaskAsrFullTextResultOutput { /** * 语音全文识别片段列表。 */ SegmentSet?: Array<AiRecognitionTaskAsrFullTextSegmentItem>; /** * 字幕文件地址。 */ SubtitlePath?: string; /** * 字幕文件存储位置。 * @deprecated */ OutputStorage?: TaskOutputStorage; } /** * Ocr 文字涉违禁信息 */ export interface AiReviewProhibitedOcrTaskOutput { /** * Ocr 文字涉违禁评分,分值为0到100。 */ Confidence: number; /** * Ocr 文字涉违禁结果建议,取值范围: <li>pass。</li> <li>review。</li> <li>block。</li> */ Suggestion: string; /** * Ocr 文字有涉违禁嫌疑的视频片段列表。 */ SegmentSet: Array<MediaContentReviewOcrTextSegmentItem>; } /** * DeleteSchedule返回参数结构体 */ export interface DeleteScheduleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ManageTask返回参数结构体 */ export interface ManageTaskResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BatchDeleteStreamLinkFlow请求参数结构体 */ export interface BatchDeleteStreamLinkFlowRequest { /** * EventId。 */ EventId: string; /** * Event关联的流Id数组,如果不传默认删除Event下面的所有媒体传输流。 */ FlowIds?: Array<string>; } /** * 传输流的媒体数据。 */ export interface FlowMediaInfo { /** * 时间戳,单位是秒。 */ Timestamp: number; /** * 总带宽。 */ Network: number; /** * 传输流的视频数据。 */ Video: Array<FlowMediaVideo>; /** * 传输流的音频数据。 */ Audio: Array<FlowMediaAudio>; /** * 标志同一次推流。 */ SessionId: string; /** * 客户端IP。 */ ClientIp: string; } /** * DeleteWorkflow请求参数结构体 */ export interface DeleteWorkflowRequest { /** * 工作流 ID。 */ WorkflowId: number; } /** * 查询输入的RTMP配置信息。 */ export interface DescribeRTMPPullSourceAddress { /** * RTMP源站的TcUrl地址。 注意:此字段可能返回 null,表示取不到有效值。 */ TcUrl: string; /** * RTMP源站的StreamKey。 RTMP源站地址拼接规则为:$TcUrl/$StreamKey。 */ StreamKey: string; } /** * 查询输出的RTMP拉流配置信息。 */ export interface DescribeOutputRTMPPullSettings { /** * 拉流地址列表。 注意:此字段可能返回 null,表示取不到有效值。 */ ServerUrls: Array<DescribeOutputRTMPPullServerUrl>; } /** * AWS S3 文件是上传触发器。 */ export interface AwsS3FileUploadTrigger { /** * 绑定的 AWS S3 存储桶。 */ S3Bucket: string; /** * 绑定的桶所在 AWS 区域,目前支持: us-east-1 eu-west-3 */ S3Region: string; /** * 绑定的输入路径目录,必须为绝对路径,即以 `/` 开头和结尾。如`/movie/201907/`,不填代表根目录`/`。 */ Dir?: string; /** * 允许触发的文件格式列表,如 ["mp4", "flv", "mov"]。不填代表所有格式的文件都可以触发工作流。 */ Formats?: Array<string>; /** * 绑定的 AWS S3 存储桶的秘钥ID。 注意:此字段可能返回 null,表示取不到有效值。 */ S3SecretId?: string; /** * 绑定的 AWS S3 存储桶的秘钥Key。 注意:此字段可能返回 null,表示取不到有效值。 */ S3SecretKey?: string; /** * 绑定的 AWS S3 存储桶对应的 SQS事件队列。 注意:队列和桶需要在同一区域。 注意:此字段可能返回 null,表示取不到有效值。 */ AwsSQS?: AwsSQS; } /** * 用户自定义文本审核任务控制参数。 */ export interface UserDefineOcrTextReviewTemplateInfoForUpdate { /** * 用户自定文本审核任务开关,可选值: <li>ON:开启自定义文本审核任务;</li> <li>OFF:关闭自定义文本审核任务。</li> */ Switch?: string; /** * 用户自定义文本过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义文本关键词素材时需要添加对应标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 */ LabelSet?: string; /** * 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 */ BlockConfidence?: number; /** * 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 */ ReviewConfidence?: number; } /** * 修改Output配置。 */ export interface ModifyOutputInfo { /** * 需要修改的Output的Id。 */ OutputId: string; /** * 输出的名称。 */ OutputName: string; /** * 输出的描述。 */ Description: string; /** * 输出的转推协议,支持SRT|RTP|RTMP。 */ Protocol: string; /** * 转推SRT的配置。 */ SRTSettings?: CreateOutputSRTSettings; /** * 转推RTP的配置。 */ RTPSettings?: CreateOutputInfoRTPSettings; /** * 转推RTMP的配置。 */ RTMPSettings?: CreateOutputRTMPSettings; /** * IP白名单列表,格式为CIDR,如0.0.0.0/0。 当Protocol为RTMP_PULL有效,为空代表不限制客户端IP。 */ AllowIpList?: Array<string>; /** * 最大拉流并发数,最大4,默认4。 */ MaxConcurrent?: number; /** * 绑定的安全组 ID。 仅支持关联一组安全组。 */ SecurityGroupIds?: Array<string>; } /** * 点播文件指定时间点截图信息 */ export interface MediaSnapshotByTimeOffsetItem { /** * 指定时间点截图规格,参见[指定时间点截图参数模板](https://cloud.tencent.com/document/product/266/33480#.E6.97.B6.E9.97.B4.E7.82.B9.E6.88.AA.E5.9B.BE.E6.A8.A1.E6.9D.BF)。 */ Definition: number; /** * 同一规格的截图信息集合,每个元素代表一张截图。 */ PicInfoSet: Array<MediaSnapshotByTimePicInfoItem>; /** * 指定时间点截图文件的存储位置。 */ Storage: TaskOutputStorage; } /** * 输出文件名的`{number}`变量的规则。 */ export interface NumberFormat { /** * `{number}`变量的起始值,默认为0。 */ InitialValue?: number; /** * `{number}`变量的增长步长,默认为1。 */ Increment?: number; /** * `{number}`变量的最小长度,不足时补占位符。默认为1。 */ MinLength?: number; /** * `{number}`变量的长度不足时,补充的占位符。默认为"0"。 */ PlaceHolder?: string; } /** * ModifySampleSnapshotTemplate请求参数结构体 */ export interface ModifySampleSnapshotTemplateRequest { /** * 采样截图模板唯一标识。 */ Definition: number; /** * 采样截图模板名称,长度限制:64 个字符。 */ Name?: string; /** * 截图宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。 <li>当 Width、Height 均为 0,则分辨率同源;</li> <li>当 Width 为 0,Height 非 0,则 Width 按比例缩放;</li> <li>当 Width 非 0,Height 为 0,则 Height 按比例缩放;</li> <li>当 Width、Height 均非 0,则分辨率按用户指定。</li> 默认值:0。 */ Width?: number; /** * 截图高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。 <li>当 Width、Height 均为 0,则分辨率同源;</li> <li>当 Width 为 0,Height 非 0,则 Width 按比例缩放;</li> <li>当 Width 非 0,Height 为 0,则 Height 按比例缩放;</li> <li>当 Width、Height 均非 0,则分辨率按用户指定。</li> 默认值:0。 */ Height?: number; /** * 分辨率自适应,可选值: <li>open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;</li> <li>close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。</li> 默认值:open。 */ ResolutionAdaptive?: string; /** * 采样截图类型,取值: <li>Percent:按百分比。</li> <li>Time:按时间间隔。</li> */ SampleType?: string; /** * 采样间隔。 <li>当 SampleType 为 Percent 时,指定采样间隔的百分比。</li> <li>当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。</li> */ SampleInterval?: number; /** * 图片格式,取值为 jpg、png、webp。 */ Format?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: <li> stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;</li> <li>black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。</li> <li>white:留白,保持视频宽高比不变,边缘剩余部分使用白色填充。</li> <li>gauss:高斯模糊,保持视频宽高比不变,边缘剩余部分使用高斯模糊。</li> 默认值:black 。 */ FillType?: string; } /** * 内容审核 Ocr 文字敏感任务输入参数类型 */ export interface AiReviewPoliticalOcrTaskInput { /** * 模板 ID。 */ Definition: number; } /** * 音视频增强配置 */ export interface EnhanceConfig { /** * 视频增强配置。 注意:此字段可能返回 null,表示取不到有效值。 */ VideoEnhance?: VideoEnhanceConfig; /** * 音频增强配置。 注意:此字段可能返回 null,表示取不到有效值。 */ AudioEnhance?: AudioEnhanceConfig; } /** * 媒体处理的输入对象信息。 */ export interface MediaInputInfo { /** * 输入来源对象的类型,支持: <li> COS:COS源</li> <li> URL:URL源</li> <li> AWS-S3:AWS 源,目前只支持转码任务 </li> */ Type: string; /** * 当 Type 为 COS 时有效,则该项为必填,表示媒体处理 COS 对象信息。 */ CosInputInfo?: CosInputInfo; /** * 当 Type 为 URL 时有效,则该项为必填,表示媒体处理 URL 对象信息。 注意:此字段可能返回 null,表示取不到有效值。 */ UrlInputInfo?: UrlInputInfo; /** * 当 Type 为 AWS-S3 时有效,则该项为必填,表示媒体处理 AWS S3 对象信息。 注意:此字段可能返回 null,表示取不到有效值。 */ S3InputInfo?: S3InputInfo; } /** * CreateWorkflow请求参数结构体 */ export interface CreateWorkflowRequest { /** * 工作流名称,最多128字符。同一个用户该名称唯一。 */ WorkflowName: string; /** * 工作流绑定的触发规则,当上传视频命中该规则到该对象时即触发工作流。 */ Trigger: WorkflowTrigger; /** * 媒体处理的文件输出存储位置。不填则继承 Trigger 中的存储位置。 */ OutputStorage?: TaskOutputStorage; /** * 媒体处理生成的文件输出的目标目录,必选以 / 开头和结尾,如`/movie/201907/`。 如果不填,表示与触发文件所在的目录一致。 */ OutputDir?: string; /** * 媒体处理类型任务参数。 */ MediaProcessTask?: MediaProcessTaskInput; /** * 视频内容审核类型任务参数。 */ AiContentReviewTask?: AiContentReviewTaskInput; /** * 视频内容分析类型任务参数。 */ AiAnalysisTask?: AiAnalysisTaskInput; /** * 视频内容识别类型任务参数。 */ AiRecognitionTask?: AiRecognitionTaskInput; /** * 任务的事件通知配置,不填代表不获取事件通知。 */ TaskNotifyConfig?: TaskNotifyConfig; /** * 工作流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。 */ TaskPriority?: number; } /** * ModifyStreamLinkEvent请求参数结构体 */ export interface ModifyStreamLinkEventRequest { /** * 媒体传输事件Event Id。 */ EventId: string; /** * 需要修改的事件名称。 */ EventName: string; /** * Event的描述信息。 */ Description?: string; } /** * 文本关键词识别控制参数。 */ export interface OcrWordsConfigureInfo { /** * 文本关键词识别任务开关,可选值: <li>ON:开启文本关键词识别任务;</li> <li>OFF:关闭文本关键词识别任务。</li> */ Switch: string; /** * 关键词过滤标签,指定需要返回的关键词的标签。如果未填或者为空,则全部结果都返回。 标签个数最多 10 个,每个标签长度最多 16 个字符。 */ LabelSet?: Array<string>; } /** * DescribeStreamLinkEvent请求参数结构体 */ export interface DescribeStreamLinkEventRequest { /** * 媒体传输事件ID。 */ EventId: string; } /** * 诊断结果项。 */ export interface DiagnoseResult { /** * 诊断出的异常类别。 注意:此字段可能返回 null,表示取不到有效值。 */ Category?: string; /** * 诊断出的具体异常类型。 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; /** * 诊断出异常开始的PTS时间戳。 注意:此字段可能返回 null,表示取不到有效值。 */ Timestamp?: number; /** * 诊断出的异常描述。 注意:此字段可能返回 null,表示取不到有效值。 */ Description?: string; /** * 诊断到异常的北京时间,采用 ISO 日期格式。 注意:此字段可能返回 null,表示取不到有效值。 */ DateTime?: string; /** * 诊断出的异常级别。 注意:此字段可能返回 null,表示取不到有效值。 */ SeverityLevel?: string; } /** * 自定义水印规格参数。 */ export interface RawWatermarkParameter { /** * 水印类型,可选值: <li>image:图片水印。</li> */ Type: string; /** * 原点位置,目前仅支持: <li>TopLeft:表示坐标原点位于视频图像左上角,水印原点为图片或文字的左上角。</li> 默认值:TopLeft。 */ CoordinateOrigin?: string; /** * 水印原点距离视频图像坐标原点的水平位置。支持 %、px 两种格式: <li>当字符串以 % 结尾,表示水印 XPos 为视频宽度指定百分比,如 10% 表示 XPos 为视频宽度的 10%;</li> <li>当字符串以 px 结尾,表示水印 XPos 为指定像素,如 100px 表示 XPos 为 100 像素。</li> 默认值:0px。 */ XPos?: string; /** * 水印原点距离视频图像坐标原点的垂直位置。支持 %、px 两种格式: <li>当字符串以 % 结尾,表示水印 YPos 为视频高度指定百分比,如 10% 表示 YPos 为视频高度的 10%;</li> <li>当字符串以 px 结尾,表示水印 YPos 为指定像素,如 100px 表示 YPos 为 100 像素。</li> 默认值:0px。 */ YPos?: string; /** * 图片水印模板,当 Type 为 image,该字段必填。当 Type 为 text,该字段无效。 */ ImageTemplate?: RawImageWatermarkInput; } /** * 内容审核 Ocr 文字敏感任务结果类型 */ export interface AiReviewTaskPoliticalOcrResult { /** * 任务状态,有 PROCESSING,SUCCESS,FAIL 三种。 */ Status?: string; /** * 错误码,空字符串表示成功,其他值表示失败,取值请参考 [媒体处理类错误码](https://cloud.tencent.com/document/product/862/50369#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。 */ ErrCodeExt?: string; /** * 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 内容审核 Ocr 文字敏感任务输入。 */ Input?: AiReviewPoliticalOcrTaskInput; /** * 内容审核 Ocr 文字敏感任务输出。 注意:此字段可能返回 null,表示取不到有效值。 */ Output?: AiReviewPoliticalOcrTaskOutput; } /** * AI 样本管理,关键词输出信息。 */ export interface AiSampleWord { /** * 关键词。 */ Keyword: string; /** * 关键词标签。 */ TagSet: Array<string>; /** * 关键词应用场景。 */ UsageSet: Array<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 PoliticalOcrReviewTemplateInfo { /** * 文本涉敏任务开关,可选值: <li>ON:开启文本涉敏任务;</li> <li>OFF:关闭文本涉敏任务。</li> */ Switch: string; /** * 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 100 分。取值范围:0~100。 */ BlockConfidence?: number; /** * 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 75 分。取值范围:0~100。 */ ReviewConfidence?: number; } /** * CreateImageSpriteTemplate请求参数结构体 */ export interface CreateImageSpriteTemplateRequest { /** * 采样类型,取值: <li>Percent:按百分比。</li> <li>Time:按时间间隔。</li> */ SampleType: string; /** * 采样间隔。 <li>当 SampleType 为 Percent 时,指定采样间隔的百分比。</li> <li>当 SampleType 为 Time 时,指定采样间隔的时间,单位为秒。</li> */ SampleInterval: number; /** * 雪碧图中小图的行数。 */ RowCount: number; /** * 雪碧图中小图的列数。 */ ColumnCount: number; /** * 雪碧图模板名称,长度限制:64 个字符。 */ Name?: string; /** * 雪碧图中小图的宽度(或长边)的最大值,取值范围:0 和 [128, 4096],单位:px。 <li>当 Width、Height 均为 0,则分辨率同源;</li> <li>当 Width 为 0,Height 非 0,则 Width 按比例缩放;</li> <li>当 Width 非 0,Height 为 0,则 Height 按比例缩放;</li> <li>当 Width、Height 均非 0,则分辨率按用户指定。</li> 默认值:0。 */ Width?: number; /** * 雪碧图中小图的高度(或短边)的最大值,取值范围:0 和 [128, 4096],单位:px。 <li>当 Width、Height 均为 0,则分辨率同源;</li> <li>当 Width 为 0,Height 非 0,则 Width 按比例缩放;</li> <li>当 Width 非 0,Height 为 0,则 Height 按比例缩放;</li> <li>当 Width、Height 均非 0,则分辨率按用户指定。</li> 默认值:0。 */ Height?: number; /** * 分辨率自适应,可选值: <li>open:开启,此时,Width 代表视频的长边,Height 表示视频的短边;</li> <li>close:关闭,此时,Width 代表视频的宽度,Height 表示视频的高度。</li> 默认值:open。 */ ResolutionAdaptive?: string; /** * 填充方式,当视频流配置宽高参数与原始视频的宽高比不一致时,对转码的处理方式,即为“填充”。可选填充方式: <li> stretch:拉伸,对每一帧进行拉伸,填满整个画面,可能导致转码后的视频被“压扁“或者“拉长“;</li> <li>black:留黑,保持视频宽高比不变,边缘剩余部分使用黑色填充。</li> 默认值:black 。 */ FillType?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 图片格式,取值为 jpg、png、webp。默认为 jpg。 */ Format?: string; } /** * 指定时间点截图信息 */ export interface MediaSnapshotByTimePicInfoItem { /** * 该张截图对应视频文件中的时间偏移,单位为秒。 */ TimeOffset: number; /** * 该张截图的路径。 */ Path: string; /** * 截图如果被打上了水印,被打水印的模板 ID 列表。 */ WaterMarkDefinition: Array<number | bigint>; } /** * 用户自定义人物审核任务控制参数 */ export interface UserDefineFaceReviewTemplateInfo { /** * 用户自定义人物审核任务开关,可选值: <li>ON:开启自定义人物审核任务;</li> <li>OFF:关闭自定义人物审核任务。</li> */ Switch: string; /** * 用户自定义人物过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回。如果要使用标签过滤功能,添加自定义人物库的时,需要添加对应人物标签。 标签个数最多 10 个,每个标签长度最多 16 个字符。 */ LabelSet?: Array<string>; /** * 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规,不填默认为 97 分。取值范围:0~100。 */ BlockConfidence?: number; /** * 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核,不填默认为 95 分。取值范围:0~100。 */ ReviewConfidence?: number; } /** * 创建的输入HLS拉流的配置信息。 */ export interface CreateInputHLSPullSettings { /** * HLS源站的源站地址,有且只能有一个。 */ SourceAddresses: Array<HLSPullSourceAddress>; } /** * 内容审核模板详情 */ export interface ContentReviewTemplateItem { /** * 内容审核模板唯一标识。 */ Definition: number; /** * 内容审核模板名称,长度限制:64 个字符。 */ Name: string; /** * 内容审核模板描述信息,长度限制:256 个字符。 */ Comment: string; /** * 鉴黄控制参数。 注意:此字段可能返回 null,表示取不到有效值。 */ PornConfigure: PornConfigureInfo; /** * 涉敏控制参数。 注意:此字段可能返回 null,表示取不到有效值。 */ TerrorismConfigure: TerrorismConfigureInfo; /** * 涉敏控制参数。 注意:此字段可能返回 null,表示取不到有效值。 */ PoliticalConfigure: PoliticalConfigureInfo; /** * 违禁控制参数。违禁内容包括: <li>谩骂;</li> <li>涉毒违法。</li> 注意:此字段可能返回 null,表示取不到有效值。 */ ProhibitedConfigure: ProhibitedConfigureInfo; /** * 用户自定义内容审核控制参数。 注意:此字段可能返回 null,表示取不到有效值。 */ UserDefineConfigure: UserDefineConfigureInfo; /** * 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/862/37710#52)。 */ CreateTime: string; /** * 模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/862/37710#52)。 */ UpdateTime: string; /** * 模板类型,取值范围: * Preset:系统预置模板; * Custom:用户自定义模板。 注意:此字段可能返回 null,表示取不到有效值。 */ Type: string; } /** * ModifyStreamLinkFlow返回参数结构体 */ export interface ModifyStreamLinkFlowResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteAIRecognitionTemplate返回参数结构体 */ export interface DeleteAIRecognitionTemplateResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 视频增强配置 */ export interface VideoEnhanceConfig { /** * 插帧帧率配置。 注意:此字段可能返回 null,表示取不到有效值。 */ FrameRate?: FrameRateConfig; /** * 超分配置。 注意:此字段可能返回 null,表示取不到有效值。 */ SuperResolution?: SuperResolutionConfig; /** * HDR配置。 注意:此字段可能返回 null,表示取不到有效值。 */ Hdr?: HdrConfig; /** * 视频降噪配置。 注意:此字段可能返回 null,表示取不到有效值。 */ Denoise?: VideoDenoiseConfig; /** * 综合增强配置。 注意:此字段可能返回 null,表示取不到有效值。 */ ImageQualityEnhance?: ImageQualityEnhanceConfig; /** * 色彩增强配置。 注意:此字段可能返回 null,表示取不到有效值。 */ ColorEnhance?: ColorEnhanceConfig; /** * 细节增强配置。 注意:此字段可能返回 null,表示取不到有效值。 */ SharpEnhance?: SharpEnhanceConfig; /** * 人脸增强配置。 注意:此字段可能返回 null,表示取不到有效值。 */ FaceEnhance?: FaceEnhanceConfig; /** * 低光照增强配置。 注意:此字段可能返回 null,表示取不到有效值。 */ LowLightEnhance?: LowLightEnhanceConfig; /** * 去划痕配置。 注意:此字段可能返回 null,表示取不到有效值。 */ ScratchRepair?: ScratchRepairConfig; /** * 去伪影(毛刺)配置。 注意:此字段可能返回 null,表示取不到有效值。 */ ArtifactRepair?: ArtifactRepairConfig; } /** * DeleteContentReviewTemplate请求参数结构体 */ export interface DeleteContentReviewTemplateRequest { /** * 内容审核模板唯一标识。 */ Definition: number; } /** * StartStreamLinkFlow返回参数结构体 */ export interface StartStreamLinkFlowResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 内容审核敏感任务输入参数类型 */ export interface AiReviewPoliticalTaskInput { /** * 模板 ID。 */ Definition: number; } /** * ModifySchedule请求参数结构体 */ export interface ModifyScheduleRequest { /** * 编排唯一标识。 */ ScheduleId: number; /** * 编排名称。 */ ScheduleName?: string; /** * 编排绑定的触发规则。 */ Trigger?: WorkflowTrigger; /** * 编排任务列表。 注意:内部不允许部分更新,如果需要更新需全量提交编排任务列表。 */ Activities?: Array<Activity>; /** * 媒体处理的文件输出存储位置。 */ OutputStorage?: TaskOutputStorage; /** * 媒体处理生成的文件输出的目标目录,必选以 / 开头和结尾。 注意:如果设置为空,则表示取消老配置的OutputDir值。 */ OutputDir?: string; /** * 任务的事件通知配置。 */ TaskNotifyConfig?: TaskNotifyConfig; } /** * 创建媒体传输流的输出的RTP的目标地址。 */ export interface CreateOutputRTPSettingsDestinations { /** * 转推的目标IP。 */ Ip: string; /** * 转推的目标端口。 */ Port: number; } /** * 智能分类任务控制参数 */ export interface ClassificationConfigureInfo { /** * 智能分类任务开关,可选值: <li>ON:开启智能分类任务;</li> <li>OFF:关闭智能分类任务。</li> */ Switch: string; } /** * 智能分类结果 */ export interface MediaAiAnalysisClassificationItem { /** * 智能分类的类别名称。 */ Classification: string; /** * 智能分类的可信度,取值范围是 0 到 100。 */ Confidence: number; } /** * ModifyWordSample返回参数结构体 */ export interface ModifyWordSampleResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 音频流配置参数 */ export interface AudioTemplateInfoForUpdate { /** * 音频流的编码格式。 当外层参数 Container 为 mp3 时,可选值为: <li>libmp3lame。</li> 当外层参数 Container 为 ogg 或 flac 时,可选值为: <li>flac。</li> 当外层参数 Container 为 m4a 时,可选值为: <li>libfdk_aac;</li> <li>libmp3lame;</li> <li>ac3。</li> 当外层参数 Container 为 mp4 或 flv 时,可选值为: <li>libfdk_aac:更适合 mp4;</li> <li>libmp3lame:更适合 flv;</li> <li>mp2。</li> 当外层参数 Container 为 hls 时,可选值为: <li>libfdk_aac;</li> <li>libmp3lame。</li> 注意:此字段可能返回 null,表示取不到有效值。 */ Codec?: string; /** * 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。 当取值为 0,表示音频码率和原始音频保持一致。 注意:此字段可能返回 null,表示取不到有效值。 */ Bitrate?: number; /** * 音频流的采样率,可选值: <li>32000</li> <li>44100</li> <li>48000</li> 单位:Hz。 注意:此字段可能返回 null,表示取不到有效值。 */ SampleRate?: number; /** * 音频通道方式,可选值: <li>1:单通道</li> <li>2:双通道</li> <li>6:立体声</li> 当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为立体声。 注意:此字段可能返回 null,表示取不到有效值。 */ AudioChannel?: number; /** * 指定输出要保留的音频轨道。默认是全部保留源的。 注意:此字段可能返回 null,表示取不到有效值。 */ StreamSelects?: Array<number | bigint>; } /** * 工作流信息详情。 */ export interface WorkflowInfo { /** * 工作流 ID。 */ WorkflowId: number; /** * 工作流名称。 */ WorkflowName: string; /** * 工作流状态,取值范围: <li>Enabled:已启用,</li> <li>Disabled:已禁用。</li> */ Status: string; /** * 工作流绑定的输入规则,当上传视频命中该规则到该对象时即触发工作流。 */ Trigger: WorkflowTrigger; /** * 媒体处理的文件输出存储位置。 注意:此字段可能返回 null,表示取不到有效值。 */ OutputStorage: TaskOutputStorage; /** * 媒体处理类型任务参数。 注意:此字段可能返回 null,表示取不到有效值。 */ MediaProcessTask: MediaProcessTaskInput; /** * 视频内容审核类型任务参数。 注意:此字段可能返回 null,表示取不到有效值。 */ AiContentReviewTask: AiContentReviewTaskInput; /** * 视频内容分析类型任务参数。 注意:此字段可能返回 null,表示取不到有效值。 */ AiAnalysisTask: AiAnalysisTaskInput; /** * 视频内容识别类型任务参数。 注意:此字段可能返回 null,表示取不到有效值。 */ AiRecognitionTask: AiRecognitionTaskInput; /** * 任务的事件通知信息,不填代表不获取事件通知。 注意:此字段可能返回 null,表示取不到有效值。 */ TaskNotifyConfig: TaskNotifyConfig; /** * 任务流的优先级,数值越大优先级越高,取值范围是 -10 到 10,不填代表 0。 */ TaskPriority: number; /** * 媒体处理生成的文件输出的目标目录,如`/movie/201907/`。 */ OutputDir: 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 SuperResolutionConfig { /** * 能力配置开关,可选值: <li>ON:开启;</li> <li>OFF:关闭。</li> 默认值:ON。 */ Switch?: string; /** * 类型,可选值: <li>lq:针对低清晰度有较多噪声视频的超分;</li> <li>hq:针对高清晰度视频超分。</li> 默认值:lq。 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; /** * 超分倍数,可选值: <li>2:目前只支持 2 倍超分。</li> 默认值:2。 注意:此字段可能返回 null,表示取不到有效值。 */ Size?: number; } /** * DeletePersonSample请求参数结构体 */ export interface DeletePersonSampleRequest { /** * 素材 ID。 */ PersonId: string; } /** * DescribeStreamLinkFlows返回参数结构体 */ export interface DescribeStreamLinkFlowsResponse { /** * 流的配置信息列表。 */ Infos: Array<DescribeFlow>; /** * 当前页数。 */ PageNum: number; /** * 每页大小。 */ PageSize: number; /** * 总数量。 */ TotalNum: number; /** * 总页数。 */ TotalPage: number; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 语音识别片段。 */ export interface AiRecognitionTaskAsrWordsSegmentItem { /** * 识别片段起始的偏移时间,单位:秒。 */ StartTimeOffset: number; /** * 识别片段终止的偏移时间,单位:秒。 */ EndTimeOffset: number; /** * 识别片段置信度。取值:0~100。 */ Confidence: number; } /** * 内容审核结果 */ export interface AiContentReviewResult { /** * 任务的类型,可以取的值有: <li>Porn:图片鉴黄</li> <li>Terrorism:图片敏感</li> <li>Political:图片敏感</li> <li>Porn.Asr:Asr 文字鉴黄</li> <li>Porn.Ocr:Ocr 文字鉴黄</li> <li>Political.Asr:Asr 文字敏感</li> <li>Political.Ocr:Ocr 文字敏感</li> <li>Terrorism.Ocr:Ocr 文字敏感</li> <li>Prohibited.Asr:Asr 文字鉴违禁</li> <li>Prohibited.Ocr:Ocr 文字鉴违禁</li> */ Type: string; /** * 采样频率,即对视频每秒截取进行审核的帧数。 */ SampleRate: number; /** * 审核的视频时长,单位:秒。 */ Duration: number; /** * 视频内容审核智能画面鉴黄任务的查询结果,当任务类型为 Porn 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ PornTask: AiReviewTaskPornResult; /** * 视频内容审核智能画面敏感任务的查询结果,当任务类型为 Terrorism 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ TerrorismTask: AiReviewTaskTerrorismResult; /** * 视频内容审核智能画面敏感任务的查询结果,当任务类型为 Political 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ PoliticalTask: AiReviewTaskPoliticalResult; /** * 视频内容审核 Asr 文字鉴黄任务的查询结果,当任务类型为 Porn.Asr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ PornAsrTask: AiReviewTaskPornAsrResult; /** * 视频内容审核 Ocr 文字鉴黄任务的查询结果,当任务类型为 Porn.Ocr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ PornOcrTask: AiReviewTaskPornOcrResult; /** * 视频内容审核 Asr 文字敏感任务的查询结果,当任务类型为 Political.Asr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ PoliticalAsrTask: AiReviewTaskPoliticalAsrResult; /** * 视频内容审核 Ocr 文字敏感任务的查询结果,当任务类型为 Political.Ocr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ PoliticalOcrTask: AiReviewTaskPoliticalOcrResult; /** * 视频内容审核 Ocr 文字敏感任务的查询结果,当任务类型为 Terrorism.Ocr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ TerrorismOcrTask: AiReviewTaskTerrorismOcrResult; /** * 视频内容审核 Asr 文字鉴违禁任务的查询结果,当任务类型为 Prohibited.Asr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ ProhibitedAsrTask: AiReviewTaskProhibitedAsrResult; /** * 视频内容审核 Ocr 文字鉴违禁任务的查询结果,当任务类型为 Prohibited.Ocr 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ ProhibitedOcrTask: AiReviewTaskProhibitedOcrResult; } /** * ParseLiveStreamProcessNotification返回参数结构体 */ export interface ParseLiveStreamProcessNotificationResponse { /** * 直播流处理结果类型,包含: <li>AiReviewResult:内容审核结果;</li> <li>AiRecognitionResult:内容识别结果;</li> <li>ProcessEof:直播流处理结束。</li> */ NotificationType?: string; /** * 视频处理任务 ID。 */ TaskId?: string; /** * 直播流处理错误信息,当 NotificationType 为 ProcessEof 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ ProcessEofInfo?: LiveStreamProcessErrorInfo; /** * 内容审核结果,当 NotificationType 为 AiReviewResult 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ AiReviewResultInfo?: LiveStreamAiReviewResultInfo; /** * 内容识别结果,当 NotificationType 为 AiRecognitionResult 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ AiRecognitionResultInfo?: LiveStreamAiRecognitionResultInfo; /** * 内容分析结果,当 NotificationType 为 AiAnalysisResult 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ AiAnalysisResultInfo?: LiveStreamAiAnalysisResultInfo; /** * 媒体质检结果,当 NotificationType 为 AiQualityControlResult 时有效。 注意:此字段可能返回 null,表示取不到有效值。 */ AiQualityControlResultInfo?: LiveStreamAiQualityControlResultInfo; /** * 用于去重的识别码,如果七天内曾有过相同的识别码的请求,则本次的请求会返回错误。最长50个字符,不带或者带空字符串表示不做去重。 */ SessionId?: string; /** * 来源上下文,用于透传用户请求信息,任务流状态变更回调将返回该字段值,最长1000个字符。 */ SessionContext?: string; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 视频内容识别输入参数类型 */ export interface AiRecognitionTaskInput { /** * 视频智能识别模板 ID 。 */ Definition: number; } /** * 音频流配置参数 */ export interface AudioTemplateInfo { /** * 音频流的编码格式。 当外层参数 Container 为 mp3 时,可选值为: <li>libmp3lame。</li> 当外层参数 Container 为 ogg 或 flac 时,可选值为: <li>flac。</li> 当外层参数 Container 为 m4a 时,可选值为: <li>libfdk_aac;</li> <li>libmp3lame;</li> <li>ac3。</li> 当外层参数 Container 为 mp4 或 flv 时,可选值为: <li>libfdk_aac:更适合 mp4;</li> <li>libmp3lame:更适合 flv。</li> 当外层参数 Container 为 hls 时,可选值为: <li>libfdk_aac;</li> <li>libmp3lame。</li> */ Codec: string; /** * 音频流的码率,取值范围:0 和 [26, 256],单位:kbps。 当取值为 0,表示音频码率和原始音频保持一致。 */ Bitrate: number; /** * 音频流的采样率,可选值: <li>32000</li> <li>44100</li> <li>48000</li> 单位:Hz。 */ SampleRate: number; /** * 音频通道方式,可选值: <li>1:单通道</li> <li>2:双通道</li> <li>6:立体声</li> 当媒体的封装格式是音频格式时(flac,ogg,mp3,m4a)时,声道数不允许设为立体声。 默认值:2。 */ AudioChannel?: number; } /** * ExecuteFunction返回参数结构体 */ export interface ExecuteFunctionResponse { /** * 处理结果打包后的字符串,具体与后台一同协调。 */ Result: string; /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 智能封面任务控制参数 */ export interface CoverConfigureInfo { /** * 智能封面任务开关,可选值: <li>ON:开启智能封面任务;</li> <li>OFF:关闭智能封面任务。</li> */ Switch: string; } /** * 视频内容识别模板详情 */ export interface AIRecognitionTemplateItem { /** * 视频内容识别模板唯一标识。 */ Definition?: number; /** * 视频内容识别模板名称。 */ Name?: string; /** * 视频内容识别模板描述信息。 */ Comment?: string; /** * 人脸识别控制参数。 */ FaceConfigure?: FaceConfigureInfo; /** * 文本全文识别控制参数。 */ OcrFullTextConfigure?: OcrFullTextConfigureInfo; /** * 文本关键词识别控制参数。 */ OcrWordsConfigure?: OcrWordsConfigureInfo; /** * 语音全文识别控制参数。 */ AsrFullTextConfigure?: AsrFullTextConfigureInfo; /** * 语音关键词识别控制参数。 */ AsrWordsConfigure?: AsrWordsConfigureInfo; /** * 语音翻译控制参数。 注意:此字段可能返回 null,表示取不到有效值。 */ TranslateConfigure?: TranslateConfigureInfo; /** * 模板创建时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/862/37710#52)。 */ CreateTime?: string; /** * 模板最后修改时间,使用 [ISO 日期格式](https://cloud.tencent.com/document/product/862/37710#52)。 */ UpdateTime?: string; /** * 模板类型,取值范围: * Preset:系统预置模板; * Custom:用户自定义模板。 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; } /** * 内容审核 Asr 文字鉴黄任务输入参数类型 */ export interface AiReviewPornAsrTaskInput { /** * 鉴黄模板 ID。 */ Definition: number; } /** * 人脸识别结果。 */ export interface AiRecognitionTaskFaceResult { /** * 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 */ Status?: string; /** * 错误码,空字符串表示成功,其他值表示失败,取值请参考 [媒体处理类错误码](https://cloud.tencent.com/document/product/862/50369#.E8.A7.86.E9.A2.91.E5.A4.84.E7.90.86.E7.B1.BB.E9.94.99.E8.AF.AF.E7.A0.81) 列表。 */ ErrCodeExt?: string; /** * 错误码,0 表示成功,其他值表示失败(该字段已不推荐使用,建议使用新的错误码字段 ErrCodeExt)。 */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 人脸识别任务输入信息。 */ Input?: AiRecognitionTaskFaceResultInput; /** * 人脸识别任务输出信息。 注意:此字段可能返回 null,表示取不到有效值。 */ Output?: AiRecognitionTaskFaceResultOutput; } /** * CreateAdaptiveDynamicStreamingTemplate请求参数结构体 */ export interface CreateAdaptiveDynamicStreamingTemplateRequest { /** * 自适应转码格式,取值范围: <li>HLS,</li> <li>MPEG-DASH。</li> */ Format: string; /** * 转自适应码流输出子流参数信息,最多输出10路子流。 注意:各个子流的帧率必须保持一致;如果不一致,采用第一个子流的帧率作为输出帧率。 */ StreamInfos: Array<AdaptiveStreamTemplate>; /** * 模板名称,长度限制:64 个字符。 */ Name?: string; /** * 是否禁止视频低码率转高码率,取值范围: <li>0:否,</li> <li>1:是。</li> 默认为否。 */ DisableHigherVideoBitrate?: number; /** * 是否禁止视频分辨率转高分辨率,取值范围: <li>0:否,</li> <li>1:是。</li> 默认为否。 */ DisableHigherVideoResolution?: number; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; } /** * 创建的输入RTMP拉流的配置信息。 */ export interface CreateInputRTMPPullSettings { /** * RTMP源站的源站地址,有且只能有一个。 */ SourceAddresses: Array<RTMPPullSourceAddress>; } /** * 画面涉敏任务控制参数。 */ export interface TerrorismImgReviewTemplateInfoForUpdate { /** * 画面涉敏任务开关,可选值: <li>ON:开启画面涉敏任务;</li> <li>OFF:关闭画面涉敏任务。</li> */ Switch?: string; /** * 画面涉敏过滤标签,审核结果包含选择的标签则返回结果,如果过滤标签为空,则审核结果全部返回,可选值为: <li>guns:武器枪支;</li> <li>crowd:人群聚集;</li> <li>bloody:血腥画面;</li> <li>police:警察部队;</li> <li>banners:涉敏旗帜;</li> <li>militant:武装分子;</li> <li>explosion:爆炸火灾;</li> <li>terrorists:涉敏人物;</li> <li>scenario:涉敏画面。</li> */ LabelSet?: Array<string>; /** * 判定涉嫌违规的分数阈值,当智能审核达到该分数以上,认为涉嫌违规。取值范围:0~100。 */ BlockConfidence?: number; /** * 判定需人工复核是否违规的分数阈值,当智能审核达到该分数以上,认为需人工复核。取值范围:0~100。 */ ReviewConfidence?: number; } /** * ModifyTranscodeTemplate请求参数结构体 */ export interface ModifyTranscodeTemplateRequest { /** * 转码模板唯一标识。 */ Definition: number; /** * 封装格式,可选值:mp4、flv、hls、mp3、flac、ogg、m4a。其中,mp3、flac、ogg、m4a 为纯音频文件。 */ Container?: string; /** * 转码模板名称,长度限制:64 个字符。 */ Name?: string; /** * 模板描述信息,长度限制:256 个字符。 */ Comment?: string; /** * 是否去除视频数据,可选值: <li>0:保留</li> <li>1:去除</li> */ RemoveVideo?: number; /** * 是否去除音频数据,可选值: <li>0:保留</li> <li>1:去除</li> */ RemoveAudio?: number; /** * 视频流配置参数。 */ VideoTemplate?: VideoTemplateInfoForUpdate; /** * 音频流配置参数。 */ AudioTemplate?: AudioTemplateInfoForUpdate; /** * 极速高清转码参数。 */ TEHDConfig?: TEHDConfigForUpdate; /** * 音视频增强参数。 */ EnhanceConfig?: EnhanceConfig; } /** * ModifyStreamLinkFlow请求参数结构体 */ export interface ModifyStreamLinkFlowRequest { /** * 流Id。 */ FlowId: string; /** * 需要修改的流名称。 */ FlowName: string; } /** * 智能精彩片段结果类型 */ export interface AiAnalysisTaskHighlightResult { /** * 任务状态,有 PROCESSING,SUCCESS 和 FAIL 三种。 */ Status?: string; /** * 错误码,0:成功,其他值:失败。 */ ErrCode?: number; /** * 错误信息。 */ Message?: string; /** * 智能精彩片段任务输入。 */ Input?: AiAnalysisTaskHighlightInput; /** * 智能精彩片段任务输出。 注意:此字段可能返回 null,表示取不到有效值。 */ Output?: AiAnalysisTaskHighlightOutput; } /** * DeleteAIAnalysisTemplate返回参数结构体 */ export interface DeleteAIAnalysisTemplateResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 查询Event的配置信息。 */ export interface DescribeEvent { /** * Event的名称。 */ EventName: string; /** * Event的Id,唯一标识一个event。 */ EventId: string; /** * Event创建时间,格式为yyyy-MM-ddTHH:mm:ssZ。 */ CreateTime: string; /** * Event的描述。 */ Description: string; /** * Event的状态信息 0:未运行 1:运行中 */ Status: number; /** * Event关联的Flow列表。 注意:此字段可能返回 null,表示取不到有效值。 */ AttachedFlowGroup: Array<DescribeFlowId>; } /** * 文字水印模板 */ export interface TextWatermarkTemplateInputForUpdate { /** * 字体类型,目前可以支持两种: <li>simkai.ttf:可以支持中文和英文;</li> <li>arial.ttf:仅支持英文。</li> */ FontType?: string; /** * 字体大小,格式:Npx,N 为数值。 */ FontSize?: string; /** * 字体颜色,格式:0xRRGGBB,默认值:0xFFFFFF(白色)。 */ FontColor?: string; /** * 文字透明度,取值范围:(0, 1] <li>0:完全透明</li> <li>1:完全不透明</li> */ FontAlpha?: number; } /** * 内容审核 Ocr 文字敏感任务输入参数类型 */ export interface AiReviewTerrorismOcrTaskInput { /** * 模板 ID。 */ Definition: number; } /** * 文本关键词识别输入。 */ export interface AiRecognitionTaskOcrWordsResultInput { /** * 文本关键词识别模板 ID。 */ Definition: number; } /** * DeleteWorkflow返回参数结构体 */ export interface DeleteWorkflowResponse { /** * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 质检异常项。 */ export interface QualityControlResult { /** * 异常类型,取值范围: Jitter:抖动, Blur:模糊, LowLighting:低光照, HighLighting:过曝, CrashScreen:花屏, BlackWhiteEdge:黑白边, SolidColorScreen:纯色屏, Noise:噪点, Mosaic:马赛克, QRCode:二维码, AppletCode:小程序码, BarCode:条形码, LowVoice:低音, HighVoice:爆音, NoVoice:静音, LowEvaluation:无参考打分低于阈值。 */ Type: string; /** * 质检结果项。 */ QualityControlItems: Array<QualityControlItem>; } /** * 内容审核鉴黄任务输入参数类型 */ export interface AiReviewPornTaskInput { /** * 鉴黄模板 ID。 注意:此字段可能返回 null,表示取不到有效值。 */ Definition: number; } /** * HDR配置 */ export interface HdrConfig { /** * 能力配置开关,可选值: <li>ON:开启;</li> <li>OFF:关闭。</li> 默认值:ON。 */ Switch?: string; /** * 类型,可选值: <li>HDR10</li> <li>HLG</li> 默认值:HDR10。 注意:video的编码方式需要为libx265; 注意:视频编码位深为10。 注意:此字段可能返回 null,表示取不到有效值。 */ Type?: string; } /** * 编排任务信息 */ export interface ScheduleTask { /** * 编排任务 ID。 */ TaskId: string; /** * 任务流状态,取值: <li>PROCESSING:处理中;</li> <li>FINISH:已完成。</li> */ Status: string; /** * 源异常时返回非0错误码,返回0 时请使用各个具体任务的 ErrCode。 */ ErrCode?: number; /** * 源异常时返回对应异常Message,否则请使用各个具体任务的 Message。 */ Message?: string; /** * 媒体处理的目标文件信息。 注意:此字段可能返回 null,表示取不到有效值。 */ InputInfo: MediaInputInfo; /** * 原始视频的元信息。 注意:此字段可能返回 null,表示取不到有效值。 */ MetaData: MediaMetaData; /** * 编排任务输出。 注意:此字段可能返回 null,表示取不到有效值。 */ ActivityResultSet: Array<ActivityResult>; } /** * CreateStreamLinkEvent请求参数结构体 */ export interface CreateStreamLinkEventRequest { /** * 事件名称。 */ EventName: string; /** * 事件描述。 */ Description?: string; } /** * CreatePersonSample请求参数结构体 */ export interface CreatePersonSampleRequest { /** * 素材名称,长度限制:20 个字符。 */ Name: string; /** * 素材应用场景,可选值: 1. Recognition:用于内容识别,等价于 Recognition.Face。 2. Review:用于不适宜内容识别,等价于 Review.Face。 3. All:包含以上全部,等价于 1+2。 */ Usages: Array<string>; /** * 素材描述,长度限制:1024 个字符。 */ Description?: string; /** * 素材图片 [Base64](https://tools.ietf.org/html/rfc4648) 编码后的字符串,仅支持 jpeg、png 图片格式。数组长度限制:5 张图片。 注意:图片必须是单人像五官较清晰的照片,像素不低于 200*200。 */ FaceContents?: Array<string>; /** * 素材标签 <li>数组长度限制:20 个标签;</li> <li>单个标签长度限制:128 个字符。</li> */ Tags?: Array<string>; } /** * 查询输出的HLS拉流URL信息。 */ export interface DescribeOutputHLSPullServerUrl { /** * HLS拉流地址的Url。 */ Url: string; } /** * DescribeStreamLinkFlowSRTStatistics请求参数结构体 */ export interface DescribeStreamLinkFlowSRTStatisticsRequest { /** * 传输流ID。 */ FlowId: string; /** * 输入或输出类型,可选[input|output]。 */ Type: string; /** * 输入或输出Id。 */ InputOutputId: string; /** * 主通道或备通道,可选[0|1]。 */ Pipeline: string; /** * 统计的开始时间,默认为前一小时,最多支持查询近7天。 UTC时间,如'2020-01-01T12:00:00Z'。 */ StartTime: string; /** * 统计的结束时间,默认为StartTime后一小时,最多支持查询24小时的数据。 UTC时间,如'2020-01-01T12:00:00Z'。 */ EndTime: string; /** * 查询间隔,可选[5s|1min|5min|15min]。 */ Period: string; } /** * 智能封面信息 */ export interface MediaAiAnalysisCoverItem { /** * 智能封面存储路径。 */ CoverPath: string; /** * 智能封面的可信度,取值范围是 0 到 100。 */ Confidence: number; } /** * 媒体处理 COS 对象信息。 */ export interface C