tencentcloud-sdk-nodejs/tencentcloud/services/trtc/v20190722/trtc_models.d.ts

腾讯云 API NODEJS SDK

/**
 * 返回的质量数据，时间:值
 */
export interface TimeValue {
    /**
     * 时间，unix时间戳（1590065877s)
     */
    Time?: number;
    /**
     * 当前时间返回参数取值，如（bigvCapFps在1590065877取值为0，则Value：0 ）
     */
    Value?: number;
}
/**
 * 机器人参数
 */
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;
}
/**
 * CreatePicture请求参数结构体
 */
export interface CreatePictureRequest {
    /**
     * 应用id
     */
    SdkAppId: number;
    /**
     * 图片内容经base64编码后的string格式,最大长度为2M
     */
    Content: string;
    /**
     * 图片后缀名
     */
    Suffix: string;
    /**
     * 图片长度
     */
    Height: number;
    /**
     * 图片宽度
     */
    Width: number;
    /**
     * 显示位置x轴方向
     */
    XPosition: number;
    /**
     * 显示位置y轴方向
     */
    YPosition: number;
}
/**
 * 音频转码参数
 */
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;
    /**
     * 服务端推送播报音频
      格式说明：音频以16KHz采样率的单声道格式提供，编码为Base64字符串。
      输入规则：当提供Audio字段时，将不接受Text字段的输入。系统将直接播放Audio字段中的音频内容。
     */
    Audio?: string;
}
/**
 * DescribeTRTCMarketQualityMetricData返回参数结构体
 */
export interface DescribeTRTCMarketQualityMetricDataResponse {
    /**
     * TRTC监控数据出参
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Data: TRTCDataResp;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 用户自定义混流布局参数列表。
 */
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，大小限制不超过5M。注意，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格式。图片大小限制不超过5MB。
  注：您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，背景图将不会生效。
     */
    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": 英语
  
  **标准版：**
  - "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"
     */
    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;
}
/**
 * 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;
}
/**
 * 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;
}
/**
 * 混流自定义渲染参数
 */
export interface McuBackgroundCustomRender {
    /**
     * 自定义渲染画面的宽度，单位为像素值，需大于0，且不能超过子布局的宽。
     */
    Width: number;
    /**
     * 自定义渲染画面的高度，单位为像素值，需大于0，且不能超过子布局的高。
     */
    Height: number;
    /**
     * 自定义渲染画面的圆角半径，单位为像素值，不能超过渲染画面Width和Height最小值的一半，不指定默认为0，表示直角。
     */
    Radius?: 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;
}
/**
 * DescribeTrtcRoomUsage返回参数结构体
 */
export interface DescribeTrtcRoomUsageResponse {
    /**
     * 房间维度用量数据，csv文件格式，单位：秒。
     */
    Data?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StopPublishCdnStream返回参数结构体
 */
export interface StopPublishCdnStreamResponse {
    /**
     * 转推任务唯一的String Id
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 造成异常体验可能的异常事件类型
 */
export interface AbnormalEvent {
    /**
     * 异常事件ID，具体值查看附录：异常体验ID映射表：https://cloud.tencent.com/document/product/647/44916
     */
    AbnormalEventId?: number;
    /**
     * 远端用户ID,""：表示异常事件不是由远端用户产生
     */
    PeerId?: string;
}
/**
 * 历史规模信息
 */
export interface ScaleInfomation {
    /**
     * 每天开始的时间
     */
    Time?: number;
    /**
     * 房间人数，用户重复进入同一个房间为1次
     */
    UserNumber?: number;
    /**
     * 房间人次，用户每次进入房间为一次
     */
    UserCount?: number;
    /**
     * sdkappid下一天内的房间数
     */
    RoomNumbers?: number;
}
/**
 * DescribeTRTCRealTimeScaleMetricData请求参数结构体
 */
export interface DescribeTRTCRealTimeScaleMetricDataRequest {
    /**
     * 用户SdkAppId（如：1400xxxxxx）
     */
    SdkAppId: string;
    /**
     * 开始时间，unix时间戳，单位：秒（查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时）
     */
    StartTime: number;
    /**
     * 结束时间，unix时间戳，单位：秒
     */
    EndTime: number;
    /**
     * 房间ID
     */
    RoomId?: string;
}
/**
 * ControlAIConversation返回参数结构体
 */
export interface ControlAIConversationResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StopAITranscription请求参数结构体
 */
export interface StopAITranscriptionRequest {
    /**
     * 唯一标识转录任务。
     */
    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;
}
/**
 * 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<string>;
    /**
     * 自定义模板中有效，指定用户视频在混合画面中的位置。
     */
    PresetLayoutConfig?: Array<PresetLayoutConfig>;
    /**
     * 自定义模板中有效，设置为1时代表启用占位图功能，0时代表不启用占位图功能，默认为0。启用占位图功能时，在预设位置的用户没有上行视频时可显示对应的占位图。
     */
    PlaceHolderMode?: number;
    /**
     * 悬浮模板、九宫格、屏幕分享模板生效，用于控制纯音频上行是否占用画面布局位置。设置为0是代表后台默认处理方式，悬浮小画面占布局位置，九宫格画面占布局位置、屏幕分享小画面不占布局位置；设置为1时代表纯音频上行占布局位置；设置为2时代表纯音频上行不占布局位置。默认为0。
     */
    PureAudioHoldPlaceMode?: number;
    /**
     * 水印参数。
     */
    WaterMarkParams?: WaterMarkParams;
    /**
     * 屏幕分享模板、悬浮模板、九宫格模板、画中画模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底，不填采用后台的默认渲染方式（屏幕分享大画面为缩放，其他为裁剪）。若此参数不生效，请提交工单寻求帮助。
     */
    RenderMode?: number;
}
/**
 * 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
     */
    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;
}
/**
 * DescribeTRTCMarketScaleData返回参数结构体
 */
export interface DescribeTRTCMarketScaleDataResponse {
    /**
     * TRTC监控数据出参
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Data?: TRTCDataResult;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 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;
}
/**
 * ModifyPicture请求参数结构体
 */
export interface ModifyPictureRequest {
    /**
     * 图片id
     */
    PictureId: number;
    /**
     * 应用id
     */
    SdkAppId: number;
    /**
     * 图片长度
     */
    Height?: number;
    /**
     * 图片宽度
     */
    Width?: number;
    /**
     * 显示位置x轴方向
     */
    XPosition?: number;
    /**
     * 显示位置y轴方向
     */
    YPosition?: number;
}
/**
 * DescribeWebRecord返回参数结构体
 */
export interface DescribeWebRecordResponse {
    /**
     * 1: 正在录制中
     */
    Status?: number;
    /**
     * 在使用RecordId查询时返回
     */
    TaskId?: string;
    /**
     * 在使用TaskId查询时返回
     */
    RecordId?: 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;
}
/**
 * DescribeRelayUsage请求参数结构体
 */
export interface DescribeRelayUsageRequest {
    /**
     * 查询开始时间，格式为YYYY-MM-DD。
     */
    StartTime: string;
    /**
     * 查询结束时间，格式为YYYY-MM-DD。
  单次查询统计区间最多不能超过31天。
     */
    EndTime: string;
    /**
     * TRTC的SdkAppId，和房间所对应的SdkAppId相同。如果没有这个参数，返回用户下全部实时音视频应用的汇总。
     */
    SdkAppId?: number;
}
/**
 * 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;
}
/**
 * StartMCUMixTranscodeByStrRoomId返回参数结构体
 */
export interface StartMCUMixTranscodeByStrRoomIdResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 腾讯云对象存储COS以及第三方云存储的账号信息
 */
export interface CloudStorage {
    /**
     * 腾讯云对象存储COS以及第三方云存储账号信息
  0：腾讯云对象存储 COS
  1：AWS
  【注意】目前第三方云存储仅支持AWS，更多第三方云存储陆续支持中
     */
    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）
     */
    Region: string;
    /**
     * 云存储桶名称。
     */
    Bucket: string;
    /**
     * 云存储的access_key账号信息。
  若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretId值。
     */
    AccessKey: string;
    /**
     * 云存储的secret_key账号信息。
  若存储至腾讯云对象存储COS，请前往https://console.cloud.tencent.com/cam/capi 查看或创建，对应链接中密钥字段的SecretKey值。
     */
    SecretKey: string;
    /**
     * 云存储bucket 的指定位置，由字符串数组组成。合法的字符串范围az,AZ,0~9,'_'和'-'，举个例子，录制文件xxx.m3u8在 ["prefix1", "prefix2"]作用下，会变成prefix1/prefix2/TaskId/xxx.m3u8。
     */
    FileNamePrefix?: Array<string>;
}
/**
 * DescribeTrtcUsage返回参数结构体
 */
export interface DescribeTrtcUsageResponse {
    /**
     * 用量类型，与UsageValue中各个位置的值对应。
     */
    UsageKey?: Array<string>;
    /**
     * 各个时间点用量明细，单位:分钟
     */
    UsageList?: Array<TrtcUsage>;
    /**
     * 唯一请求 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，标识一个录制任务；您可以通过该参数，将多个转推任务录制成一个文件。不指定该参数时，只录制当前转推任务。
  【限制长度为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;
}
/**
 * DismissRoomByStrRoomId请求参数结构体
 */
export interface DismissRoomByStrRoomIdRequest {
    /**
     * TRTC的SDKAppId。
     */
    SdkAppId: number;
    /**
     * 字符串类型房间号。
  本接口仅支持解散字符串类型房间号，如需解散数字类型房间号，请使用：DismissRoom
     */
    RoomId: string;
}
/**
 * DescribeTRTCMarketQualityMetricData请求参数结构体
 */
export interface DescribeTRTCMarketQualityMetricDataRequest {
    /**
     * 用户SdkAppId（如：1400xxxxxx）
     */
    SdkAppId: string;
    /**
     * 查询开始时间，格式为YYYY-MM-DD。（查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天）
     */
    StartTime: string;
    /**
     * 查询结束时间，格式为YYYY-MM-DD。
     */
    EndTime: string;
    /**
     * 返回数据的粒度，支持设为以下值：
  d：按天。此时返回查询时间范围内 UTC 时间为零点的数据。
  h：按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
     */
    Period: string;
}
/**
 * DescribeWebRecord请求参数结构体
 */
export interface DescribeWebRecordRequest {
    /**
     * 开始页面录制时返回的任务id
     */
    TaskId?: string;
    /**
     * 发起页面录制时传递的SdkAppId
     */
    SdkAppId?: number;
    /**
     * 发起录制时传递的RecordId, 传入此值时需要传递SdkAppId
     */
    RecordId?: string;
}
/**
 * DescribeTRTCRealTimeScaleData返回参数结构体
 */
export interface DescribeTRTCRealTimeScaleDataResponse {
    /**
     * TRTC监控数据出参
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Data?: TRTCDataResult;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: 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;
}
/**
 * CreateBasicModeration请求参数结构体
 */
export interface CreateBasicModerationRequest {
    /**
     * 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;
    /**
     * 目标审核用户id
     */
    UserId: string;
    /**
     * TRTC房间号的类型。【*注意】必须和TRTC的房间所对应的RoomId类型相同:0: 字符串类型的RoomId1: 32位整型的RoomId（默认）
     */
    RoomIdType?: number;
    /**
     * 音频文件上传到云存储的参数
     */
    AuditStorageParams?: AuditStorageParams;
}
/**
 * 点播相关参数。
 */
export interface CloudVod {
    /**
     * 腾讯云点播相关参数。
     */
    TencentVod?: TencentVod;
}
/**
 * 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;
}
/**
 * 渲染移动模式参数，不渲染移动模式时，请勿设置此参数。
 */
export interface EmulateMobileParams {
    /**
     * 移动设备类型，
  0: 手机
  1: 平板
  注意：此字段可能返回 null，表示取不到有效值。
     */
    MobileDeviceType?: number;
    /**
     * 屏幕方向，
  0: 竖屏，
  1: 横屏
  注意：此字段可能返回 null，表示取不到有效值。
     */
    ScreenOrientation?: number;
}
/**
 * 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;
}
/**
 * DescribeMixTranscodingUsage请求参数结构体
 */
export interface DescribeMixTranscodingUsageRequest {
    /**
     * 查询开始时间，格式为YYYY-MM-DD。
     */
    StartTime: string;
    /**
     * 查询结束时间，格式为YYYY-MM-DD。
  单次查询统计区间最多不能超过31天。
     */
    EndTime: string;
    /**
     * TRTC的SdkAppId，和房间所对应的SdkAppId相同。如果没有这个参数，返回用户下全部实时音视频应用的汇总。
     */
    SdkAppId?: number;
}
/**
 * DescribeStreamIngest返回参数结构体
 */
export interface DescribeStreamIngestResponse {
    /**
     * 任务的状态信息。
  InProgress：表示当前任务正在进行中。
  NotExist：表示当前任务不存在。
  示例值：InProgress
     */
    Status?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 录制的音视频转码参数。
 */
export interface MixTranscodeParams {
    /**
     * 录制视频转码参数，注意如果设置了这个参数，那么里面的字段都是必填的，没有默认值，如果不填这个参数，那么取值为默认值。
     */
    VideoParams?: VideoParams;
    /**
     * 录制音频转码参数，注意如果设置了这个参数，那么里面的字段都是必填的，没有默认值，如果不填这个参数，那么取值为默认值。
     */
    AudioParams?: AudioParams;
}
/**
 * StopStreamIngest请求参数结构体
 */
export interface StopStreamIngestRequest {
    /**
     * TRTC的SDKAppId，和任务的房间所对应的SDKAppId相同。
     */
    SdkAppId: number;
    /**
     * 任务的唯一Id，在启动任务成功后会返回。
     */
    TaskId: string;
}
/**
 * DescribeTRTCMarketQualityData返回参数结构体
 */
export interface DescribeTRTCMarketQualityDataResponse {
    /**
     * TRTC监控数据出参
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Data?: TRTCDataResult;
    /**
     * 唯一请求 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;
}
/**
 * 指定订阅流白名单或者黑名单，音频的白名单和音频黑名单不能同时设置，视频亦然。同时实际并发订阅的媒体流路数最大支持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的音频流。默认不填订阅房间内所有音频流，订阅列表用户数不超过32。
     */
    UnSubscribeAudioUserIds?: Array<string>;
    /**
     * 订阅视频流白名单，指定订阅哪几个UserId的视频流，例如["1", "2", "3"], 代表订阅UserId  1，2，3的视频流；["1.*$"], 代表订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。
     */
    SubscribeVideoUserIds?: Array<string>;
    /**
     * 订阅视频流黑名单，指定不订阅哪几个UserId的视频流，例如["1", "2", "3"], 代表不订阅UserId  1，2，3的视频流；["1.*$"], 代表不订阅UserId前缀为1的视频流。默认不填订阅房间内所有视频流，订阅列表用户数不超过32。
     */
    UnSubscribeVideoUserIds?: Array<string>;
}
/**
 * 水印类型为图片的参数列表
 */
export interface WaterMarkImage {
    /**
     * 下载的url地址， 只支持jpg, png, jpeg，大小限制不超过5M。注意，url必须携带格式后缀，url内只支持特定的字符串, 范围是a-z A-Z 0-9 '-', '.', '_', '~', ':', '/', '?', '#', '[', ']' '@', '!', '&', '(', ')', '*', '+', ',', '%', '='
     */
    WaterMarkUrl: string;
    /**
     * 画布上该画面左上角的 y 轴坐标，取值范围 [0, 2560]，不能超过画布的高。
     */
    Top: number;
    /**
     * 画布上该画面左上角的 x 轴坐标，取值范围 [0, 2560]，不能超过画布的宽。
     */
    Left: number;
    /**
     * 画布上该画面宽度的相对值，取值范围 [0, 2560]，与Left相加不应超过画布的宽。
     */
    Width: number;
    /**
     * 画布上该画面高度的相对值，取值范围 [0, 2560]，与Top相加不应超过画布的高。
     */
    Height: number;
}
/**
 * 混流用户参数
 */
export interface McuUserInfoParams {
    /**
     * 用户参数。
     */
    UserInfo: MixUserInfo;
    /**
     * 混音的音量调整：取值范围是0到100，100为原始上行音量，不填默认为100，值越小则音量越低。
  注：该参数只在音量白名单下配置生效，其他场景配置无效。
     */
    SoundLevel?: number;
}
/**
 * 用户媒体流参数。
 */
export interface UserMediaStream {
    /**
     * TRTC用户参数。
     */
    UserInfo?: MixUserInfo;
    /**
     * 主辅路流类型，0为摄像头，1为屏幕分享，不填默认为0。
     */
    StreamType?: number;
}
/**
 * sdk或webrtc的事件列表。
 */
export interface EventList {
    /**
     * 数据内容
     */
    Content?: Array<EventMessage>;
    /**
     * 发送端的userId
     */
    PeerId?: string;
}
/**
 * DescribeTrtcUsage请求参数结构体
 */
export interface DescribeTrtcUsageRequest {
    /**
     * 查询开始时间，格式为YYYY-MM-DD。
     */
    StartTime: string;
    /**
     * 查询结束时间，格式为YYYY-MM-DD。
  单次查询统计区间最多不能超过31天。
     */
    EndTime: string;
    /**
     * TRTC的SdkAppId，和房间所对应的SdkAppId相同。如果没有这个参数，返回用户下全部实时音视频应用的汇总。
     */
    SdkAppId?: number;
}
/**
 * DescribeRoomInfo返回参数结构体
 */
export interface DescribeRoomInfoResponse {
    /**
     * 返回当页数据总数
     */
    Total?: number;
    /**
     * 房间信息列表
     */
    RoomList?: Array<RoomState>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 混流布局参数。
 */
export interface McuLayoutParams {
    /**
     * 布局模式：动态布局（1：悬浮布局（默认），2：屏幕分享布局，3：九宫格布局），静态布局（4：自定义布局）。最多支持混入16路音视频流，如果用户只上行音频，也会被算作一路；自定义布局中，如果子画面只设置占位图，也被算作一路。
     */
    MixLayoutMode?: number;
    /**
     * 纯音频上行是否占布局位置，只在动态布局中有效。0表示纯音频不占布局位置，1表示纯音频占布局位置，不填默认为0。
     */
    PureAudioHoldPlaceMode?: number;
    /**
     * 自定义模板中有效，指定用户视频在混合画面中的位置，最多支持设置16个输入流。
     */
    MixLayoutList?: Array<McuLayout>;
    /**
     * 指定动态布局中悬浮布局和屏幕分享布局的大画面信息，只在悬浮布局和屏幕分享布局有效。
     */
    MaxVideoUser?: MaxVideoUser;
    /**
     * 屏幕分享模板、悬浮模板、九宫格模版有效，画面在输出时的显示模式：0为裁剪，1为缩放，2为缩放并显示黑底
     */
    RenderMode?: number;
}
/**
 * DescribeTRTCRealTimeQualityMetricData请求参数结构体
 */
export interface DescribeTRTCRealTimeQualityMetricDataRequest {
    /**
     * 用户SdkAppId（如：1400xxxxxx）
     */
    SdkAppId: string;
    /**
     * 开始时间，unix时间戳，单位：秒（查询时间范围根据监控仪表盘功能版本而定，基础版可查近3小时，进阶版可查近12小时）
     */
    StartTime: number;
    /**
     * 结束时间，unix时间戳，单位：秒
     */
    EndTime: number;
    /**
     * 房间ID
     */
    RoomId?: string;
}
/**
 * DescribeAITranscription请求参数结构体
 */
export interface DescribeAITranscriptionRequest {
    /**
     * 查询任务状态，不使用时传入空字符串。
  有两种查询方式：
  1、只填写TaskId，这种方式使用TaskId来查询任务
  2、TaskId为空字符串，填写SdkAppId和SessionId，这种方式不需要使用TaskId查询任务
     */
    TaskId: string;
    /**
     * TRTC的SdkAppId，和SessionId配合使用。
     */
    SdkAppId?: number;
    /**
     * 开启转录任务时传入的SessionId，和SdkAppId配合使用。
     */
    SessionId?: string;
}
/**
 * CreateBasicModeration返回参数结构体
 */
export interface CreateBasicModerationResponse {
    /**
     * 审核服务分配的任务ID。任务ID是对一次审核任务生命周期过程的唯一标识，结束任务时会失去意义。任务ID需要业务保存下来，作为下次针对这个任务操作的参数
     */
    TaskId?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: 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;
}
/**
 * 混流布局参数。
 */
export interface McuLayout {
    /**
     * 用户媒体流参数。不填时腾讯云后台按照上行主播的进房顺序自动填充。
     */
    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。
     */
    BackGroundColor?: string;
    /**
     * 子画面的背景图url，填写该参数，当用户关闭摄像头或未进入TRTC房间时，会在布局位置填充为指定图片。若指定图片与布局位置尺寸比例不一致，则会对图片进行拉伸处理，优先级高于BackGroundColor。支持png、jpg、jpeg、bmp、gif、webm格式。图片大小限制不超过5MB。
  注：您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，子画面的背景图将不会生效。
     */
    BackgroundImageUrl?: string;
    /**
     * 客户自定义裁剪，针对原始输入流裁剪
     */
    CustomCrop?: McuCustomCrop;
    /**
     * 子背景图在输出时的显示模式：0为裁剪，1为缩放并显示背景，2为缩放并显示黑底，3为变比例伸缩，4为自定义渲染。不填默认为3。
     */
    BackgroundRenderMode?: number;
    /**
     * 子画面的透明模版url，指向一张包含透明通道的模板图片。填写该参数，后台混流时会提取该模板图片的透明通道，将其缩放作为目标画面的透明通道，再和其他画面进行混合。您可以通过透明模版实现目标画面的半透明效果和任意形状裁剪（如圆角、星形、心形等）。 支持png格式。图片大小限制不超过5MB。
  注：1，模板图片宽高比应接近目标画面宽高比，以避免缩放适配目标画面时出现模板效果变形；2，透明模版只有RenderMode为0（裁剪）时才生效；3，您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，透明模版将不会生效。
     */
    TransparentUrl?: string;
    /**
     * 子背景图的自定义渲染参数，当BackgroundRenderMode为4时必须配置。
     */
    BackgroundCustomRender?: McuBackgroundCustomRender;
    /**
     * 子背景色生效模式，默认值为0表示均不生效。
  bit0:占位图缩放是否生效。
  bit1:上行流缩放是否生效。
  您可以将相应bit位置1启动生效，例如：
  0(00)表示子背景色不生效。
  1(01)表示子背景色只在占位图缩放时生效。
  2(10)表示子背景色只在上行流缩放时生效。
  3(11)表示子背景色在占位图缩放和上行流缩放时均生效。
  
     */
    BackGroundColorMode?: number;
}
/**
 * DescribeUserInfo返回参数结构体
 */
export interface DescribeUserInfoResponse {
    /**
     * 返回的用户总条数
     */
    Total?: number;
    /**
     * 用户信息列表
     */
    UserList?: Array<UserInformation>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * RemoveUserByStrRoomId返回参数结构体
 */
export interface RemoveUserByStrRoomIdResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeTRTCRealTimeScaleMetricData返回参数结构体
 */
export interface DescribeTRTCRealTimeScaleMetricDataResponse {
    /**
     * TRTC监控数据出参
  注意：此字段可能返回 null，表示取不到有效值。
     */
    Data?: TRTCDataResp;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * UpdateStreamIngest返回参数结构体
 */
export interface UpdateStreamIngestResponse {
    /**
     * 任务的状态信息。InProgress：表示当前任务正在进行中。NotExist：表示当前任务不存在。示例值：InProgress
     */
    Status?: string;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StartMCUMixTranscode请求参数结构体
 */
export interface StartMCUMixTranscodeRequest {
    /**
     * TRTC的SDKAppId。
     */
    SdkAppId: number;
    /**
     * 房间号。
     */
    RoomId: number;
    /**
     * 混流输出控制参数。
     */
    OutputParams: OutputParams;
    /**
     * 混流输出编码参数。
     */
    EncodeParams: EncodeParams;
    /**
     * 混流输出布局参数。
     */
    LayoutParams: LayoutParams;
    /**
     * 第三方CDN转推参数。如需转推至腾讯云云直播，此参数无需填写，会默认转推
     */
    PublishCdnParams?: PublishCdnParams;
}
/**
 * 页面录制控制参数
 */
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;
}
/**
 * 图片水印参数。
 */
export interface McuWaterMarkImage {
    /**
     * 水印图片URL地址，支持png、jpg、jpeg格式。图片大小限制不超过5MB。
  注：您需要确保图片链接的可访问性，后台单次下载超时时间为10秒，最多重试3次，若最终图片下载失败，水印图片将不会生效。
     */
    WaterMarkUrl: string;
    /**
     * 水印在输出时的宽。单位为像素值。
     */
    WaterMarkWidth: number;
    /**
     * 水印在输出时的高。单位为像素值。
     */
    WaterMarkHeight: number;
    /**
     * 水印在输出时的X偏移。单位为像素值。
     */
    LocationX: number;
    /**
     * 水印在输出时的Y偏移。单位为像素值。
     */
    LocationY: number;
    /**
     * 水印在输出时的层级，不填默认为0。
     */
    ZOrder?: number;
    /**
     * 动态水印类型，默认为0。0:关闭；1:随机位置，每秒变动一次；2:边界扫描反弹，每帧变动一次。
     */
    DynamicPosType?: number;
}
/**
 * StartPublishCdnStream返回参数结构体
 */
export interface StartPublishCdnStreamResponse {
    /**
     * 用于唯一标识转推任务，由腾讯云服务端生成，后续更新和停止请求都需要携带TaskiD参数。
     */
    TaskId?: string;
    /**
     * 唯一请求 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<number>;
}
/**
 * DescribeTRTCMarketScaleMetricData请求参数结构体
 */
export interface DescribeTRTCMarketScaleMetricDataRequest {
    /**
     * 用户SdkAppId
     */
    SdkAppId: string;
    /**
     * 查询开始时间，格式为YYYY-MM-DD。（查询时间范围根据监控仪表盘功能版本而定，【基础版】可查近30天，【进阶版】可查近60天）
     */
    StartTime: string;
    /**
     * 查询结束时间，格式为YYYY-MM-DD。
     */
    EndTime: string;
    /**
     * 返回数据的粒度，支持设为以下值：
  d：按天。此时返回查询时间范围内 UTC 时间为零点的数据。
  h：按小时。此时返回查询时间范围内 UTC 时间为整小时的数据。
     */
    Period: string;
}
/**
 * DescribeRelayUsage返回参数结构体
 */
export interface DescribeRelayUsageResponse {
    /**
     * 用量类型，与UsageValue中各个位置的值对应。
     */
    UsageKey?: Array<string>;
    /**
     * 各个时间点用量明细。
     */
    UsageList?: Array<TrtcUsage>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StartStreamIngest请求参数结构体
 */
export interface StartStreamIngestRequest {
    /**
     * 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;
    /**
     * TRTC房间号的类型。
  【*注意】必须和录制的房间所对应的RoomId类型相同:
  0: 字符串类型的RoomId
  1: 32位整型的RoomId（默认）
     */
    RoomIdType: number;
    /**
     * 输入在线媒体流机器人的UserId，用于进房发起拉流转推任务。
     */
    UserId: string;
    /**
     * 输入在线媒体流机器人UserId对应的校验签名，即UserId和UserSig相当于机器人进房的登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
     */
    UserSig: string;
    /**
     * 源流URL【必填】。如果是视频流，分辨率请保持不变。
     */
    StreamUrl?: string;
    /**
     * TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。
     */
    PrivateMapKey?: string;
    /**
     * 【本字段已废弃】视频编码参数。可选，如果不填，保持原始流的参数。
     * @deprecated
     */
    VideoEncodeParams?: VideoEncodeParams;
    /**
     * 【本字段已废弃】音频编码参数。可选，如果不填，保持原始流的参数。
     * @deprecated
     */
    AudioEncodeParams?: AudioEncodeParams;
    /**
     * 【本字段已废弃，请使用 StreamUrl 字段】源流URL，支持一个地址。
     * @deprecated
     */
    SourceUrl?: Array<string>;
    /**
     * 指定视频从某个秒时间戳播放
     */
    SeekSecond?: number;
    /**
     * 开启自动旁路推流，请确认控制台已经开启该功能。
     */
    AutoPush?: boolean;
    /**
     * 循环播放次数, 取值范围[-1, 1000],  默认1次。
   - 0 无效值
   - -1 循环播放, 需要主动调用停止接口或设置MaxDuration
  
     */
    RepeatNum?: number;
    /**
     * 循环播放最大时长,仅支持RepeatNum设置-1时生效，取值范围[1, 10080]，单位分钟。
     */
    MaxDuration?: number;
    /**
     * 音量，取值范围[0, 100]，默认100，表示原音量。
     */
    Volume?: number;
}
/**
 * DescribeRecordingUsage返回参数结构体
 */
export interface DescribeRecordingUsageResponse {
    /**
     * 用量类型，与UsageValue中各个位置的值对应。
     */
    UsageKey?: Array<string>;
    /**
     * 各个时间点用量明细。
     */
    UsageList?: Array<TrtcUsage>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * StopMCUMixTranscode请求参数结构体
 */
export interface StopMCUMixTranscodeRequest {
    /**
     * TRTC的SDKAppId。
     */
    SdkAppId: number;
    /**
     * 房间号。
     */
    RoomId: number;
}
/**
 * ModifyPicture返回参数结构体
 */
export interface ModifyPictureResponse {
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * DescribeRecordingUsage请求参数结构体
 */
export interface DescribeRecordingUsageRequest {
    /**
     * 查询开始时间，格式为YYYY-MM-DD。
     */
    StartTime: string;
    /**
     * 查询结束时间，格式为YYYY-MM-DD。
  单次查询统计区间最多不能超过31天。
     */
    EndTime: string;
    /**
     * 查询单流录制或合流录制，值为"single"或"multi"。
     */
    MixType: string;
    /**
     * TRTC的SdkAppId，和房间所对应的SdkAppId相同。如果没有这个参数，返回用户下全部实时音视频应用的汇总。
     */
    SdkAppId?: number;
}
/**
 * 云端录制查询接口，录制文件的信息
 */
export interface StorageFile {
    /**
     * 录制文件对应的UserId，如果是混流的话的这里返回的是空串。
  注意：此字段可能返回 null，表示取不到有效值。
     */
    UserId?: string;
    /**
     * 录制索引文件名。
     */
    FileName?: string;
    /**
     * 录制文件流信息。
  video：视频录制文件
  audio：音频录制文件
  audio_video：音视频录制文件
  注意：此字段可能返回 null，表示取不到有效值。
     */
    TrackType?: string;
    /**
     * 录制文件开始Unix时间戳。
     */
    BeginTimeStamp?: number;
}
/**
 * 水印布局参数
 */
export interface WaterMark {
    /**
     * 水印类型，0为图片（默认），1为文字，2为时间戳。
     */
    WaterMarkType?: number;
    /**
     * 水印为图片时的参数列表，水印为图片时校验必填。
     */
    WaterMarkImage?: WaterMarkImage;
    /**
     * 水印为文字时的参数列表，水印为文字时校验必填。
     */
    WaterMarkChar?: WaterMarkChar;
    /**
     * 水印为时间戳时的参数列表，水印为时间戳时校验必填。
     */
    WaterMarkTimestamp?: WaterMarkTimestamp;
}
/**
 * Mcu转推录制，第三方存储参数。
 */
export interface McuStorageParams {
    /**
     * 第三方云存储的账号信息（特别说明：若您选择存储至对象存储COS将会收取录制文件投递至COS的费用，详见云端录制收费说明，存储至VOD将不收取此项费用。）。
     */
    CloudStorage?: CloudStorage;
    /**
     * 腾讯云云点播的账号信息。
     */
    McuCloudVod?: McuCloudVod;
}
/**
 * DescribeScaleInfo返回参数结构体
 */
export interface DescribeScaleInfoResponse {
    /**
     * 返回的数据条数
     */
    Total?: number;
    /**
     * 返回的数据
     */
    ScaleList?: Array<ScaleInfomation>;
    /**
     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
     */
    RequestId?: string;
}
/**
 * 录制的混流布局参数。
 */
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<MixLayout>;
    /**
     * 录制背景颜色，RGB的颜色表的16进制表示，每个颜色通过8bit长度标识，默认为黑色。比如橙色对应的RGB为 R: