/** * CreateRoom请求参数结构体 */ export interface CreateRoomRequest { /** *
课堂名称。
字符数不超过256
预定的课堂开始时间,unix时间戳(秒)。
*/ StartTime: number; /** *预定的课堂结束时间,unix时间戳(秒)。
*/ EndTime: number; /** *低代码互动课堂的SdkAppId。
*/ SdkAppId: number; /** *头像区域,摄像头视频画面的分辨率。可以有如下取值:
1 标清
2 高清
3 全高清
注意:连麦人数(MaxMicNumber)>6时,仅可使用标清
设置课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。该取值影响计费,请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。
*/ MaxMicNumber: number; /** *课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频
*/ SubType: string; /** *老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
*/ TeacherId?: string; /** *进入课堂时是否自动连麦。可以有以下取值:
0 不自动连麦(需要手动申请上麦,默认值)
1 自动连麦
释放音视频权限后是否自动取消连麦。可以有以下取值:
0 自动取消连麦(默认值)
1 保持连麦状态
声音音质。可以有以下取值:
0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。
1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。
录制方式。
枚举值:
助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。
*/ Assistants?: Arrayrtc人数。
* @deprecated */ RTCAudienceNumber?: number; /** *观看类型。互动观看 (默认)
*/ AudienceType?: number; /** *录制模板。未配置时默认取值0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
*/ RecordLayout?: number; /** *课堂绑定的群组ID,非空时限制组成员进入
*/ GroupId?: string; /** *是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值:
0 不允许直接控制(需同意,默认值)
1 允许直接控制(无需同意)
开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教
横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
*/ VideoOrientation?: number; /** *开启课后评分。 0:不开启(默认) 1:开启
*/ IsGradingRequiredPostClass?: number; /** *课堂类型。 注:大班课的布局(layout)只有三分屏
枚举值:
默认值:0
*/ RoomType?: number; /** *嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效
*/ Guests?: Array拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
*/ EndDelayTime?: number; /** *直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播
*/ LiveType?: number; /** *伪直播链接。 支持的协议以及格式: 协议:HTTP、HTTPS、RTMP、HLS 。格式:FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码:H.264、VP8。音频编码:AAC、OPUS。
注意:伪直播视频规格建议最高使用1080p 30fps,4k视频会有兼容性问题导致直播失败。
*/ RecordLiveUrl?: string; /** *是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1或2的时候有效
*/ EnableAutoStart?: number; /** *录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
*/ RecordBackground?: string; /** *录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。
录制自定义语言,仅recordlayout=9的时候此参数有效
* @deprecated */ RecordLang?: string; /** *录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0
*/ RecordStream?: number; /** *板书截图生成类型。0 不生成板书(默认);1 全量模式;2 单页去重模式
*/ WhiteBoardSnapshotMode?: number; /** *字幕转写功能开关。可以有以下取值:
0 不开启字幕转写功能(默认值)
1 自动转写模式:上课自动开启,下课自动停止
2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写
设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关
录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效
*/ RecordMerge?: number; /** *转推开关
枚举值:
总条数。
*/ Total?: number; /** *信令录制视频回放观看记录列表。
*/ Records?: Array低代码互动课堂的SdkAppId。
*/ SdkAppId: number; /** *房间ID。
*/ RoomId: number; /** *分组数量。注:最大数量限制为30
*/ Number: number; } /** * BatchRegister请求参数结构体 */ export interface BatchRegisterRequest { /** * 批量注册用户信息列表 */ Users: Array分组直播参加码
*/ GroupLiveCodes?: Array总数
*/ Total?: number; /** *课堂回放信息列表
*/ Items?: Array低代码互动课堂的SdkAppId。
*/ SdkAppId: number; /** *用户在客户系统的Id,需要在同一应用下唯一。
*/ OriginId: string; /** *课堂 ID
*/ 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转推类型
枚举值:
转推URL
*/ Urls?: Array是否是腾讯云CDN。
枚举值:
课堂Id。
*/ RoomId: number; /** *请求RTMP推流链接,0:否,1:是,默认为0。
*/ 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注册获取的用户id。
*/ UserId: string; /** *课堂 ID
*/ 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; } /** * DescribeGroup返回参数结构体 */ export interface DescribeGroupResponse { /** * 群组ID */ GroupId?: string; /** * 群组名称 */ GroupName?: string; /** * 群主主讲人ID 注意:此字段可能返回 null,表示取不到有效值。 */ TeacherId?: string; /** * 群组类型 0-基础群组 1-组合群组,若为1时会返回子群组ID */ GroupType?: number; /** * 子群组ID列表 注意:此字段可能返回 null,表示取不到有效值。 */ SubGroupIds?: Array房间id
*/ RoomId?: number; /** *回放地址
*/ PlaybackUrl?: string; /** *录制时长
*/ Duration?: number; /** *录制开始时间
*/ CreateTime?: number; /** *文件大小。
单位:MB
*/ 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学校ID
*/ SdkAppId?: number; /** *房间ID
*/ 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 { /** *房间id
*/ RoomId?: number; /** *该房间信令回放的token
*/ 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低代码平台的SdkAppId。
*/ SdkAppId: number; /** *房间ID。
*/ RoomIds: Arraytoken过期时间,单位秒。如果传0则表示不过期
*/ ExpireSeconds?: number; /** *用户ID
*/ UserId?: string; } /** * 表情消息 */ export interface FaceMsgContent { /** * 表情索引,用户自定义。 */ Index: number; /** * 额外数据。 */ Data?: string; } /** * SetAppCustomContent请求参数结构体 */ export interface SetAppCustomContentRequest { /** * 自定义内容。 */ CustomContent: Array低代码互动课堂的SdkAppId
*/ SdkAppId: number; /** *房间ID
*/ RoomId: number; } /** * DescribePlaybackList请求参数结构体 */ export interface DescribePlaybackListRequest { /** *低代码平台的SdkAppId。
*/ SdkAppId: number; /** *房间ID
*/ RoomId?: number; /** *分页查询当前页数,从1开始递增
*/ Page?: number; /** *默认10条,最大上限为100条
*/ 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用户Id。
*/ UserId?: string; /** *注册成功后返回登录态token,有效期7天。token过期后可以通过调用“登录”或“源账号登录”进行更新。
*/ Token?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeUserDetail返回参数结构体 */ export interface DescribeUserDetailResponse { /** * 当前获取用户信息数组列表 */ Users?: Array课堂名称。
*/ Name?: string; /** *预定的课堂开始时间,unix时间戳(秒)。
*/ StartTime?: number; /** *预定的课堂结束时间,unix时间戳(秒)。
*/ EndTime?: number; /** *老师的UserId。
*/ TeacherId?: string; /** *低代码互动课堂的SdkAppId。
*/ SdkAppId?: number; /** *观看类型。互动观看 (默认)
*/ AudienceType?: number; /** *头像区域,摄像头视频画面的分辨率。可以有如下取值:
1 标清
2 高清
3 全高清
设置课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
*/ MaxMicNumber?: number; /** *进入课堂时是否自动连麦。可以有以下取值:
0 不自动连麦(需要手动申请上麦,默认值)
1 自动连麦
高音质模式。可以有以下取值:
0 不开启高音质(默认值)
1 开启高音质
课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频
*/ SubType?: string; /** *录制方式。
枚举值:
助教UserId列表。
*/ Assistants?: Array录制地址(协议为https)。仅在房间结束后存在。
*/ RecordUrl?: string; /** *课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。
*/ Status?: number; /** *课堂绑定的群组ID
*/ GroupId?: string; /** *打开学生麦克风/摄像头的授权开关
*/ EnableDirectControl?: number; /** *开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教
横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
*/ VideoOrientation?: number; /** *该课堂是否开启了课后评分功能。0:未开启 1:开启
*/ IsGradingRequiredPostClass?: number; /** *课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏
*/ RoomType?: number; /** *录制时长
*/ VideoDuration?: number; /** *拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
*/ EndDelayTime?: number; /** *直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播
*/ LiveType?: number; /** *伪直播链接
*/ RecordLiveUrl?: string; /** *是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
*/ EnableAutoStart?: number; /** *录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
*/ RecordBackground?: string; /** *RTMP推流链接
*/ RTMPStreamingURL?: string; /** *录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。
*/ RecordScene?: string; /** *录制自定义语言,仅recordlayout=9的时候此参数有效
*/ RecordLang?: string; /** *录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0
*/ RecordStream?: number; /** *录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
*/ RecordLayout?: number; /** *板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式
*/ WhiteBoardSnapshotMode?: number; /** *字幕转写功能开关。可以有以下取值:
0 不开启字幕转写功能(默认值)
1 自动转写模式:上课自动开启,下课自动停止
2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写
设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关
嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效
*/ Guests?: Array录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效
*/ RecordMerge?: number; /** *转推开关
枚举值:
用户Id。
*/ UserId?: string; /** *登录/注册成功后返回登录态token。有效期7天。
*/ Token?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeRecordStream返回参数结构体 */ export interface DescribeRecordStreamResponse { /** * 学校ID */ SchoolId?: number; /** * 课堂ID */ ClassId?: number; /** * 课堂类型 */ ClassType?: number; /** * 用户流信息 */ StreamInfo?: Array分组直播参加码
*/ GroupLiveCodes?: Array低代码平台的SdkAppId。
*/ SdkAppId: number; /** *房间ID。
*/ RoomId: number; /** *用户ID。
*/ UserId?: string; /** *token过期时间,单位秒。如果传0则表示不过期
*/ ExpireSeconds?: number; } /** * EndRoom请求参数结构体 */ export interface EndRoomRequest { /** * 课堂ID */ RoomId: number; } /** * CreateGroupWithMembers返回参数结构体 */ export interface CreateGroupWithMembersResponse { /** * 创建成功群组ID */ GroupId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * BatchDeleteGroupMember请求参数结构体 */ export interface BatchDeleteGroupMemberRequest { /** * 待添加群组ID列表,最大值100 */ GroupIds: Arraytoken值,用于回放鉴权。
*/ Token?: string; /** *房间ID。
*/ RoomId?: number; /** *用户ID。
*/ UserId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SendRoomNormalMessage返回参数结构体 */ export interface SendRoomNormalMessageResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DeleteSupervisor返回参数结构体 */ export interface DeleteSupervisorResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SetWatermark返回参数结构体 */ export interface SetWatermarkResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * 批量创建房间的房间信息 */ export interface RoomInfo { /** *房间名称。
字符数不超过256
预定的房间开始时间,unix时间戳。
*/ StartTime: number; /** *预定的房间结束时间,unix时间戳。
*/ EndTime: number; /** *头像区域,摄像头视频画面的分辨率。可以有如下取值:
1 标清
2 高清
3 全高清
设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
*/ MaxMicNumber: number; /** *房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频
*/ SubType: string; /** *老师ID。通过[注册用户]接口获取的UserId。
*/ TeacherId?: string; /** *进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦
*/ AutoMic?: number; /** *释放音视频权限后是否自动取消连麦。可以有以下取值: 0 自动取消连麦(默认值) 1 保持连麦状态
*/ TurnOffMic?: number; /** *高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质
*/ AudioQuality?: number; /** *录制方式。
枚举值:
助教Id列表。通过[注册用户]接口获取的UserId。
*/ Assistants?: Arrayrtc人数。
* @deprecated */ RTCAudienceNumber?: number; /** *观看类型。
*/ AudienceType?: number; /** *录制布局。
*/ RecordLayout?: number; /** *房间绑定的群组ID
*/ GroupId?: string; /** *打开学生麦克风/摄像头的授权开关
*/ EnableDirectControl?: number; /** *开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
*/ InteractionMode?: number; /** *横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
*/ VideoOrientation?: number; /** *开启课后评分。 0:不开启(默认) 1:开启
*/ IsGradingRequiredPostClass?: number; /** *课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏
*/ RoomType?: number; /** *拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
*/ EndDelayTime?: number; /** *直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播
*/ LiveType?: number; /** *伪直播链接。 支持的协议以及格式: 协议:HTTP、HTTPS、RTMP、HLS 。格式:FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码:H.264、VP8。音频编码:AAC、OPUS。
注意:伪直播视频规格建议最高使用1080p 30fps,4k视频会有兼容性问题导致直播失败。
*/ RecordLiveUrl?: string; /** *是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1或2的时候有效
*/ EnableAutoStart?: number; /** *录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道
*/ RecordBackground?: string; /** *录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。
*/ RecordScene?: string; /** *录制自定义语言,仅recordlayout=9的时候此参数有效
* @deprecated */ RecordLang?: string; /** *录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0
*/ RecordStream?: number; /** *板书截图生成类型。0 不生成板书(默认);1 全量模式;2 单页去重模式
*/ WhiteBoardSnapshotMode?: number; /** *字幕转写功能开关。可以有以下取值:
0 不开启字幕转写功能(默认值)
1 自动转写模式:上课自动开启,下课自动停止
2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写
设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关
嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效
*/ Guests?: Array录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效
*/ RecordMerge?: number; /** *转推开关
枚举值:
token值,用于回放鉴权。
*/ Results?: Array房间ID。
*/ Total?: number; /** *用户ID
*/ UserId?: string; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ForbidSendMsg返回参数结构体 */ export interface ForbidSendMsgResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * SendRoomNormalMessage请求参数结构体 */ export interface SendRoomNormalMessageRequest { /** * 低代码互动课堂的SdkAppId。 */ SdkAppId: number; /** * 房间ID。 */ RoomId: number; /** * 管理员指定消息发送方账号(若需设置 FromAccount 信息,则该参数取值不能为空) */ FromAccount: string; /** * 自定义消息 */ MsgBody: Array房间ID。
*/ RoomId?: number; /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeWhiteBoardSnapshot返回参数结构体 */ export interface DescribeWhiteBoardSnapshotResponse { /** * 板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式 */ WhiteBoardSnapshotMode?: number; /** * 板书任务状态,0:未开始,1:进行中,2:失败,3:成功,4:已删除 */ Status?: number; /** * 板书截图链接 */ Result?: Array低代码互动课堂的SdkAppId
*/ SdkAppId: number; /** *房间ID
*/ RoomId: number; /** *转推类型
枚举值:
转推URL
*/ Urls: Array是否是腾讯云CDN(默认为0)
枚举值:
低代码互动课堂的SdkAppId。
*/ SdkAppId: number; /** *课堂ID。
*/ RoomId: number; } /** * DeleteAppCustomContent返回参数结构体 */ export interface DeleteAppCustomContentResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * ModifyGroup返回参数结构体 */ export interface ModifyGroupResponse { /** * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 */ RequestId?: string; } /** * DescribeCurrentMemberList返回参数结构体 */ export interface DescribeCurrentMemberListResponse { /** * 记录总数。当前房间的总人数。 */ Total?: number; /** * 成员记录列表。 */ MemberRecords?: Array房间ID。
*/ RoomId: number; /** *低代码互动课堂的SdkAppId
*/ SdkAppId: number; /** *预定的房间开始时间,unix时间戳(秒)。直播开始后不允许修改。
*/ StartTime?: number; /** *预定的房间结束时间,unix时间戳(秒)。直播开始后不允许修改。
*/ EndTime?: number; /** *老师ID。直播开始后不允许修改。
*/ TeacherId?: string; /** *房间名称。
字符数不超过256
分辨率。可以有如下取值:
1 标清
2 高清
3 全高清
直播开始后不允许修改。
设置房间/课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。
*/ MaxMicNumber?: number; /** *进入房间时是否自动连麦。可以有以下取值:
0 不自动连麦(默认值)
1 自动连麦
直播开始后不允许修改。
高音质模式。可以有以下取值:
0 不开启高音质(默认值)
1 开启高音质
直播开始后不允许修改。
房间子类型,可以有以下取值:
videodoc 文档+视频
video 纯视频
直播开始后不允许修改。
录制方式。
枚举值:
助教Id列表。直播开始后不允许修改。
*/ Assistants?: Array房间绑定的群组ID。直播开始后不允许修改。
*/ GroupId?: string; /** *打开学生麦克风/摄像头的授权开关。直播开始后不允许修改。
*/ EnableDirectControl?: number; /** *开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教
横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
*/ VideoOrientation?: number; /** *开启课后评分。 0:不开启(默认) 1:开启
*/ IsGradingRequiredPostClass?: number; /** *房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数、暂未开放)
注:大班课的布局(layout)只有三分屏
录制模板。仅可修改还未开始的房间。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
*/ RecordLayout?: number; /** *拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
*/ EndDelayTime?: number; /** *直播方式:0 常规模式(默认)1 回放直播模式(伪直播)。 目前支持从回放直播模式(伪直播)改为常规模式,不支持从常规模式改为回放直播模式(伪直播)
*/ LiveType?: number; /** *伪直播链接。 支持的协议以及格式: 协议:HTTP、HTTPS、RTMP、HLS 。格式:FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码:H.264、VP8。音频编码:AAC、OPUS。
注意:伪直播视频规格建议最高使用1080p 30fps,4k视频会有兼容性问题导致直播失败。
*/ RecordLiveUrl?: string; /** *是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效
*/ EnableAutoStart?: number; /** *录制自定义场景,仅recordlayout=9的时候此参数有效,数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。
*/ RecordScene?: string; /** *录制自定义语言,仅recordlayout=9的时候此参数有效
* @deprecated */ RecordLang?: string; /** *板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式
*/ WhiteBoardSnapshotMode?: number; /** *字幕转写功能开关。可以有以下取值:
0 不开启字幕转写功能(默认值)
1 自动转写模式:上课自动开启,下课自动停止
2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写
设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关
嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效
*/ Guests?: Array录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效
*/ RecordMerge?: number; /** *转推开关
枚举值:
房间ID。
*/ RoomId?: number; /** *用户ID。
*/ UserId?: string; /** *单次播放会话ID。
*/ SessionId?: string; /** *播放开始时间,unix时间戳(秒)。
*/ PlayBeginTime?: number; /** *播放结束时间,unix时间戳(秒)。
*/ PlayEndTime?: number; /** *播放时长(毫秒)。
*/ Duration?: number; } /** * DescribePlayRecords请求参数结构体 */ export interface DescribePlayRecordsRequest { /** *低代码互动课堂的SdkAppId。
*/ SdkAppId: number; /** *房间ID。
*/ RoomId: number; /** *开始时间,unix时间戳(秒)。
*/ StartTime: number; /** *结束时间,unix时间戳(秒)。
*/ EndTime: number; /** *页码,从1开始递增。
默认值:1
*/ Page: number; /** *每页获取的记录条数。
取值范围:[1, 200]
默认值:20
*/ PageSize: number; /** *用户ID。
*/ UserId?: string; }