/** * DescribeAsyncTextToSpeech请求参数结构体 */ export interface DescribeAsyncTextToSpeechRequest { /** * 任务ID */ TaskId: string; } /** * ModifyCloudSliceTask返回参数结构体 */ export interface ModifyCloudSliceTaskResponse { /** * 切片任务的唯一Id,在启动切片任务成功后会返回。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 返回的质量数据,时间:值 */ export interface TimeValue { /** * 时间,unix时间戳(1590065877s) */ Time?: number; /** * 当前时间返回参数取值,如(bigvCapFps在1590065877取值为0,则Value:0 ) */ Value?: number; } /** * DescribeCloudModeration返回参数结构体 */ export interface DescribeCloudModerationResponse { /** *
AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId?: string; /** *AI内容理解任务的状态信息。Idle:表示当前任务空闲中,InProgress:表示当前任务正在进行中,Exited:表示当前任务正在退出的过程中。
枚举值:
订阅黑白名单
*/ 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翻译目标语言。
*/ TargetLang: string; /** *翻译目标语言对应的翻译术语配置。
*/ Terminology: ArrayAI 内容理解任务类型
枚举值:
默认值:3
*/ ModerationType?: number; /** *持续没有上行推流的状态超过MaxIdleTime的时长,自动停止切片。
取值范围:[30, 1800]
单位:秒
默认值:30
*/ MaxIdleTime?: number; /** *视频截帧间隔
取值范围:[1, 60]
单位:秒
默认值:5
*/ SliceVideo?: number; /** *音频切片时长
取值范围:[5, 60]
单位:秒
默认值:15
*/ SliceAudio?: number; /** *是否保存文件
枚举值:
默认值:1
*/ SaveModerationFile?: number; /** *是否回调所有内容理解结果
枚举值:
默认值:0
*/ 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词表 id
*/ VocabId: string; /** *客户维度唯一标识
*/ SdkAppId: number; } /** * GetRecognizeVocabListV3返回参数结构体 */ export interface GetRecognizeVocabListV3Response { /** *词表列表
*/ VocabList?: Array词表个数
单位:个
*/ TotalCount?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: 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,显式关联多个转推任务到一个录制任务;一般不需设置,默认录制本次转推内容。 如果有特殊需求,比如将多段转推内容分时录制到同一个文件,可以通过设置此参数来控制。举例: 时间点10:00 发起转推任务:A + RecorderKey:abc,10:05分发起转推任务B+ RecorderKey:abc,那么录制文件会包含,转推A(10:00~10:05分的内容)+转推B的内容。 【限制长度为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语音转文字支持识别的语言,默认是"zh" 中文
可通过购买「AI智能识别时长包」解锁或领取包月套餐体验版解锁不同语言. 详细说明参考:AI智能识别计费说明
语音转文本不同套餐版本支持的语言如下:
基础语言引擎:
标准语言引擎:
高级语言引擎:
bigmodel全新大模型语音识别引擎
注意:
如果缺少满足您需求的语言,请联系我们技术人员。
发起模糊识别为高级版能力,默认按照高级版收费
注意:不支持填写"zh-dialect", "16k_zh_edu", "16k_zh_medical", "16k_zh_court", "8k_zh_large", "16k_zh_large","16k_multi_lang", "16k_zh_en"
自定义参数,联系后台使用
*/ 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 { /** *音色 ID,可从音色列表获取,或使用声音克隆生成的自定义音色 ID
*/ VoiceId: string; /** *语速调节,0.5 为半速慢放,2.0 为两倍速快放,1.0 为正常语速,区间:[0.5, 2.0],默认1.0
*/ Speed?: number; /** *音量调节,默认1.0,10 为最大音量,建议保持默认值 1.0,区间:(0, 10]
*/ Volume?: number; /** *音高调节,负值声音更低沉,正值声音更尖锐,0 为原始音高,区间 [-12, 12], 默认0
*/ Pitch?: number; /** *情绪控制,目前仅flow_01_ex模型支持
枚举值:
TRTC的SdkAppId
*/ SdkAppId: number; /** *声音克隆的名称, 只允许使用数字、字母、下划线,不能超过36位
*/ VoiceName: string; /** *声音克隆的参考音频,base64字符串,支持wav、mp3、m4a格式,长度在6秒~180秒之间
*/ PromptAudio: string; /** *TTS的API密钥
* @deprecated */ APIKey?: string; /** *声音克隆的参考文本,为参考音频对应的文字。
*/ PromptText?: string; /** *TTS的模型,支持flow_02_turbo,flow_01_ex,默认为flow_02_turbo
枚举值:
需要合成的语言,默认为空,表示自动识别
flow_02_turbo支持以下语言:
flow_01_ex支持以下语言:
拓展参数
*/ ExtraParams?: 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 { /** *TRTC的SDKAppId,和TRTC的房间所对应的SDKAppId相同。
*/ SdkAppId: number; /** *AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId: string; } /** * CreateLiveStreamModeration请求参数结构体 */ export interface CreateLiveStreamModerationRequest { /** *TRTC的SdkAppId。
*/ SdkAppId: number; /** *直播流输入源
*/ Input: Input; /** *直播流ai理解审核参数
*/ LiveModerationParams: LiveModerationParams; /** *业务自定义唯一标识,原样透传到回调
入参限制:长度限制60字符
*/ DataId?: string; /** *额外信息透传结构体(房间/主播/业务自定义),原样回带到回调
*/ SourceInfo?: SourceInfo; /** *直播流ai理解转存文件存储参数
*/ LiveModerationStorageParams?: LiveModerationStorageParams; /** *单路任务最大的生命周期
取值范围:[1, 72]
单位:小时
默认值:48
*/ ResourceExpiredHour?: number; } /** * CreateCloudSliceTask请求参数结构体 */ export interface CreateCloudSliceTaskRequest { /** * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和TRTC的房间所对应的SdkAppId相同。 */ SdkAppId: number; /** * TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),为TRTC房间所对应的RoomId。 */ RoomId: string; /** * 机器人的UserId,用于进房发起切片任务。【*注意】这个UserId不能与当前房间内的主播观众UserId重复。如果一个房间发起多个切片任务时,机器人的userid也不能相互重复,否则会中断前一个切片任务。建议可以把房间ID作为UserId的标识的一部分,即机器人UserId在房间内唯一。 */ UserId: string; /** * 机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算UserSig的方案。 */ UserSig: string; /** * 云端切片控制参数。 */ SliceParams: SliceParams; /** * 云端切片文件上传到云存储的参数 */ SliceStorageParams: SliceStorageParams; /** * TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认) 示例值:1 */ RoomIdType?: number; /** * 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。 示例值:24 */ ResourceExpiredHour?: number; /** * TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。 示例值:eJw1jcEKgkAURX9FZlvY****fL9rfNX4_ */ PrivateMapKey?: string; } /** * 混流自定义渲染参数 */ export interface McuBackgroundCustomRender { /** * 自定义渲染画面的宽度,单位为像素值,需大于0,且不能超过子布局的宽。 */ Width: number; /** * 自定义渲染画面的高度,单位为像素值,需大于0,且不能超过子布局的高。 */ Height: number; /** * 自定义渲染画面的圆角半径,单位为像素值,不能超过渲染画面Width和Height最小值的一半,不指定默认为0,表示直角。 */ Radius?: number; } /** * AsyncTextToSpeech请求参数结构体 */ export interface AsyncTextToSpeechRequest { /** *需要转语音的文字内容,最大允许50000字符,注意 1汉字=2字符
*/ Text: string; /** *文本转语音的声音配置
*/ Voice: Voice; /** *TRTC的SdkAppId
*/ SdkAppId: number; /** *文本转语音的输出音频的格式
*/ AudioFormat?: AudioFormat; /** *TTS的模型,当前固定为:flow_02_turbo
枚举值:
多音字/生僻字发音纠正词典条目。指定特定词语在本次请求中使用的发音。
*/ PronunciationDict?: Array默认为0,0表示不生成字幕,1表示生成字幕
*/ AlignmentMode?: number; /** *需要合成的语言,默认为空,表示自动识别
枚举值:
AI 内容理解服务分配的任务ID。任务ID是对一次切片任务生命周期过程的唯一标识,结束任务时会失去意义。任务ID需要业务保存下来,作为下次针对这个任务操作的参数
*/ 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直播间 ID(用于结果透传与去重;数字房间号也用 string 传)
*/ RoomId?: string; /** *房间号类型
枚举值:
主播/被审核方 ID
*/ 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?: ArrayAI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 声网拉流参数 */ export interface AgoraParam { /** *声网提供的应用标识
*/ AppId?: string; /** *声网提供的频道名
*/ Channel?: string; /** *声网录制的频道模式, 可选值如下:(默认值为0) 0: 通信(默认),即常见的 1 对 1 单聊或群聊, 频道内任何用户可以自由说话; 1: 直播,有两种用户角色: 主播和观众。
枚举值:
绑定频道生成的临时Token
*/ Token?: string; /** *用户ID
*/ Uid?: number; /** *信任用户的列表
*/ TrustedUserIdList?: Array非信任用户的列表
*/ UntrustedUserIdList?: ArrayAI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId?: string; /** *AI内容理解任务的状态信息。Idle:表示当前任务空闲中,InProgress:表示当前任务正在进行中,Exited:表示当前任务正在退出的过程中。
枚举值:
翻译的目标语言,示例值["en", "ja"]。目标语种列表[中文 "zh",英语 "en",粤语"yue",越南语 "vi",日语 "ja",韩语 "ko",印度尼西亚语 "id",泰语 "th",葡萄牙语 "pt",阿拉伯语 "ar",西班牙语 "es",法语 "fr",马来语 "ms",德语 "de",意大利语 "it",俄语 "ru"]。
*/ TargetLang?: Array翻译术语表配置。
*/ Terminologies?: Array腾讯云对象存储COS以及第三方云存储账号信息
0:腾讯云对象存储 COS
1:AWS
【注意】目前第三方云存储仅支持AWS,更多第三方云存储陆续支持中
腾讯云对象存储的[地域信息](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)
*/ Region: string; /** *云存储桶名称。
*/ Bucket: string; /** *云存储的access_key账号信息。
若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretId值。
云存储的secret_key账号信息。
若存储至腾讯云对象存储COS,请前往https://console.cloud.tencent.com/cam/capi 查看或创建,对应链接中密钥字段的SecretKey值。
云存储bucket 的指定位置,由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-',举个例子,录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下,会变成prefix1/prefix2/TaskId/xxx.m3u8。
*/ FileNamePrefix?: Array词表 id
*/ VocabId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 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词表名称(同 SdkAppId 下唯一)
*/ Name: string; /** *客户维度唯一标识
*/ SdkAppId: number; /** *描述
*/ Description?: string; /** *热词+权重数组
*/ WordWeights?: Array文本形式热词
*/ WordWeightStr?: string; } /** * 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用于唯一标识转录任务,由腾讯云服务端生成,后续查询和停止请求都需要携带TaskID参数。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTRTCMarketQualityData返回参数结构体 */ export interface DescribeTRTCMarketQualityDataResponse { /** *TRTC监控数据出参
注意:此字段可能返回 null,表示取不到有效值。 */ Data?: TRTCDataResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeVoicePrint返回参数结构体 */ export interface DescribeVoicePrintResponse { /** * 总的条数 */ TotalCount?: number; /** * 声纹信息 */ Data?: Array布局模式:动态布局(1:悬浮布局(默认),2:屏幕分享布局,3:九宫格布局),静态布局(4:自定义布局)。最多支持混入16路音视频流,如果用户只上行音频,也会被算作一路;自定义布局中,如果子画面只设置占位图,也被算作一路。
*/ MixLayoutMode?: number; /** *纯音频上行是否占布局位置,只在动态布局中有效。0表示纯音频不占布局位置,1表示纯音频占布局位置,不填默认为0。
*/ PureAudioHoldPlaceMode?: number; /** *自定义模板中有效,指定用户视频在混合画面中的位置,最多支持设置16个输入流。
*/ MixLayoutList?: Array指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。
*/ MaxVideoUser?: MaxVideoUser; /** *屏幕分享模板、悬浮模板、九宫格模版有效,画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底
*/ RenderMode?: number; /** *是否保留上行sei,1:保留 0:不保留,只对动态布局生效,自定义布局不生效
取值范围:[0, 1]
默认值:1
*/ EnableStreamSEI?: number; } /** * StartWebRecord请求参数结构体 */ export interface StartWebRecordRequest { /** *【必填】需要录制的网页URL
*/ RecordUrl: string; /** *【必填】云存储相关的参数,目前支持腾讯云对象存储以及腾讯云云点播VOD,不支持第三方云存储;输出文件的存储格式仅支持hls或mp4
*/ StorageParams: StorageParams; /** *【必填】TRTC的SdkAppId
*/ SdkAppId: number; /** *录制最大时长限制, 单位 s, 合法取值范围[1800, 86400], 默认 86400s(24 小时)
*/ MaxDurationLimit?: number; /** *页面录制视频参数
*/ WebRecordVideoParams?: WebRecordVideoParams; /** *当对重复任务敏感时,请关注此值: 为了避免任务在短时间内重复发起,导致任务重复
传入录制RecordId来标识此次任务, 小于32字节,若携带RecordId发起两次以上的开始录制请求,任务只会启动一个,第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误,请更换RecordId重新发起。
若您想要推流到CDN,可以使用PublishCdnParams.N参数设置,支持最多同时推流到10个CDN地址。若转推地址是腾讯云CDN时,请将IsTencentCdn明确设置为1
*/ PublishCdnParams?: Array录制页面资源加载的超时时间,单位:秒。默认值为 0 秒,该值需大于等于 0秒,且小于等于 60秒。录制页面未启用页面加载超时检测时,请勿设置此参数。
*/ ReadyTimeout?: number; /** *渲染移动模式参数;不准备渲染移动模式页面时,请勿设置此参数。
*/ EmulateMobileParams?: EmulateMobileParams; } /** * 云端录制控制参数。 */ export interface RecordParams { /** * 录制模式: 1:单流录制,分别录制房间的订阅UserId的音频和视频,将录制文件上传至云存储; 2:合流录制,将房间内订阅UserId的音视频混录成一个音视频文件,将录制文件上传至云存储; */ RecordMode: number; /** * 房间内持续没有主播的状态超过MaxIdleTime的时长,自动停止录制,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。 */ MaxIdleTime?: number; /** * 录制的媒体流类型: 0:录制音频+视频流(默认); 1:仅录制音频流; 2:仅录制视频流, */ StreamType?: number; /** * 指定订阅流白名单或者黑名单。 */ SubscribeStreamUserIds?: SubscribeStreamUserIds; /** * 输出文件的格式(存储至COS等第三方存储时有效)。0:(默认)输出文件为hls格式。1:输出文件格式为hls+mp4。2:输出文件格式为hls+aac 。3:输出文件格式为mp4。4:输出文件格式为aac。 存储到云点播VOD时此参数无效,存储到VOD时请通过TencentVod(https://cloud.tencent.com/document/api/647/44055#TencentVod)内的MediaType设置。 */ OutputFormat?: number; /** * 单流录制模式下,用户的音视频是否合并,0:单流音视频不合并(默认)。1:单流音视频合并成一个ts。合流录制此参数无需设置,默认音视频合并。 */ AvMerge?: number; /** * 如果是aac或者mp4文件格式,超过长度限制后,系统会自动拆分视频文件。单位:分钟。默认为1440min(24h),取值范围为1-1440。【单文件限制最大为2G,满足文件大小 >2G 或录制时长度 > 24h任意一个条件,文件都会自动切分】 Hls 格式录制此参数不生效。 */ MaxMediaFileDuration?: number; /** * 指定录制主辅流,0:主流+辅流(默认);1:主流;2:辅流。 */ MediaId?: number; /** * 上行视频停止时,录制的补帧类型,0:补最后一帧 1:补黑帧 */ FillType?: number; /** * 控制录制任务是否订阅混流回推机器人,1是订阅,0是不订阅,默认是0。如果是混流录制任务,建议用订阅白名单控制订阅用户,防止同时订阅混流回推机器人和上行主播,以避免混音效果。 */ SubscribeAbility?: number; } /** * DescribeAITranscription请求参数结构体 */ export interface DescribeAITranscriptionRequest { /** * 查询任务状态,不使用时传入空字符串。 有两种查询方式: 1、只填写TaskId,这种方式使用TaskId来查询任务 2、TaskId为空字符串,填写SdkAppId和SessionId,这种方式不需要使用TaskId查询任务 */ TaskId: string; /** * TRTC的SdkAppId,和SessionId配合使用。 */ SdkAppId?: number; /** * 开启转录任务时传入的SessionId,和SdkAppId配合使用。 */ SessionId?: string; } /** * 查询旁路转码计费时长。 查询时间小于等于1天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 */ export interface SdkAppIdTrtcMcuTranscodeTimeUsage { /** * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。 */ TimeKey: string; /** * 语音时长,单位:秒。 */ AudioTime: number; /** * 视频时长-标清SD,单位:秒。 */ VideoTimeSd: number; /** * 视频时长-高清HD,单位:秒。 */ VideoTimeHd: number; /** * 视频时长-全高清FHD,单位:秒。 */ VideoTimeFhd: number; /** * 带宽,单位:Mbps。 */ Flux: number; } /** * DescribeAIConversation返回参数结构体 */ export interface DescribeAIConversationResponse { /** * 任务开始时间。 */ StartTime?: string; /** * 任务状态。有4个值:1、Idle表示任务未开始2、Preparing表示任务准备中3、InProgress表示任务正在运行4、Stopped表示任务已停止,正在清理资源中 */ Status?: string; /** * 任务的唯一标识,在启动任务时生成 */ TaskId?: string; /** * 开启对话任务时填写的SessionId,如果没写则不返回。 */ SessionId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TTS音频输出的格式 */ export interface AudioFormat { /** *生成的音频格式,注意opus格式是ogg/opus编码
TextToSpeechSSE 流式接口
支持 pcm,mp3,opus 默认: pcm
TextToSpeech 非流式接口
支持 pcm,wav,mp3,opus 默认: pcm
AsyncTextToSpeech
支持pcm,mp3,opus 默认: mp3
生成的音频采样率,默认24000
可选
MP3 比特率 (kbps),仅对 MP3 格式生效, 可以选: 64, 128, 192, 256 , 默认: 128
用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
*/ UserMediaStream?: UserMediaStream; /** *子画面在输出时的宽度,单位为像素值,不填默认为0。
*/ ImageWidth?: number; /** *子画面在输出时的高度,单位为像素值,不填默认为0。
*/ ImageHeight?: number; /** *子画面在输出时的X偏移,单位为像素值,LocationX与ImageWidth之和不能超过混流输出的总宽度,不填默认为0。
*/ LocationX?: number; /** *子画面在输出时的Y偏移,单位为像素值,LocationY与ImageHeight之和不能超过混流输出的总高度,不填默认为0。
*/ LocationY?: number; /** *子画面在输出时的层级,不填默认为0。
*/ ZOrder?: number; /** *子画面在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底。不填默认为0。
*/ RenderMode?: number; /** *【此参数配置无效,暂不支持】子画面的背景颜色,常用的颜色有:
红色:0xcc0033。
黄色:0xcc9900。
绿色:0xcccc33。
蓝色:0x99CCFF。
黑色:0x000000。
白色:0xFFFFFF。
灰色:0x999999。
子画面的占位图片url,填写该参数,当用户关闭摄像头或未进入TRTC房间时,会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致,则会对图片进行拉伸处理,优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片分辨率限制不超过2K,图片大小限制不超过5MB。
注:
1,您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,占位图片将不会生效。
2,url可支持字符集:【'0-9','a-z','A-Z','-', '.', '_', '~', ':', '/', '?', '#', '[', ']','@', '!', '&', '(', ')', '*', '+', ',', '%', '=', ';', '|'】,您需要确保url字符在可支持字符集内,若存在可支持字符集外的字符,占位图片将不会生效。
客户自定义裁剪,针对原始输入流裁剪
*/ CustomCrop?: McuCustomCrop; /** *子背景图在输出时的显示模式:0为裁剪,1为缩放并显示背景,2为缩放并显示黑底,3为变比例伸缩,4为自定义渲染。不填默认为3。
*/ BackgroundRenderMode?: number; /** *子画面的透明模版url,指向一张包含透明通道的模板图片。填写该参数,后台混流时会提取该模板图片的透明通道,将其缩放作为目标画面的透明通道,再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪(如圆角、星形、心形等)。 支持png格式。图片分辨率限制不超过2K,图片大小限制不超过5MB。
注:
1,模板图片宽高比应接近目标画面宽高比,以避免缩放适配目标画面时出现模板效果变形;2,透明模版只有RenderMode为0(裁剪)时才生效;3,您需要确保图片链接的可访问性,后台单次下载超时时间为10秒,最多重试3次,若最终图片下载失败,透明模板将不会生效。
2,url可支持字符集:【'0-9','a-z','A-Z','-', '.', '_', '~', ':', '/', '?', '#', '[', ']','@', '!', '&', '(', ')', '*', '+', ',', '%', '=', ';', '|'】,您需要确保url字符在可支持字符集内,若存在可支持字符集外的字符,透明模版将不会生效。
子背景图的自定义渲染参数,当BackgroundRenderMode为4时必须配置。
*/ BackgroundCustomRender?: McuBackgroundCustomRender; /** *子背景色生效模式,默认值为0表示均不生效。
bit0:占位图缩放是否生效。
bit1:上行流缩放是否生效。
您可以将相应bit位置1启动生效,例如:
0(00)表示子背景色不生效。
1(01)表示子背景色只在占位图缩放时生效。
2(10)表示子背景色只在上行流缩放时生效。
3(11)表示子背景色在占位图缩放和上行流缩放时均生效。
是否保留上行SEI,1:保留 0:不保留
取值范围:[0, 1]
默认值:1
*/ EnableStreamSEI?: number; } /** * DescribeUserInfo返回参数结构体 */ export interface DescribeUserInfoResponse { /** * 返回的用户总条数 */ Total?: number; /** * 用户信息列表 */ UserList?: Array词表名称
*/ Name?: string; /** *描述
*/ Description?: string; /** *词表 id
*/ VocabId?: string; /** *热词+权重数组
*/ WordWeights?: Array创建时间
*/ CreateTime?: string; /** *更新时间
*/ UpdateTime?: string; /** *是否设置默认词表
枚举值:
用于唯一标识转推任务,由腾讯云服务端生成,后续更新和停止请求都需要携带TaskID参数。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteLiveStreamModeration返回参数结构体 */ export interface DeleteLiveStreamModerationResponse { /** *AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 直播流aI理解的转存文件存储参数 */ export interface LiveModerationStorageParams { /** *直播流ai理解文件转存
*/ CloudModerationStorage?: CloudModerationStorage; } /** * StartMCUMixTranscodeByStrRoomId返回参数结构体 */ export interface StartMCUMixTranscodeByStrRoomIdResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 实时音视频用量在某一时间段的统计信息。 */ export interface TrtcUsage { /** * 时间点,格式为YYYY-MM-DD HH:mm:ss。多天查询时,HH:mm:ss为00:00:00。 */ TimeKey?: string; /** * 时间点时间戳 */ TimeStampKey?: number; /** * 用量数组。每个数值含义与UsageKey对应。单位:分钟。 */ UsageValue?: Array词对应的文本
*/ Word?: string; /** *词对应的时间起点
*/ TimeBeginMs?: number; /** *词对应的时间尾点
*/ TimeEndMs?: number; /** *词的索引起点
*/ WordBegin?: number; /** *词的索引尾点
*/ WordEnd?: number; } /** * 录制的混流布局参数。 */ export interface MixLayoutParams { /** * 布局模式: 1:悬浮布局; 2:屏幕分享布局; 3:九宫格布局; 4:自定义布局; 悬浮布局:默认第一个进入房间的主播(也可以指定一个主播)的视频画面会铺满整个屏幕。其他主播的视频画面从左下角开始依次按照进房顺序水平排列,显示为小画面,小画面悬浮于大画面之上。当画面数量小于等于17个时,每行4个(4 x 4排列)。当画面数量大于17个时,重新布局小画面为每行5个(5 x 5)排列。最多支持25个画面,如果用户只发送音频,仍然会占用画面位置。 屏幕分享布局:指定一个主播在屏幕左侧的大画面位置(如果不指定,那么大画面位置为背景色),其他主播自上而下依次垂直排列于右侧。当画面数量少于17个的时候,右侧每列最多8人,最多占据两列。当画面数量多于17个的时候,超过17个画面的主播从左下角开始依次水平排列。最多支持25个画面,如果主播只发送音频,仍然会占用画面位置。 九宫格布局:根据主播的数量自动调整每个画面的大小,每个主播的画面大小一致,最多支持25个画面。 自定义布局:根据需要在MixLayoutList内定制每个主播画面的布局。 */ MixLayoutMode: number; /** * 如果MixLayoutMode 选择为4自定义布局模式的话,设置此参数为每个主播所对应的布局画面的详细信息,最大不超过25个。 */ MixLayoutList?: Array热词
*/ Word: string; /** *权重
*/ Weight: number; } /** * DescribeMixTranscodingUsage返回参数结构体 */ export interface DescribeMixTranscodingUsageResponse { /** * 用量类型,与UsageValue中各个位置的值对应。 */ UsageKey?: Array转录服务使用的模型类型。示例值"bigmodel-zh"。语音转文本不同套餐版本支持的语言如下:
"bigmodel-xxx" :大模型引擎,推荐使用。"xxx"填写具体语言,例如"bigmodel-zh"。"xxx"可以填写中文 ("zh"),英语 ("en"),粤语 ("yue"),阿拉伯语 ("ar"),德语 ("de"),法语 ("fr"),西班牙语 ("es"),葡萄牙语 ("pt"),印度尼西亚语 ("id"),意大利语 ("it"),韩语 ("ko"),俄语 ("ru"),泰语 ("th"),越南语 ("vi"),日语 ("ja"),土耳其语 ("tr"),印地语 ("hi"),马来语 ("ms"),荷兰语 ("nl"),瑞典语 ("sv"),丹麦语 ("da"),芬兰语 ("fi"),波兰语 ("pl"),捷克语 ("cs"),菲律宾语 ("fil"),波斯语 ("fa"),希腊语 ("el"),匈牙利语 ("hu"),马其顿语 ("mk"),罗马尼亚语 ("ro")。
标准语言引擎:
高级语言引擎:
注意:
如果缺少满足您需求的语言,请联系我们技术人员。
语音识别vad的时间,范围为240-2000,默认为1000,单位为ms。更小的值会让语音识别分句更快。
示例值:1000
临时热词表:该参数用于提升识别准确率。
发起模糊识别为高级语言引擎能力, 仅支持填写除"zh-dialect"和"zh-yue"以外的高级语言引擎。注意:最多只能填写4种语言。
*/ AlternativeLanguage?: Arrayvad的远场人声抑制能力(不会对asr识别效果造成影响),范围为[0, 1],默认为0。推荐设置为1,有较好的远场人声抑制能力。
*/ VadLevel?: number; /** *是否过滤脏词(目前仅支持填写基础语言引擎和标准语言引擎),范围为[0, 2],默认值为 0。
0:不过滤脏词;1:过滤脏词;2:将脏词替换为 " * "。
是否过滤语气词(目前仅支持填写基础语言引擎和标准语言引擎),范围为[0, 2],默认值为 0。
0:不过滤语气词;1:部分过滤;2:严格过滤。
是否过滤句末的句号(目前仅支持填写基础语言引擎和标准语言引擎),范围为[0, 1],默认值为 0。
0:不过滤句末的句号;1:过滤句末的句号。
回推房间的RoomId。
*/ RoomId: string; /** *房间类型,必须和回推房间所对应的RoomId类型相同,0为整形房间号,1为字符串房间号。
*/ RoomIdType: number; /** *回推房间使用的UserId(https://cloud.tencent.com/document/product/647/46351#userid),注意这个userId不能与其他TRTC或者转推服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
*/ UserId: string; /** *回推房间UserId对应的用户签名,相当于登录密码,具体计算方法请参考TRTC计算UserSig的方案。
*/ UserSig: string; } /** * SdkAppId级别录制时长数据。 */ export interface SdkAppIdRecordUsage { /** * SdkAppId的值。 */ SdkAppId?: string; /** * 统计的时间点数据。 */ Usages?: Array直播拉流地址
入参限制:字符长度小于2048
*/ Url?: string; /** *显式协议
枚举值:
声网拉流进房参数
*/ AgoraParam?: AgoraParam; } /** * 音频编码参数。 */ export interface AudioEncode { /** * 输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。 */ SampleRate: number; /** * 输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。 */ Channel: number; /** * 输出流音频码率。取值范围[8,500],单位为kbps。 */ BitRate: number; /** * 输出流音频编码类型,取值范围[0, 1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。 */ Codec?: number; } /** * MCU混流布局参数 */ export interface LayoutParams { /** * 混流布局模板ID,0为悬浮模板(默认);1为九宫格模板;2为屏幕分享模板;3为画中画模板;4为自定义模板。 */ Template?: number; /** * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的用户ID。 */ MainVideoUserId?: string; /** * 屏幕分享模板、悬浮模板、画中画模板中有效,代表大画面对应的流类型,0为摄像头,1为屏幕分享。左侧大画面为web用户时此值填0。 */ MainVideoStreamType?: number; /** * 画中画模板中有效,代表小画面的布局参数。 */ SmallVideoLayoutParams?: SmallVideoLayoutParams; /** * 屏幕分享模板有效。设置为1时代表大画面居右,小画面居左布局。默认为0。 */ MainVideoRightAlign?: number; /** * 指定混视频的用户ID列表。设置此参数后,输出流混合此参数中包含用户的音视频,以及其他用户的纯音频。悬浮模板、九宫格、屏幕分享模板有效,最多可设置16个用户。 */ MixVideoUids?: Array音色 ID。对于不同的语言,需要填写特定的音色ID,如下所示:
如果缺少满足您需求的音色,请联系我们的技术人员。
*/ VoiceId: string; /** *语速调节,0.5 为半速慢放,2.0 为两倍速快放,1.0 为正常语速,区间:[0.5, 2.0],默认1.0。
*/ Speed?: number; /** *音量调节,0 为静音,10 为最大音量,建议保持默认值 1.0,区间:[0, 10],默认1.0。
*/ Volume?: number; /** *音高调节,负值声音更低沉,正值声音更尖锐,0 为原始音高,区间 [-12, 12],默认0。
*/ Pitch?: number; } /** * 自定义文字水印数据结构 */ export interface WaterMarkChar { /** * 文字水印的起始坐标Y值,从左上角开始 */ Top: number; /** * 文字水印的起始坐标X值,从左上角开始 */ Left: number; /** * 文字水印的宽度,单位像素值 */ Width: number; /** * 文字水印的高度,单位像素值 */ Height: number; /** * 水印文字的内容 */ Chars: string; /** * 水印文字的大小,单位像素,默认14 */ FontSize?: number; /** * 水印文字的颜色,默认白色 */ FontColor?: string; /** * 水印文字的背景色,为空代表背景透明,默认为空 */ BackGroundColor?: string; /** * 文字水印的字体,支持设置以下值: 1. Tencent (默认) 2. SourceHanSans */ Font?: string; } /** * DismissRoom请求参数结构体 */ export interface DismissRoomRequest { /** * TRTC的SDKAppId。 */ SdkAppId: number; /** * 数字房间号。本接口仅支持解散数字类型房间号,如需解散字符串类型房间号,请使用DismissRoomByStrRoomId。 */ RoomId: number; } /** * DeleteLiveStreamModeration请求参数结构体 */ export interface DeleteLiveStreamModerationRequest { /** *TRTC的SDKAppId,和TRTC的房间所对应的SDKAppId相同。
*/ SdkAppId: number; /** *AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId: string; } /** * DescribeUnusualEvent请求参数结构体 */ export interface DescribeUnusualEventRequest { /** * 用户SdkAppId(如:1400xxxxxx) */ SdkAppId: number; /** * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) 注意:支持查询14天内的数据 */ StartTime: number; /** * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877)注意:与StartTime间隔时间不超过1小时。 */ EndTime: number; /** * 房间号,查询房间内任意20条以内异常体验事件 */ RoomId?: string; } /** * GetRecognizeVocabV3请求参数结构体 */ export interface GetRecognizeVocabV3Request { /** *词表 id
*/ VocabId: string; /** *客户维度唯一标识
*/ SdkAppId: number; } /** * DescribeCloudRecording请求参数结构体 */ export interface DescribeCloudRecordingRequest { /** * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。 */ SdkAppId: number; /** * 录制任务的唯一Id,在启动录制成功后会返回。 */ TaskId: string; /** * 转推录制任务发起时所填,标识一次录制 */ RecorderKey?: string; } /** * 腾讯云点播相关参数。 */ export interface TencentVod { /** * 媒体后续任务处理操作,即完成媒体上传后,可自动发起任务流操作。参数值为任务流模板名,云点播支持 创建任务流模板 并为模板命名。 */ Procedure?: string; /** * 媒体文件过期时间,为当前时间的绝对过期时间;保存一天,就填"86400",永久保存就填"0",默认永久保存。 */ ExpireTime?: number; /** * 指定上传园区,仅适用于对上传地域有特殊需求的用户。 */ StorageRegion?: string; /** * 分类ID,用于对媒体进行分类管理,可通过 创建分类 接口,创建分类,获得分类 ID。 默认值:0,表示其他分类。 */ ClassId?: number; /** * 点播子应用 ID。如果要访问子应用中的资源,则将该字段填写为子应用 ID;否则无需填写该字段。注意:不建议填写“托管类型”的点播子应用ID,只能填写“标准类型”的点播子应用ID,否则会导致无法通过点播域名正常播放视频。 */ SubAppId?: number; /** * 任务流上下文,任务完成回调时透传。 */ SessionContext?: string; /** * 上传上下文,上传完成回调时透传。 */ SourceContext?: string; /** * 上传到vod平台的录制文件格式类型,0:mp4(默认), 1: hls, 2:aac(StreamType=1纯音频录制时有效), 3: hls+mp4, 4: hls+aac(StreamType=1纯音频录制时有效)。 */ MediaType?: number; /** * 仅支持API录制上传vod,该参数表示用户可以自定义录制文件名前缀,【限制长度为64字节,只允许包含大小写英文字母(a-zA-Z)、数字(0-9)及下划线和连词符】。前缀与自动生成的录制文件名之间用`__UserDefine_u_` 分开。 */ UserDefineRecordId?: string; } /** * DeleteVoicePrint返回参数结构体 */ export interface DeleteVoicePrintResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用量列表 */ export interface UsageList { /** * 时间 */ TimeKey?: string; /** * 用量数值 */ UsageValue?: Array录制任务的唯一Id
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TRTC数据大盘/实时监控 API接口数据出参 */ export interface TRTCDataResult { /** * StatementID值,监控仪表盘下固定为0。 注意:此字段可能返回 null,表示取不到有效值。 */ StatementID?: number; /** * 查询结果数据,以Columns-Values形式返回。 注意:此字段可能返回 null,表示取不到有效值。 */ Series?: ArrayTRTC的SDKAppId,和TRTC的房间所对应的SDKAppId相同。
*/ SdkAppId: number; /** *AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId: string; /** *指定订阅流白名单或者黑名单。
*/ SubscribeStreamUserIds?: SubscribeStreamUserIds; } /** * 录制的使用信息。 */ export interface RecordUsage { /** * 本组数据对应的时间点,格式如:2020-09-07或2020-09-07 00:05:05。 */ TimeKey?: string; /** * 视频时长-标清SD,单位:秒。 */ Class1VideoTime?: number; /** * 视频时长-高清HD,单位:秒。 */ Class2VideoTime?: number; /** * 视频时长-超清HD,单位:秒。 */ Class3VideoTime?: number; /** * 语音时长,单位:秒。 */ AudioTime?: number; } /** * CreateCloudRecording请求参数结构体 */ export interface CreateCloudRecordingRequest { /** * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。 */ SdkAppId: number; /** * TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。 注:房间号类型默认为整型,若房间号类型为字符串,请通过RoomIdType指定。 */ RoomId: string; /** * 录制机器人的UserId,用于进房发起录制任务。 【*注意】这个UserId不能与当前房间内的主播观众[UserId](https://cloud.tencent.com/document/product/647/46351#userid)重复。如果一个房间发起多个录制任务时,机器人的userid也不能相互重复,否则会中断前一个录制任务。建议可以把房间ID作为UserId的标识的一部分,即录制机器人UserId在房间内唯一。 */ UserId: string; /** * 录制机器人UserId对应的校验签名,即UserId和UserSig相当于录制机器人进房的登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。 */ UserSig: string; /** * 云端录制控制参数。 */ RecordParams: RecordParams; /** * 云端录制文件上传到云存储的参数(不支持同时设置云点播VOD和对象存储COS) */ StorageParams: StorageParams; /** * TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认) */ RoomIdType?: number; /** * 合流的转码参数,录制模式为合流的时候可以设置。 */ MixTranscodeParams?: MixTranscodeParams; /** * 合流的布局参数,录制模式为合流的时候可以设置。 */ MixLayoutParams?: MixLayoutParams; /** * 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。 */ ResourceExpiredHour?: number; /** * TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。 */ PrivateMapKey?: string; } /** * MCU混流的输出参数 */ export interface OutputParams { /** * 直播流 ID,由用户自定义设置,该流 ID 不能与用户旁路的流 ID 相同,限制64字节。 */ StreamId: string; /** * 取值范围[0,1], 填0:直播流为音视频(默认); 填1:直播流为纯音频 */ PureAudioStream?: number; /** * 自定义录制文件名称前缀。请先在实时音视频控制台开通录制功能,https://cloud.tencent.com/document/product/647/50768。 【注意】该方式仅对旧版云端录制功能的应用生效,新版云端录制功能的应用请用接口CreateCloudRecording发起录制。新、旧云端录制类型判断方式请见:https://cloud.tencent.com/document/product/647/50768#record */ RecordId?: string; /** * 取值范围[0,1],填0无实际含义; 填1:指定录制文件格式为mp3。此参数不建议使用,建议在实时音视频控制台配置纯音频录制模板。 */ RecordAudioOnly?: number; } /** * DeleteCloudRecording返回参数结构体 */ export interface DeleteCloudRecordingResponse { /** * 云录制服务分配的任务 ID。任务 ID 是对一次录制生命周期过程的唯一标识,结束录制时会失去意义。 */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 自定义模板中有效,指定用户视频在混合画面中的位置。 */ export interface PresetLayoutConfig { /** * 指定显示在该画面上的用户ID。如果不指定用户ID,会按照用户加入房间的顺序自动匹配PresetLayoutConfig中的画面设置。 */ 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; /** * 该画面在输出时的层级,不填默认为0。 */ ZOrder?: number; /** * 该画面在输出时的显示模式:0为裁剪,1为缩放,2为缩放并显示黑底。不填默认为0。 */ RenderMode?: number; /** * 该当前位置用户混入的流类型:0为混入音视频,1为只混入视频,2为只混入音频。默认为0,建议配合指定用户ID使用。 */ MixInputType?: number; /** * 占位图ID。启用占位图功能时,在当前位置的用户没有上行视频时显示占位图。占位图大小不能超过2M,在实时音视频控制台上传并生成,https://cloud.tencent.com/document/product/647/50769 */ PlaceImageId?: number; } /** * StartAITranscription请求参数结构体 */ export interface StartAITranscriptionRequest { /** * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。 */ SdkAppId: number; /** * TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),表示开启转录任务的房间号。 */ RoomId: string; /** * 转录机器人的参数。 */ TranscriptionParams: TranscriptionParams; /** * 调用方传入的唯一Id,服务端用来任务去重,重复的任务会发起失败。服务端固定使用SdkAppId+RoomId+RoomIdType+RobotUserId来去重,如果传入了SessionId,也会使用SessionId去重。 注意: TranscriptionMode为0时,需要保证一个房间内只发起一个任务,如果发起多个任务,则机器人之间会相互订阅,除非主动停止任务,否则只有10小时后任务才会超时退出,这种情况下建议填写SessionId,保证后续重复发起的任务失败。 */ SessionId?: string; /** * TRTC房间号的类型,0代表数字房间号,1代表字符串房间号。不填默认是数字房间号。 */ RoomIdType?: number; /** * 语音识别配置。 */ RecognizeConfig?: RecognizeConfig; /** * 翻译相关配置 */ TranslationConfig?: TranslationConfig; } /** * StopMCUMixTranscodeByStrRoomId请求参数结构体 */ export interface StopMCUMixTranscodeByStrRoomIdRequest { /** * TRTC的SDKAppId。 */ SdkAppId: number; /** * 字符串房间号。 */ StrRoomId: string; } /** * 语音识别使用的配置 */ export interface RecognizeConfig { /** * 语音转文字支持识别的语言,默认是"zh" 中文 可通过购买「AI智能识别时长包」解锁或领取包月套餐体验版解锁不同语言. 详细说明参考:[AI智能识别计费说明](https://cloud.tencent.com/document/product/647/111976) 语音转文本不同套餐版本支持的语言如下: **基础语言引擎**: - "zh": 中文(简体) **标准语言引擎:** - "8k_zh_large": 普方大模型引擎. 当前模型同时支持中文等语言的识别,模型参数量极大,语言模型性能增强,针对电话音频中各类场景、各类中文方言的识别准确率极大提升. - "16k_zh_large": 普方英大模型引擎. 当前模型同时支持中文、英文、多种中文方言等语言的识别,模型参数量极大,语言模型性能增强,针对噪声大、回音大、人声小、人声远等低质量音频的识别准确率极大提升. - "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" */ AlternativeLanguage?: Array {
"LLMType": "大模型类型", // String 必填,如:"openai"
"Model": "您的模型名称", // String 必填,指定使用的模型
"APIKey": "您的LLM API密钥", // String 必填
"APIUrl": "https://api.xxx.com/chat/completions", // String 必填,LLM API访问的URL
"History": 10, // Integer 选填,设置 LLM 的上下文轮次,默认值为0,最大值50
"HistoryMode": 1, // Integer 选填,1表示LLM上下文中的内容会和播放音频做同步,没有播放的音频对应的文本不会出现在上下文中。0表示不会做同步,默认值为0
"Streaming": true // Boolean 非必填,指定是否使用流式传输
}
*/
LLMConfig?: string;
/**
* 必填参数,TTS配置,详见 [TTS配置说明](https://cloud.tencent.com/document/product/647/115414 ), 为JSON字符串: TRTC TTS的配置如下:
```
{
"TTSType": "flow", // 【必填】固定为此值
"VoiceId": "v-female-R2s4N9qJ", // 【必填】精品音色 ID /克隆音色 ID, 可选择 不同音色, ID 库参考下方音色列表
"Model": "flow_01_turbo", // 【必填】当前默认的 TTS 模型版本(对应 Flash 版本)
"Speed": 1.0, //【可选】调节语速 范围 [0.5-2.0],默认 1.0; 取值越大,语速越快
"Volume": 1.0, // 【可选】调节音量 [0, 10] 默认值 1.0; 取值越大,音量越高
"Pitch": 0, // 【可选】调节语调 [-12,12],默认值为 0,其中 0 为原音色输出。
"Language": "zh" //【可选】建议填写,目前支持填写中文:zh 英文:en 粤语方言:yue; 参数参考:(ISO 639-1)
}
```
*/
TTSConfig?: string;
/**
* 数字人配置,为JSON字符串。**数字人配置需要提工单加白后才能使用**
*/
AvatarConfig?: string;
/**
* 实验性参数,联系后台使用
*/
ExperimentalParams?: string;
}
/**
* DeletePicture返回参数结构体
*/
export interface DeletePictureResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* ModifyCloudRecording请求参数结构体
*/
export interface ModifyCloudRecordingRequest {
/**
* TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
*/
SdkAppId: number;
/**
* 录制任务的唯一Id,在启动录制成功后会返回。
*/
TaskId: string;
/**
* 需要更新的混流的布局参数。
*/
MixLayoutParams?: MixLayoutParams;
/**
* 指定订阅流白名单或者黑名单。
*/
SubscribeStreamUserIds?: SubscribeStreamUserIds;
}
/**
* StopAIConversation返回参数结构体
*/
export interface StopAIConversationResponse {
/**
* 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
*/
RequestId?: string;
}
/**
* CreateLiveStreamModeration返回参数结构体
*/
export interface CreateLiveStreamModerationResponse {
/**
* AI 内容理解服务分配的任务ID。任务ID是对一次切片任务生命周期过程的唯一标识,结束任务时会失去意义。任务ID需要业务保存下来,作为下次针对这个任务操作的参数
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAIConversation请求参数结构体 */ export interface DescribeAIConversationRequest { /** * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和开启转录任务的房间使用的SdkAppId相同。 */ SdkAppId?: number; /** * 唯一标识一次任务。 */ TaskId?: string; /** * 开启任务时填写的SessionId,如果没写则不返回。 */ SessionId?: string; } /** * 混流转推的音频相关参数。 */ export interface McuAudioParams { /** * 音频编码参数。 */ AudioEncode?: AudioEncode; /** * 音频用户白名单,start时,为空或不填表示混所有主播音频,填具体值表示混指定主播音频;update时,不填表示不更新,为空表示更新为混所有主播音频,填具体值表示更新为混指定主播音频。 使用黑白名单时,黑白名单必须同时填写。都不填写时表示不更新。同一个用户同时在黑白名单时,以黑名单为主。 注:如果是跨房pk时,跨房混流需要指定音频白名单,否则pk主播的音频上行会被拉到两次,产生重音。 */ SubscribeAudioList?: Array转录服务在TRTC房间使用的UserId,注意这个userId不能与其他TRTC或者转录服务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分。
*/ UserId: string; /** *转录服务加入TRTC房间的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算UserSig的方案。
*/ UserSig: string; /** *转录用户白名单,开始服务时,为空或不填表示转录所有主播音频,填具体值表示转录指定主播音频。
使用黑白名单时,同一个用户同时在黑白名单时,以黑名单为主。
转录用户黑名单,为空或不填表示无黑名单,填具体值表示不转录指定主播音频。
同一个用户同时在黑白名单时,以黑名单为主。
所有参与转录的主播持续离开TRTC房间或切换成观众超过MaxIdleTime的时长,自动停止转录任务,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于 86400秒(24小时)。
*/ MaxIdleTime?: number; /** *自定义数据模式: 0表示不开启自定义数据,1表示开启自定义数据。
不填默认为0,表示不开启自定义数据。
tts模型参数,仅支持填写"flow_02_turbo"。
*/ Model: string; /** *tts语言,必须在TranslationParam 的TargetLang列表中。
*/ Language: string; /** *需要TTS播报的主播用户,该主播用户必须在订阅白名单里并且不在订阅黑名单里。
*/ TargetUser: TranscriptionUserInfoParams; /** *TTS 音频回推到房间的机器人用户。
*/ TTSRobotUser: TranscriptionUserInfoParams; /** *TTS的声音配置参数。
*/ Voice: TTSVoice; } /** * DownloadRecognizeVocabV3请求参数结构体 */ export interface DownloadRecognizeVocabV3Request { /** *词表 id
*/ VocabId: string; /** *客户维度唯一标识
*/ SdkAppId: number; } /** * ModifyCloudModeration返回参数结构体 */ export interface ModifyCloudModerationResponse { /** *AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 翻译术语 */ export interface Terminology { /** * 源术语 */ Source: string; /** * 目标术语翻译结果 */ Target: string; } /** * DescribeLiveStreamModeration请求参数结构体 */ export interface DescribeLiveStreamModerationRequest { /** *TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
*/ SdkAppId: number; /** *AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId: string; } /** * 录制视频转码参数。 */ export interface VideoParams { /** * 视频的宽度值,单位为像素,默认值360。不能超过1920,与height的乘积不能超过1920*1080。 */ Width: number; /** * 视频的高度值,单位为像素,默认值640。不能超过1920,与width的乘积不能超过1920*1080。 */ Height: number; /** * 视频的帧率,范围[1, 60],默认15。 */ Fps: number; /** * 视频的码率,单位是bps,范围[64000, 8192000],默认550000bps。 */ BitRate: number; /** * 视频关键帧时间间隔,单位秒,默认值10秒。 */ Gop: number; } /** * DescribeTRTCSegmentModerationUsage返回参数结构体 */ export interface DescribeTRTCSegmentModerationUsageResponse { /** * 用量指标名列表 */ UsageKey?: ArrayBase64编码的音频数据
*/ Audio?: string; /** *字幕对齐数据
*/ Alignments?: Array音频时长
*/ TotalDurationMs?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateCloudModeration请求参数结构体 */ export interface CreateCloudModerationRequest { /** *TRTC的SdkAppId,和TRTC的房间所对应的SdkAppId相同。
*/ SdkAppId: number; /** *TRTC的RoomId,为TRTC房间所对应的RoomId。
*/ RoomId: string; /** *机器人的UserId,用于进房发起AI 内容理解任务。【*注意】这个UserId不能与当前房间内的主播观众UserId重复。如果一个房间发起多个切片任务时,机器人的userid也不能相互重复,否则会中断前一个切片任务。建议可以把房间ID作为UserId的标识的一部分,即机器人UserId在房间内唯一。
*/ UserId: string; /** *AI 内容理解控制参数。
*/ ModerationParams: ModerationParams; /** *机器人UserId对应的校验签名,即UserId和UserSig相当于机器人进房的登录密码,具体计算方法请参考TRTC计算UserSig的方案。
*/ UserSig: string; /** *AI 内容理解文件上传到云存储的参数。
*/ ModerationStorageParams?: ModerationStorageParams; /** *TRTC房间号的类型。 【*注意】必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认) 示例值:1
*/ RoomIdType?: number; /** *任务ID可以调用的时效性,从成功开启任务并获得TaskID后开始计算,超时后无法调用查询、更新和停止等接口,但是切片任务不会停止。 参数的单位是小时,默认24小时(1天),最大可设置72小时(3天),最小设置6小时。举例说明:如果不设置该参数,那么开始切片成功后,查询、更新和停止切片的调用时效为24个小时。
*/ ResourceExpiredHour?: number; } /** * StopStreamIngest请求参数结构体 */ export interface StopStreamIngestRequest { /** * TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同。 */ SdkAppId: number; /** * 任务的唯一Id,在启动任务成功后会返回。 */ TaskId: string; } /** * DescribeTrtcMcuTranscodeTime请求参数结构体 */ export interface DescribeTrtcMcuTranscodeTimeRequest { /** * 查询开始时间,格式为YYYY-MM-DD。 */ StartTime: string; /** * 查询结束时间,格式为YYYY-MM-DD。 单次查询统计区间最多不能超过31天。 */ EndTime: string; /** * 应用ID,可不传。传应用ID时返回的是该应用的用量,不传时返回多个应用的合计值。 */ SdkAppId?: number; } /** * StopStreamIngest返回参数结构体 */ export interface StopStreamIngestResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用户信息,包括用户进房时间,退房时间等 */ export interface UserInformation { /** * 房间号 */ RoomStr?: string; /** * 用户Id */ UserId?: string; /** * 用户进房时间 */ JoinTs?: number; /** * 用户退房时间,用户没有退房则返回当前时间 */ LeaveTs?: number; /** * 终端类型 */ DeviceType?: string; /** * Sdk版本号 */ SdkVersion?: string; /** * 客户端IP地址 */ ClientIp?: string; /** * 判断用户是否已经离开房间 */ Finished?: boolean; } /** * DescribeScaleInfo请求参数结构体 */ export interface DescribeScaleInfoRequest { /** * 用户SdkAppId(如:1400xxxxxx) */ SdkAppId: number; /** * 查询开始时间,本地unix时间戳,单位为秒(如:1590065777) 注意:支持查询14天内的数据。 */ StartTime: number; /** * 查询结束时间,本地unix时间戳,单位为秒(如:1590065877),建议与StartTime间隔时间超过24小时。 注意:按天统计,结束时间大于前一天,否则查询数据为空(如:需查询20号数据,结束时间需晚于20号0点)。 */ EndTime: number; } /** * ControlAIConversation请求参数结构体 */ export interface ControlAIConversationRequest { /** * 任务唯一标识 */ TaskId: string; /** * 控制命令,目前支持命令如下:- ServerPushText,服务端发送文本给AI机器人,AI机器人会播报该文本. - InvokeLLM,服务端发送文本给大模型,触发对话 */ Command: string; /** * 服务端发送播报文本命令,当Command为ServerPushText时必填 */ ServerPushText?: ServerPushText; /** * 服务端发送命令主动请求大模型,当Command为InvokeLLM时会把content请求到大模型,头部增加X-Invoke-LLM="1" */ InvokeLLM?: InvokeLLM; } /** * DismissRoomByStrRoomId返回参数结构体 */ export interface DismissRoomByStrRoomIdResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopPublishCdnStream返回参数结构体 */ export interface StopPublishCdnStreamResponse { /** * 转推任务唯一的String Id */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopPublishCdnStream请求参数结构体 */ export interface StopPublishCdnStreamRequest { /** * TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和转推的房间所对应的SdkAppId相同。 */ SdkAppId: number; /** * 唯一标识转推任务。 */ TaskId: string; /** * 录制任务 key,标识一个录制任务,对应转推任务发起时指定 RecordKey; 如果填写该参数,表示调用者希望立即结束该录制任务。当RecordKey 指定的录制任务正在录制当前转推任务时,录制任务立即结束,否则录制任务不受影响。 如果没有填写该参数,但是转推任务发起时填写了 RecordKey,则表示在续录等待时间结束后才结束录制任务,续录等待期间可以使用相同的 RecordKey 发起新的转推任务,和当前转推任务录制到同一文件。 */ RecordKey?: string; } /** * DescribeUnusualEvent返回参数结构体 */ export interface DescribeUnusualEventResponse { /** * 返回的数据总条数 范围:[0,20] */ Total: number; /** * 异常体验列表 */ AbnormalExperienceList: Array热词表名称
*/ Name?: string; /** *热词表描述
*/ Description?: string; /** *热词表ID
*/ VocabId?: string; /** *词权重列表
*/ WordWeights?: Array词表创建时间
*/ CreateTime?: string; /** *词表更新时间
*/ UpdateTime?: string; /** *热词表状态,1为默认状态即在识别时默认加载该热词表进行识别,0为初始状态
*/ State?: number; } /** * 单流旁路转推的用户上行信息。 */ export interface SingleSubscribeParams { /** * 用户媒体流参数。 */ UserMediaStream: UserMediaStream; } /** * CreateCloudTranscription请求参数结构体 */ export interface CreateCloudTranscriptionRequest { /** *TRTC的SdkAppId,和转录的房间所对应的SdkAppId相同。
*/ SdkAppId: number; /** *TRTC的RoomId,转录的TRTC房间所对应的RoomId。注:房间号类型默认为整型,若房间号类型为字符串,请通过RoomIdType指定。
*/ RoomId: string; /** *房间信息RoomType,必须和转录的房间所对应的RoomId类型相同,0为整型房间号,1为字符串房间号。
*/ RoomIdType: number; /** *转录服务加入TRTC房间的参数。
*/ TranscriptionParam: TranscriptionParam; /** *转录服务ASR使用的参数。
*/ AsrParam: AsrParam; /** *转录服务翻译使用的参数。
*/ TranslationParam?: TranslationParam; /** *转录服务TTS使用的参数。
*/ TTSParam?: Array任务ID
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetRecognizeVocabListV3请求参数结构体 */ export interface GetRecognizeVocabListV3Request { /** *客户维度唯一标识
*/ SdkAppId: number; /** *分页偏移
*/ Offset?: number; /** *分页大小
*/ Limit?: number; } /** * 云端审核的控制参数。 */ export interface ModerationParams { /** *AI 内容理解任务类型, 1:音频切片理解,2:视频截帧理解,3:音视切片+视频截帧理解 默认值1
枚举值:
房间内持续没有用户(主播)上行推流的状态超过MaxIdleTime的时长,自动停止切片,单位:秒。默认值为 30 秒,该值需大于等于 5秒,且小于等于1800秒(0.5小时)。示例值:30
*/ MaxIdleTime?: number; /** *音频切片时长,默认15s 示例值:15, 范围15-60s
*/ SliceAudio?: number; /** *视频截帧间隔时长,默认5s, 范围1-60s
*/ SliceVideo?: number; /** *供应商枚举,
trtc : trtc内容理解
第三方内容理解供应商需要配置信息, ModerationSupplier为trtc时,这个参数可以不需要初始化
*/ ModerationSupplierParam?: ModerationSupplierParam; /** *是否保存文件: 0不保存文件 1保存所有文件 2仅保存命中文件
*/ SaveModerationFile?: number; /** *是否回调所有内容理解结果:0 默认回调所有结果 1 仅回调命中结果
*/ CallbackAllResults?: number; /** *指定订阅流白名单或者黑名单。
*/ SubscribeStreamUserIds?: SubscribeModerationUserIds; } /** * DescribeCloudSliceTask请求参数结构体 */ export interface DescribeCloudSliceTaskRequest { /** * TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。 */ SdkAppId: number; /** * 切片任务的唯一Id,在启动切片任务成功后会返回。 */ TaskId: string; } /** * StartMCUMixTranscodeByStrRoomId请求参数结构体 */ export interface StartMCUMixTranscodeByStrRoomIdRequest { /** * TRTC的SDKAppId。 */ SdkAppId: number; /** * 字符串房间号。 */ StrRoomId: string; /** * 混流输出控制参数。 */ OutputParams: OutputParams; /** * 混流输出编码参数。 */ EncodeParams: EncodeParams; /** * 混流输出布局参数。 */ LayoutParams: LayoutParams; /** * 第三方CDN转推参数。如需转推至腾讯云云直播,此参数无需填写,会默认转推 */ PublishCdnParams?: PublishCdnParams; } /** * SetVocabStateV3请求参数结构体 */ export interface SetVocabStateV3Request { /** *词表 id
*/ VocabId: string; /** *是否设置为默认词表
*/ State: number; /** *客户维度唯一标识
*/ SdkAppId: number; } /** * TRTC用户参数。 */ export interface MixUserInfo { /** * 用户ID。 */ UserId: string; /** * 动态布局时房间信息必须和主房间信息保持一致,自定义布局时房间信息必须和MixLayoutList中对应用户的房间信息保持一致,不填时默认与主房间信息一致。 */ RoomId?: string; /** * 房间号类型,0为整型房间号,1为字符串房间号。 */ RoomIdType?: number; } /** * DescribeTRTCMarketQualityData请求参数结构体 */ export interface DescribeTRTCMarketQualityDataRequest { /** *用户SdkAppId(如:1400xxxxxx)
*/ SdkAppId: string; /** *查询开始时间,格式为YYYY-MM-DD。(查询时间范围根据监控仪表盘功能版本而定,【基础版】可查近30天,【进阶版】可查近60天)
*/ StartTime: string; /** *查询结束时间,格式为YYYY-MM-DD。
*/ EndTime: string; /** *返回数据的粒度,支持设为以下值:
d:按天。此时返回查询时间范围内 UTC 时间为零点的数据。
h:按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
返回数据是否为小数
*/ IsFloat?: boolean; } /** * DescribeTRTCRealTimeScaleData返回参数结构体 */ export interface DescribeTRTCRealTimeScaleDataResponse { /** * TRTC监控数据出参 注意:此字段可能返回 null,表示取不到有效值。 */ Data?: TRTCDataResult; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteCloudTranscription请求参数结构体 */ export interface DeleteCloudTranscriptionRequest { /** * TRTC的SDKAppId,和转录的房间所对应的SDKAppId相同。 */ SdkAppId: number; /** * 转录任务的唯一Id,在启动转录成功后会返回。 */ TaskId: string; } /** * UpdatePublishCdnStream请求参数结构体 */ export interface UpdatePublishCdnStreamRequest { /** *TRTC的SdkAppId,和转推的房间所对应的SdkAppId相同。
*/ SdkAppId: number; /** *唯一标识转推任务。
*/ TaskId: string; /** *客户保证同一个任务,每次更新请求中的SequenceNumber递增,防止请求乱序。
*/ SequenceNumber: number; /** *是否转码,0表示无需转码,1表示需要转码。 WithTranscoding为0,表示旁路转推,默认不转码;WithTranscoding为1,表示混流转推,此时一定会转码,并收取转码费用。 注: 1,混流是必须转码的,这个参数需设置为1。 2,WithTranscoding=0时,视频输出Codec默认跟随上行视频Codec,如果上行视频Codec发生变化,CDN会断流重推。
*/ WithTranscoding: number; /** *更新相关参数,只支持更新参与混音的主播列表参数,不支持更新Codec、采样率、码率和声道数。不填表示不更新此参数。
*/ AudioParams?: McuAudioParams; /** *更新视频相关参数,转码时支持更新除编码类型之外的编码参数,视频布局参数,背景图片和背景颜色参数,水印参数。不填表示不更新此参数。
*/ VideoParams?: McuVideoParams; /** *更新单流转推的用户上行参数,仅在非转码时有效。不填表示不更新此参数。
*/ SingleSubscribeParams?: SingleSubscribeParams; /** *更新转推的CDN参数。不填表示不更新此参数。
*/ PublishCdnParams?: Array混流SEI参数
*/ SeiParams?: McuSeiParams; /** *回推房间信息
*/ FeedBackRoomParams?: Array克隆出的音色ID,可以用此id进行语音合成
*/ VoiceId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 断句配置 */ export interface TurnDetection { /** * TurnDetectionMode为3时生效,语义断句的灵敏程度 功能简介:根据用户所说的话来判断其已完成发言来分割音频 可选: "low" | "medium" | "high" | "auto" auto 是默认值,与 medium 相同。 low 将让用户有足够的时间说话。 high 将尽快对音频进行分块。 如果您希望模型在对话模式下更频繁地响应,可以将 SemanticEagerness 设置为 high 如果您希望在用户停顿时,AI能够等待片刻,可以将 SemanticEagerness 设置为 low 无论什么模式,最终都会分割送个大模型进行回复 */ SemanticEagerness?: string; } /** * UpdateStreamIngest请求参数结构体 */ export interface UpdateStreamIngestRequest { /** * TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同 */ SdkAppId: number; /** * 任务的唯一Id,在启动任务成功后会返回。 */ TaskId: string; /** * 源流URL。 */ StreamUrl?: string; /** * 音量,取值范围[0, 200],默认100,表示原音量。 */ Volume?: number; /** * 是否暂停,默认false表示不暂停。暂停期间任务仍在进行中仍会计费,暂停超过12小时会自动销毁任务, 建议主动调用停止任务接口。 */ IsPause?: boolean; /** * 是否开启播放进度回调, 默认false,当开启后,播放进度会通过trtc custom data 回调给播放端 */ EnableProgress?: boolean; /** * 播放倍速,默认1.0,可取[0.5, 0.75, 1.0, 1.25, 1.5, 1.75, 2.0] */ Tempo?: number; } /** * TextToSpeechSSE请求参数结构体 */ export interface TextToSpeechSSERequest { /** *需要转语音的文字内容,最大支持20000字符
*/ Text: string; /** *文本转语音的声音配置
*/ Voice: Voice; /** *TRTC的SdkAppId
*/ SdkAppId: number; /** *文本转语音的输出音频的格式
*/ AudioFormat?: AudioFormat; /** *TTS的API密钥
* @deprecated */ APIKey?: string; /** *TTS的模型,支持flow_02_turbo,flow_01_ex,默认为flow_02_turbo
枚举值:
需要合成的语言,默认为空,表示自动识别
flow_02_turbo支持以下语言:
flow_01_ex支持以下语言:
多音字/生僻字发音纠正词典条目。指定特定词语在本次请求中使用的发音。
*/ PronunciationDict?: Array字幕级别
枚举值:
默认值:0
*/ AlignmentMode?: number; /** *json字符串,用于拓展用法
*/ ExtraParams?: string; } /** * StopWebRecord返回参数结构体 */ export interface StopWebRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 伴生转录术语表词组对 */ export interface TermPair { /** *源术语。
*/ Source: string; /** *目标术语翻译结果。
*/ Target: string; } /** * DeletePicture请求参数结构体 */ export interface DeletePictureRequest { /** * 图片id */ PictureId: number; /** * 应用id */ SdkAppId: number; } /** * StopWebRecord请求参数结构体 */ export interface StopWebRecordRequest { /** *需要停止的任务Id
*/ TaskId: string; } /** * 混流SEI参数 */ export interface McuSeiParams { /** * 音量布局SEI */ LayoutVolume?: McuLayoutVolume; /** * 透传SEI */ PassThrough?: McuPassThrough; } /** * UpdateVoicePrint请求参数结构体 */ export interface UpdateVoicePrintRequest { /** * 声纹信息ID */ VoicePrintId: string; /** * 毫秒时间戳 */ ReqTimestamp: number; /** * 音频格式,目前只支持0,代表wav */ AudioFormat?: number; /** * 整个wav音频文件的base64字符串,其中wav文件限定为16k采样率, 16bit位深, 单声道, 8到18秒音频时长,有效音频不小于6秒(不能有太多静音段),编码数据大小不超过2M */ Audio?: string; /** * 和声纹绑定的MetaInfo,长度最大不超过512 */ AudioMetaInfo?: string; } /** * StartPublishCdnStream请求参数结构体 */ export interface StartPublishCdnStreamRequest { /** *TRTC的SdkAppId,和转推的房间所对应的SdkAppId相同。
*/ SdkAppId: number; /** *主房间信息RoomId,转推的TRTC房间所对应的RoomId。
*/ RoomId: string; /** *主房间信息RoomType,必须和转推的房间所对应的RoomId类型相同,0为整型房间号,1为字符串房间号。
*/ RoomIdType: number; /** *转推服务加入TRTC房间的机器人参数。
*/ AgentParams: AgentParams; /** *是否转码,0表示无需转码,1表示需要转码。
WithTranscoding为0,表示旁路转推,默认不转码;WithTranscoding为1,表示混流转推,此时一定会转码,并收取转码费用。
注:
1,混流是必须转码的,这个参数需设置为1。
2,WithTranscoding=0时,视频输出Codec默认跟随上行视频Codec,如果上行视频Codec发生变化,CDN会断流重推。
转推流的音频编码参数。由于音频是必转码的(不会收取转码费用),所以启动任务的时候,必须填写。
*/ AudioParams?: McuAudioParams; /** *转推流的视频编码参数,不填表示纯音频转推。
*/ VideoParams?: McuVideoParams; /** *需要单流旁路转推的用户上行参数,单流旁路转推时,WithTranscoding需要设置为0。
*/ SingleSubscribeParams?: SingleSubscribeParams; /** *转推的CDN参数,一个任务最多支持10个推流URL。和回推房间参数必须要有一个。
*/ PublishCdnParams?: Array混流SEI参数
*/ SeiParams?: McuSeiParams; /** *回推房间信息,一个任务最多支持回推10个房间,和转推CDN参数必须要有一个。注:回推房间需使用10.4及以上SDK版本,如您有需求,请联系腾讯云技术支持。
*/ FeedBackRoomParams?: Array转推录制参数,参考文档。
*/ RecordParams?: McuRecordParams; } /** * 事件信息,包括,事件时间戳,事件ID, */ export interface EventMessage { /** * 视频流类型: 0:与视频无关的事件; 2:视频为大画面; 3:视频为小画面; 7:视频为旁路画面; */ Type?: number; /** * 事件上报的时间戳,unix时间(1589891188801ms) */ Time?: number; /** * 事件Id:分为sdk的事件和webrtc的事件,详情见:附录/事件 ID 映射表:https://cloud.tencent.com/document/product/647/44916 */ EventId?: number; /** * 事件的第一个参数,如视频分辨率宽 */ ParamOne?: number; /** * 事件的第二个参数,如视频分辨率高 */ ParamTwo?: number; } /** * UpdateAIConversation请求参数结构体 */ export interface UpdateAIConversationRequest { /** * 唯一标识一个任务 */ TaskId: string; /** * 不填写则不进行更新,机器人的欢迎语 */ WelcomeMessage?: string; /** * 不填写则不进行更新。智能打断模式,0表示服务端自动打断,1表示服务端不打断,由端上发送打断信令进行打断 */ InterruptMode?: number; /** * 不填写则不进行更新。InterruptMode为0时使用,单位为毫秒,默认为500ms。表示服务端检测到持续InterruptSpeechDuration毫秒的人声则进行打断 */ InterruptSpeechDuration?: number; /** * 不填写则不进行更新,LLM配置,详情见StartAIConversation接口 */ LLMConfig?: string; /** * 不填写则不进行更新,TTS配置,详情见StartAIConversation接口 */ TTSConfig?: string; } /** * UpdatePublishCdnStream返回参数结构体 */ export interface UpdatePublishCdnStreamResponse { /** *转推任务唯一的String Id
*/ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 文字水印参数。 */ export interface McuWaterMarkText { /** * 文字水印内容。 */ Text: string; /** * 水印在输出时的宽。单位为像素值。 */ WaterMarkWidth: number; /** * 水印在输出时的高。单位为像素值。 */ WaterMarkHeight: number; /** * 水印在输出时的X偏移。单位为像素值。 */ LocationX: number; /** * 水印在输出时的Y偏移。单位为像素值。 */ LocationY: number; /** * 字体大小 */ FontSize: number; /** * 字体颜色,默认为白色。常用的颜色有: 红色:0xcc0033。 黄色:0xcc9900。 绿色:0xcccc33。 蓝色:0x99CCFF。 黑色:0x000000。 白色:0xFFFFFF。 灰色:0x999999。 */ FontColor?: string; /** * 字体背景色,不配置默认为透明。常用的颜色有: 红色:0xcc0033。 黄色:0xcc9900。 绿色:0xcccc33。 蓝色:0x99CCFF。 黑色:0x000000。 白色:0xFFFFFF。 灰色:0x999999。 */ BackGroundColor?: string; /** * 动态水印类型,默认为0。0:关闭;1:随机位置,每秒变动一次;2:边界扫描反弹,每帧变动一次。 */ DynamicPosType?: number; /** * 水印在输出时的层级,不填默认为0。 */ ZOrder?: number; /** * 水印字体,不填默认为Tencent。支持设置以下值: Tencent (默认) SourceHanSans */ Font?: string; } /** * AI转录参数 */ export interface TranscriptionParams { /** * 转录机器人的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; /** * IM[管理员账户]( https://cloud.tencent.com/document/product/269/31999#app-.E7.AE.A1.E7.90.86.E5.91.98),如果填写,后台下发消息会使用IM通道,而不是TRTC自定义消息。 * @deprecated */ IMAdminUserId?: string; /** * IM管理员账户生成的签名,用于向特定群组发送消息。如果填写,后台下发消息会使用IM通道,而不是TRTC自定义消息。必须和IM管理员的UserId一起填写。 * @deprecated */ IMAdminUserSig?: string; /** * 房间内推流用户全部退出后超过MaxIdleTime秒,后台自动关闭转录任务,默认值是60s。 */ MaxIdleTime?: number; /** * 1表示机器人只订阅单个人的流,0表示机器人订阅整个房间的流,如果不填默认订阅整个房间的流。 */ TranscriptionMode?: number; /** * TranscriptionMode为1时必填,机器人只会拉该userid的流,忽略房间里其他用户。 */ TargetUserId?: string; /** * 机器人订阅的用户列表 仅 TranscriptionMode 为 1或者 TranscriptionMode 为无限上麦模式支持传入多个用户列表 */ TargetUserIdList?: Array词表 id
*/ VocabId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UpdateRecognizeVocabV3请求参数结构体 */ export interface UpdateRecognizeVocabV3Request { /** *词表 id
*/ VocabId: string; /** *客户维度唯一标识
*/ SdkAppId: number; /** *词表名称
*/ Name?: string; /** *词表描述
*/ Description?: string; /** *热词数组
*/ WordWeights?: Arraybase64 编码的词表文本
*/ WordWeightStr?: string; } /** * 指定动态布局中悬浮布局和屏幕分享布局的大画面信息,只在悬浮布局和屏幕分享布局有效。 */ export interface MaxVideoUser { /** * 用户媒体流参数。 */ UserMediaStream: UserMediaStream; } /** * TextToSpeech请求参数结构体 */ export interface TextToSpeechRequest { /** *需要转语音的文字内容,最大支持2000字符
*/ Text: string; /** *文本转语音的声音配置
*/ Voice: Voice; /** *TRTC的SdkAppId
*/ SdkAppId: number; /** *文本转语音的输出音频的格式
*/ AudioFormat?: AudioFormat; /** *TTS的API密钥
* @deprecated */ APIKey?: string; /** *TTS的模型,支持flow_02_turbo,flow_01_ex,默认为flow_02_turbo
枚举值:
需要合成的语言,默认为空,表示自动识别
flow_02_turbo支持以下语言:
flow_01_ex支持以下语言:
多音字/生僻字发音纠正词典条目。指定特定词语在本次请求中使用的发音。
*/ PronunciationDict?: Array字幕级别
枚举值:
默认值:0
*/ AlignmentMode?: number; /** *json字符串,用于拓展用法
*/ ExtraParams?: string; } /** * DescribeStreamIngest请求参数结构体 */ export interface DescribeStreamIngestRequest { /** * TRTC的SDKAppId,和任务的房间所对应的SDKAppId相同 */ SdkAppId: number; /** * 任务的唯一Id,在启动任务成功后会返回。 */ TaskId: string; } /** * UpdateVoicePrint返回参数结构体 */ export interface UpdateVoicePrintResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * TTS相关配置 */ export interface TTSConfig { /** * 音色ID */ VoiceId: string; /** * TTS 的模型,默认是:flow_01_turbo, 可选: [ flow_01_turbo, flow_01_ex] */ Model?: string; /** * 语速,范围 0.5-2.0,默认 1.0 */ Speed?: number; /** * (0, 10] 默认值1.0 */ Volume?: number; } /** * MCU混流输出流编码参数 */ export interface EncodeParams { /** * 混流-输出流音频采样率。取值为[48000, 44100, 32000, 24000, 16000, 8000],单位是Hz。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。 */ AudioSampleRate: number; /** * 混流-输出流音频码率。取值范围[8,500],单位为kbps。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。 */ AudioBitrate: number; /** * 混流-输出流音频声道数,取值范围[1,2],1表示混流输出音频为单声道,2表示混流输出音频为双声道。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。 */ AudioChannels: number; /** * 混流-输出流宽,音视频输出时必填。取值范围[0,1920],单位为像素值。 */ VideoWidth?: number; /** * 混流-输出流高,音视频输出时必填。取值范围[0,1080],单位为像素值。 */ VideoHeight?: number; /** * 混流-输出流码率,音视频输出时必填。取值范围[1,10000],单位为kbps。 */ VideoBitrate?: number; /** * 混流-输出流帧率,音视频输出时必填。取值范围[1,60],表示混流的输出帧率可选范围为1到60fps。 */ VideoFramerate?: number; /** * 混流-输出流gop,音视频输出时必填。取值范围[1,5],单位为秒。 */ VideoGop?: number; /** * 混流-输出流背景色,取值是十进制整数。常用的颜色有: 红色:0xff0000,对应的十进制整数是16724736。 黄色:0xffff00。对应的十进制整数是16776960。 绿色:0x33cc00。对应的十进制整数是3394560。 蓝色:0x0066ff。对应的十进制整数是26367。 黑色:0x000000。对应的十进制整数是0。 白色:0xFFFFFF。对应的十进制整数是16777215。 灰色:0x999999。对应的十进制整数是10066329。 */ BackgroundColor?: number; /** * 混流-输出流背景图片,取值为实时音视频控制台上传的图片ID。 */ BackgroundImageId?: number; /** * 混流-输出流音频编码类型,取值范围[0,1, 2],0为LC-AAC,1为HE-AAC,2为HE-AACv2。默认值为0。当音频编码设置为HE-AACv2时,只支持输出流音频声道数为双声道。HE-AAC和HE-AACv2支持的输出流音频采样率范围为[48000, 44100, 32000, 24000, 16000]。混流任务发起过程中,为了保持CDN链接的稳定,不要修改音频参数(codec、采样率、码率、声道数)。 */ AudioCodec?: number; /** * 混流-输出流背景图片URL地址,支持png、jpg、jpeg、bmp格式,暂不支持透明通道。URL链接长度限制为512字节。BackgroundImageUrl和BackgroundImageId参数都填时,以BackgroundImageUrl为准。图片大小限制不超过2MB。 */ BackgroundImageUrl?: string; } /** * DownloadRecognizeVocabV3返回参数结构体 */ export interface DownloadRecognizeVocabV3Response { /** *词表 id
*/ VocabId?: string; /** *文本形式热词
*/ WordWeightStr?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeTRTCDedicatedCloudAccUsage返回参数结构体 */ export interface DescribeTRTCDedicatedCloudAccUsageResponse { /** * 用量指标名列表 */ UsageKey?: Array音频采样率枚举值:(注意1 代表48000HZ, 2 代表44100HZ, 3 代表16000HZ)
1:48000Hz(默认);
2:44100Hz
3:16000Hz。
声道数枚举值:
1:单声道;
2:双声道(默认)。
音频码率: 取值范围[32000, 128000] ,单位bps,默认64000bps。
*/ BitRate: number; } /** * StopAITranscription返回参数结构体 */ export interface StopAITranscriptionResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SeriesInfo类型 */ export interface SeriesInfo { /** * 数据列 注意:此字段可能返回 null,表示取不到有效值。 */ Columns: Array词表 id
*/ VocabId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * Mcu转推录制,点播相关参数。 */ export interface McuCloudVod { /** * 腾讯云点播相关参数。 */ McuTencentVod?: McuTencentVod; } /** * StopMCUMixTranscode请求参数结构体 */ export interface StopMCUMixTranscodeRequest { /** * TRTC的SDKAppId。 */ SdkAppId: number; /** * 房间号。 */ RoomId: number; } /** * DescribeCloudModeration请求参数结构体 */ export interface DescribeCloudModerationRequest { /** *TRTC的SDKAppId,和录制的房间所对应的SDKAppId相同。
*/ SdkAppId: number; /** *AI 内容理解任务的唯一Id,在启动切片任务成功后会返回。
*/ TaskId: string; } /** * 第三方CDN转推参数 */ export interface PublishCdnParams { /** * 腾讯云直播BizId。 */ BizId: number; /** * 第三方CDN转推的目的地址,同时只支持转推一个第三方CDN地址。 */ PublishCdnUrls: Array字幕文本
*/ Text?: string; /** *字幕对应的时间起点
*/ TimeBeginMs?: number; /** *字幕对应的时间尾点
*/ TimeEndMs?: number; /** *字幕对应的文本索引起点
*/ TextBegin?: number; /** *字幕对应的文本索引尾点
*/ TextEnd?: number; /** *词级别时间戳
*/ Words?: Array