Class CreateRoomRequest

    • Constructor Summary

      Constructors 
      Constructor 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.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method 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 禁止录制 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
      Long getEnableDirectControl()
      Get 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值: 0 不允许直接控制(需同意,默认值) 1 允许直接控制(无需同意)
      Long getEndDelayTime()
      Get 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
      Long getEndTime()
      Get 预定的房间结束时间,unix时间戳(秒)。
      String getGroupId()
      Get 房间绑定的群组ID,非空时限制组成员进入
      Long getInteractionMode()
      Get 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
      Long getIsGradingRequiredPostClass()
      Get 开启课后评分。 0:不开启(默认) 1:开启
      Long getMaxMicNumber()
      Get 最大连麦人数(不包括老师)。取值范围[0, 16]
      String getName()
      Get 房间名称。
      Long getRecordLayout()
      Get 录制模板。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
      Long getResolution()
      Get 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
      Long getRoomType()
      Get 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
      Long getRTCAudienceNumber()
      Get rtc人数。
      Long getSdkAppId()
      Get 低代码互动课堂的SdkAppId。
      Long getStartTime()
      Get 预定的房间开始时间,unix时间戳(秒)。
      String getSubType()
      Get 房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频
      String getTeacherId()
      Get 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
      Long getTurnOffMic()
      Get 释放音视频权限后是否自动取消连麦。可以有以下取值: 0 自动取消连麦(默认值) 1 保持连麦状态
      Long getVideoOrientation()
      Get 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
      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 禁止录制 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
      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 setInteractionMode​(Long InteractionMode)
      Set 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
      void setIsGradingRequiredPostClass​(Long IsGradingRequiredPostClass)
      Set 开启课后评分。 0:不开启(默认) 1:开启
      void setMaxMicNumber​(Long MaxMicNumber)
      Set 最大连麦人数(不包括老师)。取值范围[0, 16]
      void setName​(String Name)
      Set 房间名称。
      void setRecordLayout​(Long RecordLayout)
      Set 录制模板。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
      void setResolution​(Long Resolution)
      Set 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
      void setRoomType​(Long RoomType)
      Set 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
      void setRTCAudienceNumber​(Long RTCAudienceNumber)
      Set rtc人数。
      void setSdkAppId​(Long SdkAppId)
      Set 低代码互动课堂的SdkAppId。
      void setStartTime​(Long StartTime)
      Set 预定的房间开始时间,unix时间戳(秒)。
      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 toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • CreateRoomRequest

        public CreateRoomRequest()
      • CreateRoomRequest

        public 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.
    • Method Detail

      • getName

        public String getName()
        Get 房间名称。
        Returns:
        Name 房间名称。
      • setName

        public void setName​(String Name)
        Set 房间名称。
        Parameters:
        Name - 房间名称。
      • getStartTime

        public Long getStartTime()
        Get 预定的房间开始时间,unix时间戳(秒)。
        Returns:
        StartTime 预定的房间开始时间,unix时间戳(秒)。
      • setStartTime

        public void setStartTime​(Long StartTime)
        Set 预定的房间开始时间,unix时间戳(秒)。
        Parameters:
        StartTime - 预定的房间开始时间,unix时间戳(秒)。
      • getEndTime

        public Long getEndTime()
        Get 预定的房间结束时间,unix时间戳(秒)。
        Returns:
        EndTime 预定的房间结束时间,unix时间戳(秒)。
      • setEndTime

        public void setEndTime​(Long EndTime)
        Set 预定的房间结束时间,unix时间戳(秒)。
        Parameters:
        EndTime - 预定的房间结束时间,unix时间戳(秒)。
      • getSdkAppId

        public Long getSdkAppId()
        Get 低代码互动课堂的SdkAppId。
        Returns:
        SdkAppId 低代码互动课堂的SdkAppId。
      • setSdkAppId

        public void setSdkAppId​(Long SdkAppId)
        Set 低代码互动课堂的SdkAppId。
        Parameters:
        SdkAppId - 低代码互动课堂的SdkAppId。
      • getResolution

        public Long getResolution()
        Get 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
        Returns:
        Resolution 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
      • setResolution

        public void setResolution​(Long Resolution)
        Set 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
        Parameters:
        Resolution - 分辨率。可以有如下取值: 1 标清 2 高清 3 全高清
      • getMaxMicNumber

        public Long getMaxMicNumber()
        Get 最大连麦人数(不包括老师)。取值范围[0, 16]
        Returns:
        MaxMicNumber 最大连麦人数(不包括老师)。取值范围[0, 16]
      • setMaxMicNumber

        public void setMaxMicNumber​(Long MaxMicNumber)
        Set 最大连麦人数(不包括老师)。取值范围[0, 16]
        Parameters:
        MaxMicNumber - 最大连麦人数(不包括老师)。取值范围[0, 16]
      • getSubType

        public String getSubType()
        Get 房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频
        Returns:
        SubType 房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频
      • setSubType

        public void setSubType​(String SubType)
        Set 房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频
        Parameters:
        SubType - 房间子类型,可以有以下取值: videodoc 文档+视频 video 纯视频
      • getTeacherId

        public String getTeacherId()
        Get 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
        Returns:
        TeacherId 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
      • setTeacherId

        public void setTeacherId​(String TeacherId)
        Set 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
        Parameters:
        TeacherId - 老师ID。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有老师权限。
      • getAutoMic

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

        public void setAutoMic​(Long AutoMic)
        Set 进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦
        Parameters:
        AutoMic - 进入课堂时是否自动连麦。可以有以下取值: 0 不自动连麦(需要手动申请上麦,默认值) 1 自动连麦
      • getTurnOffMic

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

        public void setTurnOffMic​(Long TurnOffMic)
        Set 释放音视频权限后是否自动取消连麦。可以有以下取值: 0 自动取消连麦(默认值) 1 保持连麦状态
        Parameters:
        TurnOffMic - 释放音视频权限后是否自动取消连麦。可以有以下取值: 0 自动取消连麦(默认值) 1 保持连麦状态
      • getAudioQuality

        public Long getAudioQuality()
        Get 声音音质。可以有以下取值: 0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。 1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。
        Returns:
        AudioQuality 声音音质。可以有以下取值: 0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。 1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。
      • setAudioQuality

        public void setAudioQuality​(Long AudioQuality)
        Set 声音音质。可以有以下取值: 0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。 1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。
        Parameters:
        AudioQuality - 声音音质。可以有以下取值: 0:流畅模式(默认值),占用更小的带宽、拥有更好的降噪效果,适用于1对1、小班教学、多人音视频会议等场景。 1:高音质模式,适合需要高保真传输音乐的场景,但降噪效果会被削弱,适用于音乐教学场景。
      • getDisableRecord

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

        public void setDisableRecord​(Long DisableRecord)
        Set 上课后是否禁止自动录制。可以有以下取值: 0 不禁止录制(自动开启录制,默认值) 1 禁止录制 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
        Parameters:
        DisableRecord - 上课后是否禁止自动录制。可以有以下取值: 0 不禁止录制(自动开启录制,默认值) 1 禁止录制 注:如果该配置取值为0,录制将从上课后开始,课堂结束后停止。
      • getAssistants

        public String[] getAssistants()
        Get 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。
        Returns:
        Assistants 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。
      • setAssistants

        public void setAssistants​(String[] Assistants)
        Set 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。
        Parameters:
        Assistants - 助教Id列表。通过[注册用户]接口获取的UserId。指定后该用户在房间内拥有助教权限。
      • getRTCAudienceNumber

        public Long getRTCAudienceNumber()
        Get rtc人数。
        Returns:
        RTCAudienceNumber rtc人数。
      • setRTCAudienceNumber

        public void setRTCAudienceNumber​(Long RTCAudienceNumber)
        Set rtc人数。
        Parameters:
        RTCAudienceNumber - rtc人数。
      • getAudienceType

        public Long getAudienceType()
        Get 观看类型。互动观看 (默认)
        Returns:
        AudienceType 观看类型。互动观看 (默认)
      • setAudienceType

        public void setAudienceType​(Long AudienceType)
        Set 观看类型。互动观看 (默认)
        Parameters:
        AudienceType - 观看类型。互动观看 (默认)
      • getRecordLayout

        public Long getRecordLayout()
        Get 录制模板。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
        Returns:
        RecordLayout 录制模板。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
      • setRecordLayout

        public void setRecordLayout​(Long RecordLayout)
        Set 录制模板。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
        Parameters:
        RecordLayout - 录制模板。录制模板枚举值参考:https://cloud.tencent.com/document/product/1639/89744
      • getGroupId

        public String getGroupId()
        Get 房间绑定的群组ID,非空时限制组成员进入
        Returns:
        GroupId 房间绑定的群组ID,非空时限制组成员进入
      • setGroupId

        public void setGroupId​(String GroupId)
        Set 房间绑定的群组ID,非空时限制组成员进入
        Parameters:
        GroupId - 房间绑定的群组ID,非空时限制组成员进入
      • getEnableDirectControl

        public Long getEnableDirectControl()
        Get 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值: 0 不允许直接控制(需同意,默认值) 1 允许直接控制(无需同意)
        Returns:
        EnableDirectControl 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值: 0 不允许直接控制(需同意,默认值) 1 允许直接控制(无需同意)
      • setEnableDirectControl

        public void setEnableDirectControl​(Long EnableDirectControl)
        Set 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值: 0 不允许直接控制(需同意,默认值) 1 允许直接控制(无需同意)
        Parameters:
        EnableDirectControl - 是否允许老师/助教直接控制学生的摄像头/麦克风。可以有以下取值: 0 不允许直接控制(需同意,默认值) 1 允许直接控制(无需同意)
      • getInteractionMode

        public Long getInteractionMode()
        Get 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
        Returns:
        InteractionMode 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
      • setInteractionMode

        public void setInteractionMode​(Long InteractionMode)
        Set 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
        Parameters:
        InteractionMode - 开启专注模式。 0 收看全部角色音视频(默认) 1 只看老师和助教
      • getVideoOrientation

        public Long getVideoOrientation()
        Get 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
        Returns:
        VideoOrientation 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
      • setVideoOrientation

        public void setVideoOrientation​(Long VideoOrientation)
        Set 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
        Parameters:
        VideoOrientation - 横竖屏。0:横屏开播(默认值); 1:竖屏开播,当前仅支持移动端的纯视频类型
      • getIsGradingRequiredPostClass

        public Long getIsGradingRequiredPostClass()
        Get 开启课后评分。 0:不开启(默认) 1:开启
        Returns:
        IsGradingRequiredPostClass 开启课后评分。 0:不开启(默认) 1:开启
      • setIsGradingRequiredPostClass

        public void setIsGradingRequiredPostClass​(Long IsGradingRequiredPostClass)
        Set 开启课后评分。 0:不开启(默认) 1:开启
        Parameters:
        IsGradingRequiredPostClass - 开启课后评分。 0:不开启(默认) 1:开启
      • getRoomType

        public Long getRoomType()
        Get 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
        Returns:
        RoomType 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
      • setRoomType

        public void setRoomType​(Long RoomType)
        Set 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
        Parameters:
        RoomType - 房间类型: 0 小班课(默认值); 1 大班课; 2 1V1 (后续扩展)
      • getEndDelayTime

        public Long getEndDelayTime()
        Get 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
        Returns:
        EndDelayTime 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
      • setEndDelayTime

        public void setEndDelayTime​(Long EndDelayTime)
        Set 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟
        Parameters:
        EndDelayTime - 拖堂时间:单位分钟,0为不限制(默认值), -1为不能拖堂,大于0为拖堂的时间,最大值120分钟