UNPKG

tencentcloud-sdk-nodejs

Version:
2,193 lines (2,176 loc) 221 kB
/** * DescribeAsyncTextToSpeech请求参数结构体 */ export interface DescribeAsyncTextToSpeechRequest { /** * 任务ID */ TaskId: string; } /** * ModifyCloudSliceTask返回参数结构体 */ export interface ModifyCloudSliceTaskResponse { /** * 切片任务的唯一Id,在启动切片任务成功后会返回。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCloudModeration返回参数结构体 */ export interface DescribeCloudModerationResponse { /** * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p> */ TaskId?: string; /** * <p>AI内容理解任务的状态信息。Idle:表示当前任务空闲中,InProgress:表示当前任务正在进行中,Exited:表示当前任务正在退出的过程中。</p><p>枚举值:</p><ul><li>InProgress: 进行中</li></ul> */ Status?: string; /** * <p>订阅黑白名单</p> */ SubscribeStreamUserIds?: SubscribeModerationUserIds; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StartStreamIngest返回参数结构体 */ export interface StartStreamIngestResponse { /** * 输入在线媒体流的任务 ID。任务 ID 是对一次输入在线媒体流生命周期过程的唯一标识,结束任务时会失去意义。任务 ID 需要业务保存下来,作为下次针对这个任务操作的参数。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 机器人参数 */ export interface AgentConfig { /** * 机器人的UserId,用于进房发起任务。【注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个任务时,机器人的UserId也不能相互重复,否则会中断前一个任务。需要保证机器人UserId在房间内唯一。 */ UserId: string; /** * 机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 */ UserSig: string; /** * 机器人拉流的UserId, 填写后,机器人会拉取该UserId的流进行实时处理 */ TargetUserId: string; /** * 房间内超过MaxIdleTime 没有推流,后台自动关闭任务,默认值是60s。 */ MaxIdleTime?: number; /** * 机器人的欢迎语 */ WelcomeMessage?: string; /** * 智能打断模式,默认为0,0表示服务端自动打断,1表示服务端不打断,由端上发送打断信令进行打断 */ InterruptMode?: number; /** * InterruptMode为0时使用,单位为毫秒,默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断。 */ InterruptSpeechDuration?: number; /** * 控制新一轮对话的触发方式,默认为0。 - 0表示当服务端语音识别检测出的完整一句话后,自动触发一轮新的对话。 - 1表示客户端在收到字幕消息后,自行决定是否手动发送聊天信令触发一轮新的对话。 */ TurnDetectionMode?: number; /** * 是否过滤掉用户只说了一个字的句子,true表示过滤,false表示不过滤,默认值为true */ FilterOneWord?: boolean; /** * 欢迎消息优先级,0默认,1高优,高优不能被打断。 */ WelcomeMessagePriority?: number; /** * 用于过滤LLM返回内容,不播放括号中的内容。 1:中文括号() 2:英文括号() 3:中文方括号【】 4:英文方括号[] 5:英文花括号{} 默认值为空,表示不进行过滤。 */ FilterBracketsContent?: number; /** * 环境音设置 */ AmbientSound?: AmbientSound; /** * 声纹配置 */ VoicePrint?: VoicePrint; /** * 语义断句检测 */ TurnDetection?: TurnDetection; /** * 机器人字幕显示模式。 - 0表示尽快显示,不会和音频播放进行同步。此时字幕全量下发,后面的字幕会包含前面的字幕。 - 1表示句子级别的实时显示,会和音频播放进行同步,只有当前句子对应的音频播放完后,下一条字幕才会下发。此时字幕增量下发,端上需要把前后的字幕进行拼接才是完整字幕。 */ SubtitleMode?: number; /** * 打断词列表,在AI说话期间,只有说出列表中的打断词才会打断AI说话。 注意:打断词不会触发AI回复。 */ InterruptWordList?: Array<string>; } /** * 伴生转录术语表项 */ export interface TerminologyItem { /** * <p>翻译目标语言。</p> */ TargetLang: string; /** * <p>翻译目标语言对应的翻译术语配置。</p> */ Terminology: Array<TermPair>; } /** * 直播流ai内容理解参数 */ export interface LiveModerationParams { /** * <p>AI 内容理解任务类型</p><p>枚举值:</p><ul><li>1: 音频切片理解</li><li>2: 视频截帧理解</li><li>3: 音视切片+视频截帧理解 </li></ul><p>默认值:3</p> */ ModerationType?: number; /** * <p>持续没有上行推流的状态超过MaxIdleTime的时长,自动停止切片。</p><p>取值范围:[30, 1800]</p><p>单位:秒</p><p>默认值:30</p> */ MaxIdleTime?: number; /** * <p>视频截帧间隔</p><p>取值范围:[1, 60]</p><p>单位:秒</p><p>默认值:5</p> */ SliceVideo?: number; /** * <p>音频切片时长</p><p>取值范围:[5, 60]</p><p>单位:秒</p><p>默认值:15</p> */ SliceAudio?: number; /** * <p>是否保存文件</p><p>枚举值:</p><ul><li>0: 0不保存</li><li>1: 1保存所有</li><li>2: 仅命中</li></ul><p>默认值:1</p> */ SaveModerationFile?: number; /** * <p>是否回调所有内容理解结果</p><p>枚举值:</p><ul><li>0: 回调所有结果</li><li>1: 仅回调命中结果</li></ul><p>默认值:0</p> */ CallbackAllResults?: number; } /** * CreatePicture请求参数结构体 */ export interface CreatePictureRequest { /** * 应用id */ SdkAppId: number; /** * 图片内容经base64编码后的string格式,最大长度为2M */ Content: string; /** * 图片后缀名 */ Suffix: string; /** * 图片长度 */ Height: number; /** * 图片宽度 */ Width: number; /** * 显示位置x轴方向 */ XPosition: number; /** * 显示位置y轴方向 */ YPosition: number; } /** * 指定订阅流白名单或者黑名单,音频的白名单和音频黑名单不能同时设置,视频亦然。同时实际并发订阅的媒体流路数最大支持25路流,混流场景下视频的多画面最大支持24画面。支持通过设置".*$"通配符,来前缀匹配黑白名单的UserId,注意房间里不能有和通配符规则相同的用户,否则将视为订阅具体用户,前缀规则会失效。 */ export interface SubscribeModerationUserIds { /** * 订阅音频流白名单,指定订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的音频流;["1.*$"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流,订阅列表用户数不超过32。 注意:此字段可能返回 null,表示取不到有效值。 */ SubscribeAudioUserIds?: Array<string>; /** * 订阅音频流黑名单,指定不订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的音频流;["1.*$"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流,订阅列表用户数不超过32。 注意:此字段可能返回 null,表示取不到有效值。 */ UnSubscribeAudioUserIds?: Array<string>; /** * 订阅视频流白名单,指定订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的视频流;["1.*$"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。 注意:此字段可能返回 null,表示取不到有效值。 */ SubscribeVideoUserIds?: Array<string>; /** * 订阅视频流黑名单,指定不订阅哪几个UserId的视频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的视频流;["1.*$"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流,订阅列表用户数不超过32。 注意:此字段可能返回 null,表示取不到有效值。 */ UnSubscribeVideoUserIds?: Array<string>; } /** * 音频转码参数 */ export interface AudioEncodeParams { /** * 音频采样率,取值为[48000, 44100],单位是Hz。 */ SampleRate?: number; /** * 音频声道数,取值范围[1,2],1表示音频为单声道,2表示音频为双声道。 */ Channel?: number; /** * 音频码率,取值范围[8,500],单位为kbps。 */ BitRate?: number; /** * 音量,取值范围[0,300]。默认100,表示原始音量;0表示静音。 */ Volume?: number; } /** * 服务端控制AI对话机器人播报指定文本 */ export interface ServerPushText { /** * 服务端推送播报文本 */ Text?: string; /** * 是否允许该文本打断机器人说话 */ Interrupt?: boolean; /** * 播报完文本后,是否自动关闭对话任务 */ StopAfterPlay?: boolean; /** * 服务端推送播报音频 格式说明:音频必须为单声道,采样率必须跟对应TTS的采样率保持一致,编码为Base64字符串。 输入规则:当提供Audio字段时,将不接受Text字段的输入。系统将直接播放Audio字段中的音频内容。 */ Audio?: string; /** * 默认为0,仅在Interrupt为false时有效 - 0表示当前有交互发生时,会丢弃Interrupt为false的消息 - 1表示当前有交互发生时,不会丢弃Interrupt为false的消息,而是缓存下来,等待当前交互结束后,再去处理 注意:DropMode为1时,允许缓存多个消息,如果后续出现了打断,缓存的消息会被清空 */ DropMode?: number; /** * ServerPushText消息的优先级,0表示可被打断,1表示不会被打断。**目前仅支持传入0,如果需要传入1,请提工单联系我们添加权限。** 注意:在接收到Priority=1的消息后,后续其他任何消息都会被忽略(包括Priority=1的消息),直到Priority=1的消息处理结束。该字段可与Interrupt、DropMode字段配合使用。 例子: - Priority=1、Interrupt=true,会打断现有交互,立刻播报,播报过程中不会被打断 - Priority=1、Interrupt=false、DropMode=1,会等待当前交互结束,再进行播报,播报过程中不会被打断 */ Priority?: number; /** * 是否将文本加入到llm历史上下文中 */ AddHistory?: boolean; /** * 如果填写,会和字幕绑定发送到端上,注意确保内容为json字符串 */ MetaInfo?: string; } /** * 转推录制参数 */ export interface McuRecordParams { /** * 转推录制模式, 0/不填: 暂不支持,行为未定义; 1: 不开启录制; 2: 开启录制(使用控制台自动录制模板参数,参考:[跳转文档](https://cloud.tencent.com/document/product/647/111748#.E5.BD.95.E5.88.B6.E6.8E.A7.E5.88.B6.E6.96.B9.E6.A1.88)); 3: 开启录制(使用API指定参数)。 */ UniRecord?: number; /** * 录制任务 key,标识一个录制任务;您可以通过该参数,将多个转推任务录制成一个文件。不指定该参数时,只录制当前转推任务。 【限制长度为128字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线(_)和连词符(-)】 */ RecordKey?: string; /** * 【仅当UniRecord=3时此参数有效】 续录等待时间,对应录制模板“续录等待时长”,单位:秒。该值需大于等于 5,且小于等于 86400(24小时),默认值为 30。启用续录时,录制任务空闲超过RecordWaitTime的时长,自动结束。 */ RecordWaitTime?: number; /** * 【仅当UniRecord=3时此参数有效】 录制输出文件格式列表,对应录制模板“文件格式”,支持“hls”、"mp4"、"aac"三种格式,默认值为"mp4"。其中"mp4"和"aac"格式,不能同时指定。 只录制 mp4格式,示例值:["mp4"]。同时录制mp4 和 HLS 格式,示例值:["mp4","hls"]。 */ RecordFormat?: Array<string>; /** * 【仅当UniRecord=3时此参数有效】 单个文件录制时长,对应录制模板“单个录制文件时长”,单位:分钟。该值需大于等于 1,且小于等于 1440(24小时),默认值为 1440。只对"mp4"或"aac"格式生效。实际单文件录制时长还受单文件大小不超过 2G 限制,超过2G则强制拆分。 */ MaxMediaFileDuration?: number; /** * 【仅当UniRecord=3时此参数有效】 录制的音视频类型,对应录制模板“录制格式”,0:音视频,1:纯音频,2:纯视频。最终录制文件内容是录制指定类型和转推内容的交集。 */ StreamType?: number; /** * 录制文件名前缀,不超过64字符。只有存储为vod时生效。 【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线(_)和连词符(-)】 */ UserDefineRecordPrefix?: string; /** * 【仅当UniRecord=3时此参数有效】 录制文件存储参数,对应控制台“存储位置”及相关参数。目前支持云点播VOD和对象存储COS两种存储方式,只能填写一种。 */ McuStorageParams?: McuStorageParams; } /** * 用户自定义混流布局参数列表。 */ export interface MixLayout { /** * 画布上该画面左上角的 y 轴坐标,取值范围 [0, 1920],不能超过画布的高。 */ Top: number; /** * 画布上该画面左上角的 x 轴坐标,取值范围 [0, 1920],不能超过画布的宽。 */ Left: number; /** * 画布上该画面宽度的相对值,取值范围 [0, 1920],与Left相加不应超过画布的宽。 */ Width: number; /** * 画布上该画面高度的相对值,取值范围 [0, 1920],与Top相加不应超过画布的高。 */ Height: number; /** * 字符串内容为待显示在该画面的主播对应的UserId,如果不指定,会按照主播加入房间的顺序匹配。 */ UserId?: string; /** * 画布的透明度值,取值范围[0, 255]。0表示不透明,255表示全透明。默认值为0。 */ Alpha?: number; /** * 0 :拉伸模式,这个模式下整个视频内容会全部显示,并填满子画面,在源视频和目的视频宽高比不一致的时候,画面不会缺少内容,但是画面可能产生形变; 1 :剪裁模式(默认),这个模式下会严格按照目的视频的宽高比对源视频剪裁之后再拉伸,并填满子画面画布,在源视频和目的视频宽高比不一致的时候,画面保持不变形,但是会被剪裁; 2 :填黑模式,这个模式下会严格保持源视频的宽高比进行等比缩放,在源视频和目的视频宽高比不一致的时候,画面的上下侧边缘或者左右侧边缘会露出子画面画布的背景; 3 :智能拉伸模式,这个模式类似剪裁模式,区别是在源视频和目的视频宽高比不一致的时候,限制了最大剪裁比例为画面的宽度或者高度的20%; */ RenderMode?: number; /** * 对应订阅流的主辅路标识: 0:主流(默认); 1:辅流; */ MediaId?: number; /** * 该画布的图层顺序, 这个值越小表示图层越靠后。默认值为0。 */ ImageLayer?: number; /** * 图片的url地址, 只支持jpg, png, jpeg,图片分辨率限制不超过2K,图片大小限制不超过5MB。注意,url必须携带格式后缀,url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '=' */ SubBackgroundImage?: string; } /** * 混流转推的视频相关参数。 */ export interface McuVideoParams { /** * 输出流视频编码参数。 */ VideoEncode?: VideoEncode; /** * 混流布局参数。 */ LayoutParams?: McuLayoutParams; /** * 整个画布背景颜色,常用的颜色有: 红色:0xcc0033。 黄色:0xcc9900。 绿色:0xcccc33。 蓝色:0x99CCFF。 黑色:0x000000。 白色:0xFFFFFF。 灰色:0x999999。 */ BackGroundColor?: string; /** * 整个画布的背景图片url,优先级高于BackGroundColor。支持png、jpg、jpeg格式。图片分辨率限制不超过2K,图片大小限制不超过5MB。 注: 1,您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,背景图片将不会生效。 2,url可支持字符集:【'0-9','a-z','A-Z','-', '.', '_', '~', ':', '/', '?', '#', '[', ']','@', '!', '&', '(', ')', '*', '+', ',', '%', '=', ';', '|'】,您需要确保url字符在可支持字符集内,若存在可支持字符集外的字符,背景图片将不会生效。 */ BackgroundImageUrl?: string; /** * 混流布局的水印参数。 */ WaterMarkList?: Array<McuWaterMarkParams>; /** * 背景图在输出时的显示模式:0为裁剪,1为缩放并显示黑底,2为变比例伸缩。后台默认为变比例伸缩。 */ BackgroundRenderMode?: number; } /** * DescribeTRTCRealTimeScaleData请求参数结构体 */ export interface DescribeTRTCRealTimeScaleDataRequest { /** * 用户SdkAppId(如:1400xxxxxx) */ SdkAppId: string; /** * 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) */ StartTime: number; /** * 结束时间,unix时间戳,单位:秒 */ EndTime: number; /** * 房间ID */ RoomId?: string; } /** * StartAIConversation返回参数结构体 */ export interface StartAIConversationResponse { /** * 用于唯一标识对话任务。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 语音转文字参数 */ export interface STTConfig { /** * 语音转文字支持识别的语言,默认是"zh" 中文 可通过购买「AI智能识别时长包」解锁或领取包月套餐体验版解锁不同语言. 详细说明参考:[AI智能识别计费说明](https://cloud.tencent.com/document/product/647/111976) 语音转文本不同套餐版本支持的语言如下: **基础语言引擎**: - "zh": 中文(简体) - "zh-TW": 中文(繁体) - "en": 英语 - "16k_zh_edu":中文教育 - "16k_zh_medical":中文医疗 - "16k_zh_court":中文法庭 **标准语言引擎:** - "8k_zh_large": 普方大模型引擎. 当前模型同时支持中文等语言的识别,模型参数量极大,语言模型性能增强,针对电话音频中各类场景、各类中文方言的识别准确率极大提升. - "16k_zh_large": 普方英大模型引擎. 当前模型同时支持中文、英文、多种中文方言等语言的识别,模型参数量极大,语言模型性能增强,针对噪声大、回音大、人声小、人声远等低质量音频的识别准确率极大提升. - "16k_multi_lang": 多语种大模型引擎. 当前模型同时支持英语、日语、韩语、阿拉伯语、菲律宾语、法语、印地语、印尼语、马来语、葡萄牙语、西班牙语、泰语、土耳其语、越南语、德语的识别,可实现15个语种的自动识别(句子/段落级别). - "16k_zh_en": 中英大模型引擎. 当前模型同时支持中文、英语识别,模型参数量极大,语言模型性能增强,针对噪声大、回音大、人声小、人声远等低质量音频的识别准确率极大提升. **高级语言引擎:** - "zh-dialect": 中国方言 - "zh-yue": 中国粤语 - "vi": 越南语 - "ja": 日语 - "ko": 韩语 - "id": 印度尼西亚语 - "th": 泰语 - "pt": 葡萄牙语 - "tr": 土耳其语 - "ar": 阿拉伯语 - "es": 西班牙语 - "hi": 印地语 - "fr": 法语 - "ms": 马来语 - "fil": 菲律宾语 - "de": 德语 - "it": 意大利语 - "ru": 俄语 - "sv": 瑞典语 - "da": 丹麦语 - "no": 挪威语 **注意:** 如果缺少满足您需求的语言,请联系我们技术人员。 */ Language?: string; /** * **发起模糊识别为高级版能力,默认按照高级版收费** 注意:不支持填写"zh-dialect", "16k_zh_edu", "16k_zh_medical", "16k_zh_court", "8k_zh_large", "16k_zh_large","16k_multi_lang", "16k_zh_en" */ AlternativeLanguage?: Array<string>; /** * 自定义参数,联系后台使用 */ CustomParam?: string; /** * 语音识别vad的时间,范围为240-2000,默认为1000,单位为ms。更小的值会让语音识别分句更快。 */ VadSilenceTime?: number; /** * 热词表:该参数用于提升识别准确率。 单个热词限制:"热词|权重",单个热词不超过30个字符(最多10个汉字),权重[1-11]或者100,如:“腾讯云|5” 或 “ASR|11”; 热词表限制:多个热词用英文逗号分割,最多支持128个热词,如:“腾讯云|10,语音识别|5,ASR|11”; */ HotWordList?: string; /** * vad的远场人声抑制能力(不会对asr识别效果造成影响),范围为[0, 5],默认为0,表示不开启远场人声抑制能力。推荐设置为2,有较好的远场人声抑制能力。嘈杂的办公室环境下可以设置为3,更为嘈杂的环境下可以使用4和5。注意较高的VadLevel可能会将单字当作噪声给过滤。 */ VadLevel?: number; } /** * TTS的声音参数配置 */ export interface Voice { /** * <p>音色 ID,可从音色列表获取,或使用声音克隆生成的自定义音色 ID</p> */ VoiceId: string; /** * <p>语速调节,0.5 为半速慢放,2.0 为两倍速快放,1.0 为正常语速,区间:[0.5, 2.0],默认1.0</p> */ Speed?: number; /** * <p>音量调节,默认1.0,10 为最大音量,建议保持默认值 1.0,区间:(0, 10]</p> */ Volume?: number; /** * <p>音高调节,负值声音更低沉,正值声音更尖锐,0 为原始音高,区间 [-12, 12], 默认0</p> */ Pitch?: number; /** * <p>情绪控制,目前仅flow_01_ex模型支持</p><p>枚举值:</p><ul><li>happy: 高兴</li><li>sad: 悲伤</li><li>angry: 愤怒</li><li>fearful: 害怕</li><li>disgusted: 厌恶</li><li>surprised: 惊讶</li><li>calm: 中性</li><li>fluent: 生动</li><li>whisper: 低语</li></ul> */ Emotion?: string; } /** * DescribeTRTCMarketScaleData请求参数结构体 */ export interface DescribeTRTCMarketScaleDataRequest { /** * 用户SdkAppId */ SdkAppId: string; /** * 查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天) */ StartTime: string; /** * 查询结束时间,格式为YYYY-MM-DD。 */ EndTime: string; /** * 返回数据的粒度,支持设为以下值: d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。 h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。 */ Period: string; } /** * 音量布局SEI参数,可以自定义AppData和PayloadType类型。 该参数内容可以为空,表示携带默认的音量布局SEI。 */ export interface McuLayoutVolume { /** * AppData的内容,会被写入自定义SEI中的app_data字段,长度需小于4096。 */ AppData?: string; /** * SEI消息的payload_type,默认值100,取值范围100-254(244除外,244为我们内部自定义的时间戳SEI) */ PayloadType?: number; /** * SEI发送间隔,单位毫秒,默认值为1000。 */ Interval?: number; /** * 取值范围[0,1],填1:发送关键帧时会确保带SEI;填0:发送关键帧时不确保带SEI。默认值为0。 */ FollowIdr?: number; } /** * VoiceClone请求参数结构体 */ export interface VoiceCloneRequest { /** * <p>TRTC的SdkAppId</p> */ SdkAppId: number; /** * <p>声音克隆的名称, 只允许使用数字、字母、下划线,不能超过36位</p> */ VoiceName: string; /** * <p>声音克隆的参考音频,base64字符串,支持wav、mp3、m4a格式,长度在6秒~180秒之间</p> */ PromptAudio: string; /** * <p>TTS的API密钥</p> * @deprecated */ APIKey?: string; /** * <p>声音克隆的参考文本,为参考音频对应的文字。</p> */ PromptText?: string; /** * <p>TTS的模型,支持flow_02_turbo,flow_01_ex,默认为flow_02_turbo</p><p>枚举值:</p><ul><li>flow_02_turbo: 高性价比模型,兼顾效果和成本</li><li>flow_01_ex: 高天花板模型,能力全面,在音色克隆上表现更优</li></ul> */ Model?: string; /** * <p>需要合成的语言,默认为空,表示自动识别</p><p>flow_02_turbo支持以下语言:</p><ul><li>zh:中文</li><li>en:英文</li><li>ja:日语</li><li>ko:韩语</li><li>yue:粤语</li><li>ms:马来语</li><li>ar:阿拉伯语</li><li>id:印尼语</li><li>th:泰语</li><li>vi:越南语</li></ul><p>flow_01_ex支持以下语言:</p><ul><li>zh:中文(简体) (Chinese Simplified)</li><li>zh-tw:中文(繁体) (Chinese Traditional)</li><li>en:英语 (English)</li><li>ja:日语 (Japanese)</li><li>ko:韩语 (Korean)</li><li>ms:马来语 (Malay)</li><li>yue:粤语 (Cantonese)</li><li>ar:阿拉伯语 (Arabic)</li><li>ru:俄语 (Russian)</li><li>es:西班牙语 (Spanish)</li><li>fr:法语 (French)</li><li>pt:葡萄牙语 (Portuguese)</li><li>de:德语 (German)</li><li>tr:土耳其语 (Turkish)</li><li>nl:荷兰语 (Dutch)</li><li>uk:乌克兰语 (Ukrainian)</li><li>vi:越南语 (Vietnamese)</li><li>id:印尼语 (Indonesian)</li><li>it:意大利语 (Italian)</li><li>th:泰语 (Thai)</li><li>pl:波兰语 (Polish)</li><li>ro:罗马尼亚语 (Romanian)</li><li>el:希腊语 (Greek)</li><li>cs:捷克语 (Czech)</li><li>fi:芬兰语 (Finnish)</li><li>hi:印地语 (Hindi)</li><li>bg:保加利亚语 (Bulgarian)</li><li>da:丹麦语 (Danish)</li><li>he:希伯来语 (Hebrew)</li><li>fa:波斯语(法尔西语) (Persian)</li><li>sk:斯洛伐克语 (Slovak)</li><li>sv:瑞典语 (Swedish)</li><li>hr:克罗地亚语 (Croatian)</li><li>tl:菲律宾语(他加禄语) (Filipino)</li><li>hu:匈牙利语 (Hungarian)</li><li>no:挪威语 (Norwegian)</li><li>sl:斯洛文尼亚语 (Slovenian)</li><li>ca:加泰罗尼亚语 (Catalan)</li><li>nn:新挪威语 (Nynorsk)</li><li>ta:泰米尔语 (Tamil)</li><li>af:南非荷兰语 (Afrikaans)</li></ul> */ Language?: string; } /** * 云端切片的控制参数。 */ export interface SliceParams { /** * 切片任务类型: 1:音频切片; 2:视频截帧; 3:音视切片+视频截帧 示例值:1 */ SliceType?: number; /** * 房间内持续没有主播的状态超过MaxIdleTime的时长,自动停止录制,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。 示例值:30 */ MaxIdleTime?: number; /** * 音频切片时长,默认15s 示例值:15 取值范围15-60s */ SliceAudio?: number; /** * 视频截帧间隔时长,默认5s, 示例值:5 取值范围5-60s */ SliceVideo?: number; /** * 指定订阅流白名单或者黑名单。 */ SubscribeStreamUserIds?: SubscribeStreamUserIds; /** * 知道图片格式类型: 0 png, 1 jpg默认0 */ SliceImageType?: number; /** * 已废弃,从控制台配置回调url */ SliceCallbackUrl?: string; } /** * DescribeUserEvent请求参数结构体 */ export interface DescribeUserEventRequest { /** * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。 */ CommId: string; /** * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) 注意:支持查询14天内的数据 */ StartTime: number; /** * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) 注意:查询时间大于房间结束时间,以房间结束时间为准。 */ EndTime: number; /** * 用户UserId */ UserId: string; /** * 房间号(如:223) */ RoomId: string; /** * 用户SdkAppId(如:1400xxxxxx) */ SdkAppId: number; } /** * DeleteCloudModeration请求参数结构体 */ export interface DeleteCloudModerationRequest { /** * <p>TRTC的SDKAppId,和TRTC的房间所对应的SDKAppId相同。</p> */ SdkAppId: number; /** * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p> */ TaskId: string; } /** * CreateLiveStreamModeration请求参数结构体 */ export interface CreateLiveStreamModerationRequest { /** * <p>TRTC的<a href="https://cloud.tencent.com/document/product/647/46351#sdkappid">SdkAppId</a>。</p> */ SdkAppId: number; /** * <p>直播流输入源</p> */ Input: Input; /** * <p>直播流ai理解审核参数</p> */ LiveModerationParams: LiveModerationParams; /** * <p>业务自定义唯一标识,原样透传到回调</p><p>入参限制:长度限制60字符</p> */ DataId: string; /** * <p>额外信息透传结构体(房间/主播/业务自定义),原样回带到回调</p> */ SourceInfo?: SourceInfo; /** * <p>直播流ai理解转存文件存储参数</p> */ LiveModerationStorageParams?: LiveModerationStorageParams; /** * <p>单路任务最大的生命周期</p><p>取值范围:[1, 72]</p><p>单位:小时</p><p>默认值:48</p> */ ResourceExpiredHour?: number; } /** * 混流自定义渲染参数 */ export interface McuBackgroundCustomRender { /** * 自定义渲染画面的宽度,单位为像素值,需大于0,且不能超过子布局的宽。 */ Width: number; /** * 自定义渲染画面的高度,单位为像素值,需大于0,且不能超过子布局的高。 */ Height: number; /** * 自定义渲染画面的圆角半径,单位为像素值,不能超过渲染画面Width和Height最小值的一半,不指定默认为0,表示直角。 */ Radius?: number; } /** * AsyncTextToSpeech请求参数结构体 */ export interface AsyncTextToSpeechRequest { /** * <p>需要转语音的文字内容,最大允许50000字符,注意 1汉字=2字符</p> */ Text: string; /** * <p>文本转语音的声音配置</p> */ Voice: Voice; /** * <p>TRTC的SdkAppId</p> */ SdkAppId: number; /** * <p>文本转语音的输出音频的格式</p> */ AudioFormat?: AudioFormat; /** * <p>TTS的模型,当前固定为:flow_02_turbo</p><p>枚举值:</p><ul><li>flow_02_turbo: flow_02_turbo</li></ul> */ Model?: string; /** * <p>多音字/生僻字发音纠正词典条目。指定特定词语在本次请求中使用的发音。</p> */ PronunciationDict?: Array<PronunciationDict>; /** * <p>默认为0,0表示不生成字幕,1表示生成字幕</p> */ AlignmentMode?: number; /** * <p>需要合成的语言,默认为空,表示自动识别</p><p>枚举值:</p><ul><li>zh: 中文</li><li>en: 英文</li><li>ja: 日语</li><li>ko: 韩语</li><li>yue: 粤语</li><li>ms: 马来语</li><li>ar: 阿拉伯语</li><li>id: 印尼语</li><li>th: 泰语</li><li>vi: 越南语</li></ul> */ LanguageCode?: string; } /** * DescribeTrtcRoomUsage返回参数结构体 */ export interface DescribeTrtcRoomUsageResponse { /** * 房间维度用量数据,csv文件格式,单位:秒。 */ Data?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TRTC数据大盘/实时监控 API接口数据出参 */ export interface TRTCDataResp { /** * StatementID值,监控仪表盘下固定为0。 注意:此字段可能返回 null,表示取不到有效值。 */ StatementID: number; /** * 查询结果数据,以Columns-Values形式返回。 注意:此字段可能返回 null,表示取不到有效值。 */ Series: Array<SeriesInfo>; /** * Total值,监控仪表盘功能下固定为1。 注意:此字段可能返回 null,表示取不到有效值。 */ Total: number; } /** * RegisterVoicePrint请求参数结构体 */ export interface RegisterVoicePrintRequest { /** * 整个wav音频文件的base64字符串,其中wav文件限定为16k采样率, 16bit位深, 单声道, 8到18秒音频时长,有效音频不小于6秒(不能有太多静音段),编码数据大小不超过2M */ Audio: string; /** * 毫秒时间戳 */ ReqTimestamp: number; /** * 音频格式,目前只支持0,代表wav */ AudioFormat: number; /** * 音频名称,长度不要超过32 */ AudioName: string; /** * 和声纹绑定的MetaInfo,长度最大不超过512 */ AudioMetaInfo?: string; } /** * 转录用户信息 */ export interface TranscriptionUserInfoParams { /** * 用户ID。 */ UserId: string; } /** * 造成异常体验可能的异常事件类型 */ export interface AbnormalEvent { /** * 异常事件ID,具体值查看附录:异常体验ID映射表:https://cloud.tencent.com/document/product/647/44916 */ AbnormalEventId?: number; /** * 远端用户ID,"":表示异常事件不是由远端用户产生 */ PeerId?: string; } /** * DeleteCloudSliceTask请求参数结构体 */ export interface DeleteCloudSliceTaskRequest { /** * TRTC的SDKAppId,和TRTC的房间所对应的SDKAppId相同。 */ SdkAppId: number; /** * 切片任务的唯一Id,在启动切片任务成功后会返回。 */ TaskId: string; } /** * 历史规模信息 */ export interface ScaleInfomation { /** * 每天开始的时间 */ Time?: number; /** * 房间人数,用户重复进入同一个房间为1次 */ UserNumber?: number; /** * 房间人次,用户每次进入房间为一次 */ UserCount?: number; /** * sdkappid下一天内的房间数 */ RoomNumbers?: number; } /** * 转推服务加入TRTC房间的机器人参数。 */ export interface AgentParams { /** * 转推服务在TRTC房间使用的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。 */ UserId: string; /** * 转推服务加入TRTC房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 */ UserSig?: string; /** * 所有参与混流转推的主播持续离开TRTC房间或切换成观众超过MaxIdleTime的时长,自动停止转推,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。 */ MaxIdleTime?: number; } /** * ControlAIConversation返回参数结构体 */ export interface ControlAIConversationResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopAIConversation请求参数结构体 */ export interface StopAIConversationRequest { /** * 唯一标识任务。 */ TaskId: string; } /** * 视频转码参数 */ export interface VideoEncodeParams { /** * 宽。取值范围[0,1920],单位为像素值。 */ Width?: number; /** * 高。取值范围[0,1080],单位为像素值。 */ Height?: number; /** * 帧率。取值范围[1,60],表示帧率可选范围为1到60fps。 */ Fps?: number; /** * 码率。取值范围[1,10000],单位为kbps。 */ BitRate?: number; /** * gop。取值范围[1,2],单位为秒。 */ Gop?: number; } /** * UpdateAIConversation返回参数结构体 */ export interface UpdateAIConversationResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserEvent返回参数结构体 */ export interface DescribeUserEventResponse { /** * 返回的事件列表,若没有数据,会返回空数组。 */ Data: Array<EventList>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 视频编码参数。 */ export interface VideoEncode { /** * 输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。 */ Width: number; /** * 输出流高,音视频输出时必填。取值范围[0,1920],单位为像素值。 */ Height: number; /** * 输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。 */ Fps: number; /** * 输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。 */ BitRate: number; /** * 输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。 */ Gop: number; } /** * DescribeCloudRecording返回参数结构体 */ export interface DescribeCloudRecordingResponse { /** * 录制任务的唯一Id。 */ TaskId?: string; /** * 云端录制任务的状态信息。 Idle:表示当前录制任务空闲中 InProgress:表示当前录制任务正在进行中。 Exited:表示当前录制任务正在退出的过程中。 */ Status?: string; /** * 录制文件信息。 */ StorageFileList?: Array<StorageFile>; /** * 转推录制任务发起时所填,标识一次录制 */ RecorderKey?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopMCUMixTranscodeByStrRoomId返回参数结构体 */ export interface StopMCUMixTranscodeByStrRoomIdResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 图片列表信息 */ export interface PictureInfo { /** * 图片长度 */ Height?: number; /** * 图片宽度 */ Width?: number; /** * 显示位置x轴方向 */ XPosition?: number; /** * 显示位置y轴方向 */ YPosition?: number; /** * 应用id */ SdkAppId?: number; /** * 图片id */ PictureId?: number; } /** * DescribeCallDetailInfo请求参数结构体 */ export interface DescribeCallDetailInfoRequest { /** * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。 */ CommId: string; /** * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777), 注意:支持查询14天内的数据。 */ StartTime: number; /** * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) 注意:查询起止时间需小于1小时,超过则返回null,即与StartTime间隔时间不超过1小时。 */ EndTime: number; /** * 用户SdkAppId(如:1400xxxxxx)。 */ SdkAppId: number; /** * 需查询的用户数组,默认不填返回6个用户。 */ UserIds?: Array<string>; /** * 需查询的指标,不填则只返回用户列表,填all则返回所有指标。 appCpu:APP CPU使用率; sysCpu:系统 CPU使用率; aBit:上/下行音频码率;单位:bps aBlock:音频卡顿时长;单位:ms bigvBit:上/下行视频码率;单位:bps bigvCapFps:视频采集帧率; bigvEncFps:视频发送帧率; bigvDecFps:渲染帧率; bigvBlock:视频卡顿时长;单位:ms aLoss:上/下行音频丢包率; bigvLoss:上/下行视频丢包率; bigvWidth:上/下行分辨率宽; bigvHeight:上/下行分辨率高; aCapEnergy:音频采集能量; aPlayEnergy:音频播放能量; rtt:SDK到云端的往返延时;单位: ms bigvRecFps: 云端送达帧率; */ DataType?: Array<string>; /** * 当前页数,默认为0, 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。 */ PageNumber?: number; /** * 每页个数,默认为6, 范围:[1,100] 注意:DataType不为null,UserIds长度不能超过6,PageSize最大值不超过6; DataType 为null,UserIds长度不超过100,PageSize最大不超过100。 */ PageSize?: number; } /** * CreateCloudModeration返回参数结构体 */ export interface CreateCloudModerationResponse { /** * <p>AI 内容理解服务分配的任务ID。任务ID是对一次切片任务生命周期过程的唯一标识,结束任务时会失去意义。任务ID需要业务保存下来,作为下次针对这个任务操作的参数</p> */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTRTCSegmentModerationUsage请求参数结构体 */ export interface DescribeTRTCSegmentModerationUsageRequest { /** * 查询开始时间,格式为YYYY-MM-DD HH:mm:ss。 */ StartTime: string; /** * 查询结束时间,格式为YYYY-MM-DD HH:mm:ss。单次查询统计区间最多不能超过31天。 */ EndTime: string; /** * 媒体类型,枚举值:audio(音频)、picture(图片) */ Type: string; /** * 使用场景(业务类型),枚举值:0 = AI 内容理解(审核场景)、1 = 音视频切片(云端切片场景) */ Business: number; /** * 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。 */ SdkAppId?: number; } /** * DescribeTRTCMarketScaleData返回参数结构体 */ export interface DescribeTRTCMarketScaleDataResponse { /** * TRTC监控数据出参 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: TRTCDataResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 翻译相关配置 */ export interface TranslationConfig { /** * 翻译的目标语言,目标语种列表(ISO 639-1) */ TargetLanguages: Array<string>; /** * 1: 仅文字翻译, 2: 语音同传 */ Mode?: number; /** * 语音同传配置,开启同传时,需要传递 */ TTSConfig?: TTSConfig; /** * 翻译术语集合 */ Terminology?: Array<Terminology>; } /** * Mcu转推录制,腾讯云点播相关参数。 */ export interface McuTencentVod { /** * 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。 */ Procedure?: string; /** * 媒体文件过期时间,为当前时间的绝对过期时间;保存一天,就填"86400",永久保存就填"0",默认永久保存。 */ ExpireTime?: number; /** * 指定上传园区,仅适用于对上传地域有特殊需求的用户。 */ StorageRegion?: string; /** * 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。 默认值:0,表示其他分类。 */ ClassId?: number; /** * 点播 子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。 */ SubAppId?: number; /** * 任务流上下文,任务完成回调时透传。 */ SessionContext?: string; /** * 上传上下文,上传完成回调时透传。 */ SourceContext?: string; } /** * RegisterVoicePrint返回参数结构体 */ export interface RegisterVoicePrintResponse { /** * 声纹信息ID */ VoicePrintId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 额外信息透传结构体(房间/主播/业务自定义),原样回带到回调 */ export interface SourceInfo { /** * <p>直播间 ID(用于结果透传与去重;数字房间号也用 string 传)</p> */ RoomId?: string; /** * <p>房间号类型</p><p>枚举值:</p><ul><li>0: 字符串房间号</li><li>1: 数字房间号</li></ul> */ RoomIdType?: number; /** * <p>主播/被审核方 ID</p> */ UserId?: string; } /** * ModifyPicture请求参数结构体 */ export interface ModifyPictureRequest { /** * 图片id */ PictureId: number; /** * 应用id */ SdkAppId: number; /** * 图片长度 */ Height?: number; /** * 图片宽度 */ Width?: number; /** * 显示位置x轴方向 */ XPosition?: number; /** * 显示位置y轴方向 */ YPosition?: number; } /** * 页面录制控制参数 */ export interface WebRecordVideoParams { /** * 录制画面宽度,默认为1280,取值范围[0, 1920] */ Width?: number; /** * 录制画面高度,默认为720,取值范围[0, 1080] */ Height?: number; /** * 指定输出格式,可选hls,mp4。存储到云点播VOD时此参数无效,存储到VOD时请通过TencentVod(https://cloud.tencent.com/document/api/647/44055#TencentVod)内的MediaType设置。 */ Format?: string; /** * 如果是aac或者mp4文件格式,超过长度限制后,系统会自动拆分视频文件。单位:分钟。默认为1440min(24h),取值范围为1-1440。【单文件限制最大为2G,满足文件大小 >2G 或录制时长度 > 24h任意一个条件,文件都会自动切分】 Hls 格式录制此参数不生效。 示例值:1440 */ MaxMediaFileDuration?: number; } /** * DescribeWebRecord返回参数结构体 */ export interface DescribeWebRecordResponse { /** * 1: 正在录制中 */ Status?: number; /** * 在使用RecordId查询时返回 */ TaskId?: string; /** * 在使用TaskId查询时返回 */ RecordId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCloudTranscription返回参数结构体 */ export interface DescribeCloudTranscriptionResponse { /** * 任务开始时间。 */ StartTime?: number; /** * 转录任务状态。Idle:表示当前转录任务空闲中 InProgress:表示当前转录任务正在进行中。 Exited:表示当前转录任务正在退出的过程中。 */ Status?: string; /** * 转录任务的唯一Id。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserInfo请求参数结构体 */ export interface DescribeUserInfoRequest { /** * 通话 ID(唯一标识一次通话): SdkAppId_RoomId(房间号)_ CreateTime(房间创建时间,unix时间戳,单位为s)例:1400xxxxxx_218695_1590065777。通过 DescribeRoomInfo(查询历史房间列表)接口获取([查询历史房间列表](https://cloud.tencent.com/document/product/647/44050))。 */ CommId: string; /** * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)注意:最大支持查询14天内的数据 */ StartTime: number; /** * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) 注意:与StartTime间隔时间不超过4小时。 */ EndTime: number; /** * 用户SdkAppId(如:1400xxxxxx) */ SdkAppId: number; /** * 需查询的用户数组,不填默认返回6个用户 范围:[1,100]。 */ UserIds?: Array<string>; /** * 当前页数,默认为0, 注意:PageNumber和PageSize 其中一个不填均默认返回6条数据。 */ PageNumber?: number; /** * 每页个数,默认为6, 范围:[1,100]。 */ PageSize?: number; } /** * DeleteCloudModeration返回参数结构体 */ export interface DeleteCloudModerationResponse { /** * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p> */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRelayUsage请求参数结构体 */ export interface DescribeRelayUsageRequest { /** * 查询开始时间,格式为YYYY-MM-DD。 */ StartTime: string; /** * 查询结束时间,格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。 */ EndTime: string; /** * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 */ SdkAppId?: number; } /** * DismissRoom返回参数结构体 */ export interface DismissRoomResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * MCU混流水印参数 */ export interface WaterMarkParams { /** * 混流-水印图片ID。取值为实时音视频控制台上传的图片ID。 */ WaterMarkId: number; /** * 混流-水印宽。单位为像素值。水印宽+X偏移不能超过整个画布宽。 */ WaterMarkWidth: number; /** * 混流-水印高。单位为像素值。水印高+Y偏移不能超过整个画布高。 */ WaterMarkHeight: number; /** * 水印在输出时的X偏移。单位为像素值。水印宽+X偏移不能超过整个画布宽。 */ LocationX: number; /** * 水印在输出时的Y偏移。单位为像素值。水印高+Y偏移不能超过整个画布高。 */ LocationY: number; /** * 混流-水印图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。WaterMarkUrl和WaterMarkId参数都填时,以WaterMarkUrl为准。图片大小限制不超过2MB。 */ WaterMarkUrl?: string; } /** * DescribeRecordStatistic返回参数结构体 */ export interface DescribeRecordStatisticResponse { /** * 应用的用量信息数组。 */ SdkAppIdUsages: Array<SdkAppIdRecordUsage>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveStreamModeration返回参数结构体 */ export interface DescribeLiveStreamModerationResponse { /** * <p>AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。</p> */ TaskId?: string; /** * <p>AI内容理解任务的状态信息。Idle:表示当前任务空闲中,InProgress:表示当前任务正在进行中,Exited:表示当前任务正在退出的过程中。</p><p>枚举值:</p><ul><li>InProgress: 进行中</li></ul> */ Status?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteVoicePrint请求参数结构体 */ export interface DeleteVoicePrintRequest { /** * 声纹信息ID */ VoicePrintId: string; } /** * DescribeAsyncTextToSpeech返回参数结构体 */ export interface DescribeAsyncTextToSpeechResponse { /** * 任务状态 - Processing,处理中 - Success,任务成功 - Failed,任务失败 - Expired,任务过期 */ Status?: string; /** * 音频下载url */ AudioDownloadUrl?: string; /** * 字幕下载url */ SubtitleDownloadUrl?: string; /** * 音频时长 */ TotalDurationMs?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 翻译相关的参数 */ export interface TranslationParam { /** * <p>翻译的目标语言,示例值[&quot;en&quot;, &quot;ja&quot;]。目标语种列表[中文 &quot;zh&quot;,英语 &quot;en&quot;,粤语&quot;yue&quot;,越南语 &quot;vi&quot;,日语 &quot;ja&quot;,韩语 &quot;ko&quot;,印度尼西亚语 &quot;id&quot;,泰语 &quot;th&quot;,葡萄牙语 &quot;pt&quot;,阿拉伯语 &quot;ar&quot;,西班牙语 &quot;es&quot;,法语 &quot;fr&quot;,马来语 &quot;ms&quot;,德语 &quot;de&quot;,意大利语 &quot;it&quot;,俄语 &quot;ru&quot;]。</p> */ TargetLang?: Array<string>; /** * <p>翻译术语表配置。</p> */ Terminologies?: Array<TerminologyItem>; } /** * 腾讯云对象存储COS以及第三方云存储的账号信息 */ export interface CloudStorage { /** * <p>腾讯云对象存储COS以及第三方云存储账号信息<br>0:腾讯云对象存储 COS<br>1:AWS<br>【注意】目前第三方云存储仅支持AWS,更多第三方云存储陆续支持中</p> */ Vendor: number; /** * <p>腾讯云对象存储的[地域信息](https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F)。<br>示例值:cn-shanghai-1</p><p>AWS S3[地域信息](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions)</p> */ Region: string; /** * <p>云存储桶名称。</p> */ Bucket: string; /** * <p>云存储的access_key账号信息。<br>若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretId值。</p> */ AccessKey: string; /** * <p>云存储的secret_key账号信息。<br>若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretKey值。</p> */ SecretKey: string; /** * <p>云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围az,AZ,0~9,&#39;_&#39;和&#39;-&#39;,举个例子,录制文件xxx.m3u8在 [&quot;prefix1&quot;, &quot;prefix2&quot;]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8。</p> */ FileNamePrefix?: Array<string>; } /** * 声纹配置参数 */ export interface VoicePrint { /** * 默认为0,表示不启用声纹。1表示启用声纹,此时需要填写voiceprint id。 */ Mode?: number; /** * VoicePrint Mode为1时需要填写,目前仅支持填写一个声纹id */ IdList?: Array<string>; } /** * DescribeTrtcUsage返回参数结构体 */ export interface DescribeTrtcUsageResponse { /** * 用量类型,与UsageValue中各个位置的值对应。 */ UsageKey?: Array<string>; /** * 各个时间点用量明细,单位:分钟 */ UsageList?: Array<TrtcUsage>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopAITranscription请求参数结构体 */ export interface StopAITranscriptionRequest { /** * 唯一标识转录任务。 */ TaskId: string; } /** * 返回的质量数据,时间:值 */ export interface TimeValue { /** * 时间,unix时间戳(1590065877s) */ Time?: number; /** * 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 ) */ Value?: number; } /** * CreateCloudRecording返回参数结构体 */ export interface CreateCloudRecordingResponse { /** * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。任务 ID需要业务保存下来,作为下次针对这个录制任务操作的参数。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * RemoveUser请求参数结构体 */ export interface RemoveUserRequest { /** * TRTC的SDKAppId。 */ SdkAppId: number; /** * 房间号。 */ RoomId: number; /** * 要移出的用户列表,最多10个。 */ UserIds: Array<string>; } /** * DescribeWebRecord请求参数结构体 */ export interface DescribeWebRecordRequest { /** * 开始页面录制时返回的任务id */ TaskId?: string; /** * 发起页面录制时传递的SdkAppId */ SdkAppId?: number; /** * 发起录制时传递的RecordId, 传入此值时需要传递SdkAppId */ RecordId?: string; } /** * 背景音设置,将在通话中添加环境音效,使体验更加逼真。目前支持以下选项: coffee_shops: 咖啡店氛围,背景中有人聊天。 busy_office: 客服中心 street_traffic: 户外街道 evening_mountain: 户外山林 */ export interface AmbientSound { /** * 环境场景选择 */ Scene: string; /** * 控制环境音的音量。取值的范围是 [0,2]。值越低,环境音越小;值越高,环境音越响亮。如果未设置,则使用默认值 1。 */ Volume?: number; } /** * DescribeRecordStatistic请求参数结构体 */ export interface DescribeRecordStatisticRequest { /** * 查询开始日期,格式为YYYY-MM-DD。 */ StartTime: string; /** * 查询结束日期,格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。 */ EndTime: string; /** * 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。 */ SdkAppId?: number; } /** * DescribeRoomInfo请求参数结构体 */ export interface DescribeRoomInfoRequest { /** * 用户SdkAppId(如:1400xxxxxx) */ SdkAppId: number; /** * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777)注意:最大支持查询14天内的数据 */ StartTime: number; /** * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877) 注意:与StartTime间隔时间不超过24小时。 */ EndTime: number; /** * 房间号(如:223) */ RoomId?: string; /** * 当前页数,默认为0, 注意:PageNumber和PageSize 其中一个不填均默认返回10条数据。 */ PageNumber?: number; /** * 每页个数,默认为10, 范围:[1,100] */ PageSize?: number; } /** * 录制存储参数 */ export interface StorageParams { /** * 腾讯云对象存储COS以及第三方云存储的账号信息 */ CloudStorage?: CloudStorage; /** * 腾讯云云点播Vod的存储信息 */ CloudVod?: CloudVod; } /** * 点播相关参数。 */ export interface CloudVod { /** * 腾讯云点播相关参数。 */ TencentVod?: TencentVod; } /** * 腾讯云对象存储COS以及第三方云存储的账号信息 */ export interface CloudSliceStorage { /** * 腾讯云对象存储COS以及第三方云存储账号信息 0:腾讯云对象存储 COS 1:AWS S3 2: 阿里云 OSS 示例值:0 */ Vendor: number; /** * 腾讯云对象存储的[地域信息](https://cloud.tencent.com/document/product/436/6224#.E5.9C.B0.E5.9F.9F)。 示例值:cn-shanghai-1 AWS S3[地域信息](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-regions) 示例值:ap-southeast-3 */ Region: string; /** * 云存储桶名称。 */ Bucket: string; /** * 云存储的access_key账号信息。 若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretId值。 示例值:test-accesskey */ AccessKey: string; /** * 云存储的secret_key账号信息。 若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretKey值。 示例值:test-secretkey */ SecretKey: string; /** * 云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-',举个例子,切片文件xxx.mp3在 ["prefix1", "prefix2"]作用下,音频切片文件会变成prefix1/prefix2/{taskId}/{userId}/audios/{sdkappid}_{roomId}_{userid}_{UTC时间}.ogg,视频截帧会变成prefix1/prefix2/{taskId}/{userId}/images/{sdkappid}_{roomId}_{userid}_{UTC时间}.png */ FileNamePrefix?: Array<string>; } /** * DescribeTRTCMarketScaleMetricData返回参数结构体 */ export interface DescribeTRTCMarketScaleMetricDataResponse { /** * TRTC监控数据出参 注意:此字段可能返回 null,表示取不到有效值。 */ Data: TRTCDataResp; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 渲染移动模式参数,不渲染移动模式时,请勿设置此参数。 */ export interface EmulateMobileParams { /** * 移动设备类型, 0: 手机 1: 平板 */ MobileDeviceType?: number; /** * 屏幕方向, 0: 竖屏, 1: 横屏 */ ScreenOrientation?: number; } /** * 多音字/生僻字发音纠正词典条目。指定特定词语在本次请求中使用的发音。 */ export interface PronunciationDict { /** * 需要纠正发音的词语,前后空格自动去除。同一请求中若有重复词语,以最后一条为准。 */ Word: string; /** * 目标发音,支持以下格式:<br>① 带声调数字的拼音(1=阴平,2=阳平,3=上声,4=去声,5=轻声),如 yin2 hang2;<br>② 拼音连写(无空格),如 yin2hang2;<br>③ 文字+拼音混写,如 银hang2;<br>④ 直接文本替换,会将原始文本替换为目标文本 */ Pronunciation: string; } /** * DescribeCallDetailInfo返回参数结构体 */ export interface DescribeCallDetailInfoResponse { /** * 返回的用户总条数 */ Total?: number; /** * 用户信息列表 */ UserList?: Array<UserInformation>; /** * 质量数据 */ Data?: Array<QualityData>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTRTCRealTimeQualityData返回参数结构体 */ export interface DescribeTRTCRealTimeQualityDataResponse { /** * TRTC监控数据出参 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: TRTCDataResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 混流自定义裁剪参数 */ export interface McuCustomCrop { /** * 自定义裁剪起始位置的X偏移,单位为像素值,大于等于0。 */ LocationX: number; /** * 自定义裁剪起始位置的Y偏移,单位为像素值,大于等于0。 */ LocationY: number; /** * 自定义裁剪画面的宽度,单位为像素值,大于0,且LocationX+Width不超过10000 */ Width: number; /** * 自定义裁剪画面的高度,单位为像素值,大于0,且LocationY+Height不超过10000 */ Height: number; } /** * DescribeTRTCAIRecognitionUsage返回参数结构体 */ export interface DescribeTRTCAIRecognitionUsageResponse { /** * 用量类型列表 */ UsageKey?: Array<string>; /** * 用量列表 */ UsageList?: Array<UsageList>; /** * 总用量列表 */ TotalUsage?: Array<number>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMixTranscodingUsage请求参数结构体 */ export interface DescribeMixTranscodingUsageRequest { /** * 查询开始时间,格式为YYYY-MM-DD。 */ StartTime: string; /** * 查询结束时间,格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。 */ EndTime: string; /** * TRTC的SdkAppId,和房间所对应的SdkAppId相同。如果没有这个参数,返回用户下全部实时音视频应用的汇总。 */ SdkAppId?: number; } /** * DescribeTRTCRealTimeQualityData请求参数结构体 */ export interface DescribeTRTCRealTimeQualityDataRequest { /** * 用户SdkAppId(如:1400xxxxxx) */ SdkAppId: string; /** * 开始时间,unix时间戳,单位:秒(查询时间范围根据监控仪表盘功能版本而定,基础版可查近3小时,进阶版可查近12小时) */ StartTime: number; /** * 结束时间,unix时间戳,单位:秒 */ EndTime: number; /** * 房间ID */ RoomId?: string; } /** * DescribeStreamIngest返回参数结构体 */ export interface DescribeStreamIngestResponse { /** * 任务的状态信息。 InProgress:表示当前任务正在进行中。 NotExist:表示当前任务不存在。 示例值:InProgress */ Status?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 录制的音视频转码参数。 */ export interface MixTranscodeParams { /** * 录制视频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。 */ VideoParams?: VideoParams; /** * 录制音频转码参数,注意如果设置了这个参数,那么里面的字段都是必填的,没有默认值,如果不填这个参数,那么取值为默认值。 */ AudioParams?: AudioParams; } /** * CreateCloudTranscription返回参数结构体 */ export interface CreateCloudTranscriptionResponse { /** * <p>用于唯一标识转录任务,由腾讯云服务端生成,后续查询和停止请求都需要携带TaskID参数。</p> */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTRTCMarketQualityData返回参数结构体 */ export interface DescribeTRTCMarketQualityDataResponse { /** * <p>TRTC监控数据出参</p> 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: TRTCDataResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeVoicePrint返回参数结构体 */ export interface DescribeVoicePrintResponse { /** * 总的条数 */ TotalCount?: number; /** * 声纹信息 */ Data?: Array<VoicePrintInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 画中画模板中有效,代表小画面的布局参数 */ export interface SmallVideoLayoutParams { /** * 代表小画面对应的用户ID。 */ UserId: string; /** * 代表小画面对应的流类型,0为摄像头,1为屏幕分享。小画面为web用户时此值填0。 */ StreamType: number; /** * 小画面在输出时的宽度,单位为像素值,不填默认为0。 */ ImageWidth?: number; /** * 小画面在输出时的高度,单位为像素值,不填默认为0。 */ ImageHeight?: number; /** * 小画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。 */ LocationX?: number; /** * 小画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。 */ LocationY?: number; } /** * 声纹查询数据 */ export interface VoicePrintInfo { /** * 声纹ID */ VoicePrintId?: string; /** * 应用id */ AppId?: number; /** * 和声纹绑定的MetaInfo */ VoicePrintMetaInfo?: string; /** * 创建时间 */ CreateTime?: string; /** * 更新时间 */ UpdateTime?: string; /** * 音频格式,当前只有0(代表wav) */ AudioFormat?: number; /** * 音频名称 */ AudioName?: string; /** * 请求毫秒时间戳 */ ReqTimestamp?: number; } /** * 云端录制查询接口,录制文件的信息 */ export interface StorageFile { /** * 录制文件对应的UserId,如果是混流的话的这里返回的是空串。 注意:此字段可能返回 null,表示取不到有效值。 */ UserId?: string; /** * 录制索引文件名。 */ FileName?: string; /** * 录制文件流信息。 video:视频录制文件 audio:音频录制文件 audio_video:音视频录制文件 注意:此字段可能返回 null,表示取不到有效值。 */ TrackType?: string; /** * 录制文件开始Unix时间戳。 */ BeginTimeStamp?: number; } /** * 指定订阅流白名单或者黑名单,音频的白名单和音频黑名单不能同时设置,视频亦然。同时实际并发订阅的媒体流路数最大支持25路流,混流场景下视频的多画面最大支持24画面。支持通过设置".*$"通配符,来前缀匹配黑白名单的UserId,注意房间里不能有和通配符规则相同的用户,否则将视为订阅具体用户,前缀规则会失效。 */ export interface SubscribeStreamUserIds { /** * 订阅音频流白名单,指定订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表订阅UserId 1,2,3的音频流;["1.*$"], 代表订阅UserId前缀为1的音频流。默认不填订阅房间内所有的音频流,订阅列表用户数不超过32。 */ SubscribeAudioUserIds?: Array<string>; /** * 订阅音频流黑名单,指定不订阅哪几个UserId的音频流,例如["1", "2", "3"], 代表不订阅UserId 1,2,3的音频流;["1.*$"], 代表不订阅UserId前缀为1的音频流。默认不填订阅房间内所有音频流,订阅