com.tencentcloudapi.lcic.v20220817.models

Class RoomInfo

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lcic.v20220817.models.RoomInfo

public class RoomInfo
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
RoomInfo()
RoomInfo(RoomInfo 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

Modifier and Type	Method and Description
String[]	getAssistants() Get The user IDs of the teacher assistants.
Long	getAudienceType() Get The audience type.
Long	getAudioQuality() Get Whether to enable the high audio quality mode.
Long	getAutoMic() Get Whether to automatically turn the mic on when a user enters the room.
Long	getDisableRecord() Get Whether to disable auto recording.
Long	getEnableAutoStart() Get Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid
Long	getEnableDirectControl() Get Whether the students' consent is required to control their cameras/microphones.
Long	getEndDelayTime() Get Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes
Long	getEndTime() Get The room end time (Unix timestamp).
String	getGroupId() Get The ID of the group to bind.
Long	getInteractionMode() Get Turn on focus mode.
Long	getIsGradingRequiredPostClass() Get Whether the room is enabled for grading after the lesson.
Long	getLiveType() Get Live type: 0 regular (default) 1 Simulated Live
Long	getMaxMicNumber() Get The maximum number of mic-on users (excluding the teacher).
String	getName() Get The room name.
String	getRecordBackground() Get Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being
String	getRecordLang() Deprecated.
Long	getRecordLayout() Get The recording layout.
String	getRecordLiveUrl() Get Simulated Live link
String	getRecordScene() Get Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.
Long	getResolution() Get The resolution.
Long	getRoomType() Get Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
Long	getRTCAudienceNumber() Get The number of RTC users.
Long	getStartTime() Get The room start time (Unix timestamp).
String	getSubType() Get The room subtype.
String	getTeacherId() Get The user ID of the teacher.
Long	getTurnOffMic() Get Whether to disconnect communication after audio/video permissions are revoked.
Long	getVideoOrientation() Get Horizontal and vertical screen.
void	setAssistants(String[] Assistants) Set The user IDs of the teacher assistants.
void	setAudienceType(Long AudienceType) Set The audience type.
void	setAudioQuality(Long AudioQuality) Set Whether to enable the high audio quality mode.
void	setAutoMic(Long AutoMic) Set Whether to automatically turn the mic on when a user enters the room.
void	setDisableRecord(Long DisableRecord) Set Whether to disable auto recording.
void	setEnableAutoStart(Long EnableAutoStart) Set Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid
void	setEnableDirectControl(Long EnableDirectControl) Set Whether the students' consent is required to control their cameras/microphones.
void	setEndDelayTime(Long EndDelayTime) Set Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes
void	setEndTime(Long EndTime) Set The room end time (Unix timestamp).
void	setGroupId(String GroupId) Set The ID of the group to bind.
void	setInteractionMode(Long InteractionMode) Set Turn on focus mode.
void	setIsGradingRequiredPostClass(Long IsGradingRequiredPostClass) Set Whether the room is enabled for grading after the lesson.
void	setLiveType(Long LiveType) Set Live type: 0 regular (default) 1 Simulated Live
void	setMaxMicNumber(Long MaxMicNumber) Set The maximum number of mic-on users (excluding the teacher).
void	setName(String Name) Set The room name.
void	setRecordBackground(String RecordBackground) Set Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being
void	setRecordLang(String RecordLang) Deprecated.
void	setRecordLayout(Long RecordLayout) Set The recording layout.
void	setRecordLiveUrl(String RecordLiveUrl) Set Simulated Live link
void	setRecordScene(String RecordScene) Set Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.
void	setResolution(Long Resolution) Set The resolution.
void	setRoomType(Long RoomType) Set Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
void	setRTCAudienceNumber(Long RTCAudienceNumber) Set The number of RTC users.
void	setStartTime(Long StartTime) Set The room start time (Unix timestamp).
void	setSubType(String SubType) Set The room subtype.
void	setTeacherId(String TeacherId) Set The user ID of the teacher.
void	setTurnOffMic(Long TurnOffMic) Set Whether to disconnect communication after audio/video permissions are revoked.
void	setVideoOrientation(Long VideoOrientation) Set Horizontal and vertical screen.
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RoomInfo

public RoomInfo()

RoomInfo

public RoomInfo(RoomInfo 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 The room name.

Returns:

Name The room name.

setName

public void setName(String Name)

Set The room name.

Parameters:

Name - The room name.

getStartTime

public Long getStartTime()

Get The room start time (Unix timestamp).

Returns:

StartTime The room start time (Unix timestamp).

setStartTime

public void setStartTime(Long StartTime)

Set The room start time (Unix timestamp).

Parameters:

StartTime - The room start time (Unix timestamp).

getEndTime

public Long getEndTime()

Get The room end time (Unix timestamp).

Returns:

EndTime The room end time (Unix timestamp).

setEndTime

public void setEndTime(Long EndTime)

Set The room end time (Unix timestamp).

Parameters:

EndTime - The room end time (Unix timestamp).

getResolution

public Long getResolution()

Get The resolution. Valid values: `1`: SD; `2`: HD; `3`: FHD.

Returns:

Resolution The resolution. Valid values: `1`: SD; `2`: HD; `3`: FHD.

setResolution

public void setResolution(Long Resolution)

Set The resolution. Valid values: `1`: SD; `2`: HD; `3`: FHD.

Parameters:

Resolution - The resolution. Valid values: `1`: SD; `2`: HD; `3`: FHD.

getMaxMicNumber

public Long getMaxMicNumber()

Get The maximum number of mic-on users (excluding the teacher). Value range: 0-16.

Returns:

MaxMicNumber The maximum number of mic-on users (excluding the teacher). Value range: 0-16.

setMaxMicNumber

public void setMaxMicNumber(Long MaxMicNumber)

Set The maximum number of mic-on users (excluding the teacher). Value range: 0-16.

Parameters:

MaxMicNumber - The maximum number of mic-on users (excluding the teacher). Value range: 0-16.

getSubType

public String getSubType()

Get The room subtype. Valid values: `videodoc`: Document + Video; `video`: Video only; `coteaching`: Dual-teacher.

Returns:

SubType The room subtype. Valid values: `videodoc`: Document + Video; `video`: Video only; `coteaching`: Dual-teacher.

setSubType

public void setSubType(String SubType)

Set The room subtype. Valid values: `videodoc`: Document + Video; `video`: Video only; `coteaching`: Dual-teacher.

Parameters:

SubType - The room subtype. Valid values: `videodoc`: Document + Video; `video`: Video only; `coteaching`: Dual-teacher.

getTeacherId

public String getTeacherId()

Get The user ID of the teacher. User IDs are returned by the user registration APIs.

Returns:

TeacherId The user ID of the teacher. User IDs are returned by the user registration APIs.

setTeacherId

public void setTeacherId(String TeacherId)

Set The user ID of the teacher. User IDs are returned by the user registration APIs.

Parameters:

TeacherId - The user ID of the teacher. User IDs are returned by the user registration APIs.

getAutoMic

public Long getAutoMic()

Get Whether to automatically turn the mic on when a user enters the room. Valid values: `0` (default): No; `1`: Yes.

Returns:

AutoMic Whether to automatically turn the mic on when a user enters the room. Valid values: `0` (default): No; `1`: Yes.

setAutoMic

public void setAutoMic(Long AutoMic)

Set Whether to automatically turn the mic on when a user enters the room. Valid values: `0` (default): No; `1`: Yes.

Parameters:

AutoMic - Whether to automatically turn the mic on when a user enters the room. Valid values: `0` (default): No; `1`: Yes.

getTurnOffMic

public Long getTurnOffMic()

Get Whether to disconnect communication after audio/video permissions are revoked. Valid values: `0` (default): Yes; `1`: No.

Returns:

TurnOffMic Whether to disconnect communication after audio/video permissions are revoked. Valid values: `0` (default): Yes; `1`: No.

setTurnOffMic

public void setTurnOffMic(Long TurnOffMic)

Set Whether to disconnect communication after audio/video permissions are revoked. Valid values: `0` (default): Yes; `1`: No.

Parameters:

TurnOffMic - Whether to disconnect communication after audio/video permissions are revoked. Valid values: `0` (default): Yes; `1`: No.

getAudioQuality

public Long getAudioQuality()

Get Whether to enable the high audio quality mode. Valid values: `0` (default): No; `1`: Yes.

Returns:

AudioQuality Whether to enable the high audio quality mode. Valid values: `0` (default): No; `1`: Yes.

setAudioQuality

public void setAudioQuality(Long AudioQuality)

Set Whether to enable the high audio quality mode. Valid values: `0` (default): No; `1`: Yes.

Parameters:

AudioQuality - Whether to enable the high audio quality mode. Valid values: `0` (default): No; `1`: Yes.

getDisableRecord

public Long getDisableRecord()

Get Whether to disable auto recording. Valid values: `0` (default): No; `1`: Yes. If this parameter is `0`, recording will start when the class starts and stops when the class ends.

Returns:

DisableRecord Whether to disable auto recording. Valid values: `0` (default): No; `1`: Yes. If this parameter is `0`, recording will start when the class starts and stops when the class ends.

setDisableRecord

public void setDisableRecord(Long DisableRecord)

Set Whether to disable auto recording. Valid values: `0` (default): No; `1`: Yes. If this parameter is `0`, recording will start when the class starts and stops when the class ends.

Parameters:

DisableRecord - Whether to disable auto recording. Valid values: `0` (default): No; `1`: Yes. If this parameter is `0`, recording will start when the class starts and stops when the class ends.

getAssistants

public String[] getAssistants()

Get The user IDs of the teacher assistants. User IDs are returned by the user registration APIs.

Returns:

Assistants The user IDs of the teacher assistants. User IDs are returned by the user registration APIs.

setAssistants

public void setAssistants(String[] Assistants)

Set The user IDs of the teacher assistants. User IDs are returned by the user registration APIs.

Parameters:

Assistants - The user IDs of the teacher assistants. User IDs are returned by the user registration APIs.

getRTCAudienceNumber

public Long getRTCAudienceNumber()

Get The number of RTC users.

Returns:

RTCAudienceNumber The number of RTC users.

setRTCAudienceNumber

public void setRTCAudienceNumber(Long RTCAudienceNumber)

Set The number of RTC users.

Parameters:

RTCAudienceNumber - The number of RTC users.

getAudienceType

public Long getAudienceType()

Get The audience type.

Returns:

AudienceType The audience type.

setAudienceType

public void setAudienceType(Long AudienceType)

Set The audience type.

Parameters:

AudienceType - The audience type.

getRecordLayout

public Long getRecordLayout()

Get The recording layout.

Returns:

RecordLayout The recording layout.

setRecordLayout

public void setRecordLayout(Long RecordLayout)

Set The recording layout.

Parameters:

RecordLayout - The recording layout.

getGroupId

public String getGroupId()

Get The ID of the group to bind. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

GroupId The ID of the group to bind. Note: This field may return null, indicating that no valid values can be obtained.

setGroupId

public void setGroupId(String GroupId)

Set The ID of the group to bind. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

GroupId - The ID of the group to bind. Note: This field may return null, indicating that no valid values can be obtained.

getEnableDirectControl

public Long getEnableDirectControl()

Get Whether the students' consent is required to control their cameras/microphones.

Returns:

EnableDirectControl Whether the students' consent is required to control their cameras/microphones.

setEnableDirectControl

public void setEnableDirectControl(Long EnableDirectControl)

Set Whether the students' consent is required to control their cameras/microphones.

Parameters:

EnableDirectControl - Whether the students' consent is required to control their cameras/microphones.

getInteractionMode

public Long getInteractionMode()

Get Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and teaching assistants

Returns:

InteractionMode Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and teaching assistants

setInteractionMode

public void setInteractionMode(Long InteractionMode)

Set Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and teaching assistants

Parameters:

InteractionMode - Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and teaching assistants

getVideoOrientation

public Long getVideoOrientation()

Get Horizontal and vertical screen. 0: Horizontal screen to open broadcast (default); 1: Vertical screen to open broadcast, currently only support mobile pure video type

Returns:

VideoOrientation Horizontal and vertical screen. 0: Horizontal screen to open broadcast (default); 1: Vertical screen to open broadcast, currently only support mobile pure video type

setVideoOrientation

public void setVideoOrientation(Long VideoOrientation)

Set Horizontal and vertical screen. 0: Horizontal screen to open broadcast (default); 1: Vertical screen to open broadcast, currently only support mobile pure video type

Parameters:

VideoOrientation - Horizontal and vertical screen. 0: Horizontal screen to open broadcast (default); 1: Vertical screen to open broadcast, currently only support mobile pure video type

getIsGradingRequiredPostClass

public Long getIsGradingRequiredPostClass()

Get Whether the room is enabled for grading after the lesson. 0: not enabled 1: enabled

Returns:

IsGradingRequiredPostClass Whether the room is enabled for grading after the lesson. 0: not enabled 1: enabled

setIsGradingRequiredPostClass

public void setIsGradingRequiredPostClass(Long IsGradingRequiredPostClass)

Set Whether the room is enabled for grading after the lesson. 0: not enabled 1: enabled

Parameters:

IsGradingRequiredPostClass - Whether the room is enabled for grading after the lesson. 0: not enabled 1: enabled

getRoomType

public Long getRoomType()

Get Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)

Returns:

RoomType Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)

setRoomType

public void setRoomType(Long RoomType)

Set Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)

Parameters:

RoomType - Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)

getEndDelayTime

public Long getEndDelayTime()

Get Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes

Returns:

EndDelayTime Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes

setEndDelayTime

public void setEndDelayTime(Long EndDelayTime)

Set Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes

Parameters:

EndDelayTime - Drag class time: unit minutes, 0 is unlimited (default), -1 is can't drag the class, greater than 0 is the time of dragging the class, the maximum value of 120 minutes

getLiveType

public Long getLiveType()

Get Live type: 0 regular (default) 1 Simulated Live

Returns:

LiveType Live type: 0 regular (default) 1 Simulated Live

setLiveType

public void setLiveType(Long LiveType)

Set Live type: 0 regular (default) 1 Simulated Live

Parameters:

LiveType - Live type: 0 regular (default) 1 Simulated Live

getRecordLiveUrl

public String getRecordLiveUrl()

Get Simulated Live link

Returns:

RecordLiveUrl Simulated Live link

setRecordLiveUrl

public void setRecordLiveUrl(String RecordLiveUrl)

Set Simulated Live link

Parameters:

RecordLiveUrl - Simulated Live link

getEnableAutoStart

public Long getEnableAutoStart()

Get Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid

Returns:

EnableAutoStart Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid

setEnableAutoStart

public void setEnableAutoStart(Long EnableAutoStart)

Set Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid

Parameters:

EnableAutoStart - Whether to start the lesson automatically: 0 not automatic lesson (default) 1 automatic lesson live_type=1 is valid

getRecordBackground

public String getRecordBackground()

Get Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being

Returns:

RecordBackground Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being

setRecordBackground

public void setRecordBackground(String RecordBackground)

Set Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being

Parameters:

RecordBackground - Recorded file background image, support png, jpg, jpeg, bmp format, does not support transparent channel for the time being

getRecordScene

public String getRecordScene()

Get Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.

Returns:

RecordScene Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.

setRecordScene

public void setRecordScene(String RecordScene)

Set Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.

Parameters:

RecordScene - Record customized scene, only recordlayout=9 this parameter is valid, the data content for the user-defined scene parameters, data format for the json key-value pairs, where the key-value pairs of the value for the string type.

getRecordLang

@Deprecated
public String getRecordLang()

Deprecated.

Get Record customized language, only when recordlayout=9, this parameter is valid.

Returns:

RecordLang Record customized language, only when recordlayout=9, this parameter is valid.

setRecordLang

@Deprecated
public void setRecordLang(String RecordLang)

Deprecated.

Set Record customized language, only when recordlayout=9, this parameter is valid.

Parameters:

RecordLang - Record customized language, only when recordlayout=9, this parameter is valid.

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel