Class: TencentCloud::Lcic::V20220817::DescribeRoomResponse

Inherits:
Common::AbstractModel
  • Object
show all
Defined in:
lib/v20220817/models.rb

Overview

DescribeRoom返回参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name = nil, starttime = nil, endtime = nil, teacherid = nil, sdkappid = nil, audiencetype = nil, resolution = nil, maxmicnumber = nil, automic = nil, audioquality = nil, subtype = nil, disablerecord = nil, assistants = nil, recordurl = nil, status = nil, groupid = nil, enabledirectcontrol = nil, interactionmode = nil, videoorientation = nil, isgradingrequiredpostclass = nil, roomtype = nil, videoduration = nil, enddelaytime = nil, livetype = nil, recordliveurl = nil, enableautostart = nil, recordbackground = nil, rtmpstreamingurl = nil, recordscene = nil, recordlang = nil, recordstream = nil, recordlayout = nil, whiteboardsnapshotmode = nil, subtitlestranscription = nil, guests = nil, recordmerge = nil, requestid = nil) ⇒ DescribeRoomResponse

Returns a new instance of DescribeRoomResponse.



2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
# File 'lib/v20220817/models.rb', line 2549

def initialize(name=nil, starttime=nil, endtime=nil, teacherid=nil, sdkappid=nil, audiencetype=nil, resolution=nil, maxmicnumber=nil, automic=nil, audioquality=nil, subtype=nil, disablerecord=nil, assistants=nil, recordurl=nil, status=nil, groupid=nil, enabledirectcontrol=nil, interactionmode=nil, videoorientation=nil, isgradingrequiredpostclass=nil, roomtype=nil, videoduration=nil, enddelaytime=nil, livetype=nil, recordliveurl=nil, enableautostart=nil, recordbackground=nil, rtmpstreamingurl=nil, recordscene=nil, recordlang=nil, recordstream=nil, recordlayout=nil, whiteboardsnapshotmode=nil, subtitlestranscription=nil, guests=nil, recordmerge=nil, requestid=nil)
  @Name = name
  @StartTime = starttime
  @EndTime = endtime
  @TeacherId = teacherid
  @SdkAppId = sdkappid
  @AudienceType = audiencetype
  @Resolution = resolution
  @MaxMicNumber = maxmicnumber
  @AutoMic = automic
  @AudioQuality = audioquality
  @SubType = subtype
  @DisableRecord = disablerecord
  @Assistants = assistants
  @RecordUrl = recordurl
  @Status = status
  @GroupId = groupid
  @EnableDirectControl = enabledirectcontrol
  @InteractionMode = interactionmode
  @VideoOrientation = videoorientation
  @IsGradingRequiredPostClass = isgradingrequiredpostclass
  @RoomType = roomtype
  @VideoDuration = videoduration
  @EndDelayTime = enddelaytime
  @LiveType = livetype
  @RecordLiveUrl = recordliveurl
  @EnableAutoStart = enableautostart
  @RecordBackground = recordbackground
  @RTMPStreamingURL = rtmpstreamingurl
  @RecordScene = recordscene
  @RecordLang = recordlang
  @RecordStream = recordstream
  @RecordLayout = recordlayout
  @WhiteBoardSnapshotMode = whiteboardsnapshotmode
  @SubtitlesTranscription = subtitlestranscription
  @Guests = guests
  @RecordMerge = recordmerge
  @RequestId = requestid
end

Instance Attribute Details

#AssistantsObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def Assistants
  @Assistants
end

#AudienceTypeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def AudienceType
  @AudienceType
end

#AudioQualityObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def AudioQuality
  @AudioQuality
end

#AutoMicObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def AutoMic
  @AutoMic
end

#DisableRecordObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def DisableRecord
  @DisableRecord
end

#EnableAutoStartObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def EnableAutoStart
  @EnableAutoStart
end

#EnableDirectControlObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def EnableDirectControl
  @EnableDirectControl
end

#EndDelayTimeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def EndDelayTime
  @EndDelayTime
end

#EndTimeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def EndTime
  @EndTime
end

#GroupIdObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def GroupId
  @GroupId
end

#GuestsObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def Guests
  @Guests
end

#InteractionModeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def InteractionMode
  @InteractionMode
end

#IsGradingRequiredPostClassObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def IsGradingRequiredPostClass
  @IsGradingRequiredPostClass
end

#LiveTypeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def LiveType
  @LiveType
end

#MaxMicNumberObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def MaxMicNumber
  @MaxMicNumber
end

#NameObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def Name
  @Name
end

#RecordBackgroundObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RecordBackground
  @RecordBackground
end

#RecordLangObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RecordLang
  @RecordLang
end

#RecordLayoutObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RecordLayout
  @RecordLayout
end

#RecordLiveUrlObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RecordLiveUrl
  @RecordLiveUrl
end

#RecordMergeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RecordMerge
  @RecordMerge
end

#RecordSceneObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RecordScene
  @RecordScene
end

#RecordStreamObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RecordStream
  @RecordStream
end

#RecordUrlObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RecordUrl
  @RecordUrl
end

#RequestIdObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RequestId
  @RequestId
end

#ResolutionObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def Resolution
  @Resolution
end

#RoomTypeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RoomType
  @RoomType
end

#RTMPStreamingURLObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def RTMPStreamingURL
  @RTMPStreamingURL
end

#SdkAppIdObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def SdkAppId
  @SdkAppId
end

#StartTimeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def StartTime
  @StartTime
end

#StatusObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def Status
  @Status
end

#SubtitlesTranscriptionObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def SubtitlesTranscription
  @SubtitlesTranscription
end

#SubTypeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def SubType
  @SubType
end

#TeacherIdObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def TeacherId
  @TeacherId
end

#VideoDurationObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def VideoDuration
  @VideoDuration
end

#VideoOrientationObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def VideoOrientation
  @VideoOrientation
end

#WhiteBoardSnapshotModeObject

1 标清2 高清3 全高清0 不自动连麦(需要手动申请上麦,默认值)1 自动连麦0 不开启高音质(默认值)1 开启高音质0 不禁止录制(自动开启录制,默认值)1 禁止录制注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。0 收看全部角色音视频(默认) 1 只看老师和助教0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    课堂名称。

  • StartTime:

    预定的课堂开始时间,unix时间戳(秒)。

  • EndTime:

    预定的课堂结束时间,unix时间戳(秒)。

  • TeacherId:

    老师的UserId。

  • SdkAppId:

    低代码互动课堂的SdkAppId。

  • AudienceType:

    观看类型。互动观看 (默认)

  • Resolution:

    头像区域,摄像头视频画面的分辨率。可以有如下取值:

  • MaxMicNumber:
  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值:

  • AudioQuality:

    高音质模式。可以有以下取值:

  • SubType:

    课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频

  • DisableRecord:

    上课后是否禁止自动录制。可以有以下取值:

  • Assistants:

    助教UserId列表。

  • RecordUrl:

    录制地址(协议为https)。仅在房间结束后存在。

  • Status:

    课堂状态。0为未开始,1为已开始,2为已结束,3为已过期。

  • GroupId:

    课堂绑定的群组ID

  • EnableDirectControl:

    打开学生麦克风/摄像头的授权开关

  • InteractionMode:

    开启专注模式。

  • VideoOrientation:

    横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass:

    该课堂是否开启了课后评分功能。0:未开启 1:开启

  • RoomType:

    课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏

  • VideoDuration:

    录制时长

  • EndDelayTime:

    拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟

  • LiveType:

    直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播

  • RecordLiveUrl:

    伪直播链接

  • EnableAutoStart:

    是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1的时候有效

  • RecordBackground:

    录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道

  • RTMPStreamingURL:

    RTMP推流链接

  • RecordScene:

    录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

    录制自定义语言,仅recordlayout=9的时候此参数有效

  • RecordStream:

    录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0

  • RecordLayout:

    录制模板。房间子类型为视频+白板(SubType=videodoc)时默认为3,房间子类型为纯视频(SubType=video)时默认为0。录制模板枚举值参考:cloud.tencent.com/document/product/1639/89744

  • WhiteBoardSnapshotMode:

    板书截图生成类型。0 不生成板书;1 全量模式;2 单页去重模式

  • SubtitlesTranscription:

    字幕转写功能开关。可以有以下取值:

  • Guests:

    嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效

  • RecordMerge:

    录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效

  • RequestId:

    唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。



2547
2548
2549
# File 'lib/v20220817/models.rb', line 2547

def WhiteBoardSnapshotMode
  @WhiteBoardSnapshotMode
end

Instance Method Details

#deserialize(params) ⇒ Object



2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
# File 'lib/v20220817/models.rb', line 2589

def deserialize(params)
  @Name = params['Name']
  @StartTime = params['StartTime']
  @EndTime = params['EndTime']
  @TeacherId = params['TeacherId']
  @SdkAppId = params['SdkAppId']
  @AudienceType = params['AudienceType']
  @Resolution = params['Resolution']
  @MaxMicNumber = params['MaxMicNumber']
  @AutoMic = params['AutoMic']
  @AudioQuality = params['AudioQuality']
  @SubType = params['SubType']
  @DisableRecord = params['DisableRecord']
  @Assistants = params['Assistants']
  @RecordUrl = params['RecordUrl']
  @Status = params['Status']
  @GroupId = params['GroupId']
  @EnableDirectControl = params['EnableDirectControl']
  @InteractionMode = params['InteractionMode']
  @VideoOrientation = params['VideoOrientation']
  @IsGradingRequiredPostClass = params['IsGradingRequiredPostClass']
  @RoomType = params['RoomType']
  @VideoDuration = params['VideoDuration']
  @EndDelayTime = params['EndDelayTime']
  @LiveType = params['LiveType']
  @RecordLiveUrl = params['RecordLiveUrl']
  @EnableAutoStart = params['EnableAutoStart']
  @RecordBackground = params['RecordBackground']
  @RTMPStreamingURL = params['RTMPStreamingURL']
  @RecordScene = params['RecordScene']
  @RecordLang = params['RecordLang']
  @RecordStream = params['RecordStream']
  @RecordLayout = params['RecordLayout']
  @WhiteBoardSnapshotMode = params['WhiteBoardSnapshotMode']
  @SubtitlesTranscription = params['SubtitlesTranscription']
  @Guests = params['Guests']
  @RecordMerge = params['RecordMerge']
  @RequestId = params['RequestId']
end