Class: TencentCloud::Lcic::V20220817::RoomInfo

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

Overview

批量创建房间的房间信息

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name = nil, starttime = nil, endtime = 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, enddelaytime = nil, livetype = nil, recordliveurl = nil, enableautostart = nil, recordbackground = nil, recordscene = nil, recordlang = nil, recordstream = nil, whiteboardsnapshotmode = nil, subtitlestranscription = nil, guests = nil, recordmerge = nil) ⇒ RoomInfo

Returns a new instance of RoomInfo.



4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
 
# File 'lib/v20220817/models.rb', line 4557

def initialize(name=nil, starttime=nil, endtime=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, enddelaytime=nil, livetype=nil, recordliveurl=nil, enableautostart=nil, recordbackground=nil, recordscene=nil, recordlang=nil, recordstream=nil, whiteboardsnapshotmode=nil, subtitlestranscription=nil, guests=nil, recordmerge=nil)
  @Name = name
  @StartTime = starttime
  @EndTime = endtime
  @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
  @EndDelayTime = enddelaytime
  @LiveType = livetype
  @RecordLiveUrl = recordliveurl
  @EnableAutoStart = enableautostart
  @RecordBackground = recordbackground
  @RecordScene = recordscene
  @RecordLang = recordlang
  @RecordStream = recordstream
  @WhiteBoardSnapshotMode = whiteboardsnapshotmode
  @SubtitlesTranscription = subtitlestranscription
  @Guests = guests
  @RecordMerge = recordmerge
end

Instance Attribute Details

#Assistants ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def Assistants
  @Assistants
end

#AudienceType ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def AudienceType
  @AudienceType
end

#AudioQuality ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def AudioQuality
  @AudioQuality
end

#AutoMic ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def AutoMic
  @AutoMic
end

#DisableRecord ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def DisableRecord
  @DisableRecord
end

#EnableAutoStart ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def EnableAutoStart
  @EnableAutoStart
end

#EnableDirectControl ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def EnableDirectControl
  @EnableDirectControl
end

#EndDelayTime ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def EndDelayTime
  @EndDelayTime
end

#EndTime ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def EndTime
  @EndTime
end

#GroupId ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def GroupId
  @GroupId
end

#Guests ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def Guests
  @Guests
end

#InteractionMode ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def InteractionMode
  @InteractionMode
end

#IsGradingRequiredPostClass ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def IsGradingRequiredPostClass
  @IsGradingRequiredPostClass
end

#LiveType ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def LiveType
  @LiveType
end

#MaxMicNumber ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def MaxMicNumber
  @MaxMicNumber
end

#Name ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def Name
  @Name
end

#RecordBackground ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def RecordBackground
  @RecordBackground
end

#RecordLang ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def RecordLang
  @RecordLang
end

#RecordLayout ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def RecordLayout
  @RecordLayout
end

#RecordLiveUrl ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def RecordLiveUrl
  @RecordLiveUrl
end

#RecordMerge ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def RecordMerge
  @RecordMerge
end

#RecordScene ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def RecordScene
  @RecordScene
end

#RecordStream ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def RecordStream
  @RecordStream
end

#Resolution ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def Resolution
  @Resolution
end

#RoomType ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def RoomType
  @RoomType
end

#RTCAudienceNumber ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def RTCAudienceNumber
  @RTCAudienceNumber
end

#StartTime ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def StartTime
  @StartTime
end

#SubtitlesTranscription ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def SubtitlesTranscription
  @SubtitlesTranscription
end

#SubType ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def SubType
  @SubType
end

#TeacherId ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def TeacherId
  @TeacherId
end

#TurnOffMic ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def TurnOffMic
  @TurnOffMic
end

#VideoOrientation ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def VideoOrientation
  @VideoOrientation
end

#WhiteBoardSnapshotMode ⇒ Object

Parameters:

  • Name: (p) —

    房间名称。
    字符数不超过256

  • StartTime: (p) —

    预定的房间开始时间，unix时间戳。

  • EndTime: (p) —

    预定的房间结束时间，unix时间戳。

  • Resolution: (p) —

    头像区域，摄像头视频画面的分辨率。可以有如下取值：
    1 标清
    2 高清
    3 全高清

  • 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 开启高音质

  • DisableRecord: (p) —

    上课后是否禁止自动录制。可以有以下取值： 0 不禁止录制（自动开启录制，默认值） 1 禁止录制 注：如果该配置取值为0，录制将从上课后开始，课堂结束后停止。

  • Assistants: (p) —

    助教Id列表。通过[注册用户]接口获取的UserId。

  • RTCAudienceNumber: (p) —

    rtc人数。

  • AudienceType: (p) —

    观看类型。

  • RecordLayout: (p) —

    录制布局。

  • GroupId: (p) —

    房间绑定的群组ID

  • EnableDirectControl: (p) —

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

  • InteractionMode: (p) —

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

  • VideoOrientation: (p) —

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

  • IsGradingRequiredPostClass: (p) —

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

  • RoomType: (p) —

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

  • 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时老师或者助教端展示字幕转写开关

  • Guests: (p) —

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

  • RecordMerge: (p) —

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



4550
4551
4552
 
# File 'lib/v20220817/models.rb', line 4550

def WhiteBoardSnapshotMode
  @WhiteBoardSnapshotMode
end

Instance Method Details

#deserialize(params) ⇒ Object 



4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
 
# File 'lib/v20220817/models.rb', line 4593

def deserialize(params)
  @Name = params['Name']
  @StartTime = params['StartTime']
  @EndTime = params['EndTime']
  @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']
  @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']
  @Guests = params['Guests']
  @RecordMerge = params['RecordMerge']
end