com.tencentcloudapi.tiw.v20190919.models

Class StartWhiteboardPushRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tiw.v20190919.models.StartWhiteboardPushRequest

public class StartWhiteboardPushRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

skipSign

Constructor Summary

Constructors

Constructor and Description
StartWhiteboardPushRequest()
StartWhiteboardPushRequest(StartWhiteboardPushRequest 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
Boolean	getAutoManageBackup() Get Specifies whether to synchronize operations on the primary whiteboard push task to the backup task.
Boolean	getAutoPublish() Get Specifies whether to enable automatic relay whiteboard push when the relay push mode in TRTC is set to `SubscribeRelayUserIds`.
Boolean	getAutoRecord() Get Specifies whether to automatically record the whiteboard push when the recording mode in TRTC is set to `SubscribeStreamUserIds`.
Long	getAutoStopTimeout() Get Whiteboard push timeout.
WhiteboardPushBackupParam	getBackup() Get Parameters of the backup whiteboard push task.
String	getExtraData() Get Internal parameter.
AuthParam	getIMAuthParam() Get IM authentication parameters.
String	getPrivateMapKey() Get Advanced permission control parameter in TRTC.
String	getPushUserId() Get User ID used by the whiteboard push service for entering the whiteboard room.
String	getPushUserSig() Get User's IM signature corresponding to the PushUserId.
Long	getRoomId() Get Room ID of the whiteboard push task.
Long	getSdkAppId() Get SdkAppId of the whiteboard application.
AuthParam	getTRTCAuthParam() Get TRTC authentication parameters, used for room entrance authentication for TRTC push.
String	getTRTCEnterRoomMode() Get This parameter is available only to users in the allowlist for trial.
Long	getTRTCRoomId() Get TRTC room ID of the numeric type.
String	getTRTCRoomIdStr() Get TRTC room ID of the string type.
String	getUserDefinedRecordId() Get ID of the whiteboard push recording.
String	getUserDefinedStreamId() Get Stream ID used by TRTC for relay whiteboard push.
Long	getVideoBitrate() Get Whiteboard push bitrate.
Long	getVideoFPS() Get Frame rate of the whiteboard push video.
Whiteboard	getWhiteboard() Get Whiteboard parameters, such as the width, height, and background color of the whiteboard.
void	setAutoManageBackup(Boolean AutoManageBackup) Set Specifies whether to synchronize operations on the primary whiteboard push task to the backup task.
void	setAutoPublish(Boolean AutoPublish) Set Specifies whether to enable automatic relay whiteboard push when the relay push mode in TRTC is set to `SubscribeRelayUserIds`.
void	setAutoRecord(Boolean AutoRecord) Set Specifies whether to automatically record the whiteboard push when the recording mode in TRTC is set to `SubscribeStreamUserIds`.
void	setAutoStopTimeout(Long AutoStopTimeout) Set Whiteboard push timeout.
void	setBackup(WhiteboardPushBackupParam Backup) Set Parameters of the backup whiteboard push task.
void	setExtraData(String ExtraData) Set Internal parameter.
void	setIMAuthParam(AuthParam IMAuthParam) Set IM authentication parameters.
void	setPrivateMapKey(String PrivateMapKey) Set Advanced permission control parameter in TRTC.
void	setPushUserId(String PushUserId) Set User ID used by the whiteboard push service for entering the whiteboard room.
void	setPushUserSig(String PushUserSig) Set User's IM signature corresponding to the PushUserId.
void	setRoomId(Long RoomId) Set Room ID of the whiteboard push task.
void	setSdkAppId(Long SdkAppId) Set SdkAppId of the whiteboard application.
void	setTRTCAuthParam(AuthParam TRTCAuthParam) Set TRTC authentication parameters, used for room entrance authentication for TRTC push.
void	setTRTCEnterRoomMode(String TRTCEnterRoomMode) Set This parameter is available only to users in the allowlist for trial.
void	setTRTCRoomId(Long TRTCRoomId) Set TRTC room ID of the numeric type.
void	setTRTCRoomIdStr(String TRTCRoomIdStr) Set TRTC room ID of the string type.
void	setUserDefinedRecordId(String UserDefinedRecordId) Set ID of the whiteboard push recording.
void	setUserDefinedStreamId(String UserDefinedStreamId) Set Stream ID used by TRTC for relay whiteboard push.
void	setVideoBitrate(Long VideoBitrate) Set Whiteboard push bitrate.
void	setVideoFPS(Long VideoFPS) Set Frame rate of the whiteboard push video.
void	setWhiteboard(Whiteboard Whiteboard) Set Whiteboard parameters, such as the width, height, and background color of the whiteboard.
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, getMultipartRequestParams, getSkipSign, set, 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

StartWhiteboardPushRequest

public StartWhiteboardPushRequest()

StartWhiteboardPushRequest

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

getSdkAppId

public Long getSdkAppId()

Get SdkAppId of the whiteboard application.

Returns:

SdkAppId SdkAppId of the whiteboard application.

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set SdkAppId of the whiteboard application.

Parameters:

SdkAppId - SdkAppId of the whiteboard application.

getRoomId

public Long getRoomId()

Get Room ID of the whiteboard push task. Valid range: (1,4294967295). 1. By default, the whiteboard push task uses the RoomId string as the GroupID of the IM group. For example, if the RoomId string is 1234, the GroupID of the IM group is also 1234. Message synchronization requires joining a group. Make sure that an IM group is created before the push starts. Otherwise, the push fails. 2. If neither TRTCRoomId nor TRTCRoomIdStr is specified, the value of RoomId is used as the Tencent Real-Time Communication (TRTC) room ID for the whiteboard push task.

Returns:

RoomId Room ID of the whiteboard push task. Valid range: (1,4294967295). 1. By default, the whiteboard push task uses the RoomId string as the GroupID of the IM group. For example, if the RoomId string is 1234, the GroupID of the IM group is also 1234. Message synchronization requires joining a group. Make sure that an IM group is created before the push starts. Otherwise, the push fails. 2. If neither TRTCRoomId nor TRTCRoomIdStr is specified, the value of RoomId is used as the Tencent Real-Time Communication (TRTC) room ID for the whiteboard push task.

setRoomId

public void setRoomId(Long RoomId)

Set Room ID of the whiteboard push task. Valid range: (1,4294967295). 1. By default, the whiteboard push task uses the RoomId string as the GroupID of the IM group. For example, if the RoomId string is 1234, the GroupID of the IM group is also 1234. Message synchronization requires joining a group. Make sure that an IM group is created before the push starts. Otherwise, the push fails. 2. If neither TRTCRoomId nor TRTCRoomIdStr is specified, the value of RoomId is used as the Tencent Real-Time Communication (TRTC) room ID for the whiteboard push task.

Parameters:

RoomId - Room ID of the whiteboard push task. Valid range: (1,4294967295). 1. By default, the whiteboard push task uses the RoomId string as the GroupID of the IM group. For example, if the RoomId string is 1234, the GroupID of the IM group is also 1234. Message synchronization requires joining a group. Make sure that an IM group is created before the push starts. Otherwise, the push fails. 2. If neither TRTCRoomId nor TRTCRoomIdStr is specified, the value of RoomId is used as the Tencent Real-Time Communication (TRTC) room ID for the whiteboard push task.

getPushUserId

public String getPushUserId()

Get User ID used by the whiteboard push service for entering the whiteboard room. If `IMAuthParam`and `TRTCAuthParam` are not specified, this user ID is used for operations such as logging in to the IM application, joining an IM group, and entering the room for TRTC whiteboard push. The ID cannot exceed 60 bytes in length and must be an unused ID. The whiteboard push service uses the user ID to enter the room for whiteboard audio/video push. If this ID is already used in another scenario, the other scenario and whiteboard push service will conflict, affecting the pushing operation.

Returns:

PushUserId User ID used by the whiteboard push service for entering the whiteboard room. If `IMAuthParam`and `TRTCAuthParam` are not specified, this user ID is used for operations such as logging in to the IM application, joining an IM group, and entering the room for TRTC whiteboard push. The ID cannot exceed 60 bytes in length and must be an unused ID. The whiteboard push service uses the user ID to enter the room for whiteboard audio/video push. If this ID is already used in another scenario, the other scenario and whiteboard push service will conflict, affecting the pushing operation.

setPushUserId

public void setPushUserId(String PushUserId)

Set User ID used by the whiteboard push service for entering the whiteboard room. If `IMAuthParam`and `TRTCAuthParam` are not specified, this user ID is used for operations such as logging in to the IM application, joining an IM group, and entering the room for TRTC whiteboard push. The ID cannot exceed 60 bytes in length and must be an unused ID. The whiteboard push service uses the user ID to enter the room for whiteboard audio/video push. If this ID is already used in another scenario, the other scenario and whiteboard push service will conflict, affecting the pushing operation.

Parameters:

PushUserId - User ID used by the whiteboard push service for entering the whiteboard room. If `IMAuthParam`and `TRTCAuthParam` are not specified, this user ID is used for operations such as logging in to the IM application, joining an IM group, and entering the room for TRTC whiteboard push. The ID cannot exceed 60 bytes in length and must be an unused ID. The whiteboard push service uses the user ID to enter the room for whiteboard audio/video push. If this ID is already used in another scenario, the other scenario and whiteboard push service will conflict, affecting the pushing operation.

getPushUserSig

public String getPushUserSig()

Get User's IM signature corresponding to the PushUserId.

Returns:

PushUserSig User's IM signature corresponding to the PushUserId.

setPushUserSig

public void setPushUserSig(String PushUserSig)

Set User's IM signature corresponding to the PushUserId.

Parameters:

PushUserSig - User's IM signature corresponding to the PushUserId.

getWhiteboard

public Whiteboard getWhiteboard()

Get Whiteboard parameters, such as the width, height, and background color of the whiteboard.

Returns:

Whiteboard Whiteboard parameters, such as the width, height, and background color of the whiteboard.

setWhiteboard

public void setWhiteboard(Whiteboard Whiteboard)

Set Whiteboard parameters, such as the width, height, and background color of the whiteboard.

Parameters:

Whiteboard - Whiteboard parameters, such as the width, height, and background color of the whiteboard.

getAutoStopTimeout

public Long getAutoStopTimeout()

Get Whiteboard push timeout. Unit: seconds. Valid range: [300,259200]. Default value: 1800. If no operation is performed on the whiteboard for the specified period of time, the whiteboard push service automatically stops whiteboard push.

Returns:

AutoStopTimeout Whiteboard push timeout. Unit: seconds. Valid range: [300,259200]. Default value: 1800. If no operation is performed on the whiteboard for the specified period of time, the whiteboard push service automatically stops whiteboard push.

setAutoStopTimeout

public void setAutoStopTimeout(Long AutoStopTimeout)

Set Whiteboard push timeout. Unit: seconds. Valid range: [300,259200]. Default value: 1800. If no operation is performed on the whiteboard for the specified period of time, the whiteboard push service automatically stops whiteboard push.

Parameters:

AutoStopTimeout - Whiteboard push timeout. Unit: seconds. Valid range: [300,259200]. Default value: 1800. If no operation is performed on the whiteboard for the specified period of time, the whiteboard push service automatically stops whiteboard push.

getAutoManageBackup

public Boolean getAutoManageBackup()

Get Specifies whether to synchronize operations on the primary whiteboard push task to the backup task.

Returns:

AutoManageBackup Specifies whether to synchronize operations on the primary whiteboard push task to the backup task.

setAutoManageBackup

public void setAutoManageBackup(Boolean AutoManageBackup)

Set Specifies whether to synchronize operations on the primary whiteboard push task to the backup task.

Parameters:

AutoManageBackup - Specifies whether to synchronize operations on the primary whiteboard push task to the backup task.

getBackup

public WhiteboardPushBackupParam getBackup()

Get Parameters of the backup whiteboard push task. After the backup parameters are specified, the whiteboard push service adds a relayed video stream. That is, there are two video streams on the whiteboard in the same room.

Returns:

Backup Parameters of the backup whiteboard push task. After the backup parameters are specified, the whiteboard push service adds a relayed video stream. That is, there are two video streams on the whiteboard in the same room.

setBackup

public void setBackup(WhiteboardPushBackupParam Backup)

Set Parameters of the backup whiteboard push task. After the backup parameters are specified, the whiteboard push service adds a relayed video stream. That is, there are two video streams on the whiteboard in the same room.

Parameters:

Backup - Parameters of the backup whiteboard push task. After the backup parameters are specified, the whiteboard push service adds a relayed video stream. That is, there are two video streams on the whiteboard in the same room.

getPrivateMapKey

public String getPrivateMapKey()

Get Advanced permission control parameter in TRTC. If the advanced permission control feature is enabled in TRTC, this parameter is required.

Returns:

PrivateMapKey Advanced permission control parameter in TRTC. If the advanced permission control feature is enabled in TRTC, this parameter is required.

setPrivateMapKey

public void setPrivateMapKey(String PrivateMapKey)

Set Advanced permission control parameter in TRTC. If the advanced permission control feature is enabled in TRTC, this parameter is required.

Parameters:

PrivateMapKey - Advanced permission control parameter in TRTC. If the advanced permission control feature is enabled in TRTC, this parameter is required.

getVideoFPS

public Long getVideoFPS()

Get Frame rate of the whiteboard push video. Valid range: [0,30]. Default value: 20. Unit: fps.

Returns:

VideoFPS Frame rate of the whiteboard push video. Valid range: [0,30]. Default value: 20. Unit: fps.

setVideoFPS

public void setVideoFPS(Long VideoFPS)

Set Frame rate of the whiteboard push video. Valid range: [0,30]. Default value: 20. Unit: fps.

Parameters:

VideoFPS - Frame rate of the whiteboard push video. Valid range: [0,30]. Default value: 20. Unit: fps.

getVideoBitrate

public Long getVideoBitrate()

Get Whiteboard push bitrate. Valid range: [0,2000]. Default value: 1200. Unit: kbps. The bitrate specified here is a reference value. During actual push, a dynamic bitrate is used. The actual bitrate does not remain the specified value but rather fluctuates around it.

Returns:

VideoBitrate Whiteboard push bitrate. Valid range: [0,2000]. Default value: 1200. Unit: kbps. The bitrate specified here is a reference value. During actual push, a dynamic bitrate is used. The actual bitrate does not remain the specified value but rather fluctuates around it.

setVideoBitrate

public void setVideoBitrate(Long VideoBitrate)

Set Whiteboard push bitrate. Valid range: [0,2000]. Default value: 1200. Unit: kbps. The bitrate specified here is a reference value. During actual push, a dynamic bitrate is used. The actual bitrate does not remain the specified value but rather fluctuates around it.

Parameters:

VideoBitrate - Whiteboard push bitrate. Valid range: [0,2000]. Default value: 1200. Unit: kbps. The bitrate specified here is a reference value. During actual push, a dynamic bitrate is used. The actual bitrate does not remain the specified value but rather fluctuates around it.

getAutoRecord

public Boolean getAutoRecord()

Get Specifies whether to automatically record the whiteboard push when the recording mode in TRTC is set to `SubscribeStreamUserIds`. Default value: `false`. If you need to enable automatic whiteboard push recording, set this parameter to `true`. If the recording mode in TRTC is set to `Global Auto Recording`, ignore this parameter.

Returns:

AutoRecord Specifies whether to automatically record the whiteboard push when the recording mode in TRTC is set to `SubscribeStreamUserIds`. Default value: `false`. If you need to enable automatic whiteboard push recording, set this parameter to `true`. If the recording mode in TRTC is set to `Global Auto Recording`, ignore this parameter.

setAutoRecord

public void setAutoRecord(Boolean AutoRecord)

Set Specifies whether to automatically record the whiteboard push when the recording mode in TRTC is set to `SubscribeStreamUserIds`. Default value: `false`. If you need to enable automatic whiteboard push recording, set this parameter to `true`. If the recording mode in TRTC is set to `Global Auto Recording`, ignore this parameter.

Parameters:

AutoRecord - Specifies whether to automatically record the whiteboard push when the recording mode in TRTC is set to `SubscribeStreamUserIds`. Default value: `false`. If you need to enable automatic whiteboard push recording, set this parameter to `true`. If the recording mode in TRTC is set to `Global Auto Recording`, ignore this parameter.

getUserDefinedRecordId

public String getUserDefinedRecordId()

Get ID of the whiteboard push recording. The ID is filled in the `userdefinerecordid` parameter in the callback message after cloud recording is complete in TRTC, helping you identify the recording callback and locate the video file in VOD media resource management. The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). After this parameter is set, automatic whiteboard push recording is enabled regardless of the value of the `AutoRecord` parameter. Default RecordId generation rule: urlencode(SdkAppID_RoomID_PushUserID) Example: SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 Therefore: RecordId = 12345678_12345_push_user_1

Returns:

UserDefinedRecordId ID of the whiteboard push recording. The ID is filled in the `userdefinerecordid` parameter in the callback message after cloud recording is complete in TRTC, helping you identify the recording callback and locate the video file in VOD media resource management. The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). After this parameter is set, automatic whiteboard push recording is enabled regardless of the value of the `AutoRecord` parameter. Default RecordId generation rule: urlencode(SdkAppID_RoomID_PushUserID) Example: SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 Therefore: RecordId = 12345678_12345_push_user_1

setUserDefinedRecordId

public void setUserDefinedRecordId(String UserDefinedRecordId)

Set ID of the whiteboard push recording. The ID is filled in the `userdefinerecordid` parameter in the callback message after cloud recording is complete in TRTC, helping you identify the recording callback and locate the video file in VOD media resource management. The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). After this parameter is set, automatic whiteboard push recording is enabled regardless of the value of the `AutoRecord` parameter. Default RecordId generation rule: urlencode(SdkAppID_RoomID_PushUserID) Example: SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 Therefore: RecordId = 12345678_12345_push_user_1

Parameters:

UserDefinedRecordId - ID of the whiteboard push recording. The ID is filled in the `userdefinerecordid` parameter in the callback message after cloud recording is complete in TRTC, helping you identify the recording callback and locate the video file in VOD media resource management. The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). After this parameter is set, automatic whiteboard push recording is enabled regardless of the value of the `AutoRecord` parameter. Default RecordId generation rule: urlencode(SdkAppID_RoomID_PushUserID) Example: SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 Therefore: RecordId = 12345678_12345_push_user_1

getAutoPublish

public Boolean getAutoPublish()

Get Specifies whether to enable automatic relay whiteboard push when the relay push mode in TRTC is set to `SubscribeRelayUserIds`. Default value: `false`. If you need to enable automatic relay whiteboard push, set this parameter to `true`. If the recording mode in TRTC is set to `Global Auto Relay`, ignore this parameter.

Returns:

AutoPublish Specifies whether to enable automatic relay whiteboard push when the relay push mode in TRTC is set to `SubscribeRelayUserIds`. Default value: `false`. If you need to enable automatic relay whiteboard push, set this parameter to `true`. If the recording mode in TRTC is set to `Global Auto Relay`, ignore this parameter.

setAutoPublish

public void setAutoPublish(Boolean AutoPublish)

Set Specifies whether to enable automatic relay whiteboard push when the relay push mode in TRTC is set to `SubscribeRelayUserIds`. Default value: `false`. If you need to enable automatic relay whiteboard push, set this parameter to `true`. If the recording mode in TRTC is set to `Global Auto Relay`, ignore this parameter.

Parameters:

AutoPublish - Specifies whether to enable automatic relay whiteboard push when the relay push mode in TRTC is set to `SubscribeRelayUserIds`. Default value: `false`. If you need to enable automatic relay whiteboard push, set this parameter to `true`. If the recording mode in TRTC is set to `Global Auto Relay`, ignore this parameter.

getUserDefinedStreamId

public String getUserDefinedStreamId()

Get Stream ID used by TRTC for relay whiteboard push. With this ID, you can stream the user’s audio/video by using the domain name and standard streaming solution (FLV or HLS) in TRTC. The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). After this parameter is set, automatic relay whiteboard push is enabled regardless of the value of the `AutoPublish` parameter. Default StreamID generation rule: urlencode(SdkAppID_RoomID_PushUserID_main) Example: SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 Therefore, StreamID = 12345678_12345_push_user_1_main

Returns:

UserDefinedStreamId Stream ID used by TRTC for relay whiteboard push. With this ID, you can stream the user’s audio/video by using the domain name and standard streaming solution (FLV or HLS) in TRTC. The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). After this parameter is set, automatic relay whiteboard push is enabled regardless of the value of the `AutoPublish` parameter. Default StreamID generation rule: urlencode(SdkAppID_RoomID_PushUserID_main) Example: SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 Therefore, StreamID = 12345678_12345_push_user_1_main

setUserDefinedStreamId

public void setUserDefinedStreamId(String UserDefinedStreamId)

Set Stream ID used by TRTC for relay whiteboard push. With this ID, you can stream the user’s audio/video by using the domain name and standard streaming solution (FLV or HLS) in TRTC. The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). After this parameter is set, automatic relay whiteboard push is enabled regardless of the value of the `AutoPublish` parameter. Default StreamID generation rule: urlencode(SdkAppID_RoomID_PushUserID_main) Example: SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 Therefore, StreamID = 12345678_12345_push_user_1_main

Parameters:

UserDefinedStreamId - Stream ID used by TRTC for relay whiteboard push. With this ID, you can stream the user’s audio/video by using the domain name and standard streaming solution (FLV or HLS) in TRTC. The value can be up to 64 bytes in length and contain letters (a-z and A-Z), digits (0-9), underscores (_), and hyphens (-). After this parameter is set, automatic relay whiteboard push is enabled regardless of the value of the `AutoPublish` parameter. Default StreamID generation rule: urlencode(SdkAppID_RoomID_PushUserID_main) Example: SdkAppID = 12345678，RoomID = 12345，PushUserID = push_user_1 Therefore, StreamID = 12345678_12345_push_user_1_main

getExtraData

public String getExtraData()

Get Internal parameter. You can ignore this parameter.

Returns:

ExtraData Internal parameter. You can ignore this parameter.

setExtraData

public void setExtraData(String ExtraData)

Set Internal parameter. You can ignore this parameter.

Parameters:

ExtraData - Internal parameter. You can ignore this parameter.

getTRTCRoomId

public Long getTRTCRoomId()

Get TRTC room ID of the numeric type. Valid range: (1,4294967295). If RoomId and TRTCRoomId are both specified, the value of TRTCRoomId takes priority as the room ID for TRTC whiteboard push. If the TRTCRoomIdStr parameter is specified, this parameter is ignored.

Returns:

TRTCRoomId TRTC room ID of the numeric type. Valid range: (1,4294967295). If RoomId and TRTCRoomId are both specified, the value of TRTCRoomId takes priority as the room ID for TRTC whiteboard push. If the TRTCRoomIdStr parameter is specified, this parameter is ignored.

setTRTCRoomId

public void setTRTCRoomId(Long TRTCRoomId)

Set TRTC room ID of the numeric type. Valid range: (1,4294967295). If RoomId and TRTCRoomId are both specified, the value of TRTCRoomId takes priority as the room ID for TRTC whiteboard push. If the TRTCRoomIdStr parameter is specified, this parameter is ignored.

Parameters:

TRTCRoomId - TRTC room ID of the numeric type. Valid range: (1,4294967295). If RoomId and TRTCRoomId are both specified, the value of TRTCRoomId takes priority as the room ID for TRTC whiteboard push. If the TRTCRoomIdStr parameter is specified, this parameter is ignored.

getTRTCRoomIdStr

public String getTRTCRoomIdStr()

Get TRTC room ID of the string type. If TRTCRoomIdStr is specified, its value takes priority as the room ID for TRTC whiteboard push.

Returns:

TRTCRoomIdStr TRTC room ID of the string type. If TRTCRoomIdStr is specified, its value takes priority as the room ID for TRTC whiteboard push.

setTRTCRoomIdStr

public void setTRTCRoomIdStr(String TRTCRoomIdStr)

Set TRTC room ID of the string type. If TRTCRoomIdStr is specified, its value takes priority as the room ID for TRTC whiteboard push.

Parameters:

TRTCRoomIdStr - TRTC room ID of the string type. If TRTCRoomIdStr is specified, its value takes priority as the room ID for TRTC whiteboard push.

getIMAuthParam

public AuthParam getIMAuthParam()

Get IM authentication parameters. If the ID of the IM application used by whiteboard messages is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the IM application. If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the transmission channel for whiteboard messages. If this parameter is left empty, the SdkAppId value in the common parameters is used.

Returns:

IMAuthParam IM authentication parameters. If the ID of the IM application used by whiteboard messages is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the IM application. If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the transmission channel for whiteboard messages. If this parameter is left empty, the SdkAppId value in the common parameters is used.

setIMAuthParam

public void setIMAuthParam(AuthParam IMAuthParam)

Set IM authentication parameters. If the ID of the IM application used by whiteboard messages is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the IM application. If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the transmission channel for whiteboard messages. If this parameter is left empty, the SdkAppId value in the common parameters is used.

Parameters:

IMAuthParam - IM authentication parameters. If the ID of the IM application used by whiteboard messages is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the IM application. If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the transmission channel for whiteboard messages. If this parameter is left empty, the SdkAppId value in the common parameters is used.

getTRTCAuthParam

public AuthParam getTRTCAuthParam()

Get TRTC authentication parameters, used for room entrance authentication for TRTC push. If the ID of the TRTC application to which the target TRTC room belongs is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the TRTC application. If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the ID of the target TRTC application. If this parameter is left empty, the SdkAppId value in the common parameters is used.

Returns:

TRTCAuthParam TRTC authentication parameters, used for room entrance authentication for TRTC push. If the ID of the TRTC application to which the target TRTC room belongs is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the TRTC application. If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the ID of the target TRTC application. If this parameter is left empty, the SdkAppId value in the common parameters is used.

setTRTCAuthParam

public void setTRTCAuthParam(AuthParam TRTCAuthParam)

Set TRTC authentication parameters, used for room entrance authentication for TRTC push. If the ID of the TRTC application to which the target TRTC room belongs is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the TRTC application. If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the ID of the target TRTC application. If this parameter is left empty, the SdkAppId value in the common parameters is used.

Parameters:

TRTCAuthParam - TRTC authentication parameters, used for room entrance authentication for TRTC push. If the ID of the TRTC application to which the target TRTC room belongs is different from SdkAppId of the whiteboard application, specify this parameter to provide authentication information of the TRTC application. If this parameter is specified, the whiteboard push service preferably uses the SdkAppId value in this parameter as the ID of the target TRTC application. If this parameter is left empty, the SdkAppId value in the common parameters is used.

getTRTCEnterRoomMode

public String getTRTCEnterRoomMode()

Get This parameter is available only to users in the allowlist for trial. TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCall`. `TRTCAppSceneVideoCall`: This scenario is most suitable when there are two or more people on a video call. The internal encoders and network protocols are optimized for video smoothness to reduce call latency and lagging. `TRTCAppSceneLIVE`: This scenario is most suitable when there is only one person speaking or performing for an online audience, and occasionally multiple people interact with one another through video. The internal encoders and network protocols are optimized for performance and compatibility to deliver better performance and video clarity.

Returns:

TRTCEnterRoomMode This parameter is available only to users in the allowlist for trial. TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCall`. `TRTCAppSceneVideoCall`: This scenario is most suitable when there are two or more people on a video call. The internal encoders and network protocols are optimized for video smoothness to reduce call latency and lagging. `TRTCAppSceneLIVE`: This scenario is most suitable when there is only one person speaking or performing for an online audience, and occasionally multiple people interact with one another through video. The internal encoders and network protocols are optimized for performance and compatibility to deliver better performance and video clarity.

setTRTCEnterRoomMode

public void setTRTCEnterRoomMode(String TRTCEnterRoomMode)

Set This parameter is available only to users in the allowlist for trial. TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCall`. `TRTCAppSceneVideoCall`: This scenario is most suitable when there are two or more people on a video call. The internal encoders and network protocols are optimized for video smoothness to reduce call latency and lagging. `TRTCAppSceneLIVE`: This scenario is most suitable when there is only one person speaking or performing for an online audience, and occasionally multiple people interact with one another through video. The internal encoders and network protocols are optimized for performance and compatibility to deliver better performance and video clarity.

Parameters:

TRTCEnterRoomMode - This parameter is available only to users in the allowlist for trial. TRTC room entrance mode for whiteboard push. Default value: `TRTCAppSceneVideoCall`. `TRTCAppSceneVideoCall`: This scenario is most suitable when there are two or more people on a video call. The internal encoders and network protocols are optimized for video smoothness to reduce call latency and lagging. `TRTCAppSceneLIVE`: This scenario is most suitable when there is only one person speaking or performing for an online audience, and occasionally multiple people interact with one another through video. The internal encoders and network protocols are optimized for performance and compatibility to deliver better performance and video clarity.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel