public class CreateRoomRequest extends AbstractModel
header, skipSign| Constructor and Description | 
|---|
| CreateRoomRequest() | 
| CreateRoomRequest(CreateRoomRequest source)NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
       and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy. | 
| Modifier and Type | Method and Description | 
|---|---|
| String[] | getAssistants()Get 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。 | 
| Long | getAudienceType()Get 观看类型。互动观看 (默认) | 
| Long | getAudioQuality()Get 声音音质。可以有以下取值:
0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。
1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。 | 
| Long | getAutoMic()Get 进入课堂时是否自动连麦。可以有以下取值:
0 不自动连麦(需要手动申请上麦,默认值)
1 自动连麦 | 
| Long | getDisableRecord()Get 录制方式,可以有以下取值:0 开启自动录制(默认值)1  禁止录制2 开启手动录制 注: - 如果该配置取值为0,录制将从上课后开始,课堂结束后停止。 - 如果该配置取值为2,需通过startRecord、stopRecord接口控制录制的开始和结束。 | 
| Long | getEnableAutoStart()Get 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1或2的时候有效 | 
| Long | getEnableDirectControl()Get 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值:
0 不允许直接控制(需同意,默认值)
1 允许直接控制(无需同意) | 
| Long | getEndDelayTime()Get 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟 | 
| Long | getEndTime()Get 预定的课堂结束时间,unix时间戳(秒)。 | 
| String | getGroupId()Get 课堂绑定的群组ID,非空时限制组成员进入 | 
| String[] | getGuests()Get 嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效 | 
| Long | getInteractionMode()Get 开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教 | 
| Long | getIsGradingRequiredPostClass()Get 开启课后评分。 0:不开启(默认)  1:开启 | 
| Long | getLiveType()Get 直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播 | 
| Long | getMaxMicNumber()Get 设置课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。该取值影响计费,请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。 | 
| String | getName()Get 课堂名称。
字符数不超过256 | 
| String | getRecordBackground()Get 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道 | 
| String | getRecordLang()Deprecated.   | 
| Long | getRecordLayout()Get 录制模板。未配置时默认取值0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744 | 
| String | getRecordLiveUrl()Get 伪直播链接。 支持的协议以及格式: 协议:HTTP、HTTPS、RTMP、HLS 。格式:FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码:H.264、VP8。音频编码:AAC、OPUS。 | 
| Long | getRecordMerge()Get 录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效 | 
| String | getRecordScene()Get 录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。 | 
| Long | getRecordStream()Get 录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0 | 
| Long | getResolution()Get 头像区域,摄像头视频画面的分辨率。可以有如下取值:
1 标清
2 高清
3 全高清
注意:连麦人数(MaxMicNumber)>6时,仅可使用标清 | 
| Long | getRoomType()Get 课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏 | 
| Long | getRTCAudienceNumber()Deprecated.   | 
| Long | getSdkAppId()Get 低代码互动课堂的SdkAppId。 | 
| Long | getStartTime()Get 预定的课堂开始时间,unix时间戳(秒)。 | 
| Long | getSubtitlesTranscription()Get 字幕转写功能开关。可以有以下取值:
0 不开启字幕转写功能(默认值)
1 自动转写模式:上课自动开启,下课自动停止 | 
| String | getSubType()Get 课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频 | 
| String | getTeacherId()Get 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。 | 
| Long | getTurnOffMic()Get 释放音视频权限后是否自动取消连麦。可以有以下取值:
0 自动取消连麦(默认值)
1 保持连麦状态 | 
| Long | getVideoOrientation()Get 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型 | 
| Long | getWhiteBoardSnapshotMode()Get 板书截图生成类型。0 不生成板书(默认);1 全量模式;2 单页去重模式 | 
| void | setAssistants(String[] Assistants)Set 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。 | 
| void | setAudienceType(Long AudienceType)Set 观看类型。互动观看 (默认) | 
| void | setAudioQuality(Long AudioQuality)Set 声音音质。可以有以下取值:
0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。
1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。 | 
| void | setAutoMic(Long AutoMic)Set 进入课堂时是否自动连麦。可以有以下取值:
0 不自动连麦(需要手动申请上麦,默认值)
1 自动连麦 | 
| void | setDisableRecord(Long DisableRecord)Set 录制方式,可以有以下取值:0 开启自动录制(默认值)1  禁止录制2 开启手动录制 注: - 如果该配置取值为0,录制将从上课后开始,课堂结束后停止。 - 如果该配置取值为2,需通过startRecord、stopRecord接口控制录制的开始和结束。 | 
| void | setEnableAutoStart(Long EnableAutoStart)Set 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1或2的时候有效 | 
| void | setEnableDirectControl(Long EnableDirectControl)Set 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值:
0 不允许直接控制(需同意,默认值)
1 允许直接控制(无需同意) | 
| void | setEndDelayTime(Long EndDelayTime)Set 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟 | 
| void | setEndTime(Long EndTime)Set 预定的课堂结束时间,unix时间戳(秒)。 | 
| void | setGroupId(String GroupId)Set 课堂绑定的群组ID,非空时限制组成员进入 | 
| void | setGuests(String[] Guests)Set 嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效 | 
| void | setInteractionMode(Long InteractionMode)Set 开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教 | 
| void | setIsGradingRequiredPostClass(Long IsGradingRequiredPostClass)Set 开启课后评分。 0:不开启(默认)  1:开启 | 
| void | setLiveType(Long LiveType)Set 直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播 | 
| void | setMaxMicNumber(Long MaxMicNumber)Set 设置课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。该取值影响计费,请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。 | 
| void | setName(String Name)Set 课堂名称。
字符数不超过256 | 
| void | setRecordBackground(String RecordBackground)Set 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道 | 
| void | setRecordLang(String RecordLang)Deprecated.   | 
| void | setRecordLayout(Long RecordLayout)Set 录制模板。未配置时默认取值0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744 | 
| void | setRecordLiveUrl(String RecordLiveUrl)Set 伪直播链接。 支持的协议以及格式: 协议:HTTP、HTTPS、RTMP、HLS 。格式:FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码:H.264、VP8。音频编码:AAC、OPUS。 | 
| void | setRecordMerge(Long RecordMerge)Set 录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效 | 
| void | setRecordScene(String RecordScene)Set 录制自定义场景。注意:仅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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。 | 
| void | setRecordStream(Long RecordStream)Set 录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0 | 
| void | setResolution(Long Resolution)Set 头像区域,摄像头视频画面的分辨率。可以有如下取值:
1 标清
2 高清
3 全高清
注意:连麦人数(MaxMicNumber)>6时,仅可使用标清 | 
| void | setRoomType(Long RoomType)Set 课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏 | 
| void | setRTCAudienceNumber(Long RTCAudienceNumber)Deprecated.   | 
| void | setSdkAppId(Long SdkAppId)Set 低代码互动课堂的SdkAppId。 | 
| void | setStartTime(Long StartTime)Set 预定的课堂开始时间,unix时间戳(秒)。 | 
| void | setSubtitlesTranscription(Long SubtitlesTranscription)Set 字幕转写功能开关。可以有以下取值:
0 不开启字幕转写功能(默认值)
1 自动转写模式:上课自动开启,下课自动停止 | 
| void | setSubType(String SubType)Set 课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频 | 
| void | setTeacherId(String TeacherId)Set 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。 | 
| void | setTurnOffMic(Long TurnOffMic)Set 释放音视频权限后是否自动取消连麦。可以有以下取值:
0 自动取消连麦(默认值)
1 保持连麦状态 | 
| void | setVideoOrientation(Long VideoOrientation)Set 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型 | 
| void | setWhiteBoardSnapshotMode(Long WhiteBoardSnapshotMode)Set 板书截图生成类型。0 不生成板书(默认);1 全量模式;2 单页去重模式 | 
| void | toMap(HashMap<String,String> map,
     String prefix)Internal implementation, normal users should not use it. | 
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonStringpublic CreateRoomRequest()
public CreateRoomRequest(CreateRoomRequest source)
public String getName()
public void setName(String Name)
Name - 课堂名称。
字符数不超过256public Long getStartTime()
public void setStartTime(Long StartTime)
StartTime - 预定的课堂开始时间,unix时间戳(秒)。public Long getEndTime()
public void setEndTime(Long EndTime)
EndTime - 预定的课堂结束时间,unix时间戳(秒)。public Long getSdkAppId()
public void setSdkAppId(Long SdkAppId)
SdkAppId - 低代码互动课堂的SdkAppId。public Long getResolution()
public void setResolution(Long Resolution)
Resolution - 头像区域,摄像头视频画面的分辨率。可以有如下取值:
1 标清
2 高清
3 全高清
注意:连麦人数(MaxMicNumber)>6时,仅可使用标清public Long getMaxMicNumber()
public void setMaxMicNumber(Long MaxMicNumber)
MaxMicNumber - 设置课堂同时最大可与老师进行连麦互动的人数,该参数支持正式上课/开播前调用修改房间修改。小班课取值范围[0,16],大班课取值范围[0,1],当取值为0时表示当前课堂/直播,不支持连麦互动。该取值影响计费,请根据业务实际情况设置。计费规则见“购买指南”下“计费概述”。public String getSubType()
public void setSubType(String SubType)
SubType - 课堂子类型,可以有以下取值:videodoc 文档+视频video 纯视频public String getTeacherId()
public void setTeacherId(String TeacherId)
TeacherId - 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。public Long getAutoMic()
public void setAutoMic(Long AutoMic)
AutoMic - 进入课堂时是否自动连麦。可以有以下取值:
0 不自动连麦(需要手动申请上麦,默认值)
1 自动连麦public Long getTurnOffMic()
public void setTurnOffMic(Long TurnOffMic)
TurnOffMic - 释放音视频权限后是否自动取消连麦。可以有以下取值:
0 自动取消连麦(默认值)
1 保持连麦状态public Long getAudioQuality()
public void setAudioQuality(Long AudioQuality)
AudioQuality - 声音音质。可以有以下取值:
0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。
1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。public Long getDisableRecord()
public void setDisableRecord(Long DisableRecord)
DisableRecord - 录制方式,可以有以下取值:0 开启自动录制(默认值)1  禁止录制2 开启手动录制 注: - 如果该配置取值为0,录制将从上课后开始,课堂结束后停止。 - 如果该配置取值为2,需通过startRecord、stopRecord接口控制录制的开始和结束。public String[] getAssistants()
public void setAssistants(String[] Assistants)
Assistants - 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。@Deprecated public Long getRTCAudienceNumber()
@Deprecated public void setRTCAudienceNumber(Long RTCAudienceNumber)
RTCAudienceNumber - rtc人数。public Long getAudienceType()
public void setAudienceType(Long AudienceType)
AudienceType - 观看类型。互动观看 (默认)public Long getRecordLayout()
public void setRecordLayout(Long RecordLayout)
RecordLayout - 录制模板。未配置时默认取值0。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744public String getGroupId()
public void setGroupId(String GroupId)
GroupId - 课堂绑定的群组ID,非空时限制组成员进入public Long getEnableDirectControl()
public void setEnableDirectControl(Long EnableDirectControl)
EnableDirectControl - 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值:
0 不允许直接控制(需同意,默认值)
1 允许直接控制(无需同意)public Long getInteractionMode()
public void setInteractionMode(Long InteractionMode)
InteractionMode - 开启专注模式。
0 收看全部角色音视频(默认)
1 只看老师和助教public Long getVideoOrientation()
public void setVideoOrientation(Long VideoOrientation)
VideoOrientation - 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型public Long getIsGradingRequiredPostClass()
public void setIsGradingRequiredPostClass(Long IsGradingRequiredPostClass)
IsGradingRequiredPostClass - 开启课后评分。 0:不开启(默认)  1:开启public Long getRoomType()
public void setRoomType(Long RoomType)
RoomType - 课堂类型: 0 小班课(默认值); 1 大班课; 2 1V1 (预留参数,暂未开放); 3 圆桌会议 注:大班课的布局(layout)只有三分屏public String[] getGuests()
public void setGuests(String[] Guests)
Guests - 嘉宾Id列表。当圆桌会议模式(RoomType==3)时生效public Long getEndDelayTime()
public void setEndDelayTime(Long EndDelayTime)
EndDelayTime - 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟public Long getLiveType()
public void setLiveType(Long LiveType)
LiveType - 直播类型:0 常规(默认)1 伪直播 2 RTMP推流直播public String getRecordLiveUrl()
public void setRecordLiveUrl(String RecordLiveUrl)
RecordLiveUrl - 伪直播链接。 支持的协议以及格式: 协议:HTTP、HTTPS、RTMP、HLS 。格式:FLV、MP3、MP4、MPEG-TS、MOV、MKV、M4A。视频编码:H.264、VP8。音频编码:AAC、OPUS。public Long getEnableAutoStart()
public void setEnableAutoStart(Long EnableAutoStart)
EnableAutoStart - 是否自动开始上课:0 不自动上课(默认) 1 自动上课 live_type=1或2的时候有效public String getRecordBackground()
public void setRecordBackground(String RecordBackground)
RecordBackground - 录制文件背景图片,支持png、jpg、jpeg、bmp格式,暂不支持透明通道public String getRecordScene()
public void setRecordScene(String RecordScene)
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:录制页面中涉及客户自己的服务需要鉴权时进行配置。一般情况下,无需配置。@Deprecated public String getRecordLang()
@Deprecated public void setRecordLang(String RecordLang)
RecordLang - 录制自定义语言,仅recordlayout=9的时候此参数有效public Long getRecordStream()
public void setRecordStream(Long RecordStream)
RecordStream - 录制类型 0 仅录制混流(默认) ;1 录制混流+单流,该模式下除混流录制基础上,分别录制老师、台上学生的音视频流,每路录制都会产生相应的录制费用 。示例:0public Long getWhiteBoardSnapshotMode()
public void setWhiteBoardSnapshotMode(Long WhiteBoardSnapshotMode)
WhiteBoardSnapshotMode - 板书截图生成类型。0 不生成板书(默认);1 全量模式;2 单页去重模式public Long getSubtitlesTranscription()
public void setSubtitlesTranscription(Long SubtitlesTranscription)
SubtitlesTranscription - 字幕转写功能开关。可以有以下取值:
0 不开启字幕转写功能(默认值)
1 自动转写模式:上课自动开启,下课自动停止public Long getRecordMerge()
public void setRecordMerge(Long RecordMerge)
RecordMerge - 录制文件合并开关。0 关闭 1 开启 注:只有在一节课多次启用手动录制时,此功能才有效Copyright © 2025. All rights reserved.