com.tencentcloudapi.trtc.v20190722.models

Class McuRecordParams

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.McuRecordParams

public class McuRecordParams
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
McuRecordParams()
McuRecordParams(McuRecordParams 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	getMaxMediaFileDuration() Get [Valid only when UniRecord=3] Single File Duration Corresponds to template parameter "Max File Duration." Unit: minutes.
McuStorageParams	getMcuStorageParams() Get [Valid only when UniRecord=3] Recording Storage Parameters Corresponds to console parameter "Storage Location." Supports Tencent VOD or COS (exclusively).
String[]	getRecordFormat() Get [Valid only when UniRecord=3] Recording Output Formats Corresponds to template parameter "File Format." Supported values: hls, mp4, aac.
String	getRecordKey() Get Recording Task Key Identifies a recording task.
Long	getRecordWaitTime() Get [Valid only when UniRecord=3] Recording Resume Wait Time Corresponds to template parameter "Resume Wait Duration." Unit: seconds.
Long	getStreamType() Get [Valid only when UniRecord=3] Recording Media Type Corresponds to template parameter "Recording Format." 0: Audio+Video, 1: Audio only, 2: Video only.
Long	getUniRecord() Get Relay Recording Mode 0/blank: Not currently supported, behavior undefined.
String	getUserDefineRecordPrefix() Get Recording Filename Prefix Filename prefix (<=64 bytes).
void	setMaxMediaFileDuration(Long MaxMediaFileDuration) Set [Valid only when UniRecord=3] Single File Duration Corresponds to template parameter "Max File Duration." Unit: minutes.
void	setMcuStorageParams(McuStorageParams McuStorageParams) Set [Valid only when UniRecord=3] Recording Storage Parameters Corresponds to console parameter "Storage Location." Supports Tencent VOD or COS (exclusively).
void	setRecordFormat(String[] RecordFormat) Set [Valid only when UniRecord=3] Recording Output Formats Corresponds to template parameter "File Format." Supported values: hls, mp4, aac.
void	setRecordKey(String RecordKey) Set Recording Task Key Identifies a recording task.
void	setRecordWaitTime(Long RecordWaitTime) Set [Valid only when UniRecord=3] Recording Resume Wait Time Corresponds to template parameter "Resume Wait Duration." Unit: seconds.
void	setStreamType(Long StreamType) Set [Valid only when UniRecord=3] Recording Media Type Corresponds to template parameter "Recording Format." 0: Audio+Video, 1: Audio only, 2: Video only.
void	setUniRecord(Long UniRecord) Set Relay Recording Mode 0/blank: Not currently supported, behavior undefined.
void	setUserDefineRecordPrefix(String UserDefineRecordPrefix) Set Recording Filename Prefix Filename prefix (<=64 bytes).
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

McuRecordParams

public McuRecordParams()

McuRecordParams

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

getUniRecord

public Long getUniRecord()

Get Relay Recording Mode 0/blank: Not currently supported, behavior undefined. 1: Disable recording. 2: Start recording (uses console's auto-recording template parameters. Reference: [Link to Documentation]). 3: Start recording (uses API-specified parameters). Example: 2

Returns:

UniRecord Relay Recording Mode 0/blank: Not currently supported, behavior undefined. 1: Disable recording. 2: Start recording (uses console's auto-recording template parameters. Reference: [Link to Documentation]). 3: Start recording (uses API-specified parameters). Example: 2

setUniRecord

public void setUniRecord(Long UniRecord)

Set Relay Recording Mode 0/blank: Not currently supported, behavior undefined. 1: Disable recording. 2: Start recording (uses console's auto-recording template parameters. Reference: [Link to Documentation]). 3: Start recording (uses API-specified parameters). Example: 2

Parameters:

UniRecord - Relay Recording Mode 0/blank: Not currently supported, behavior undefined. 1: Disable recording. 2: Start recording (uses console's auto-recording template parameters. Reference: [Link to Documentation]). 3: Start recording (uses API-specified parameters). Example: 2

getRecordKey

public String getRecordKey()

Get Recording Task Key Identifies a recording task. This parameter allows merging multiple relay tasks into one recording file. If unspecified, only records the current relay task. [Format: Up to 128 bytes; only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-).] Example: test_record_key_a

Returns:

RecordKey Recording Task Key Identifies a recording task. This parameter allows merging multiple relay tasks into one recording file. If unspecified, only records the current relay task. [Format: Up to 128 bytes; only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-).] Example: test_record_key_a

setRecordKey

public void setRecordKey(String RecordKey)

Set Recording Task Key Identifies a recording task. This parameter allows merging multiple relay tasks into one recording file. If unspecified, only records the current relay task. [Format: Up to 128 bytes; only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-).] Example: test_record_key_a

Parameters:

RecordKey - Recording Task Key Identifies a recording task. This parameter allows merging multiple relay tasks into one recording file. If unspecified, only records the current relay task. [Format: Up to 128 bytes; only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-).] Example: test_record_key_a

getRecordWaitTime

public Long getRecordWaitTime()

Get [Valid only when UniRecord=3] Recording Resume Wait Time Corresponds to template parameter "Resume Wait Duration." Unit: seconds. Range: 5-86400 (24 hours). Default: 30. Recording stops if idle longer than this value. Example: 30

Returns:

RecordWaitTime [Valid only when UniRecord=3] Recording Resume Wait Time Corresponds to template parameter "Resume Wait Duration." Unit: seconds. Range: 5-86400 (24 hours). Default: 30. Recording stops if idle longer than this value. Example: 30

setRecordWaitTime

public void setRecordWaitTime(Long RecordWaitTime)

Set [Valid only when UniRecord=3] Recording Resume Wait Time Corresponds to template parameter "Resume Wait Duration." Unit: seconds. Range: 5-86400 (24 hours). Default: 30. Recording stops if idle longer than this value. Example: 30

Parameters:

RecordWaitTime - [Valid only when UniRecord=3] Recording Resume Wait Time Corresponds to template parameter "Resume Wait Duration." Unit: seconds. Range: 5-86400 (24 hours). Default: 30. Recording stops if idle longer than this value. Example: 30

getRecordFormat

public String[] getRecordFormat()

Get [Valid only when UniRecord=3] Recording Output Formats Corresponds to template parameter "File Format." Supported values: hls, mp4, aac. Default: mp4. Note: mp4 and aac formats are mutually exclusive. Example (MP4 only): ["mp4"] Example (MP4 + HLS): ["mp4","hls"]

Returns:

RecordFormat [Valid only when UniRecord=3] Recording Output Formats Corresponds to template parameter "File Format." Supported values: hls, mp4, aac. Default: mp4. Note: mp4 and aac formats are mutually exclusive. Example (MP4 only): ["mp4"] Example (MP4 + HLS): ["mp4","hls"]

setRecordFormat

public void setRecordFormat(String[] RecordFormat)

Set [Valid only when UniRecord=3] Recording Output Formats Corresponds to template parameter "File Format." Supported values: hls, mp4, aac. Default: mp4. Note: mp4 and aac formats are mutually exclusive. Example (MP4 only): ["mp4"] Example (MP4 + HLS): ["mp4","hls"]

Parameters:

RecordFormat - [Valid only when UniRecord=3] Recording Output Formats Corresponds to template parameter "File Format." Supported values: hls, mp4, aac. Default: mp4. Note: mp4 and aac formats are mutually exclusive. Example (MP4 only): ["mp4"] Example (MP4 + HLS): ["mp4","hls"]

getMaxMediaFileDuration

public Long getMaxMediaFileDuration()

Get [Valid only when UniRecord=3] Single File Duration Corresponds to template parameter "Max File Duration." Unit: minutes. Range: 1-1440 (24 hours). Default: 1440. Applies only to mp4/aac. Actual duration is capped at 2GB file size. Example: 1440

Returns:

MaxMediaFileDuration [Valid only when UniRecord=3] Single File Duration Corresponds to template parameter "Max File Duration." Unit: minutes. Range: 1-1440 (24 hours). Default: 1440. Applies only to mp4/aac. Actual duration is capped at 2GB file size. Example: 1440

setMaxMediaFileDuration

public void setMaxMediaFileDuration(Long MaxMediaFileDuration)

Set [Valid only when UniRecord=3] Single File Duration Corresponds to template parameter "Max File Duration." Unit: minutes. Range: 1-1440 (24 hours). Default: 1440. Applies only to mp4/aac. Actual duration is capped at 2GB file size. Example: 1440

Parameters:

MaxMediaFileDuration - [Valid only when UniRecord=3] Single File Duration Corresponds to template parameter "Max File Duration." Unit: minutes. Range: 1-1440 (24 hours). Default: 1440. Applies only to mp4/aac. Actual duration is capped at 2GB file size. Example: 1440

getStreamType

public Long getStreamType()

Get [Valid only when UniRecord=3] Recording Media Type Corresponds to template parameter "Recording Format." 0: Audio+Video, 1: Audio only, 2: Video only. Output is the intersection of this setting and relay content. Example: 0

Returns:

StreamType [Valid only when UniRecord=3] Recording Media Type Corresponds to template parameter "Recording Format." 0: Audio+Video, 1: Audio only, 2: Video only. Output is the intersection of this setting and relay content. Example: 0

setStreamType

public void setStreamType(Long StreamType)

Set [Valid only when UniRecord=3] Recording Media Type Corresponds to template parameter "Recording Format." 0: Audio+Video, 1: Audio only, 2: Video only. Output is the intersection of this setting and relay content. Example: 0

Parameters:

StreamType - [Valid only when UniRecord=3] Recording Media Type Corresponds to template parameter "Recording Format." 0: Audio+Video, 1: Audio only, 2: Video only. Output is the intersection of this setting and relay content. Example: 0

getUserDefineRecordPrefix

public String getUserDefineRecordPrefix()

Get Recording Filename Prefix Filename prefix (<=64 bytes). Applies only to VOD storage. Format: Letters (a-z, A-Z), numbers (0-9), underscores (_), hyphens (-).* Example: mcu_record_prefix

Returns:

UserDefineRecordPrefix Recording Filename Prefix Filename prefix (<=64 bytes). Applies only to VOD storage. Format: Letters (a-z, A-Z), numbers (0-9), underscores (_), hyphens (-).* Example: mcu_record_prefix

setUserDefineRecordPrefix

public void setUserDefineRecordPrefix(String UserDefineRecordPrefix)

Set Recording Filename Prefix Filename prefix (<=64 bytes). Applies only to VOD storage. Format: Letters (a-z, A-Z), numbers (0-9), underscores (_), hyphens (-).* Example: mcu_record_prefix

Parameters:

UserDefineRecordPrefix - Recording Filename Prefix Filename prefix (<=64 bytes). Applies only to VOD storage. Format: Letters (a-z, A-Z), numbers (0-9), underscores (_), hyphens (-).* Example: mcu_record_prefix

getMcuStorageParams

public McuStorageParams getMcuStorageParams()

Get [Valid only when UniRecord=3] Recording Storage Parameters Corresponds to console parameter "Storage Location." Supports Tencent VOD or COS (exclusively). Example: {"McuCloudVod":{"McuTencentVod":{"ExpireTime":86400}}}

Returns:

McuStorageParams [Valid only when UniRecord=3] Recording Storage Parameters Corresponds to console parameter "Storage Location." Supports Tencent VOD or COS (exclusively). Example: {"McuCloudVod":{"McuTencentVod":{"ExpireTime":86400}}}

setMcuStorageParams

public void setMcuStorageParams(McuStorageParams McuStorageParams)

Set [Valid only when UniRecord=3] Recording Storage Parameters Corresponds to console parameter "Storage Location." Supports Tencent VOD or COS (exclusively). Example: {"McuCloudVod":{"McuTencentVod":{"ExpireTime":86400}}}

Parameters:

McuStorageParams - [Valid only when UniRecord=3] Recording Storage Parameters Corresponds to console parameter "Storage Location." Supports Tencent VOD or COS (exclusively). Example: {"McuCloudVod":{"McuTencentVod":{"ExpireTime":86400}}}

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.