Class: TencentCloud::Lcic::V20220817::CreateRoomRequest

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

Overview

CreateRoom请求参数结构体

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CreateRoomRequest.



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
 
# File 'lib/v20220817/models.rb', line 973

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

Instance Attribute Details

#Assistants ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def Assistants
  @Assistants
end

#AudienceType ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def AudienceType
  @AudienceType
end

#AudioQuality ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def AudioQuality
  @AudioQuality
end

#AutoMic ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def AutoMic
  @AutoMic
end

#DisableRecord ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def DisableRecord
  @DisableRecord
end

#EnableAutoStart ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def EnableAutoStart
  @EnableAutoStart
end

#EnableDirectControl ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def EnableDirectControl
  @EnableDirectControl
end

#EndDelayTime ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def EndDelayTime
  @EndDelayTime
end

#EndTime ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def EndTime
  @EndTime
end

#GroupId ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def GroupId
  @GroupId
end

#Guests ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def Guests
  @Guests
end

#InteractionMode ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def InteractionMode
  @InteractionMode
end

#IsGradingRequiredPostClass ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def IsGradingRequiredPostClass
  @IsGradingRequiredPostClass
end

#LiveType ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def LiveType
  @LiveType
end

#MaxMicNumber ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def MaxMicNumber
  @MaxMicNumber
end

#Name ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def Name
  @Name
end

#RecordBackground ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def RecordBackground
  @RecordBackground
end

#RecordLang ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def RecordLang
  @RecordLang
end

#RecordLayout ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def RecordLayout
  @RecordLayout
end

#RecordLiveUrl ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def RecordLiveUrl
  @RecordLiveUrl
end

#RecordMerge ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def RecordMerge
  @RecordMerge
end

#RecordScene ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def RecordScene
  @RecordScene
end

#RecordStream ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def RecordStream
  @RecordStream
end

#Resolution ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def Resolution
  @Resolution
end

#RoomType ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def RoomType
  @RoomType
end

#RTCAudienceNumber ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def RTCAudienceNumber
  @RTCAudienceNumber
end

#SdkAppId ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def SdkAppId
  @SdkAppId
end

#StartTime ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def StartTime
  @StartTime
end

#SubtitlesTranscription ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def SubtitlesTranscription
  @SubtitlesTranscription
end

#SubType ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def SubType
  @SubType
end

#TeacherId ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def TeacherId
  @TeacherId
end

#TurnOffMic ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def TurnOffMic
  @TurnOffMic
end

#VideoOrientation ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def VideoOrientation
  @VideoOrientation
end

#WhiteBoardSnapshotMode ⇒ Object

Parameters:

  • Name: (p) —

    课堂名称。
    字符数不超过256

  • StartTime: (p) —

    预定的课堂开始时间，unix时间戳（秒）。

  • EndTime: (p) —

    预定的课堂结束时间，unix时间戳（秒）。

  • SdkAppId: (p) —

    低代码互动课堂的SdkAppId。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清
    注意：连麦人数（MaxMicNumber）>6时，仅可使用标清

  • MaxMicNumber: (p) —

    设置课堂同时最大可与老师进行连麦互动的人数，该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16]，大班课取值范围[0,1]，当取值为0时表示当前课堂/直播，不支持连麦互动。该取值影响计费，请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。

  • SubType: (p) —

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

  • TeacherId: (p) —

    老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。

  • AutoMic: (p) —

    进入课堂时是否自动连麦。可以有以下取值：
    0 不自动连麦（需要手动申请上麦，默认值）
    1 自动连麦

  • TurnOffMic: (p) —

    释放音视频权限后是否自动取消连麦。可以有以下取值：
    0 自动取消连麦（默认值）
    1 保持连麦状态

  • AudioQuality: (p) —

    声音音质。可以有以下取值：
    0：流畅模式（默认值），占用更小的带宽、拥有更好的降噪效果，适用于1对1、小班教学、多人音视频会议等场景。
    1：高音质模式，适合需要高保真传输音乐的场景，但降噪效果会被削弱，适用于音乐教学场景。

  • DisableRecord: (p) —

    录制方式，可以有以下取值：0 开启自动录制（默认值）1 禁止录制2 开启手动录制 注： - 如果该配置取值为0，录制将从上课后开始，课堂结束后停止。 - 如果该配置取值为2，需通过startRecord、stopRecord接口控制录制的开始和结束。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。互动观看 （默认）

  • RecordLayout: (p) —

    录制模板。未配置时默认取值0。录制模板枚举值参考：https://cloud.tencent.com/document/product/1639/89744

  • GroupId: (p) —

    课堂绑定的群组ID,非空时限制组成员进入

  • EnableDirectControl: (p) —

    是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值：
    0 不允许直接控制（需同意，默认值）
    1 允许直接控制（无需同意）

  • InteractionMode: (p) —

    开启专注模式。
    0 收看全部角色音视频(默认)
    1 只看老师和助教

  • VideoOrientation: (p) —

    横竖屏。0：横屏开播（默认值）; 1：竖屏开播，当前仅支持移动端的纯视频类型

  • IsGradingRequiredPostClass: (p) —

    开启课后评分。 0：不开启(默认) 1：开启

  • RoomType: (p) —

    课堂类型。 注：大班课的布局(layout)只有三分屏

    枚举值：

    • 0： 小班课（默认值）
    • 1： 大班课
    • 2： 1V1 (预留参数，暂未开放);
    • 3： 圆桌会议
    • 4： 分组直播

    默认值：0

  • Guests: (p) —

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

  • EndDelayTime: (p) —

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

  • LiveType: (p) —

    直播类型：0 常规（默认）1 伪直播 2 RTMP推流直播

  • RecordLiveUrl: (p) —

    伪直播链接。 支持的协议以及格式： 协议：HTTP、HTTPS、RTMP、HLS 。格式：FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码：H.264、VP8。音频编码：AAC、OPUS。

    注意：伪直播视频规格建议最高使用1080p 30fps，4k视频会有兼容性问题导致直播失败。

  • EnableAutoStart: (p) —

    是否自动开始上课：0 不自动上课（默认） 1 自动上课 live_type=1或2的时候有效

  • RecordBackground: (p) —

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

  • RecordScene: (p) —

    录制自定义场景。注意：仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败，失败后无法补救。数据内容为用户自定义场景参数，数据格式为json键值对方式，其中键值对的value为string类型。

    自定义场景参数的含义。如下：
    scene：自定义js/css对应的场景值。如scene=recordScene，会加载 recordScene 场景对应的 js/css，这样就可以自定义录制页面的元素。
    lng：录制页面对应的语种。如lng=en，则录制界面为en。（枚举值：en,zh，zh-TW，jp，ar，kr，vi）
    customToken：录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下，无需配置。

  • RecordLang: (p) —

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

  • RecordStream: (p) —

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

  • WhiteBoardSnapshotMode: (p) —

    板书截图生成类型。0 不生成板书（默认）；1 全量模式；2 单页去重模式

  • SubtitlesTranscription: (p) —

    字幕转写功能开关。可以有以下取值：
    0 不开启字幕转写功能（默认值）
    1 自动转写模式：上课自动开启，下课自动停止
    2 手动转写模式：支持老师或者助教通过客户端API手动开启/关闭字幕转写
    设置0和1时客户端均不展示手动开关，设置2时老师或者助教端展示字幕转写开关

  • RecordMerge: (p) —

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



966
967
968
 
# File 'lib/v20220817/models.rb', line 966

def WhiteBoardSnapshotMode
  @WhiteBoardSnapshotMode
end

Instance Method Details

#deserialize(params) ⇒ Object 



1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
 
# File 'lib/v20220817/models.rb', line 1010

def deserialize(params)
  @Name = params['Name']
  @StartTime = params['StartTime']
  @EndTime = params['EndTime']
  @SdkAppId = params['SdkAppId']
  @Resolution = params['Resolution']
  @MaxMicNumber = params['MaxMicNumber']
  @SubType = params['SubType']
  @TeacherId = params['TeacherId']
  @AutoMic = params['AutoMic']
  @TurnOffMic = params['TurnOffMic']
  @AudioQuality = params['AudioQuality']
  @DisableRecord = params['DisableRecord']
  @Assistants = params['Assistants']
  @RTCAudienceNumber = params['RTCAudienceNumber']
  @AudienceType = params['AudienceType']
  @RecordLayout = params['RecordLayout']
  @GroupId = params['GroupId']
  @EnableDirectControl = params['EnableDirectControl']
  @InteractionMode = params['InteractionMode']
  @VideoOrientation = params['VideoOrientation']
  @IsGradingRequiredPostClass = params['IsGradingRequiredPostClass']
  @RoomType = params['RoomType']
  @Guests = params['Guests']
  @EndDelayTime = params['EndDelayTime']
  @LiveType = params['LiveType']
  @RecordLiveUrl = params['RecordLiveUrl']
  @EnableAutoStart = params['EnableAutoStart']
  @RecordBackground = params['RecordBackground']
  @RecordScene = params['RecordScene']
  @RecordLang = params['RecordLang']
  @RecordStream = params['RecordStream']
  @WhiteBoardSnapshotMode = params['WhiteBoardSnapshotMode']
  @SubtitlesTranscription = params['SubtitlesTranscription']
  @RecordMerge = params['RecordMerge']
end