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.



4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
# File 'lib/v20220817/models.rb', line 4525

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

#AssistantsObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def Assistants
  @Assistants
end

#AudienceTypeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def AudienceType
  @AudienceType
end

#AudioQualityObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def AudioQuality
  @AudioQuality
end

#AutoMicObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def AutoMic
  @AutoMic
end

#DisableRecordObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def DisableRecord
  @DisableRecord
end

#EnableAutoStartObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def EnableAutoStart
  @EnableAutoStart
end

#EnableDirectControlObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def EnableDirectControl
  @EnableDirectControl
end

#EndDelayTimeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def EndDelayTime
  @EndDelayTime
end

#EndTimeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def EndTime
  @EndTime
end

#GroupIdObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def GroupId
  @GroupId
end

#GuestsObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def Guests
  @Guests
end

#InteractionModeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def InteractionMode
  @InteractionMode
end

#IsGradingRequiredPostClassObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def IsGradingRequiredPostClass
  @IsGradingRequiredPostClass
end

#LiveTypeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def LiveType
  @LiveType
end

#MaxMicNumberObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def MaxMicNumber
  @MaxMicNumber
end

#NameObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def Name
  @Name
end

#RecordBackgroundObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def RecordBackground
  @RecordBackground
end

#RecordLangObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def RecordLang
  @RecordLang
end

#RecordLayoutObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def RecordLayout
  @RecordLayout
end

#RecordLiveUrlObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def RecordLiveUrl
  @RecordLiveUrl
end

#RecordMergeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def RecordMerge
  @RecordMerge
end

#RecordSceneObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def RecordScene
  @RecordScene
end

#RecordStreamObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def RecordStream
  @RecordStream
end

#ResolutionObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def Resolution
  @Resolution
end

#RoomTypeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def RoomType
  @RoomType
end

#RTCAudienceNumberObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def RTCAudienceNumber
  @RTCAudienceNumber
end

#StartTimeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def StartTime
  @StartTime
end

#SubtitlesTranscriptionObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def SubtitlesTranscription
  @SubtitlesTranscription
end

#SubTypeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def SubType
  @SubType
end

#TeacherIdObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def TeacherId
  @TeacherId
end

#TurnOffMicObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def TurnOffMic
  @TurnOffMic
end

#VideoOrientationObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def VideoOrientation
  @VideoOrientation
end

#WhiteBoardSnapshotModeObject

字符数不超过256 1 标清2 高清3 全高清0 不开启字幕转写功能(默认值)1 自动转写模式:上课自动开启,下课自动停止2 手动转写模式:支持老师或者助教通过客户端API手动开启/关闭字幕转写设置0和1时客户端均不展示手动开关,设置2时老师或者助教端展示字幕转写开关

Parameters:

  • Name:

    房间名称。

  • StartTime:

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

  • EndTime:

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

  • Resolution:

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

  • MaxMicNumber:
  • SubType:

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

  • TeacherId:

    老师ID。通过接口获取的UserId。

  • AutoMic:

    进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦

  • TurnOffMic:

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

  • AudioQuality:

    高音质模式。可以有以下取值: 0 不开启高音质(默认值) 1 开启高音质

  • DisableRecord:

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

  • Assistants:

    助教Id列表。通过接口获取的UserId。

  • RTCAudienceNumber:

    rtc人数。

  • AudienceType:

    观看类型。

  • RecordLayout:

    录制布局。

  • GroupId:

    房间绑定的群组ID

  • EnableDirectControl:

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

  • InteractionMode:

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

  • VideoOrientation:

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

  • IsGradingRequiredPostClass:

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

  • RoomType:

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

  • EndDelayTime:

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

  • LiveType:

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

  • RecordLiveUrl:

    伪直播回放链接

  • EnableAutoStart:

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

  • RecordBackground:

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

  • RecordScene:

    录制自定义场景。注意:仅recordlayout=9的时候此参数有效。需注意各类参数配置正确能够生效。不然会造成录制失败,失败后无法补救。数据内容为用户自定义场景参数,数据格式为json键值对方式,其中键值对的value为string类型。自定义场景参数的含义。如下: scene:自定义js/css对应的场景值。如scene=recordScene,会加载 recordScene 场景对应的 js/css,这样就可以自定义录制页面的元素。 lng:录制页面对应的语种。如lng=en,则录制界面为en。(枚举值:en,zh,zh-TW,jp,ar,kr,vi) customToken:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。

  • RecordLang:

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

  • RecordStream:

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

  • WhiteBoardSnapshotMode:

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

  • SubtitlesTranscription:

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

  • Guests:

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

  • RecordMerge:

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



4518
4519
4520
# File 'lib/v20220817/models.rb', line 4518

def WhiteBoardSnapshotMode
  @WhiteBoardSnapshotMode
end

Instance Method Details

#deserialize(params) ⇒ Object



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
4592
4593
4594
4595
# File 'lib/v20220817/models.rb', line 4561

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