400-881-9892

文档中心

官方文档,可查阅产品介绍、快速入门、用户指南、开发指南、API参考、SDK参考、帮助等信息。

文档中心 互动课堂

修改教室模板

Example

请求方式 POST

https://global.talk-cloud.net/api/room/v1/modifyRoomTemplate

参数名 必选 类型 说明
Content-Type 是 string application/json;
Tk-authkey 是 string 企业Key

公共参数:

参数 必填 类型 说明
templateId 是 int 模版id
templateName 否 string 模版名称名称 (字符不能超过30)
videoType 否 int 视频分辨率:0:240x180;1:320x240;2:640x480;3:1280x720 ;4:1920x1080;6: 960x540;7: 640x360;8: 320x180;9:160x120;11:960x720
videoFramerate 否 int 视频帧率:10,15,20,25,30
roomLayoutId 否 int 教室布局ID。一对一教室布局:51视频居右/52双师布局/53视频布局/54视频居左/1视频置顶/2视频置底/55视频居左带聊天/56视频居右带聊天; 一对多教室布局:1视频置顶/2视频置底/3视频围绕/4主讲居右/6主讲视频/7自由视频/10视频居左/11主讲居左; 大班课教室布局:3视频居右/8课件全屏布局/9纯视频(横)/12视频居左/13(1v1)伪上台布局;云直播布局:3:视频居右(默认)/ 9:纯视频(横)/ 15:纯视频(竖)/ 12:视频居左/ 14:画中画
teaDualCameras 否 int 0:不使用,1:使用。支持布局:一对一:1视频置顶、2视频置底。一对多:1视频置顶、2视频置底。大班课:3视频居右、12视频居左
stuDualCameras 否 int 0:不使用,1:使用。支持布局:一对一:1视频置顶、2视频置底。一对多:1视频置顶、2视频置底。大班课:3视频居右、12视频居左
roomThemeId 否 int 教室主题id 可通过接口api/company/v1/getThemeList获取
logoId 否 int 教室logoid,可通过接口api/company/v1/logoList获取
watermarkId 否 int 水印id 可通过接口api/company/v1/watermarkList获取
rewardTitleGroupId 否 int 称号组ID(通过接口api/company/v1/getRewardTitleGroup获取)
classOverUrl 否 string 教室结束后跳转链接地址(字符不能超过128)
livePullType 否 int (roomType=7时支持此参数)直播延迟类型,默认0普通直播≈3秒,1快直播≈1秒(收费与普通直播不同)
liveCoverId 否 int (roomType=7或8时支持此参数)直播pc封面素材id 可通过接口api/company/v1/coverList获取
mobileLiveCoverId 否 int (roomType=7或8时支持此参数)直播mobile封面素材id 可通过接口api/company/v1/coverList获取
fileDisplay 否 int (roomType=8时支持此参数)课件展示 0:适应全部,1:适应宽度
numDisplay 否 int (roomType=8时支持此参数)数据展示 0:不显示 1:显示人数 2:显示访问次数

功能参数(教室工具):

参数 必填 类型 说明
useSignin 否 int 签到(roomType=7或8时生效) 0:否 1:是
useAnnouncement 否 int 公告(roomType=7或8时生效) 0:否 1:是
useGroupPhoto 否 int 合影(roomType=3时生效) 0:否 1:是
useRedPacket 否 int 红包(roomType=3或7或8时生效) 0:否 1:是
useVoiceEvaluation 否 int 语音测评(roomType=0或3时生效) (收费项) 0:否 1:是
useResponder 否 int 抢答器(roomType=3时生效) 0:否 1:是
timerMachine 否 int 计时器 0:否 1:是
answerMachine 否 int 答题器 0:否 1:是
useQuestionnaire 否 int 问卷(roomType=7或8时生效) 0:否 1:是
automaticallySendTrophy 否 int 自动发送奖杯 0:否 1:是
screenSharing 否 int 屏幕共享 0:否 1:是 (联系商务开通)
stuShowScreenSharing 否 int 学生工具箱显示共享桌面 (roomType=0或3时生效)0:否 1:是 (联系商务开通)
useTurntable 否 int 转盘(roomType=0或3时生效) 0:否 1:是
allowStudentsUseTurntable 否 int 允许学生使用转盘(roomType=0或3时生效) 0:否 1:是
chineseGo 否 int 围棋 0:否 1:是
smallWhiteboard 否 int 小白板(roomType=0或3时生效) 0:否 1:是
synchronousCoEditing 否 int 同步协作编辑(roomType=0或3时生效) 0:否 1:是
readingIndicator 否 int 朗读指示器(roomType=0或3时生效) 0:否 1:是
showLocalMediaFiles 否 int 共享本地媒体文件(仅PC客户端生效)(roomType=0或3时生效) 0:否 1:是 (联系商务开通)
openUploadfile 否 int 是否开启教室内上传课件功能 0:否 1:是 默认:1
aIScenarioDialogue 否 int AI情景对话(roomType=0或3时生效) 0:否 1:是

功能参数(聊天区):

参数 必填 类型 说明
showChatRegion 否 int 显示文本聊天区 0:否 1:是
showIntroduceTab 否 int 显示介绍tab(roomType=7或8时生效) 0:否 1:是
showChatTab 否 int 显示聊天tab(roomType=7或8时生效) 0:否 1:是
showQuestionTab 否 int 显示问答tab(roomType=7或8时生效) 0:否 1:是
chatUploadPic 否 int 允许聊天区(含问答)上传图片 0:否 1:是
allowChatAreaToPostLinks 否 int 允许聊天区(含问答)发布链接 0:否 1:是
hideTranslationBtn 否 int 隐藏聊天区翻译按钮 0:否 1:是
chatDisplaySupportsFiltering 否 int 聊天内容展示支持过滤(roomType=8时生效) 0:否 1:是

功能参数(上台连麦):

参数 必填 类型 说明
allowAssistantOpenAV 否 int 助教上台 0:否 1:是
hideTrophy 否 int 隐藏奖杯 0:否 1:是
useTeacherPointer 否 int 教鞭(roomType=3或7时生效) 0:否 1:是
studentCloseCameraDefault 否 int 学生上台默认关闭摄像头 0:否 1:是
stuDefaultCloseMicrophone 否 int 学生上台默认关闭麦克风(roomType=7或8时生效) 0:否 1:是
autoOpenAudio 否 int 上课后自动开启音频(roomType=0或3时生效) 0:否 1:是
autoOpenVideo 否 int 上课后自动开启视频(roomType=0或3时生效) 0:否 1:是
allowStudentCloseAudio 否 int 允许学生关闭自己的音频 0:否 1:是
allowStudentCloseVideo 否 int 允许学生关闭自己的视频 0:否 1:是
showYourself 否 int 只显示老师和自己的音视频(roomType=3时生效) 0:否 1:是
studentAudioIsolation 否 int 音频隔离(学生音频隔离)(roomType=3时生效) 0:否 1:是
studentVideoIsolation 否 int 视频隔离(学生视频隔离)(roomType=3时生效) 0:否 1:是
studentAlwaysOnStage 否 int 学生始终在台上(roomType=3时生效) 0:否 1:是 默认:企业配置项
supportConnection 否 int 是否支持连麦(roomType=7或8时生效) 0:否 1:是 默认:0

功能参数(白板区域):

参数 必填 类型 说明
enableBoardWriting 否 int 启用板书 0:否 1:是
hideTurnPageBtn 否 int 隐藏翻页按钮 0:否 1:是
allowTurnPages 否 int 允许学生本地翻页 0:否 1:是
screenShotLocal 否 int 翻页工具条显示截图功能 0:否 1:是

功能参数(画笔涂鸦):

参数 必填 类型 说明
isBrushAndOnStageSplit 否 int 将画笔和上台拆分(roomType=3时生效) 0:否 1:是
enableBrushTip 否 int 启用画笔笔锋 0:否 1:是
studentGraffitiToolNoShape 否 int 学生涂鸦工具无形状 0:否 1:是
studentGraffitiToolNoFont 否 int 学生涂鸦工具无字体 0:否 1:是
studentGraffitiToolNoIndicators 否 int 学生涂鸦工具无指示器 0:否 1
allowAuthorizeAllDoodle 否 int 允许授权全体涂鸦(roomType=3时生效) 0:否 1:是
stuAutoDisplayBrushTool 否 int 学生上台自动显示画笔工具(roomType=0或3时生效) 0:否 1:是

功能参数(房间设置):

参数 必填 类型 说明
largeClassSupportTimeShift 否 int 支持时移(roomType=7时生效) 0:否 1:是
roomUsearquee 否 int 房间使用跑马灯 0:否 1:是
showRoomPopulation 否 int 显示房间人数(roomType=7时生效) 0:否 1:是
oneVsMoreShowShare 否 int 显示分享功能(roomType=3时生效) 0:否 1:是
largeClassHideTheShare 否 int 隐藏分享(roomType=7时生效) 0:否 1:是
largeClassHideThePlayBack 否 int 隐藏回放(roomType=7时生效) 0:否 1:是

功能参数(录制件):

参数 必填 类型 说明
notMakeRecord 否 int 不生成录制件 0:否 1:是
makeMp4Record 否 int 课后mp4(roomType=0或3时生效,notMakeRecord = 0是此参数设置有效) 0:否 1:是;
isRtmp4Record 否 int 实时录制 0:否 1:是;(此参数级别高与makeMp4Record参数)
mp4DisplayLogo 否 int Mp4录制件显示教室logo/教室名称 (roomType=0或3时生效,makeMp4Record = 1是此参数设置有效)1:显示 0:不显示;默认:1
isOpenRecordSegment 否 int 是否生成精彩片段(roomType=0或3时生效,makeMp4Record = 1是此参数设置有效) 0:否 1:是;
isOpenAnalyze 否 int 是否开启学情分析(roomType=0或3时生效,需要联系商务开通此功能才可使用,notMakeRecord = 0是此参数设置有效) 0:否 1:是;默认:0
analyzeType 否 int 分析类型,0所有、1只分析老师、2只分析学生(当isOpenAnalyze=1时生效)(roomType=0或3时生效,) 默认:0
faceRecognition 否 int 是否开启人脸查重(roomType=0或3时生效) (收费项,需联系商务开通,开通后需要配置通用回调地址接口查重数据) 0:否 1:是 默认:0
speechRecognition 否 int 课后语音识别(roomType=0或3时生效,notMakeRecord = 0是此参数设置有效) (收费项) 0:否 1:是
recordSubtitle 否 int 回放展示字幕(roomType=0或3时生效,notMakeRecord = 0并speechRecognition = 1时,此参数配置生效) 0:否 1:是

功能参数(音视频):

参数 必填 类型 说明
remoteVideoMirrorMode 否 int 远端视频镜像模式 0:否 1:是
allowTeachersViewStudentScreens 否 int 允许老师查看学生屏幕(roomType=0或3时生效) 0:否 1:是
useSubTitle 否 int 开启实时字幕(roomType=0或3时生效) (收费项) 0:否 1:是
teaSubtitleLanguage 否 string 老师讲课口语语种,zh/en/fr/ja/ko/es/id/vi。默认:zh(中文简体) 中、英、法、日、韩、西班牙、印尼、越南
stuSubtitle 否 int 学生字幕展示方式 1:仅语音翻译、2:语音翻译+识别、3:仅语音识别 默认:1
allowRemoteControl 否 int 允许老师远程控制学生屏幕(roomType=0或3时生效) 0:否 1:是 默认:企业配置项(收费,当allowTeachersViewStudentScreens为1时,此配置才会生效)
参数名称 类型 描述
result int 0成功,其他失败
data.templateId int 模版ID

返回示例

1
2
3
4
5
6
{
    "result":0,
    "data": {
        "templateId":2121
    }
}