com.tencentcloudapi.tiw.v20190919.models

Class StartOnlineRecordRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tiw.v20190919.models.StartOnlineRecordRequest

public class StartOnlineRecordRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

skipSign

Constructor Summary

Constructors

Constructor and Description
StartOnlineRecordRequest()
StartOnlineRecordRequest(StartOnlineRecordRequest 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	getAudioFileNeeded() Get Whether to return the audio-only recording file of different streams in the result callback.
Long	getAutoStopTimeout() Get Recording timeout.
String	getChatGroupId() Get
Concat	getConcat() Get Real-time recording video splicing parameter
String	getExtraData() Get Internal parameter.
String[]	getExtras() Get List of advanced features used List of possible values: MIX_STREAM - Stream mixing feature
String	getGroupId() Get (Disused) IM group ID of the whiteboard.
MixStream	getMixStream() Get Real-time recording stream mixing parameter Notes: 1.
RecordControl	getRecordControl() Get A group of real-time recording parameters.
String	getRecordMode() Get
String	getRecordUserId() Get User ID used by the recording service for entering a room.
String	getRecordUserSig() Get Signature corresponding to RecordUserId
Long	getRoomId() Get ID of the room for recording.
Long	getSdkAppId() Get SdkAppId of the customer
Whiteboard	getWhiteboard() Get Real-time recording whiteboard parameter, such as the whiteboard width and height
void	setAudioFileNeeded(Boolean AudioFileNeeded) Set Whether to return the audio-only recording file of different streams in the result callback.
void	setAutoStopTimeout(Long AutoStopTimeout) Set Recording timeout.
void	setChatGroupId(String ChatGroupId) Set
void	setConcat(Concat Concat) Set Real-time recording video splicing parameter
void	setExtraData(String ExtraData) Set Internal parameter.
void	setExtras(String[] Extras) Set List of advanced features used List of possible values: MIX_STREAM - Stream mixing feature
void	setGroupId(String GroupId) Set (Disused) IM group ID of the whiteboard.
void	setMixStream(MixStream MixStream) Set Real-time recording stream mixing parameter Notes: 1.
void	setRecordControl(RecordControl RecordControl) Set A group of real-time recording parameters.
void	setRecordMode(String RecordMode) Set
void	setRecordUserId(String RecordUserId) Set User ID used by the recording service for entering a room.
void	setRecordUserSig(String RecordUserSig) Set Signature corresponding to RecordUserId
void	setRoomId(Long RoomId) Set ID of the room for recording.
void	setSdkAppId(Long SdkAppId) Set SdkAppId of the customer
void	setWhiteboard(Whiteboard Whiteboard) Set Real-time recording whiteboard parameter, such as the whiteboard width and height
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

StartOnlineRecordRequest

public StartOnlineRecordRequest()

StartOnlineRecordRequest

public StartOnlineRecordRequest(StartOnlineRecordRequest 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 customer

Returns:

SdkAppId SdkAppId of the customer

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set SdkAppId of the customer

Parameters:

SdkAppId - SdkAppId of the customer

getRoomId

public Long getRoomId()

Get ID of the room for recording. Value range: (1, 4294967295)

Returns:

RoomId ID of the room for recording. Value range: (1, 4294967295)

setRoomId

public void setRoomId(Long RoomId)

Set ID of the room for recording. Value range: (1, 4294967295)

Parameters:

RoomId - ID of the room for recording. Value range: (1, 4294967295)

getRecordUserId

public String getRecordUserId()

Get User ID used by the recording service for entering a room. The ID cannot exceed 60 bytes in length. Its format is `tic_record_user_${RoomId}_${Random}`, where `${RoomId}` indicates the ID of the room for recording and `${Random}` is a random string. The ID must be an unused ID in the SDK. The recording service uses the user ID to enter the room for audio, video, and whiteboard recording. If this ID is already used in the SDK, the SDK and recording service will conflict, affecting the recording operation.

Returns:

RecordUserId User ID used by the recording service for entering a room. The ID cannot exceed 60 bytes in length. Its format is `tic_record_user_${RoomId}_${Random}`, where `${RoomId}` indicates the ID of the room for recording and `${Random}` is a random string. The ID must be an unused ID in the SDK. The recording service uses the user ID to enter the room for audio, video, and whiteboard recording. If this ID is already used in the SDK, the SDK and recording service will conflict, affecting the recording operation.

setRecordUserId

public void setRecordUserId(String RecordUserId)

Set User ID used by the recording service for entering a room. The ID cannot exceed 60 bytes in length. Its format is `tic_record_user_${RoomId}_${Random}`, where `${RoomId}` indicates the ID of the room for recording and `${Random}` is a random string. The ID must be an unused ID in the SDK. The recording service uses the user ID to enter the room for audio, video, and whiteboard recording. If this ID is already used in the SDK, the SDK and recording service will conflict, affecting the recording operation.

Parameters:

RecordUserId - User ID used by the recording service for entering a room. The ID cannot exceed 60 bytes in length. Its format is `tic_record_user_${RoomId}_${Random}`, where `${RoomId}` indicates the ID of the room for recording and `${Random}` is a random string. The ID must be an unused ID in the SDK. The recording service uses the user ID to enter the room for audio, video, and whiteboard recording. If this ID is already used in the SDK, the SDK and recording service will conflict, affecting the recording operation.

getRecordUserSig

public String getRecordUserSig()

Get Signature corresponding to RecordUserId

Returns:

RecordUserSig Signature corresponding to RecordUserId

setRecordUserSig

public void setRecordUserSig(String RecordUserSig)

Set Signature corresponding to RecordUserId

Parameters:

RecordUserSig - Signature corresponding to RecordUserId

getGroupId

public String getGroupId()

Get (Disused) IM group ID of the whiteboard. By default, it is the same as the room ID.

Returns:

GroupId (Disused) IM group ID of the whiteboard. By default, it is the same as the room ID.

setGroupId

public void setGroupId(String GroupId)

Set (Disused) IM group ID of the whiteboard. By default, it is the same as the room ID.

Parameters:

GroupId - (Disused) IM group ID of the whiteboard. By default, it is the same as the room ID.

getConcat

public Concat getConcat()

Get Real-time recording video splicing parameter

Returns:

Concat Real-time recording video splicing parameter

setConcat

public void setConcat(Concat Concat)

Set Real-time recording video splicing parameter

Parameters:

Concat - Real-time recording video splicing parameter

getWhiteboard

public Whiteboard getWhiteboard()

Get Real-time recording whiteboard parameter, such as the whiteboard width and height

Returns:

Whiteboard Real-time recording whiteboard parameter, such as the whiteboard width and height

setWhiteboard

public void setWhiteboard(Whiteboard Whiteboard)

Set Real-time recording whiteboard parameter, such as the whiteboard width and height

Parameters:

Whiteboard - Real-time recording whiteboard parameter, such as the whiteboard width and height

getMixStream

public MixStream getMixStream()

Get Real-time recording stream mixing parameter Notes: 1. The stream mixing feature needs to be enabled separately. If you need the feature, contact TIW customer service. 2. To use the stream mixing feature, the Extras parameter is required and must contain "MIX_STREAM".

Returns:

MixStream Real-time recording stream mixing parameter Notes: 1. The stream mixing feature needs to be enabled separately. If you need the feature, contact TIW customer service. 2. To use the stream mixing feature, the Extras parameter is required and must contain "MIX_STREAM".

setMixStream

public void setMixStream(MixStream MixStream)

Set Real-time recording stream mixing parameter Notes: 1. The stream mixing feature needs to be enabled separately. If you need the feature, contact TIW customer service. 2. To use the stream mixing feature, the Extras parameter is required and must contain "MIX_STREAM".

Parameters:

MixStream - Real-time recording stream mixing parameter Notes: 1. The stream mixing feature needs to be enabled separately. If you need the feature, contact TIW customer service. 2. To use the stream mixing feature, the Extras parameter is required and must contain "MIX_STREAM".

getExtras

public String[] getExtras()

Get List of advanced features used List of possible values: MIX_STREAM - Stream mixing feature

Returns:

Extras List of advanced features used List of possible values: MIX_STREAM - Stream mixing feature

setExtras

public void setExtras(String[] Extras)

Set List of advanced features used List of possible values: MIX_STREAM - Stream mixing feature

Parameters:

Extras - List of advanced features used List of possible values: MIX_STREAM - Stream mixing feature

getAudioFileNeeded

public Boolean getAudioFileNeeded()

Get Whether to return the audio-only recording file of different streams in the result callback. The file format is mp3.

Returns:

AudioFileNeeded Whether to return the audio-only recording file of different streams in the result callback. The file format is mp3.

setAudioFileNeeded

public void setAudioFileNeeded(Boolean AudioFileNeeded)

Set Whether to return the audio-only recording file of different streams in the result callback. The file format is mp3.

Parameters:

AudioFileNeeded - Whether to return the audio-only recording file of different streams in the result callback. The file format is mp3.

getRecordControl

public RecordControl getRecordControl()

Get A group of real-time recording parameters. It specifies the streams to be recorded, whether to disable the audio recording, and whether to record only low-resolution videos, etc.

Returns:

RecordControl A group of real-time recording parameters. It specifies the streams to be recorded, whether to disable the audio recording, and whether to record only low-resolution videos, etc.

setRecordControl

public void setRecordControl(RecordControl RecordControl)

Set A group of real-time recording parameters. It specifies the streams to be recorded, whether to disable the audio recording, and whether to record only low-resolution videos, etc.

Parameters:

RecordControl - A group of real-time recording parameters. It specifies the streams to be recorded, whether to disable the audio recording, and whether to record only low-resolution videos, etc.

getRecordMode

public String getRecordMode()

Get

Returns:

RecordMode

setRecordMode

public void setRecordMode(String RecordMode)

Set

Parameters:

RecordMode -

getChatGroupId

public String getChatGroupId()

Get

Returns:

ChatGroupId

setChatGroupId

public void setChatGroupId(String ChatGroupId)

Set

Parameters:

ChatGroupId -

getAutoStopTimeout

public Long getAutoStopTimeout()

Get Recording timeout. Unit: seconds. Valid range: [300,86400]. Default value: 300. If no upstream audio/video exists or no operation is performed on the whiteboard for the specified period of time, the recording service automatically stops the recording task.

Returns:

AutoStopTimeout Recording timeout. Unit: seconds. Valid range: [300,86400]. Default value: 300. If no upstream audio/video exists or no operation is performed on the whiteboard for the specified period of time, the recording service automatically stops the recording task.

setAutoStopTimeout

public void setAutoStopTimeout(Long AutoStopTimeout)

Set Recording timeout. Unit: seconds. Valid range: [300,86400]. Default value: 300. If no upstream audio/video exists or no operation is performed on the whiteboard for the specified period of time, the recording service automatically stops the recording task.

Parameters:

AutoStopTimeout - Recording timeout. Unit: seconds. Valid range: [300,86400]. Default value: 300. If no upstream audio/video exists or no operation is performed on the whiteboard for the specified period of time, the recording service automatically stops the recording task.

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.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel