com.tencentcloudapi.trtc.v20190722.models

Class TranscriptionParams

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.TranscriptionParams

public class TranscriptionParams
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
TranscriptionParams()
TranscriptionParams(TranscriptionParams 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
Long	getMaxIdleTime() Get If there is no streaming in the room for more than MaxIdleTime, the background will automatically close the task.
String	getTargetUserId() Get Required when TranscriptionMode is 1.
Long	getTranscriptionMode() Get 1 means the robot subscribes to the stream of only one person, 0 means the robot subscribes to the stream of the entire room.
String	getUserId() Get The robot's UserId is used to enter a room and initiate tasks.
String	getUserSig() Get The verification signature corresponding to the robot's UserId, that is, UserId and UserSig are equivalent to the robot's login password to enter the room.
void	setMaxIdleTime(Long MaxIdleTime) Set If there is no streaming in the room for more than MaxIdleTime, the background will automatically close the task.
void	setTargetUserId(String TargetUserId) Set Required when TranscriptionMode is 1.
void	setTranscriptionMode(Long TranscriptionMode) Set 1 means the robot subscribes to the stream of only one person, 0 means the robot subscribes to the stream of the entire room.
void	setUserId(String UserId) Set The robot's UserId is used to enter a room and initiate tasks.
void	setUserSig(String UserSig) Set The verification signature corresponding to the robot's UserId, that is, UserId and UserSig are equivalent to the robot's login password to enter the room.
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

TranscriptionParams

public TranscriptionParams()

TranscriptionParams

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

getUserId

public String getUserId()

Get The robot's UserId is used to enter a room and initiate tasks. [Note] This UserId cannot be repeated with the host viewer [UserId](https://cloud.tencent.com/document/product/647/46351#userid) in the current room. If multiple tasks are initiated in a room, the robot's UserId cannot be repeated, otherwise the previous task will be interrupted. The robot's UserId must be unique in the room.

Returns:

UserId The robot's UserId is used to enter a room and initiate tasks. [Note] This UserId cannot be repeated with the host viewer [UserId](https://cloud.tencent.com/document/product/647/46351#userid) in the current room. If multiple tasks are initiated in a room, the robot's UserId cannot be repeated, otherwise the previous task will be interrupted. The robot's UserId must be unique in the room.

setUserId

public void setUserId(String UserId)

Set The robot's UserId is used to enter a room and initiate tasks. [Note] This UserId cannot be repeated with the host viewer [UserId](https://cloud.tencent.com/document/product/647/46351#userid) in the current room. If multiple tasks are initiated in a room, the robot's UserId cannot be repeated, otherwise the previous task will be interrupted. The robot's UserId must be unique in the room.

Parameters:

UserId - The robot's UserId is used to enter a room and initiate tasks. [Note] This UserId cannot be repeated with the host viewer [UserId](https://cloud.tencent.com/document/product/647/46351#userid) in the current room. If multiple tasks are initiated in a room, the robot's UserId cannot be repeated, otherwise the previous task will be interrupted. The robot's UserId must be unique in the room.

getUserSig

public String getUserSig()

Get The verification signature corresponding to the robot's UserId, that is, UserId and UserSig are equivalent to the robot's login password to enter the room. For the specific calculation method, please refer to the TRTC calculation [UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig) solution.

Returns:

UserSig The verification signature corresponding to the robot's UserId, that is, UserId and UserSig are equivalent to the robot's login password to enter the room. For the specific calculation method, please refer to the TRTC calculation [UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig) solution.

setUserSig

public void setUserSig(String UserSig)

Set The verification signature corresponding to the robot's UserId, that is, UserId and UserSig are equivalent to the robot's login password to enter the room. For the specific calculation method, please refer to the TRTC calculation [UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig) solution.

Parameters:

UserSig - The verification signature corresponding to the robot's UserId, that is, UserId and UserSig are equivalent to the robot's login password to enter the room. For the specific calculation method, please refer to the TRTC calculation [UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig) solution.

getMaxIdleTime

public Long getMaxIdleTime()

Get If there is no streaming in the room for more than MaxIdleTime, the background will automatically close the task. The default value is 60s.

Returns:

MaxIdleTime If there is no streaming in the room for more than MaxIdleTime, the background will automatically close the task. The default value is 60s.

setMaxIdleTime

public void setMaxIdleTime(Long MaxIdleTime)

Set If there is no streaming in the room for more than MaxIdleTime, the background will automatically close the task. The default value is 60s.

Parameters:

MaxIdleTime - If there is no streaming in the room for more than MaxIdleTime, the background will automatically close the task. The default value is 60s.

getTranscriptionMode

public Long getTranscriptionMode()

Get 1 means the robot subscribes to the stream of only one person, 0 means the robot subscribes to the stream of the entire room. If it is not filled in, the robot subscribes to the stream of the entire room by default.

Returns:

TranscriptionMode 1 means the robot subscribes to the stream of only one person, 0 means the robot subscribes to the stream of the entire room. If it is not filled in, the robot subscribes to the stream of the entire room by default.

setTranscriptionMode

public void setTranscriptionMode(Long TranscriptionMode)

Set 1 means the robot subscribes to the stream of only one person, 0 means the robot subscribes to the stream of the entire room. If it is not filled in, the robot subscribes to the stream of the entire room by default.

Parameters:

TranscriptionMode - 1 means the robot subscribes to the stream of only one person, 0 means the robot subscribes to the stream of the entire room. If it is not filled in, the robot subscribes to the stream of the entire room by default.

getTargetUserId

public String getTargetUserId()

Get Required when TranscriptionMode is 1. The robot will only pull the stream of the userid and ignore other users in the room.

Returns:

TargetUserId Required when TranscriptionMode is 1. The robot will only pull the stream of the userid and ignore other users in the room.

setTargetUserId

public void setTargetUserId(String TargetUserId)

Set Required when TranscriptionMode is 1. The robot will only pull the stream of the userid and ignore other users in the room.

Parameters:

TargetUserId - Required when TranscriptionMode is 1. The robot will only pull the stream of the userid and ignore other users in the room.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel