com.tencentcloudapi.live.v20180801.models

Class RecordParam

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.live.v20180801.models.RecordParam

public class RecordParam
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
RecordParam()
RecordParam(RecordParam 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	getClassId() Get VOD subapplication category Note: this field may return `null`, indicating that no valid value is obtained.
Long	getEnable() Get Whether to enable recording in the current format.
String	getProcedure() Get Task flow Note: this field may return `null`, indicating that no valid value is obtained.
Long	getRecordInterval() Get Max recording time per file Default value: `1800` (seconds) Value range: 30-7200 This parameter is invalid for HLS.
String	getStorageMode() Get Video storage class.
Long	getStorageTime() Get Storage duration of the recording file Value range: 0-129600000 seconds (0-1500 days) `0`: permanent
String	getVodFileName() Get Recording filename.
Long	getVodSubAppId() Get VOD subapplication ID.
void	setClassId(Long ClassId) Set VOD subapplication category Note: this field may return `null`, indicating that no valid value is obtained.
void	setEnable(Long Enable) Set Whether to enable recording in the current format.
void	setProcedure(String Procedure) Set Task flow Note: this field may return `null`, indicating that no valid value is obtained.
void	setRecordInterval(Long RecordInterval) Set Max recording time per file Default value: `1800` (seconds) Value range: 30-7200 This parameter is invalid for HLS.
void	setStorageMode(String StorageMode) Set Video storage class.
void	setStorageTime(Long StorageTime) Set Storage duration of the recording file Value range: 0-129600000 seconds (0-1500 days) `0`: permanent
void	setVodFileName(String VodFileName) Set Recording filename.
void	setVodSubAppId(Long VodSubAppId) Set VOD subapplication ID.
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

RecordParam

public RecordParam()

RecordParam

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

getRecordInterval

public Long getRecordInterval()

Get Max recording time per file Default value: `1800` (seconds) Value range: 30-7200 This parameter is invalid for HLS. Only one HLS file will be generated from push start to push end.

Returns:

RecordInterval Max recording time per file Default value: `1800` (seconds) Value range: 30-7200 This parameter is invalid for HLS. Only one HLS file will be generated from push start to push end.

setRecordInterval

public void setRecordInterval(Long RecordInterval)

Set Max recording time per file Default value: `1800` (seconds) Value range: 30-7200 This parameter is invalid for HLS. Only one HLS file will be generated from push start to push end.

Parameters:

RecordInterval - Max recording time per file Default value: `1800` (seconds) Value range: 30-7200 This parameter is invalid for HLS. Only one HLS file will be generated from push start to push end.

getStorageTime

public Long getStorageTime()

Get Storage duration of the recording file Value range: 0-129600000 seconds (0-1500 days) `0`: permanent

Returns:

StorageTime Storage duration of the recording file Value range: 0-129600000 seconds (0-1500 days) `0`: permanent

setStorageTime

public void setStorageTime(Long StorageTime)

Set Storage duration of the recording file Value range: 0-129600000 seconds (0-1500 days) `0`: permanent

Parameters:

StorageTime - Storage duration of the recording file Value range: 0-129600000 seconds (0-1500 days) `0`: permanent

getEnable

public Long getEnable()

Get Whether to enable recording in the current format. Default value: 0. 0: no, 1: yes.

Returns:

Enable Whether to enable recording in the current format. Default value: 0. 0: no, 1: yes.

setEnable

public void setEnable(Long Enable)

Set Whether to enable recording in the current format. Default value: 0. 0: no, 1: yes.

Parameters:

Enable - Whether to enable recording in the current format. Default value: 0. 0: no, 1: yes.

getVodSubAppId

public Long getVodSubAppId()

Get VOD subapplication ID.

Returns:

VodSubAppId VOD subapplication ID.

setVodSubAppId

public void setVodSubAppId(Long VodSubAppId)

Set VOD subapplication ID.

Parameters:

VodSubAppId - VOD subapplication ID.

getVodFileName

public String getVodFileName()

Get Recording filename. Supported special placeholders include: {StreamID}: stream ID {StartYear}: start time - year {StartMonth}: start time - month {StartDay}: start time - day {StartHour}: start time - hour {StartMinute}: start time - minute {StartSecond}: start time - second {StartMillisecond}: start time - millisecond {EndYear}: end time - year {EndMonth}: end time - month {EndDay}: end time - day {EndHour}: end time - hour {EndMinute}: end time - minute {EndSecond}: end time - second {EndMillisecond}: end time - millisecond If this parameter is not set, the recording filename will be `{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}` by default

Returns:

VodFileName Recording filename. Supported special placeholders include: {StreamID}: stream ID {StartYear}: start time - year {StartMonth}: start time - month {StartDay}: start time - day {StartHour}: start time - hour {StartMinute}: start time - minute {StartSecond}: start time - second {StartMillisecond}: start time - millisecond {EndYear}: end time - year {EndMonth}: end time - month {EndDay}: end time - day {EndHour}: end time - hour {EndMinute}: end time - minute {EndSecond}: end time - second {EndMillisecond}: end time - millisecond If this parameter is not set, the recording filename will be `{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}` by default

setVodFileName

public void setVodFileName(String VodFileName)

Set Recording filename. Supported special placeholders include: {StreamID}: stream ID {StartYear}: start time - year {StartMonth}: start time - month {StartDay}: start time - day {StartHour}: start time - hour {StartMinute}: start time - minute {StartSecond}: start time - second {StartMillisecond}: start time - millisecond {EndYear}: end time - year {EndMonth}: end time - month {EndDay}: end time - day {EndHour}: end time - hour {EndMinute}: end time - minute {EndSecond}: end time - second {EndMillisecond}: end time - millisecond If this parameter is not set, the recording filename will be `{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}` by default

Parameters:

VodFileName - Recording filename. Supported special placeholders include: {StreamID}: stream ID {StartYear}: start time - year {StartMonth}: start time - month {StartDay}: start time - day {StartHour}: start time - hour {StartMinute}: start time - minute {StartSecond}: start time - second {StartMillisecond}: start time - millisecond {EndYear}: end time - year {EndMonth}: end time - month {EndDay}: end time - day {EndHour}: end time - hour {EndMinute}: end time - minute {EndSecond}: end time - second {EndMillisecond}: end time - millisecond If this parameter is not set, the recording filename will be `{StreamID}_{StartYear}-{StartMonth}-{StartDay}-{StartHour}-{StartMinute}-{StartSecond}_{EndYear}-{EndMonth}-{EndDay}-{EndHour}-{EndMinute}-{EndSecond}` by default

getProcedure

public String getProcedure()

Get Task flow Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

Procedure Task flow Note: this field may return `null`, indicating that no valid value is obtained.

setProcedure

public void setProcedure(String Procedure)

Set Task flow Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

Procedure - Task flow Note: this field may return `null`, indicating that no valid value is obtained.

getStorageMode

public String getStorageMode()

Get Video storage class. Valid values: `normal`: STANDARD `cold`: STANDARD_IA Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

StorageMode Video storage class. Valid values: `normal`: STANDARD `cold`: STANDARD_IA Note: this field may return `null`, indicating that no valid value is obtained.

setStorageMode

public void setStorageMode(String StorageMode)

Set Video storage class. Valid values: `normal`: STANDARD `cold`: STANDARD_IA Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

StorageMode - Video storage class. Valid values: `normal`: STANDARD `cold`: STANDARD_IA Note: this field may return `null`, indicating that no valid value is obtained.

getClassId

public Long getClassId()

Get VOD subapplication category Note: this field may return `null`, indicating that no valid value is obtained.

Returns:

ClassId VOD subapplication category Note: this field may return `null`, indicating that no valid value is obtained.

setClassId

public void setClassId(Long ClassId)

Set VOD subapplication category Note: this field may return `null`, indicating that no valid value is obtained.

Parameters:

ClassId - VOD subapplication category Note: this field may return `null`, indicating that no valid value is obtained.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel