com.tencentcloudapi.trtc.v20190722.models

Class CreateCloudRecordingRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.CreateCloudRecordingRequest

public class CreateCloudRecordingRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
CreateCloudRecordingRequest()
CreateCloudRecordingRequest(CreateCloudRecordingRequest 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
MixLayoutParams	getMixLayoutParams() Get The layout parameters, which are valid if the mixed-stream recording mode is used.
MixTranscodeParams	getMixTranscodeParams() Get The stream mixing parameters, which are valid if the mixed-stream recording mode is used.
String	getPrivateMapKey() Get The permission ticket for a TRTC room.
RecordParams	getRecordParams() Get The on-cloud recording parameters.
Long	getResourceExpiredHour() Get The amount of time (in hours) during which API requests can be made after recording starts.
String	getRoomId() Get The [room ID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.
Long	getRoomIdType() Get The type of the TRTC room ID, which must be the same as the ID type of the room whose streams are recorded.
Long	getSdkAppId() Get The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.
StorageParams	getStorageParams() Get The storage information of the recording file.
String	getUserId() Get The [user ID](https://www.tencentcloud.com/document/product/647/37714#userid) of the recording robot in the TRTC room, which cannot be identical to the user IDs of anchors in the room or other recording robots.
String	getUserSig() Get The signature (similar to a login password) required for the recording robot to enter the room.
void	setMixLayoutParams(MixLayoutParams MixLayoutParams) Set The layout parameters, which are valid if the mixed-stream recording mode is used.
void	setMixTranscodeParams(MixTranscodeParams MixTranscodeParams) Set The stream mixing parameters, which are valid if the mixed-stream recording mode is used.
void	setPrivateMapKey(String PrivateMapKey) Set The permission ticket for a TRTC room.
void	setRecordParams(RecordParams RecordParams) Set The on-cloud recording parameters.
void	setResourceExpiredHour(Long ResourceExpiredHour) Set The amount of time (in hours) during which API requests can be made after recording starts.
void	setRoomId(String RoomId) Set The [room ID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.
void	setRoomIdType(Long RoomIdType) Set The type of the TRTC room ID, which must be the same as the ID type of the room whose streams are recorded.
void	setSdkAppId(Long SdkAppId) Set The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.
void	setStorageParams(StorageParams StorageParams) Set The storage information of the recording file.
void	setUserId(String UserId) Set The [user ID](https://www.tencentcloud.com/document/product/647/37714#userid) of the recording robot in the TRTC room, which cannot be identical to the user IDs of anchors in the room or other recording robots.
void	setUserSig(String UserSig) Set The signature (similar to a login password) required for the recording robot 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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateCloudRecordingRequest

public CreateCloudRecordingRequest()

CreateCloudRecordingRequest

public CreateCloudRecordingRequest(CreateCloudRecordingRequest 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 The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.

Returns:

SdkAppId The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.

Parameters:

SdkAppId - The [SDKAppID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.

getRoomId

public String getRoomId()

Get The [room ID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.

Returns:

RoomId The [room ID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.

setRoomId

public void setRoomId(String RoomId)

Set The [room ID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.

Parameters:

RoomId - The [room ID](https://intl.cloud.tencent.com/document/product/647/37714) of the TRTC room whose streams are recorded.

getUserId

public String getUserId()

Get The [user ID](https://www.tencentcloud.com/document/product/647/37714#userid) of the recording robot in the TRTC room, which cannot be identical to the user IDs of anchors in the room or other recording robots. To distinguish this user ID from others, we recommend you include the room ID in the user ID.

Returns:

UserId The [user ID](https://www.tencentcloud.com/document/product/647/37714#userid) of the recording robot in the TRTC room, which cannot be identical to the user IDs of anchors in the room or other recording robots. To distinguish this user ID from others, we recommend you include the room ID in the user ID.

setUserId

public void setUserId(String UserId)

Set The [user ID](https://www.tencentcloud.com/document/product/647/37714#userid) of the recording robot in the TRTC room, which cannot be identical to the user IDs of anchors in the room or other recording robots. To distinguish this user ID from others, we recommend you include the room ID in the user ID.

Parameters:

UserId - The [user ID](https://www.tencentcloud.com/document/product/647/37714#userid) of the recording robot in the TRTC room, which cannot be identical to the user IDs of anchors in the room or other recording robots. To distinguish this user ID from others, we recommend you include the room ID in the user ID.

getUserSig

public String getUserSig()

Get The signature (similar to a login password) required for the recording robot to enter the room. Each user ID corresponds to a signature. For information on how to calculate the signature, see [What is UserSig?](https://intl.cloud.tencent.com/document/product/647/38104).

Returns:

UserSig The signature (similar to a login password) required for the recording robot to enter the room. Each user ID corresponds to a signature. For information on how to calculate the signature, see [What is UserSig?](https://intl.cloud.tencent.com/document/product/647/38104).

setUserSig

public void setUserSig(String UserSig)

Set The signature (similar to a login password) required for the recording robot to enter the room. Each user ID corresponds to a signature. For information on how to calculate the signature, see [What is UserSig?](https://intl.cloud.tencent.com/document/product/647/38104).

Parameters:

UserSig - The signature (similar to a login password) required for the recording robot to enter the room. Each user ID corresponds to a signature. For information on how to calculate the signature, see [What is UserSig?](https://intl.cloud.tencent.com/document/product/647/38104).

getRecordParams

public RecordParams getRecordParams()

Get The on-cloud recording parameters.

Returns:

RecordParams The on-cloud recording parameters.

setRecordParams

public void setRecordParams(RecordParams RecordParams)

Set The on-cloud recording parameters.

Parameters:

RecordParams - The on-cloud recording parameters.

getStorageParams

public StorageParams getStorageParams()

Get The storage information of the recording file. Currently, you can save recording files to Tencent Cloud VOD or COS.

Returns:

StorageParams The storage information of the recording file. Currently, you can save recording files to Tencent Cloud VOD or COS.

setStorageParams

public void setStorageParams(StorageParams StorageParams)

Set The storage information of the recording file. Currently, you can save recording files to Tencent Cloud VOD or COS.

Parameters:

StorageParams - The storage information of the recording file. Currently, you can save recording files to Tencent Cloud VOD or COS.

getRoomIdType

public Long getRoomIdType()

Get The type of the TRTC room ID, which must be the same as the ID type of the room whose streams are recorded. 0: String 1: 32-bit integer (default)

Returns:

RoomIdType The type of the TRTC room ID, which must be the same as the ID type of the room whose streams are recorded. 0: String 1: 32-bit integer (default)

setRoomIdType

public void setRoomIdType(Long RoomIdType)

Set The type of the TRTC room ID, which must be the same as the ID type of the room whose streams are recorded. 0: String 1: 32-bit integer (default)

Parameters:

RoomIdType - The type of the TRTC room ID, which must be the same as the ID type of the room whose streams are recorded. 0: String 1: 32-bit integer (default)

getMixTranscodeParams

public MixTranscodeParams getMixTranscodeParams()

Get The stream mixing parameters, which are valid if the mixed-stream recording mode is used.

Returns:

MixTranscodeParams The stream mixing parameters, which are valid if the mixed-stream recording mode is used.

setMixTranscodeParams

public void setMixTranscodeParams(MixTranscodeParams MixTranscodeParams)

Set The stream mixing parameters, which are valid if the mixed-stream recording mode is used.

Parameters:

MixTranscodeParams - The stream mixing parameters, which are valid if the mixed-stream recording mode is used.

getMixLayoutParams

public MixLayoutParams getMixLayoutParams()

Get The layout parameters, which are valid if the mixed-stream recording mode is used.

Returns:

MixLayoutParams The layout parameters, which are valid if the mixed-stream recording mode is used.

setMixLayoutParams

public void setMixLayoutParams(MixLayoutParams MixLayoutParams)

Set The layout parameters, which are valid if the mixed-stream recording mode is used.

Parameters:

MixLayoutParams - The layout parameters, which are valid if the mixed-stream recording mode is used.

getResourceExpiredHour

public Long getResourceExpiredHour()

Get The amount of time (in hours) during which API requests can be made after recording starts. Calculation starts when a recording task is started (when the recording task ID is returned). Once the period elapses, the query, modification, and stop recording APIs can no longer be called, but the recording task will continue. The default value is `72` (three days), and the maximum and minimum values allowed are `720` (30 days) and `6` respectively. If you do not set this parameter, the query, modification, and stop recording APIs can be called within 72 hours after recording starts.

Returns:

ResourceExpiredHour The amount of time (in hours) during which API requests can be made after recording starts. Calculation starts when a recording task is started (when the recording task ID is returned). Once the period elapses, the query, modification, and stop recording APIs can no longer be called, but the recording task will continue. The default value is `72` (three days), and the maximum and minimum values allowed are `720` (30 days) and `6` respectively. If you do not set this parameter, the query, modification, and stop recording APIs can be called within 72 hours after recording starts.

setResourceExpiredHour

public void setResourceExpiredHour(Long ResourceExpiredHour)

Set The amount of time (in hours) during which API requests can be made after recording starts. Calculation starts when a recording task is started (when the recording task ID is returned). Once the period elapses, the query, modification, and stop recording APIs can no longer be called, but the recording task will continue. The default value is `72` (three days), and the maximum and minimum values allowed are `720` (30 days) and `6` respectively. If you do not set this parameter, the query, modification, and stop recording APIs can be called within 72 hours after recording starts.

Parameters:

ResourceExpiredHour - The amount of time (in hours) during which API requests can be made after recording starts. Calculation starts when a recording task is started (when the recording task ID is returned). Once the period elapses, the query, modification, and stop recording APIs can no longer be called, but the recording task will continue. The default value is `72` (three days), and the maximum and minimum values allowed are `720` (30 days) and `6` respectively. If you do not set this parameter, the query, modification, and stop recording APIs can be called within 72 hours after recording starts.

getPrivateMapKey

public String getPrivateMapKey()

Get The permission ticket for a TRTC room. This parameter is required if advanced permission control is enabled in the console, in which case the TRTC backend will verify users’ [PrivateMapKey](https://intl.cloud.tencent.com/document/product/647/32240?from_cn_redirect=1), which include an encrypted room ID and permission bit list. A user providing only `UserSig` and not `PrivateMapKey` will be unable to enter the room.

Returns:

PrivateMapKey The permission ticket for a TRTC room. This parameter is required if advanced permission control is enabled in the console, in which case the TRTC backend will verify users’ [PrivateMapKey](https://intl.cloud.tencent.com/document/product/647/32240?from_cn_redirect=1), which include an encrypted room ID and permission bit list. A user providing only `UserSig` and not `PrivateMapKey` will be unable to enter the room.

setPrivateMapKey

public void setPrivateMapKey(String PrivateMapKey)

Set The permission ticket for a TRTC room. This parameter is required if advanced permission control is enabled in the console, in which case the TRTC backend will verify users’ [PrivateMapKey](https://intl.cloud.tencent.com/document/product/647/32240?from_cn_redirect=1), which include an encrypted room ID and permission bit list. A user providing only `UserSig` and not `PrivateMapKey` will be unable to enter the room.

Parameters:

PrivateMapKey - The permission ticket for a TRTC room. This parameter is required if advanced permission control is enabled in the console, in which case the TRTC backend will verify users’ [PrivateMapKey](https://intl.cloud.tencent.com/document/product/647/32240?from_cn_redirect=1), which include an encrypted room ID and permission bit list. A user providing only `UserSig` and not `PrivateMapKey` will be unable to enter 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