com.tencentcloudapi.lcic.v20220817.models

Class CreateRoomRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lcic.v20220817.models.CreateRoomRequest

public class CreateRoomRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

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.

Method Summary

Modifier and Type	Method and Description
String[]	getAssistants() Get The user IDs of the teaching 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 the user enters a 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 when
Long	getEnableDirectControl() Get Whether the teacher/teaching assistant can control students' cameras/microphones without the students' consent.
Long	getEndDelayTime() Get Drag class time: unit: minutes.
Long	getEndTime() Get Reserved room end time, in UNIX timestamp format
String	getGroupId() Get The ID of the group to bind.
Long	getInteractionMode() Get Turn on focus mode.
Long	getIsGradingRequiredPostClass() Get Enable after-class grading.
Long	getLiveType() Get Live type: 0 regular (default) 1 Simulated Live
Long	getMaxMicNumber() Get Maximum number of mic-on users (excluding teachers).
String	getName() Get 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 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 Resolution.
Long	getRoomType() Get Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
Long	getRTCAudienceNumber() Get The number of RTC users.
Long	getSdkAppId() Get LCIC SdkAppId
Long	getStartTime() Get Reserved room start time, in UNIX timestamp format
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 teaching 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 the user enters a 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 when
void	setEnableDirectControl(Long EnableDirectControl) Set Whether the teacher/teaching assistant can control students' cameras/microphones without the students' consent.
void	setEndDelayTime(Long EndDelayTime) Set Drag class time: unit: minutes.
void	setEndTime(Long EndTime) Set Reserved room end time, in UNIX timestamp format
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 Enable after-class grading.
void	setLiveType(Long LiveType) Set Live type: 0 regular (default) 1 Simulated Live
void	setMaxMicNumber(Long MaxMicNumber) Set Maximum number of mic-on users (excluding teachers).
void	setName(String Name) Set 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 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 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	setSdkAppId(Long SdkAppId) Set LCIC SdkAppId
void	setStartTime(Long StartTime) Set Reserved room start time, in UNIX timestamp format
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

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 Room name

Returns:

Name Room name

setName

public void setName(String Name)

Set Room name

Parameters:

Name - Room name

getStartTime

public Long getStartTime()

Get Reserved room start time, in UNIX timestamp format

Returns:

StartTime Reserved room start time, in UNIX timestamp format

setStartTime

public void setStartTime(Long StartTime)

Set Reserved room start time, in UNIX timestamp format

Parameters:

StartTime - Reserved room start time, in UNIX timestamp format

getEndTime

public Long getEndTime()

Get Reserved room end time, in UNIX timestamp format

Returns:

EndTime Reserved room end time, in UNIX timestamp format

setEndTime

public void setEndTime(Long EndTime)

Set Reserved room end time, in UNIX timestamp format

Parameters:

EndTime - Reserved room end time, in UNIX timestamp format

getSdkAppId

public Long getSdkAppId()

Get LCIC SdkAppId

Returns:

SdkAppId LCIC SdkAppId

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set LCIC SdkAppId

Parameters:

SdkAppId - LCIC SdkAppId

getResolution

public Long getResolution()

Get Resolution. Valid values: 1: SD; 2: HD; 3: FHD

Returns:

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

setResolution

public void setResolution(Long Resolution)

Set Resolution. Valid values: 1: SD; 2: HD; 3: FHD

Parameters:

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

getMaxMicNumber

public Long getMaxMicNumber()

Get Maximum number of mic-on users (excluding teachers). Value range: [0, 16]

Returns:

MaxMicNumber Maximum number of mic-on users (excluding teachers). Value range: [0, 16]

setMaxMicNumber

public void setMaxMicNumber(Long MaxMicNumber)

Set Maximum number of mic-on users (excluding teachers). Value range: [0, 16]

Parameters:

MaxMicNumber - Maximum number of mic-on users (excluding teachers). Value range: [0, 16]

getSubType

public String getSubType()

Get The room subtype. Valid values: videodoc: Document + Video; video: Video only.

Returns:

SubType The room subtype. Valid values: videodoc: Document + Video; video: Video only.

setSubType

public void setSubType(String SubType)

Set The room subtype. Valid values: videodoc: Document + Video; video: Video only.

Parameters:

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

getTeacherId

public String getTeacherId()

Get The user ID of the teacher. User IDs are returned by the user registration APIs. The user specified will have teacher permissions in the room created.

Returns:

TeacherId The user ID of the teacher. User IDs are returned by the user registration APIs. The user specified will have teacher permissions in the room created.

setTeacherId

public void setTeacherId(String TeacherId)

Set The user ID of the teacher. User IDs are returned by the user registration APIs. The user specified will have teacher permissions in the room created.

Parameters:

TeacherId - The user ID of the teacher. User IDs are returned by the user registration APIs. The user specified will have teacher permissions in the room created.

getAutoMic

public Long getAutoMic()

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

Returns:

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

setAutoMic

public void setAutoMic(Long AutoMic)

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

Parameters:

AutoMic - Whether to automatically turn the mic on when the user enters a room. Valid values: 0: No (default value); 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: No (default value); 1: Yes.

Returns:

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

setAudioQuality

public void setAudioQuality(Long AudioQuality)

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

Parameters:

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

getDisableRecord

public Long getDisableRecord()

Get Whether to disable auto recording. Valid values: 0: No (default); 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: No (default); 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: No (default); 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: No (default); 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 teaching assistants. User IDs are returned by the user registration APIs. The users specified will have teaching assistant permissions in the room created.

Returns:

Assistants The user IDs of the teaching assistants. User IDs are returned by the user registration APIs. The users specified will have teaching assistant permissions in the room created.

setAssistants

public void setAssistants(String[] Assistants)

Set The user IDs of the teaching assistants. User IDs are returned by the user registration APIs. The users specified will have teaching assistant permissions in the room created.

Parameters:

Assistants - The user IDs of the teaching assistants. User IDs are returned by the user registration APIs. The users specified will have teaching assistant permissions in the room created.

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 Recording layout

Returns:

RecordLayout Recording layout

setRecordLayout

public void setRecordLayout(Long RecordLayout)

Set Recording layout

Parameters:

RecordLayout - Recording layout

getGroupId

public String getGroupId()

Get The ID of the group to bind. If you specify this parameter, only members of the group can enter this room.

Returns:

GroupId The ID of the group to bind. If you specify this parameter, only members of the group can enter this room.

setGroupId

public void setGroupId(String GroupId)

Set The ID of the group to bind. If you specify this parameter, only members of the group can enter this room.

Parameters:

GroupId - The ID of the group to bind. If you specify this parameter, only members of the group can enter this room.

getEnableDirectControl

public Long getEnableDirectControl()

Get Whether the teacher/teaching assistant can control students' cameras/microphones without the students' consent. Valid values: `0` (default): No (consent required) `1`: Yes (no consent required)

Returns:

EnableDirectControl Whether the teacher/teaching assistant can control students' cameras/microphones without the students' consent. Valid values: `0` (default): No (consent required) `1`: Yes (no consent required)

setEnableDirectControl

public void setEnableDirectControl(Long EnableDirectControl)

Set Whether the teacher/teaching assistant can control students' cameras/microphones without the students' consent. Valid values: `0` (default): No (consent required) `1`: Yes (no consent required)

Parameters:

EnableDirectControl - Whether the teacher/teaching assistant can control students' cameras/microphones without the students' consent. Valid values: `0` (default): No (consent required) `1`: Yes (no consent required)

getInteractionMode

public Long getInteractionMode()

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

Returns:

InteractionMode Turn on focus mode. 0 Watch all character audio and video (default) 1 Watch only teachers and 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 assistants

Parameters:

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

getVideoOrientation

public Long getVideoOrientation()

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

Returns:

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

setVideoOrientation

public void setVideoOrientation(Long VideoOrientation)

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

Parameters:

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

getIsGradingRequiredPostClass

public Long getIsGradingRequiredPostClass()

Get Enable after-class grading. 0: not on (default) 1: on

Returns:

IsGradingRequiredPostClass Enable after-class grading. 0: not on (default) 1: on

setIsGradingRequiredPostClass

public void setIsGradingRequiredPostClass(Long IsGradingRequiredPostClass)

Set Enable after-class grading. 0: not on (default) 1: on

Parameters:

IsGradingRequiredPostClass - Enable after-class grading. 0: not on (default) 1: on

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: no limit (default), -1: can't drag class, greater than 0: the time of dragging class. maximum value: 120 minutes.

Returns:

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

setEndDelayTime

public void setEndDelayTime(Long EndDelayTime)

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

Parameters:

EndDelayTime - Drag class time: unit: minutes. 0: no limit (default), -1: can't drag class, greater than 0: the time of dragging class. maximum value: 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 when

Returns:

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

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 when

Parameters:

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

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