com.tencentcloudapi.trtc.v20190722.models

Class StartWebRecordRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.StartWebRecordRequest

public class StartWebRecordRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
StartWebRecordRequest()
StartWebRecordRequest(StartWebRecordRequest 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
EmulateMobileParams	getEmulateMobileParams() Get Render mobile mode parameters; do not set this parameter if you are not going to render mobile mode pages.
Long	getMaxDurationLimit() Get Maximum recording duration limit, in seconds.
McuPublishCdnParam[]	getPublishCdnParams() Get If you want to push the stream to a CDN, you can use the PublishCdnParams.N parameter to set it.
Long	getReadyTimeout() Get The timeout for loading page resources during recording, in seconds.
String	getRecordId() Get When sensitive to repetitive tasks, please pay attention to this value: To avoid tasks being initiated repeatedly in a short period, leading to task duplication, pass in the recording RecordId to identify the current task.
String	getRecordUrl() Get URL of the web page to be recorded
Long	getSdkAppId() Get [Required] The SDKAppID of the TRTC room
StorageParams	getStorageParams() Get [Required] Parameters related to cloud storage.
WebRecordVideoParams	getWebRecordVideoParams() Get web-page recording video parameters
void	setEmulateMobileParams(EmulateMobileParams EmulateMobileParams) Set Render mobile mode parameters; do not set this parameter if you are not going to render mobile mode pages.
void	setMaxDurationLimit(Long MaxDurationLimit) Set Maximum recording duration limit, in seconds.
void	setPublishCdnParams(McuPublishCdnParam[] PublishCdnParams) Set If you want to push the stream to a CDN, you can use the PublishCdnParams.N parameter to set it.
void	setReadyTimeout(Long ReadyTimeout) Set The timeout for loading page resources during recording, in seconds.
void	setRecordId(String RecordId) Set When sensitive to repetitive tasks, please pay attention to this value: To avoid tasks being initiated repeatedly in a short period, leading to task duplication, pass in the recording RecordId to identify the current task.
void	setRecordUrl(String RecordUrl) Set URL of the web page to be recorded
void	setSdkAppId(Long SdkAppId) Set [Required] The SDKAppID of the TRTC room
void	setStorageParams(StorageParams StorageParams) Set [Required] Parameters related to cloud storage.
void	setWebRecordVideoParams(WebRecordVideoParams WebRecordVideoParams) Set web-page recording video parameters
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, isStream, 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

StartWebRecordRequest

public StartWebRecordRequest()

StartWebRecordRequest

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

getRecordUrl

public String getRecordUrl()

Get URL of the web page to be recorded

Returns:

RecordUrl URL of the web page to be recorded

setRecordUrl

public void setRecordUrl(String RecordUrl)

Set URL of the web page to be recorded

Parameters:

RecordUrl - URL of the web page to be recorded

getMaxDurationLimit

public Long getMaxDurationLimit()

Get Maximum recording duration limit, in seconds. Valid range: [1800, 36000]. Default is 36,000 seconds (10 hours).

Returns:

MaxDurationLimit Maximum recording duration limit, in seconds. Valid range: [1800, 36000]. Default is 36,000 seconds (10 hours).

setMaxDurationLimit

public void setMaxDurationLimit(Long MaxDurationLimit)

Set Maximum recording duration limit, in seconds. Valid range: [1800, 36000]. Default is 36,000 seconds (10 hours).

Parameters:

MaxDurationLimit - Maximum recording duration limit, in seconds. Valid range: [1800, 36000]. Default is 36,000 seconds (10 hours).

getStorageParams

public StorageParams getStorageParams()

Get [Required] Parameters related to cloud storage. Currently, Tencent Cloud Object Storage and Tencent Cloud VOD are supported, but third-party cloud storage is not supported. The storage format of the output file only supports hls or mp4.

Returns:

StorageParams [Required] Parameters related to cloud storage. Currently, Tencent Cloud Object Storage and Tencent Cloud VOD are supported, but third-party cloud storage is not supported. The storage format of the output file only supports hls or mp4.

setStorageParams

public void setStorageParams(StorageParams StorageParams)

Set [Required] Parameters related to cloud storage. Currently, Tencent Cloud Object Storage and Tencent Cloud VOD are supported, but third-party cloud storage is not supported. The storage format of the output file only supports hls or mp4.

Parameters:

StorageParams - [Required] Parameters related to cloud storage. Currently, Tencent Cloud Object Storage and Tencent Cloud VOD are supported, but third-party cloud storage is not supported. The storage format of the output file only supports hls or mp4.

getWebRecordVideoParams

public WebRecordVideoParams getWebRecordVideoParams()

Get web-page recording video parameters

Returns:

WebRecordVideoParams web-page recording video parameters

setWebRecordVideoParams

public void setWebRecordVideoParams(WebRecordVideoParams WebRecordVideoParams)

Set web-page recording video parameters

Parameters:

WebRecordVideoParams - web-page recording video parameters

getSdkAppId

public Long getSdkAppId()

Get [Required] The SDKAppID of the TRTC room

Returns:

SdkAppId [Required] The SDKAppID of the TRTC room

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set [Required] The SDKAppID of the TRTC room

Parameters:

SdkAppId - [Required] The SDKAppID of the TRTC room

getRecordId

public String getRecordId()

Get When sensitive to repetitive tasks, please pay attention to this value: To avoid tasks being initiated repeatedly in a short period, leading to task duplication, pass in the recording RecordId to identify the current task. The RecordId should be less than 32 bytes. If you carry the RecordId and initiate the start recording request more than once, only one task will be started, and the second one will report the error FailedOperation.TaskExist. Note that if the StartWebRecord call fails with an error other than FailedOperation.TaskExist, please change the RecordId and initiate the request again.

Returns:

RecordId When sensitive to repetitive tasks, please pay attention to this value: To avoid tasks being initiated repeatedly in a short period, leading to task duplication, pass in the recording RecordId to identify the current task. The RecordId should be less than 32 bytes. If you carry the RecordId and initiate the start recording request more than once, only one task will be started, and the second one will report the error FailedOperation.TaskExist. Note that if the StartWebRecord call fails with an error other than FailedOperation.TaskExist, please change the RecordId and initiate the request again.

setRecordId

public void setRecordId(String RecordId)

Set When sensitive to repetitive tasks, please pay attention to this value: To avoid tasks being initiated repeatedly in a short period, leading to task duplication, pass in the recording RecordId to identify the current task. The RecordId should be less than 32 bytes. If you carry the RecordId and initiate the start recording request more than once, only one task will be started, and the second one will report the error FailedOperation.TaskExist. Note that if the StartWebRecord call fails with an error other than FailedOperation.TaskExist, please change the RecordId and initiate the request again.

Parameters:

RecordId - When sensitive to repetitive tasks, please pay attention to this value: To avoid tasks being initiated repeatedly in a short period, leading to task duplication, pass in the recording RecordId to identify the current task. The RecordId should be less than 32 bytes. If you carry the RecordId and initiate the start recording request more than once, only one task will be started, and the second one will report the error FailedOperation.TaskExist. Note that if the StartWebRecord call fails with an error other than FailedOperation.TaskExist, please change the RecordId and initiate the request again.

getPublishCdnParams

public McuPublishCdnParam[] getPublishCdnParams()

Get If you want to push the stream to a CDN, you can use the PublishCdnParams.N parameter to set it. It supports pushing streams to up to 10 CDN addresses simultaneously. If the relay address is a Tencent Cloud CDN, please explicitly set IsTencentCdn to 1.

Returns:

PublishCdnParams If you want to push the stream to a CDN, you can use the PublishCdnParams.N parameter to set it. It supports pushing streams to up to 10 CDN addresses simultaneously. If the relay address is a Tencent Cloud CDN, please explicitly set IsTencentCdn to 1.

setPublishCdnParams

public void setPublishCdnParams(McuPublishCdnParam[] PublishCdnParams)

Set If you want to push the stream to a CDN, you can use the PublishCdnParams.N parameter to set it. It supports pushing streams to up to 10 CDN addresses simultaneously. If the relay address is a Tencent Cloud CDN, please explicitly set IsTencentCdn to 1.

Parameters:

PublishCdnParams - If you want to push the stream to a CDN, you can use the PublishCdnParams.N parameter to set it. It supports pushing streams to up to 10 CDN addresses simultaneously. If the relay address is a Tencent Cloud CDN, please explicitly set IsTencentCdn to 1.

getReadyTimeout

public Long getReadyTimeout()

Get The timeout for loading page resources during recording, in seconds. The default value is 0 seconds. This value must be greater than or equal to 0 seconds and less than or equal to 60 seconds. If page load timeout detection is not enabled for the recording page, please do not set this parameter.

Returns:

ReadyTimeout The timeout for loading page resources during recording, in seconds. The default value is 0 seconds. This value must be greater than or equal to 0 seconds and less than or equal to 60 seconds. If page load timeout detection is not enabled for the recording page, please do not set this parameter.

setReadyTimeout

public void setReadyTimeout(Long ReadyTimeout)

Set The timeout for loading page resources during recording, in seconds. The default value is 0 seconds. This value must be greater than or equal to 0 seconds and less than or equal to 60 seconds. If page load timeout detection is not enabled for the recording page, please do not set this parameter.

Parameters:

ReadyTimeout - The timeout for loading page resources during recording, in seconds. The default value is 0 seconds. This value must be greater than or equal to 0 seconds and less than or equal to 60 seconds. If page load timeout detection is not enabled for the recording page, please do not set this parameter.

getEmulateMobileParams

public EmulateMobileParams getEmulateMobileParams()

Get Render mobile mode parameters; do not set this parameter if you are not going to render mobile mode pages.

Returns:

EmulateMobileParams Render mobile mode parameters; do not set this parameter if you are not going to render mobile mode pages.

setEmulateMobileParams

public void setEmulateMobileParams(EmulateMobileParams EmulateMobileParams)

Set Render mobile mode parameters; do not set this parameter if you are not going to render mobile mode pages.

Parameters:

EmulateMobileParams - Render mobile mode parameters; do not set this parameter if you are not going to render mobile mode pages.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.