UNPKG

tencentcloud-sdk-nodejs

Version:
2,664 lines (2,655 loc) 125 kB
/** * CreateRoom请求参数结构体 */ export interface CreateRoomRequest { /** * <p>课堂名称。<br>字符数不超过256</p> */ Name: string; /** * <p>预定的课堂开始时间,unix时间戳(秒)。</p> */ StartTime: number; /** * <p>预定的课堂结束时间,unix时间戳(秒)。</p> */ EndTime: number; /** * <p>低代码互动课堂的SdkAppId。</p> */ SdkAppId: number; /** * <p>头像区域,摄像头视频画面的分辨率。可以有如下取值:<br>1 标清<br>2 高清<br>3 全高清<br>注意:连麦人数(MaxMicNumber)&gt;6时,仅可使用标清</p> */ Resolution: number; /** * <p>设置课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。该取值影响计费,请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。</p> */ MaxMicNumber: number; /** * <p>课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频</p> */ SubType: string; /** * <p>老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。</p> */ TeacherId?: string; /** * <p>进入课堂时是否自动连麦。可以有以下取值:<br>0 不自动连麦(需要手动申请上麦,默认值)<br>1 自动连麦</p> */ AutoMic?: number; /** * <p>释放音视频权限后是否自动取消连麦。可以有以下取值:<br>0 自动取消连麦(默认值)<br>1 保持连麦状态</p> */ TurnOffMic?: number; /** * <p>声音音质。可以有以下取值:<br>0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。<br>1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。</p> */ AudioQuality?: number; /** * <p>录制方式。</p><p>枚举值:</p><ul><li>0: 开启自动录制(默认)</li><li>1: 禁止录制</li><li>2: 开启手动录制。(仅支持页面录制,需通过startRecord、stopRecord接口控制录制的开始和结束。)</li><li>3: 信令录制。</li></ul> */ DisableRecord?: number; /** * <p>助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。</p> */ Assistants?: Array<string>; /** * <p>rtc人数。</p> * @deprecated */ RTCAudienceNumber?: number; /** * <p>观看类型。互动观看 (默认)</p> */ AudienceType?: number; /** * <p>录制模板。未配置时默认取值0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744</p> */ RecordLayout?: number; /** * <p>课堂绑定的群组ID,非空时限制组成员进入</p> */ GroupId?: string; /** * <p>是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值:<br>0 不允许直接控制(需同意,默认值)<br>1 允许直接控制(无需同意)</p> */ EnableDirectControl?: number; /** * <p>开启专注模式。<br>0 收看全部角色音视频(默认)<br>1 只看老师和助教</p> */ InteractionMode?: number; /** * <p>横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型</p> */ VideoOrientation?: number; /** * <p>开启课后评分。 0:不开启(默认) 1:开启</p> */ IsGradingRequiredPostClass?: number; /** * <p>课堂类型。 注:大班课的布局(layout)只有三分屏</p><p>枚举值:</p><ul><li>0: 小班课(默认值)</li><li>1: 大班课</li><li>2: 1V1 (预留参数,暂未开放);</li><li>3: 圆桌会议</li><li>4: 分组直播 </li></ul><p>默认值:0</p> */ RoomType?: number; /** * <p>嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效</p> */ Guests?: Array<string>; /** * <p>拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟</p> */ EndDelayTime?: number; /** * <p>直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播</p> */ LiveType?: number; /** * <p>伪直播链接。 支持的协议以及格式: 协议:HTTP、HTTPS、RTMP、HLS 。格式:FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码:H.264、VP8。音频编码:AAC、OPUS。</p><p>注意:伪直播视频规格建议最高使用1080p 30fps,4k视频会有兼容性问题导致直播失败。</p> */ RecordLiveUrl?: string; /** * <p>是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1或2的时候有效</p> */ EnableAutoStart?: number; /** * <p>录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道</p> */ RecordBackground?: string; /** * <p>录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。</p><p>自定义场景参数的含义。如下:<br> scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。<br> lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi)<br> customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。</p> */ RecordScene?: string; /** * <p>录制自定义语言,仅recordlayout=9的时候此参数有效</p> * @deprecated */ RecordLang?: string; /** * <p>录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0</p> */ RecordStream?: number; /** * <p>板书截图生成类型。0 不生成板书(默认);1 全量模式;2 单页去重模式</p> */ WhiteBoardSnapshotMode?: number; /** * <p>字幕转写功能开关。可以有以下取值:<br>0 不开启字幕转写功能(默认值)<br>1 自动转写模式:上课自动开启,下课自动停止<br>2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写<br>设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关</p> */ SubtitlesTranscription?: number; /** * <p>录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效</p> */ RecordMerge?: number; /** * <p>转推开关</p><p>枚举值:</p><ul><li>0: 关闭</li><li>1: 开启</li></ul> */ EnableLiveRelay?: number; } /** * 转存配置 */ export interface TransferItem { /** * 转存状态, 1正常 2停用 注意:此字段可能返回 null,表示取不到有效值。 */ State?: number; } /** * DescribeQuestionList请求参数结构体 */ export interface DescribeQuestionListRequest { /** * 房间ID */ RoomId: number; /** * 分页查询当前页数,从1开始递增,默认值为1 */ Page?: number; /** * 分页查询当前页数,从1开始递增,默认值为1 */ Limit?: number; } /** * ModifyRoom返回参数结构体 */ export interface ModifyRoomResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LoginOriginId请求参数结构体 */ export interface LoginOriginIdRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 用户在客户系统的Id,需要在同一应用下唯一。 */ OriginId: string; } /** * DescribeAppDetail返回参数结构体 */ export interface DescribeAppDetailResponse { /** * SDK 对应的AppId */ SdkAppId?: string; /** * 应用配置 */ AppConfig?: AppConfig; /** * 场景配置 */ SceneConfig?: Array<SceneItem>; /** * 转存配置 */ TransferConfig?: TransferItem; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSupervisor请求参数结构体 */ export interface DeleteSupervisorRequest { /** * 应用ID */ SdkAppId: number; /** * 用户ID列表 */ Users: Array<string>; } /** * DeleteUser请求参数结构体 */ export interface DeleteUserRequest { /** * 待删除用户的ID */ UserId: string; } /** * 水印配置 */ export interface WatermarkConfig { /** * 水印图片的url */ Url?: string; /** * 水印宽。为比例值 */ Width?: number; /** * 水印高。为比例值 */ Height?: number; /** * 水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间。 */ LocationX?: number; /** * 水印Y偏移, 取值:0-100, 表示区域Y方向的百分比。比如50,则表示位于Y轴中间。 */ LocationY?: number; } /** * DescribeSupervisors返回参数结构体 */ export interface DescribeSupervisorsResponse { /** * 数据总量 */ Total?: number; /** * 分页查询当前页数 */ Page?: number; /** * 当前页数据量 */ Limit?: number; /** * 巡课列表 */ UserIds?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWhiteBoardSnapshot请求参数结构体 */ export interface DescribeWhiteBoardSnapshotRequest { /** * 房间ID */ RoomId?: number; } /** * DeleteUser返回参数结构体 */ export interface DeleteUserResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteWhiteBoardSnapshot请求参数结构体 */ export interface DeleteWhiteBoardSnapshotRequest { /** * 课堂ID */ RoomId?: number; } /** * BatchDeleteRecord请求参数结构体 */ export interface BatchDeleteRecordRequest { /** * 房间ID列表 */ RoomIds: Array<number | bigint>; /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; } /** * DescribePlayRecords返回参数结构体 */ export interface DescribePlayRecordsResponse { /** * <p>总条数。</p> */ Total?: number; /** * <p>信令录制视频回放观看记录列表。</p> */ Records?: Array<PlayRecord>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyApp返回参数结构体 */ export interface ModifyAppResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UnblockKickedUser返回参数结构体 */ export interface UnblockKickedUserResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateGroupLiveCodes请求参数结构体 */ export interface CreateGroupLiveCodesRequest { /** * <p>低代码互动课堂的SdkAppId。</p> */ SdkAppId: number; /** * <p>房间ID。</p> */ RoomId: number; /** * <p>分组数量。注:最大数量限制为30</p> */ Number: number; } /** * BatchRegister请求参数结构体 */ export interface BatchRegisterRequest { /** * 批量注册用户信息列表 */ Users: Array<BatchUserRequest>; } /** * StartRecord请求参数结构体 */ export interface StartRecordRequest { /** * 学校ID */ SdkAppId: number; /** * 房间ID */ RoomId: number; } /** * DeleteRoom返回参数结构体 */ export interface DeleteRoomResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserProfile请求参数结构体 */ export interface ModifyUserProfileRequest { /** * 待修改用户ID */ UserId: string; /** * 待修改的用户名。对应注册用户下“Name“字段,本次修改是对此内容进行修改。 */ Nickname?: string; /** * 待修改头像url */ Avatar?: string; } /** * CreateGroupWithMembers请求参数结构体 */ export interface CreateGroupWithMembersRequest { /** * 待创建群组名称 */ GroupName: string; /** * 低代码平台应用ID */ SdkAppId: number; /** * 默认绑定主讲老师ID */ TeacherId?: string; /** * 群组成员列表,一次性最多200个 */ MemberIds?: Array<string>; } /** * DescribeDocumentsByRoom请求参数结构体 */ export interface DescribeDocumentsByRoomRequest { /** * 房间ID。 */ RoomId: number; /** * 低代码互动课堂的SdkAppId */ SdkAppId: number; /** * 分页查询当前页数,从1开始递增,默认值为1 */ Page?: number; /** * 每页数据量,最大1000,默认值为100 */ Limit?: number; /** * 课件权限。 [0]:获取owner的私有课件; [1]:获取owner的公开课件; [0,1]:则获取owner的私有课件和公开课件; [2]:获取owner的私有课件和所有人(包括owner)的公开课件。 默认值为[2] */ Permission?: Array<number | bigint>; /** * 文档所有者的user_id,不填默认获取SdkAppId下所有课件 */ Owner?: string; } /** * BatchCreateGroupWithMembers返回参数结构体 */ export interface BatchCreateGroupWithMembersResponse { /** * 新创建群组ID列表,与输入创建参数顺序一致 */ GroupIds?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateGroupLiveCodes返回参数结构体 */ export interface CreateGroupLiveCodesResponse { /** * <p>分组直播参加码</p> */ GroupLiveCodes?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 成员记录信息。 */ export interface MemberRecord { /** * 用户ID。 */ UserId?: string; /** * 用户名称。 */ UserName?: string; /** * 在线时长,单位秒。 */ PresentTime?: number; /** * 是否开启摄像头。 */ Camera?: number; /** * 是否开启麦克风。 */ Mic?: number; /** * 是否禁言。 */ Silence?: number; /** * 回答问题数量。 */ AnswerQuestions?: number; /** * 举手数量。 */ HandUps?: number; /** * 首次进入房间的unix时间戳。 */ FirstJoinTimestamp?: number; /** * 最后一次退出房间的unix时间戳。 */ LastQuitTimestamp?: number; /** * 奖励次数。 */ Rewords?: number; /** * 用户IP。 */ IPAddress?: string; /** * 用户位置信息。 */ Location?: string; /** * 用户设备平台信息。0:unknown 1:windows 2:mac 3:android 4:ios 5:web 6:h5 7:miniprogram (小程序) */ Device?: number; /** * 每个成员上麦次数。 */ PerMemberMicCount?: number; /** * 每个成员发送消息数量。 */ PerMemberMessageCount?: number; /** * 用户角色。0代表学生;1代表老师; 2助教;3巡课。 */ Role?: number; /** * 上课班号 */ GroupId?: string; /** * 子上课班号 注意:此字段可能返回 null,表示取不到有效值。 */ SubGroupId?: Array<string>; /** * 本堂课用户是否上过台。0 否;1 是 */ Stage?: number; /** * 用户状态。0为未到,1为在线,2为离线,3为被踢,4为永久被踢,5为暂时掉线 */ CurrentState?: number; } /** * DeleteAppCustomContent请求参数结构体 */ export interface DeleteAppCustomContentRequest { /** * 应用ID。 */ SdkAppId: number; /** * 指定需要删除的已设置的scene场景自定义元素,如果为空则删除应用下已设置的所有自定义元素。 */ Scenes?: Array<string>; } /** * SendRoomNotificationMessage返回参数结构体 */ export interface SendRoomNotificationMessageResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BatchAddGroupMember返回参数结构体 */ export interface BatchAddGroupMemberResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyUserProfile返回参数结构体 */ export interface ModifyUserProfileResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetWatermark返回参数结构体 */ export interface GetWatermarkResponse { /** * 老师视频区域的水印参数配置 */ TeacherLogo?: WatermarkConfig; /** * 白板区域的水印参数配置 */ BoardLogo?: WatermarkConfig; /** * 背景图片配置 */ BackgroundPicture?: BackgroundPictureConfig; /** * 文字水印配置 */ Text?: TextMarkConfig; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribePlaybackList返回参数结构体 */ export interface DescribePlaybackListResponse { /** * <p>总数</p> */ Total?: number; /** * <p>课堂回放信息列表</p> */ Items?: Array<PlaybackItem>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BatchRegister返回参数结构体 */ export interface BatchRegisterResponse { /** * 注册成功的用户列表 */ Users?: Array<BatchUserInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LoginOriginIdWithRoom请求参数结构体 */ export interface LoginOriginIdWithRoomRequest { /** * <p>低代码互动课堂的SdkAppId。</p> */ SdkAppId: number; /** * <p>用户在客户系统的Id,需要在同一应用下唯一。</p> */ OriginId: string; /** * <p>课堂 ID</p> */ RoomId: number; } /** * BindDocumentToRoom返回参数结构体 */ export interface BindDocumentToRoomResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * StopRecord返回参数结构体 */ export interface StopRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateGroupWithSubGroup请求参数结构体 */ export interface CreateGroupWithSubGroupRequest { /** * 待创建的新群组名 */ GroupName: string; /** * 低代码平台应用ID */ SdkAppId: number; /** * 子群组ID列表,子群组ID不能重复,最多40个 */ SubGroupIds: Array<string>; /** * 群组默认主讲老师ID */ TeacherId?: string; } /** * DescribeLiveRelayConfig返回参数结构体 */ export interface DescribeLiveRelayConfigResponse { /** * <p>转推类型</p><p>枚举值:</p><ul><li>0: 单流</li><li>1: 混流</li></ul> */ RelayType?: number; /** * <p>转推URL</p> */ Urls?: Array<string>; /** * <p>是否是腾讯云CDN。</p><p>枚举值:</p><ul><li>0: 转推非腾讯云CDN</li><li>1: 转推腾讯CDN</li></ul> */ IsTencentCdn?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 课堂评分字段 */ export interface ClassScoreItem { /** * 课堂iD */ RoomId?: number; /** * 用户ID */ UserId?: string; /** * 评分时间 */ CreateTime?: number; /** * 课堂评分 */ Score?: number; /** * 课堂评价 */ ScoreMsg?: string; } /** * DescribeRoomForbiddenUser请求参数结构体 */ export interface DescribeRoomForbiddenUserRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 房间ID。 */ RoomId: number; } /** * DescribeRoom请求参数结构体 */ export interface DescribeRoomRequest { /** * <p>课堂Id。</p> */ RoomId: number; /** * <p>请求RTMP推流链接,0:否,1:是,默认为0。</p> */ RTMPStreamingURL?: number; } /** * BatchDescribeDocument请求参数结构体 */ export interface BatchDescribeDocumentRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 分页查询当前页数,从1开始递增 */ Page: number; /** * 每页数据量,最大200 */ Limit: number; /** * 课件权限。[0]:获取owner的私有课件;[1]:获取owner的公开课件; [0,1]:则获取owner的私有课件和公开课件;[2]:获取owner的私有课件和所有人(包括owner)的公开课件 */ Permission: Array<number | bigint>; /** * 课件所有者的user_id,不填默认获取SdkAppId下所有课件 */ Owner?: string; /** * 课件名称搜索词 */ Keyword?: string; /** * 课件id列表,从列表中查询,忽略错误的id */ DocumentId?: Array<string>; } /** * RegisterUser请求参数结构体 */ export interface RegisterUserRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 对应用户昵称。对应修改用户信息下“nickname“字段,在修改用户信息时,可以对该字段进行调整,从而更改用户的昵称。 */ Name?: string; /** * 用户在客户系统的Id,需要在同一应用下唯一。入参为空时默认赋值为UserId。 */ OriginId?: string; /** * 用户头像。 */ Avatar?: string; } /** * BatchCreateRoom返回参数结构体 */ export interface BatchCreateRoomResponse { /** * 创建成功课堂ID,与传入课堂信息顺序一致 */ RoomIds?: Array<number | bigint>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeEditVersions请求参数结构体 */ export interface DescribeEditVersionsRequest { /** * <p>应用ID</p> */ SdkAppId: number; /** * <p>课堂ID</p> */ RoomId: number; } /** * LoginUserWithRoom请求参数结构体 */ export interface LoginUserWithRoomRequest { /** * <p>注册获取的用户id。</p> */ UserId: string; /** * <p>课堂 ID</p> */ RoomId: number; } /** * UnbindDocumentFromRoom返回参数结构体 */ export interface UnbindDocumentFromRoomResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateDocument返回参数结构体 */ export interface CreateDocumentResponse { /** * 文档ID。 */ DocumentId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeMarquee请求参数结构体 */ export interface DescribeMarqueeRequest { /** * 学校ID */ SdkAppId: number; /** * 房间号 */ RoomId: number; } /** * SetWatermark请求参数结构体 */ export interface SetWatermarkRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 老师视频区域的水印参数地址,设置为空字符串表示删除 */ TeacherUrl?: string; /** * 白板视频区域的水印参数地址,设置为空字符串表示删除 */ BoardUrl?: string; /** * 视频默认图片(在没有视频流的时候显示),设置为空字符串表示删除 */ VideoUrl?: string; /** * 白板区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比 */ BoardW?: number; /** * 白板区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比 */ BoardH?: number; /** * 白板区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间 */ BoardX?: number; /** * 白板区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间 */ BoardY?: number; /** * 老师视频区域水印的宽度,取值:0-100,默认为0,表示区域X方向的百分比 */ TeacherW?: number; /** * 老师视频区域水印的高度,取值:0-100,默认为0, 表示区域Y方向的百分比 */ TeacherH?: number; /** * 老师视频区域水印X偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间 */ TeacherX?: number; /** * 老师视频区域水印Y偏移, 取值:0-100, 表示区域X方向的百分比。比如50,则表示位于X轴中间 */ TeacherY?: number; /** * 文字水印内容,设置为空字符串表示删除 */ Text?: string; /** * 文字水印颜色 */ TextColor?: string; } /** * DescribeGroup返回参数结构体 */ export interface DescribeGroupResponse { /** * 群组ID */ GroupId?: string; /** * 群组名称 */ GroupName?: string; /** * 群主主讲人ID 注意:此字段可能返回 null,表示取不到有效值。 */ TeacherId?: string; /** * 群组类型 0-基础群组 1-组合群组,若为1时会返回子群组ID */ GroupType?: number; /** * 子群组ID列表 注意:此字段可能返回 null,表示取不到有效值。 */ SubGroupIds?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetAppCustomContent返回参数结构体 */ export interface SetAppCustomContentResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * UnblockKickedUser请求参数结构体 */ export interface UnblockKickedUserRequest { /** * 低代码平台的SdkAppId。 */ SdkAppId: number; /** * 课堂Id。 */ RoomId: number; /** * 需要解禁踢出的成员Id。 */ UserId: string; } /** * 用户注册请求信息 */ export interface BatchUserRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 用户名称。 */ Name?: string; /** * 用户在客户系统的Id,需要在同一应用下唯一。入参为空时默认赋值为UserId 。 */ OriginId?: string; /** * 用户头像。 */ Avatar?: string; } /** * DeleteWhiteBoardSnapshot返回参数结构体 */ export interface DeleteWhiteBoardSnapshotResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LoginUser返回参数结构体 */ export interface LoginUserResponse { /** * 用户Id。 */ UserId?: string; /** * 注册成功后返回登录态token,有效期7天。token过期后可以通过调用“登录”或“源账号登录”进行更新。 */ Token?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyGroup请求参数结构体 */ export interface ModifyGroupRequest { /** * 需要修改的群组ID */ GroupId: string; /** * 低代码平台应用ID */ SdkAppId: number; /** * 默认绑定主讲老师ID */ TeacherId?: string; /** * 待修改的群组名称 */ GroupName?: string; } /** * DescribeAppDetail请求参数结构体 */ export interface DescribeAppDetailRequest { /** * 应用ID。低代码互动课堂的SdkAppId。 */ ApplicationId: string; /** * 开发商ID */ DeveloperId: string; } /** * KickUserFromRoom返回参数结构体 */ export interface KickUserFromRoomResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteGroup请求参数结构体 */ export interface DeleteGroupRequest { /** * 待删除群组ID列表 */ GroupIds: Array<string>; /** * 低代码平台应用ID */ SdkAppId: number; } /** * StartRoom请求参数结构体 */ export interface StartRoomRequest { /** * 课堂ID */ RoomId: number; } /** * AddGroupMember请求参数结构体 */ export interface AddGroupMemberRequest { /** * 群组ID */ GroupId: string; /** * 低代码平台应用ID */ SdkAppId: number; /** * 成员列表,最大值200 */ MemberIds: Array<string>; } /** * DescribeGroupList请求参数结构体 */ export interface DescribeGroupListRequest { /** * 低代码平台应用ID */ SdkAppId: number; /** * 分页查询当前页数,默认从1开始递增。 */ Page?: number; /** * 每页数据量,默认20,最大1000。 */ Limit?: number; /** * 主讲人ID筛选群组,与MemberId有且只有一个,都传时以此字段获取 */ TeacherId?: string; /** * 成员ID刷选群组,与TeacherId有且只有一个 */ MemberId?: string; } /** * GetRoomMessage请求参数结构体 */ export interface GetRoomMessageRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 课堂Id。 */ RoomId: number; /** * 消息序列。获取该序列以前的消息(不包含该seq消息) */ Seq?: number; /** * 消息拉取的条数。最大数量不能超过套餐包限制。 */ Limit?: number; /** * 请求消息的userId */ UserId?: string; } /** * DescribeDocuments返回参数结构体 */ export interface DescribeDocumentsResponse { /** * 符合查询条件文档总数 */ Total?: number; /** * 文档信息列表 注意:此字段可能返回 null,表示取不到有效值。 */ Documents?: Array<DocumentInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRecord请求参数结构体 */ export interface DescribeRecordRequest { /** * 学校ID */ SdkAppId: number; /** * 房间ID */ RoomId: number; } /** * 文档信息 */ export interface DocumentInfo { /** * 文档Id */ DocumentId?: string; /** * 文档原址url */ DocumentUrl?: string; /** * 文档名称 */ DocumentName?: string; /** * 文档所有者UserId */ Owner?: string; /** * 应用Id */ SdkAppId?: number; /** * 文档权限,0:私有课件 1:公共课件 */ Permission?: number; /** * 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码 */ TranscodeResult?: string; /** * 转码类型 */ TranscodeType?: number; /** * 转码进度, 0 - 100 表示(0% - 100%) */ TranscodeProgress?: number; /** * 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功 */ TranscodeState?: number; /** * 转码失败后的错误信息 */ TranscodeInfo?: string; /** * 文档类型 */ DocumentType?: string; /** * 文档大小,单位:字节 */ DocumentSize?: number; /** * 更新的UNIX时间戳 */ UpdateTime?: number; /** * 课件页数 */ Pages?: number; /** * 宽,仅在静态转码的课件有效 */ Width?: number; /** * 高,仅在静态转码的课件有效 */ Height?: number; /** * 封面,仅转码的课件会生成封面 */ Cover?: string; /** * 课件预览地址 */ Preview?: string; /** * 文档的分辨率 */ Resolution?: string; /** * 转码后文档的最小分辨率,和创建文档时传入的参数一致。 */ MinScaleResolution?: string; } /** * 房间列表 */ export interface RoomItem { /** * 名称 */ Name?: string; /** * 房间ID */ RoomId?: number; /** * 房间状态。0 未开始 ;1进行中 ;2 已结束;3已过期 */ Status?: number; /** * 开始时间 */ StartTime?: number; /** * 结束时间 */ EndTime?: number; /** * 实际开始时间 */ RealStartTime?: number; /** * 实际结束时间 */ RealEndTime?: number; /** * 头像区域,摄像头视频画面的分辨率。可以有如下取值: 1 标清 2 高清 3 全高清 */ Resolution?: number; /** * 最大允许连麦人数。已废弃,使用字段 MaxMicNumber */ MaxRTCMember?: number; /** * 房间录制地址。已废弃,使用新字段 RecordUrl */ ReplayUrl?: string; /** * 录制地址(协议为https)。仅在房间结束后存在。 */ RecordUrl?: string; /** * 课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。 */ MaxMicNumber?: number; /** * 打开学生麦克风/摄像头的授权开关 */ EnableDirectControl?: number; /** * 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教 */ InteractionMode?: number; /** * 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型 */ VideoOrientation?: number; /** * 开启课后评分。 0:不开启(默认) 1:开启 */ IsGradingRequiredPostClass?: number; /** * 房间类型。0:小班课(默认值);1:大班课;2:1V1(后续扩展) 注:大班课的布局(layout)只有三分屏 */ RoomType?: number; /** * 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟 */ EndDelayTime?: number; /** * 直播类型:0 常规(默认)1 伪直播 */ LiveType?: number; /** * 伪直播回放链接 */ RecordLiveUrl?: string; /** * 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效 */ EnableAutoStart?: number; /** * 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道 */ RecordBackground?: string; /** * 录制自定义场景,仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。 */ RecordScene?: string; /** * 录制自定义语言,仅recordlayout=9的时候此参数有效 */ RecordLang?: string; /** * 板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式 */ WhiteBoardSnapshotMode?: number; /** * 字幕转写功能开关:0关闭,1开启,默认关闭 */ SubtitlesTranscription?: number; } /** * 课堂回放信息 */ export interface PlaybackItem { /** * <p>房间id</p> */ RoomId?: number; /** * <p>回放地址</p> */ PlaybackUrl?: string; /** * <p>录制时长</p> */ Duration?: number; /** * <p>录制开始时间</p> */ CreateTime?: number; /** * <p>文件大小。</p><p>单位:MB</p> */ FileSize?: number; } /** * DeleteDocument返回参数结构体 */ export interface DeleteDocumentResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteRecord请求参数结构体 */ export interface DeleteRecordRequest { /** * 房间Id。 */ RoomId: number; /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; } /** * BatchDeleteGroupMember返回参数结构体 */ export interface BatchDeleteGroupMemberResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * CreateGroupWithSubGroup返回参数结构体 */ export interface CreateGroupWithSubGroupResponse { /** * 新创建群组ID */ GroupId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDocuments请求参数结构体 */ export interface DescribeDocumentsRequest { /** * 学校id */ SchoolId: number; /** * 分页查询当前页数,从1开始递增 */ Page: number; /** * 每页数据量,最大1000 */ Limit: number; /** * 课件权限。[0]:获取owner的私有课件;[1]:获取owner的公开课件; [0,1]:则获取owner的私有课件和公开课件;[2]:获取owner的私有课件和所有人(包括owner)的公开课件 */ Permission: Array<number | bigint>; /** * 课件所有者的user_id,不填默认获取school_id下所有课件 */ Owner?: string; /** * 课件名称搜索词 */ Keyword?: string; /** * 课件id列表,从列表中查询,忽略错误的id */ DocumentId?: Array<string>; } /** * 单条消息体内容 */ export interface MessageItem { /** * 消息类型。0表示文本消息,1表示图片消息 */ MessageType?: number; /** * 文本消息内容。message type为0时有效。 */ TextMessage?: string; /** * 图片消息URL。 message type为1时有效。 */ ImageMessage?: string; /** * 自定义消息内容。message type为2时有效。 */ CustomMessage?: CustomMsgContent; } /** * 获取群组列表返回的群组信息 */ export interface GroupInfo { /** * 群组ID */ GroupId?: string; /** * 群组名称 */ GroupName?: string; /** * 群组主讲人ID */ TeacherId?: string; /** * 群组类型 0-基础群组 1-组合群组,若为1时会返回子群组ID列表 */ GroupType?: number; /** * 子群组ID列表,如有。 注意:此字段可能返回 null,表示取不到有效值。 */ SubGroupIds?: string; } /** * GetRoomEvent请求参数结构体 */ export interface GetRoomEventRequest { /** * 课堂Id。 */ RoomId: number; /** * 应用Id。 */ SdkAppId: number; /** * 起始页,1开始。keyword为空时有效。 */ Page: number; /** * 每页个数。keyword为空时有效。一次性最多100条。 */ Limit: number; /** * 搜索事件类型。有以下事件类型: RoomStart:房间开始 RoomEnd:房间结束 MemberJoin:成员加入 MemberQuit:成员退出 RecordFinish:录制结束 CameraOn: 摄像头打开 CameraOff: 摄像头关闭 MicOn: 麦克风打开 MicOff: 麦克风关闭 ScreenOn: 屏幕共享打开 ScreenOff: 屏幕共享关闭 VisibleOn: 页面可见 VisibleOff: 页面不可见 */ Keyword?: string; } /** * DescribeRecord返回参数结构体 */ export interface DescribeRecordResponse { /** * 学校ID */ SchoolId?: number; /** * 课堂ID */ ClassId?: number; /** * 录制信息 */ RecordInfo?: Array<CustomRecordInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDocument返回参数结构体 */ export interface DescribeDocumentResponse { /** * 文档Id */ DocumentId?: string; /** * 文档原址url */ DocumentUrl?: string; /** * 文档名称 */ DocumentName?: string; /** * 文档所有者UserId */ Owner?: string; /** * 应用Id */ SdkAppId?: number; /** * 文档权限 */ Permission?: number; /** * 转码结果,无需转码为空,转码成功为结果url,转码失败为错误码 */ TranscodeResult?: string; /** * 转码类型 */ TranscodeType?: number; /** * 转码进度, 0 - 100 表示(0% - 100%) */ TranscodeProgress?: number; /** * 转码状态,0为无需转码,1为正在转码,2为转码失败,3为转码成功 */ TranscodeState?: number; /** * 转码失败后的错误信息 */ TranscodeInfo?: string; /** * 文档类型 */ DocumentType?: string; /** * 文档大小,单位:字节 */ DocumentSize?: number; /** * 更新的UNIX时间戳 */ UpdateTime?: number; /** * 课件页数 */ Pages?: number; /** * 课件预览地址 */ Preview?: string; /** * 文档的分辨率 */ Resolution?: string; /** * 转码后文档的最小分辨率,和创建文档时传入的参数一致。 */ MinScaleResolution?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteGroupMember返回参数结构体 */ export interface DeleteGroupMemberResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeGroupMemberList返回参数结构体 */ export interface DescribeGroupMemberListResponse { /** * 符合查询条件总条数 */ Total?: number; /** * 查询成员列表 注意:此字段可能返回 null,表示取不到有效值。 */ MemberIds?: Array<string>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetMarquee请求参数结构体 */ export interface SetMarqueeRequest { /** * 学校ID */ SdkAppId: number; /** * 房间号 */ RoomId: number; /** * 跑马灯类型:1为固定值,2为用户昵称,3为固定值+用户昵称,4为用户ID,5为originId+固定值,6为用户昵称(originId) */ MarqueeType: number; /** * 显示方式:1为滚动,2为闪烁 */ DisplayMode: number; /** * 固定值内容(当MarqueeType=1或5,则展示固定值内容) */ Content?: string; /** * 字体大小(数字,像素单位,范围:10到24)。 */ FontSize?: number; /** * 字体粗细:1为粗体,0为细体 */ FontWeight?: number; /** * 字体颜色(十六进制颜色值,例如:#00FF00(绿色)) */ FontColor?: string; /** * 字体透明度(数字,范围 0.0 到 1.0) */ FontOpacity?: number; /** * 背景颜色(十六进制颜色值,例如:#FFFF00(黄色)) */ BackgroundColor?: string; /** * 背景透明度(数字,范围 0.0 到 1.0) */ BackgroundOpacity?: number; /** * 跑马灯文字移动/闪烁指定像素所需时间,范围:1-10;数值越小,跑马灯滚动/闪烁速度越快 */ Duration?: number; /** * 跑马灯个数:目前仅支持1或2, 对应显示单排或双排 */ MarqueeCount?: number; } /** * ForbidSendMsg请求参数结构体 */ export interface ForbidSendMsgRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 课堂ID */ RoomId: number; /** * 需要禁言的用户账号,最多支持500个账号 */ MembersAccount: Array<string>; /** * 需禁言时间,单位为秒,为0时表示取消禁言,4294967295为永久禁言。 */ MuteTime: number; } /** * DescribeGroupLiveCodes请求参数结构体 */ export interface DescribeGroupLiveCodesRequest { /** * <p>学校ID</p> */ SdkAppId?: number; /** * <p>房间ID</p> */ RoomId?: number; } /** * 房间事件信息。 */ export interface EventInfo { /** * 事件发生的秒级unix时间戳。 */ Timestamp?: number; /** * 事件类型,有以下值: RoomStart:房间开始 RoomEnd:房间结束 MemberJoin:成员加入 MemberQuit:成员退出 RecordFinish:录制结束 CameraOn: 摄像头打开 CameraOff: 摄像头关闭 MicOn: 麦克风打开 MicOff: 麦克风关闭 ScreenOn: 屏幕共享打开 ScreenOff: 屏幕共享关闭 VisibleOn: 页面可见 VisibleOff: 页面不可见 */ EventType?: string; /** * 事件详细内容,包含房间号,成员类型事件包含用户Id。 */ EventData?: EventDataInfo; } /** * DescribeScoreList请求参数结构体 */ export interface DescribeScoreListRequest { /** * 课堂ID */ RoomId: number; /** * 分页查询当前页数,从1开始递增 */ Page?: number; /** * 默认是10条 */ Limit?: number; } /** * token结果 */ export interface TokenResult { /** * <p>房间id</p> */ RoomId?: number; /** * <p>该房间信令回放的token</p> */ Token?: string; } /** * DescribeRecordStream请求参数结构体 */ export interface DescribeRecordStreamRequest { /** * 学校ID */ SdkAppId: number; /** * 房间ID */ RoomId: number; } /** * 应用配置信息 */ export interface AppConfig { /** * 应用ID */ ApplicationId?: string; /** * 应用名称 */ AppName?: string; /** * 应用状态 1正常 2停用 */ State?: number; /** * 1试用 2轻量版 3标准版 4旗舰版 */ AppVersion?: number; /** * 创建时间 */ CreatedAt?: string; /** * 回调 */ Callback?: string; /** * 回调Key */ CallbackKey?: string; } /** * DeleteRecord返回参数结构体 */ export interface DeleteRecordResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeAnswerList请求参数结构体 */ export interface DescribeAnswerListRequest { /** * 问题ID */ QuestionId: string; /** * 1 */ Page?: number; /** * 100 */ Limit?: number; } /** * BatchCreateRoom请求参数结构体 */ export interface BatchCreateRoomRequest { /** * 低代码平台的SdkAppId。 */ SdkAppId: number; /** * 批量创建课堂的配置信息 */ RoomInfos: Array<RoomInfo>; } /** * DescribeGroupMemberList请求参数结构体 */ export interface DescribeGroupMemberListRequest { /** * 群组ID */ GroupId: string; /** * 低代码平台应用ID */ SdkAppId: number; /** * 分页值,默认1 */ Page?: number; /** * 每页数据量,默认20,最大1000 */ Limit?: number; } /** * DescribeRoomForbiddenUser返回参数结构体 */ export interface DescribeRoomForbiddenUserResponse { /** * 禁言用户信息数组,内容包括被禁言的成员 ID,及其被禁言到的时间(使用 UTC 时间,即世界协调时间) */ MutedAccountList?: Array<MutedAccountList>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 用户信息结构体 */ export interface UserInfo { /** * 应用Id。 */ SdkAppId?: number; /** * 用户Id。 */ UserId?: string; /** * 用户昵称。 */ Name?: string; /** * 用户头像Url。 */ Avatar?: string; /** * 用户在客户系统的Id */ OriginId?: string; } /** * DescribeUser返回参数结构体 */ export interface DescribeUserResponse { /** * 应用Id。 */ SdkAppId?: number; /** * 用户Id。 */ UserId?: string; /** * 用户昵称。 */ Name?: string; /** * 用户头像Url。 */ Avatar?: string; /** * 用户在客户系统的Id */ OriginId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * GetEditVersionToken请求参数结构体 */ export interface GetEditVersionTokenRequest { /** * <p>实时互动-教育版的SdkAppId。</p> */ SdkAppId: number; /** * <p>课堂ID</p> */ RoomId: number; /** * <p>用户ID</p> */ UserId: string; /** * <p>token过期时间,0代表无过期时间,单位毫秒。</p> */ ExpireSeconds?: number; } /** * DescribeScoreList返回参数结构体 */ export interface DescribeScoreListResponse { /** * 总数 */ Total?: number; /** * 课堂评分列表 */ Scores?: Array<ClassScoreItem>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeDocument请求参数结构体 */ export interface DescribeDocumentRequest { /** * 文档Id(唯一id) */ DocumentId: string; } /** * BatchDeleteRecord返回参数结构体 */ export interface BatchDeleteRecordResponse { /** * 本次操作删除成功的房间ID列表。如果入参列表中某个房间ID的录制文件已经删除,则出参列表中无对应的房间ID。 注意:此字段可能返回 null,表示取不到有效值。 */ RoomIds?: Array<number | bigint>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BatchGetPlaybackToken请求参数结构体 */ export interface BatchGetPlaybackTokenRequest { /** * <p>低代码平台的SdkAppId。</p> */ SdkAppId: number; /** * <p>房间ID。</p> */ RoomIds: Array<number | bigint>; /** * <p>token过期时间,单位秒。如果传0则表示不过期</p> */ ExpireSeconds?: number; /** * <p>用户ID</p> */ UserId?: string; } /** * 表情消息 */ export interface FaceMsgContent { /** * 表情索引,用户自定义。 */ Index: number; /** * 额外数据。 */ Data?: string; } /** * SetAppCustomContent请求参数结构体 */ export interface SetAppCustomContentRequest { /** * <p>自定义内容。</p> */ CustomContent: Array<AppCustomContent>; /** * <p>应用ID。</p> */ SdkAppId: number; } /** * DescribeUser请求参数结构体 */ export interface DescribeUserRequest { /** * 用户id。支持通过 user_id 或 OriginId 查询用户信息,优先使用 user_id 进行查询。 */ UserId?: string; /** * 用户在客户系统的Id。支持通过 user_id 或 OriginId 查询用户信息,优先使用 user_id 进行查询(UserId不为空时,OriginId不生效)。 */ OriginId?: string; } /** * RegisterUser返回参数结构体 */ export interface RegisterUserResponse { /** * 用户Id。 */ UserId?: string; /** * 登录/注册成功后返回登录态token。有效期7天。 */ Token?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeLiveRelayConfig请求参数结构体 */ export interface DescribeLiveRelayConfigRequest { /** * <p>低代码互动课堂的SdkAppId</p> */ SdkAppId: number; /** * <p>房间ID</p> */ RoomId: number; } /** * DescribePlaybackList请求参数结构体 */ export interface DescribePlaybackListRequest { /** * <p>低代码平台的SdkAppId。</p> */ SdkAppId: number; /** * <p>房间ID</p> */ RoomId?: number; /** * <p>分页查询当前页数,从1开始递增</p> */ Page?: number; /** * <p>默认10条,最大上限为100条</p> */ Limit?: number; } /** * BindDocumentToRoom请求参数结构体 */ export interface BindDocumentToRoomRequest { /** * 房间ID。 */ RoomId: number; /** * 文档ID。 */ DocumentId: string; /** * 绑定类型。后台可透传到客户端,默认为0。除以下例值外支持自定义该字段,并在前端实现相应业务逻辑,示例参考: 示例值:0,仅绑定课件到房间 示例值:1,绑定课件到房间后,默认展示课件 */ BindType?: number; } /** * CreateDocument请求参数结构体 */ export interface CreateDocumentRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 文档地址。 */ DocumentUrl: string; /** * 文档名称。 */ DocumentName: string; /** * 文档所有者的Id */ Owner: string; /** * 转码类型,可以有如下取值: 0 无需转码(默认),bmp,jpg,jpeg,png,gif 1 需要转码的文档,ppt,pptx,pdf,doc,docx,xls,xlsx 2 需要转码的视频,mp4,3pg,mpeg,avi,flv,wmv,rm,h264等 2 需要转码的音频,mp3,wav,wma,aac,flac,opus 3 备用转码,建议 WPS 制作的课件使用此方式转码,保证课件显示效果 请注意,待录制的页面中任何视频的分辨率不能超过页面录制最大分辨率(1920*1080),否则将导致录制失败。 - ppt课件内嵌视频或纯视频课件,在上传课件时,云api会进行转码,以确保视频分辨率不超过页面录制最大分辨率。 - h5课件中内嵌音视频内容时,由于平台无法获取视频内容,因此在制作环节需确保视频分辨率不超过页面录制最大分辨率。 */ TranscodeType?: number; /** * 权限,可以有如下取值: 0 私有文档(默认) 1 公共文档 */ Permission?: number; /** * 文档后缀名。 */ DocumentType?: string; /** * 文档大小,单位 字节 */ DocumentSize?: number; /** * 是否对不支持元素开启自动处理的功能。默认关闭。 自动处理的元素如下: 1. 墨迹:移除不支持的墨迹(例如WPS墨迹) 2. 自动翻页:移除PPT上所有自动翻页设置,并设置为单击鼠标翻页 3. 已损坏音视频:移除PPT上对损坏音视频的引用 */ AutoHandleUnsupportedElement?: boolean; /** * 转码后文档的最小分辨率,不传、传空字符串或分辨率格式错误则使用文档原分辨率。该参数仅对TranscodeType=1的课件生效。示例:1280x720,注意分辨率宽高中间为英文字母"xyz"的"x" 示例值:1280x720 */ MinScaleResolution?: string; } /** * GetRoomMessage返回参数结构体 */ export interface GetRoomMessageResponse { /** * 消息列表 */ Messages?: Array<MessageList>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 批量创建群组基础信息 */ export interface GroupBaseInfo { /** * 待创建群组名 */ GroupName: string; /** * 群组主讲人ID */ TeacherId?: string; } /** * 批量注册用户信息 */ export interface BatchUserInfo { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId?: number; /** * 用户ID。 */ UserId?: string; /** * 用户在客户系统的Id。 若用户注册时该字段为空,则默认为 UserId 值一致。 */ OriginId?: string; } /** * 编辑版本信息 */ export interface EditVersions { /** * <p>版本号</p><p>取值范围:[0, 100]</p><p>默认值:0</p> */ Version?: number; /** * <p>版本状态</p><p>枚举值:</p><ul><li>READY: 已完成</li><li>FAILED: 失败</li><li>PROCESSING: 进行中</li></ul> */ Status?: string; /** * <p>是否是主版本</p><p>枚举值:</p><ul><li>true: 是</li><li>false: 否</li></ul> */ IsMain?: boolean; /** * <p>是否源头版本</p><p>枚举值:</p><ul><li>true: 是</li><li>false: 否</li></ul> */ IsSource?: boolean; /** * <p>版本时长</p><p>取值范围:[0, 1000000]</p><p>单位:秒</p> */ KeepDurationSec?: number; /** * <p>创建时间</p><p>取值范围:[0, 10000000]</p> */ CreatedAtMs?: number; /** * <p>创建用户id</p> */ CreatorUserId?: string; /** * <p>失败原因</p><p>默认值:空</p><p>仅失败才会有原因</p> */ FailReason?: string; /** * <p>更新时间</p><p>取值范围:[0, 100000]</p> */ UpdatedAtMs?: number; /** * <p>版本名字</p> */ VersionName?: string; } /** * BatchAddGroupMember请求参数结构体 */ export interface BatchAddGroupMemberRequest { /** * 待添加群组ID列表,最大值100 */ GroupIds: Array<string>; /** * 低代码平台应用ID */ SdkAppId: number; /** * 待添加成员列表,最大值200 */ MemberIds: Array<string>; } /** * StartRecord返回参数结构体 */ export interface StartRecordResponse { /** * 任务ID */ TaskId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * LoginUserWithRoom返回参数结构体 */ export interface LoginUserWithRoomResponse { /** * <p>用户Id。</p> */ UserId?: string; /** * <p>注册成功后返回登录态token,有效期7天。token过期后可以通过调用“登录”或“源账号登录”进行更新。</p> */ Token?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserDetail返回参数结构体 */ export interface DescribeUserDetailResponse { /** * 当前获取用户信息数组列表 */ Users?: Array<UserInfo>; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRoom返回参数结构体 */ export interface DescribeRoomResponse { /** * <p>课堂名称。</p> */ Name?: string; /** * <p>预定的课堂开始时间,unix时间戳(秒)。</p> */ StartTime?: number; /** * <p>预定的课堂结束时间,unix时间戳(秒)。</p> */ EndTime?: number; /** * <p>老师的UserId。</p> */ TeacherId?: string; /** * <p>低代码互动课堂的SdkAppId。</p> */ SdkAppId?: number; /** * <p>观看类型。互动观看 (默认)</p> */ AudienceType?: number; /** * <p>头像区域,摄像头视频画面的分辨率。可以有如下取值:<br>1 标清<br>2 高清<br>3 全高清</p> */ Resolution?: number; /** * <p>设置课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。</p> */ MaxMicNumber?: number; /** * <p>进入课堂时是否自动连麦。可以有以下取值:<br>0 不自动连麦(需要手动申请上麦,默认值)<br>1 自动连麦</p> */ AutoMic?: number; /** * <p>高音质模式。可以有以下取值:<br>0 不开启高音质(默认值)<br>1 开启高音质</p> */ AudioQuality?: number; /** * <p>课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频</p> */ SubType?: string; /** * <p>录制方式。</p><p>枚举值:</p><ul><li>0: 开启自动录制</li><li>1: 禁止录制</li><li>2: 开启手动录制。(仅支持页面录制,需通过startRecord、stopRecord接口控制录制的开始和结束。)</li><li>3: 信令录制。</li></ul> */ DisableRecord?: number; /** * <p>助教UserId列表。</p> */ Assistants?: Array<string>; /** * <p>录制地址(协议为https)。仅在房间结束后存在。</p> */ RecordUrl?: string; /** * <p>课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。</p> */ Status?: number; /** * <p>课堂绑定的群组ID</p> */ GroupId?: string; /** * <p>打开学生麦克风/摄像头的授权开关</p> */ EnableDirectControl?: number; /** * <p>开启专注模式。<br>0 收看全部角色音视频(默认)<br>1 只看老师和助教</p> */ InteractionMode?: number; /** * <p>横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型</p> */ VideoOrientation?: number; /** * <p>该课堂是否开启了课后评分功能。0:未开启 1:开启</p> */ IsGradingRequiredPostClass?: number; /** * <p>课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏</p> */ RoomType?: number; /** * <p>录制时长</p> */ VideoDuration?: number; /** * <p>拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟</p> */ EndDelayTime?: number; /** * <p>直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播</p> */ LiveType?: number; /** * <p>伪直播链接</p> */ RecordLiveUrl?: string; /** * <p>是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效</p> */ EnableAutoStart?: number; /** * <p>录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道</p> */ RecordBackground?: string; /** * <p>RTMP推流链接</p> */ RTMPStreamingURL?: string; /** * <p>录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。</p> */ RecordScene?: string; /** * <p>录制自定义语言,仅recordlayout=9的时候此参数有效</p> */ RecordLang?: string; /** * <p>录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0</p> */ RecordStream?: number; /** * <p>录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:https://cloud.tencent.com/document/