com.tencentcloudapi.lcic.v20220817.models

Class DescribeRoomResponse

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.lcic.v20220817.models.DescribeRoomResponse

public class DescribeRoomResponse
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeRoomResponse()
DescribeRoomResponse(DescribeRoomResponse 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 Assistant ID list Note: This field may return null, indicating that no valid values can be obtained.
Long	getAudienceType() Get Watch 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
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 Reserved room end time, in UNIX timestamp format
String	getGroupId() Get Note: This field may return null, indicating that no valid values can be obtained.
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 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() Get Record customized language, only when recordlayout=9, this parameter is valid
String	getRecordLiveUrl() Get Simulated Live link
String	getRecordScene() Get Record customized scene, only recordlayout=9 this parameter is valid
String	getRecordUrl() Get Recording URL.
String	getRequestId() Get The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId).
Long	getResolution() Get Resolution.
Long	getRoomType() Get Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
String	getRTMPStreamingURL() Get RTMP stream link
Long	getSdkAppId() Get LCIC SdkAppId
Long	getStartTime() Get Reserved room start time, in UNIX timestamp format
Long	getStatus() Get The class status.
String	getSubType() Get The room subtype.
String	getTeacherId() Get Teacher ID
Long	getVideoDuration() Get Recording Duration
Long	getVideoOrientation() Get Horizontal and vertical screen.
void	setAssistants(String[] Assistants) Set Assistant ID list Note: This field may return null, indicating that no valid values can be obtained.
void	setAudienceType(Long AudienceType) Set Watch 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
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 Reserved room end time, in UNIX timestamp format
void	setGroupId(String GroupId) Set Note: This field may return null, indicating that no valid values can be obtained.
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 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) Set Record customized language, only when recordlayout=9, this parameter is valid
void	setRecordLiveUrl(String RecordLiveUrl) Set Simulated Live link
void	setRecordScene(String RecordScene) Set Record customized scene, only recordlayout=9 this parameter is valid
void	setRecordUrl(String RecordUrl) Set Recording URL.
void	setRequestId(String RequestId) Set The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId).
void	setResolution(Long Resolution) Set Resolution.
void	setRoomType(Long RoomType) Set Room Type: 0 Small Classroom(default); 1 Lecture Hall(public class)
void	setRTMPStreamingURL(String RTMPStreamingURL) Set RTMP stream link
void	setSdkAppId(Long SdkAppId) Set LCIC SdkAppId
void	setStartTime(Long StartTime) Set Reserved room start time, in UNIX timestamp format
void	setStatus(Long Status) Set The class status.
void	setSubType(String SubType) Set The room subtype.
void	setTeacherId(String TeacherId) Set Teacher ID
void	setVideoDuration(Long VideoDuration) Set Recording Duration
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

DescribeRoomResponse

public DescribeRoomResponse()

DescribeRoomResponse

public DescribeRoomResponse(DescribeRoomResponse 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

getTeacherId

public String getTeacherId()

Get Teacher ID

Returns:

TeacherId Teacher ID

setTeacherId

public void setTeacherId(String TeacherId)

Set Teacher ID

Parameters:

TeacherId - Teacher ID

getSdkAppId

public Long getSdkAppId()

Get LCIC SdkAppId

Returns:

SdkAppId LCIC SdkAppId

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set LCIC SdkAppId

Parameters:

SdkAppId - LCIC SdkAppId

getAudienceType

public Long getAudienceType()

Get Watch type. Can have the following values: 1 interactive viewing 2 standard viewing

Returns:

AudienceType Watch type. Can have the following values: 1 interactive viewing 2 standard viewing

setAudienceType

public void setAudienceType(Long AudienceType)

Set Watch type. Can have the following values: 1 interactive viewing 2 standard viewing

Parameters:

AudienceType - Watch type. Can have the following values: 1 interactive viewing 2 standard viewing

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]

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.

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.

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.

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 Assistant ID list Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Assistants Assistant ID list Note: This field may return null, indicating that no valid values can be obtained.

setAssistants

public void setAssistants(String[] Assistants)

Set Assistant ID list Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Assistants - Assistant ID list Note: This field may return null, indicating that no valid values can be obtained.

getRecordUrl

public String getRecordUrl()

Get Recording URL. This parameter exists only after a room is ended. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

RecordUrl Recording URL. This parameter exists only after a room is ended. Note: This field may return null, indicating that no valid values can be obtained.

setRecordUrl

public void setRecordUrl(String RecordUrl)

Set Recording URL. This parameter exists only after a room is ended. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

RecordUrl - Recording URL. This parameter exists only after a room is ended. Note: This field may return null, indicating that no valid values can be obtained.

getStatus

public Long getStatus()

Get The class status. 0: The class has not started. 1: The class has started. 2: The class ended. 3: The class expired. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

Status The class status. 0: The class has not started. 1: The class has started. 2: The class ended. 3: The class expired. Note: This field may return null, indicating that no valid values can be obtained.

setStatus

public void setStatus(Long Status)

Set The class status. 0: The class has not started. 1: The class has started. 2: The class ended. 3: The class expired. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

Status - The class status. 0: The class has not started. 1: The class has started. 2: The class ended. 3: The class expired. Note: This field may return null, indicating that no valid values can be obtained.

getGroupId

public String getGroupId()

Get Note: This field may return null, indicating that no valid values can be obtained.

Returns:

GroupId Note: This field may return null, indicating that no valid values can be obtained.

setGroupId

public void setGroupId(String GroupId)

Set Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

GroupId - 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)

getVideoDuration

public Long getVideoDuration()

Get Recording Duration

Returns:

VideoDuration Recording Duration

setVideoDuration

public void setVideoDuration(Long VideoDuration)

Set Recording Duration

Parameters:

VideoDuration - Recording Duration

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

getRTMPStreamingURL

public String getRTMPStreamingURL()

Get RTMP stream link

Returns:

RTMPStreamingURL RTMP stream link

setRTMPStreamingURL

public void setRTMPStreamingURL(String RTMPStreamingURL)

Set RTMP stream link

Parameters:

RTMPStreamingURL - RTMP stream link

getRecordScene

public String getRecordScene()

Get Record customized scene, only recordlayout=9 this parameter is valid

Returns:

RecordScene Record customized scene, only recordlayout=9 this parameter is valid

setRecordScene

public void setRecordScene(String RecordScene)

Set Record customized scene, only recordlayout=9 this parameter is valid

Parameters:

RecordScene - Record customized scene, only recordlayout=9 this parameter is valid

getRecordLang

public String getRecordLang()

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

public void setRecordLang(String RecordLang)

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

getRequestId

public String getRequestId()

Get The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Returns:

RequestId The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

setRequestId

public void setRequestId(String RequestId)

Set The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

Parameters:

RequestId - The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel