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 【仅当UniRecord=3时此参数有效】 单个文件录制时长，对应录制模板“单个录制文件时长”，单位：分钟。该值需大于等于 1，且小于等于 1440(24小时)，默认值为 1440。只对"mp4"或"aac"格式生效。实际单文件录制时长还受单文件大小不超过 2G 限制，超过2G则强制拆分。
McuStorageParams	getMcuStorageParams() Get 【仅当UniRecord=3时此参数有效】 录制文件存储参数，对应控制台“存储位置”及相关参数。目前支持云点播VOD和对象存储COS两种存储方式，只能填写一种。
String[]	getRecordFormat() Get 【仅当UniRecord=3时此参数有效】 录制输出文件格式列表，对应录制模板“文件格式”，支持“hls”、"mp4"、"aac"三种格式，默认值为"mp4"。其中"mp4"和"aac"格式，不能同时指定。 只录制 mp4格式，示例值：["mp4"]。同时录制mp4 和 HLS 格式，示例值：["mp4","hls"]。
String	getRecordKey() Get 录制任务 key，标识一个录制任务；您可以通过该参数，将多个转推任务录制成一个文件。不指定该参数时，只录制当前转推任务。 【限制长度为128字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】
Long	getRecordWaitTime() Get 【仅当UniRecord=3时此参数有效】 续录等待时间，对应录制模板“续录等待时长”，单位：秒。该值需大于等于 5，且小于等于 86400(24小时)，默认值为 30。启用续录时，录制任务空闲超过RecordWaitTime的时长，自动结束。
Long	getStreamType() Get 【仅当UniRecord=3时此参数有效】 录制的音视频类型，对应录制模板“录制格式”，0:音视频，1：纯音频，2：纯视频。最终录制文件内容是录制指定类型和转推内容的交集。
Long	getUniRecord() Get 转推录制模式， 0/不填: 暂不支持，行为未定义； 1: 不开启录制； 2: 开启录制（使用控制台自动录制模板参数，参考：[跳转文档](https://cloud.tencent.com/document/product/647/111748#.E5.BD.95.E5.88.B6.E6.8E.A7.E5.88.B6.E6.96.B9.E6.A1.88)）； 3: 开启录制（使用API指定参数）。
String	getUserDefineRecordPrefix() Get 录制文件名前缀，不超过64字符。只有存储为vod时生效。 【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】
void	setMaxMediaFileDuration(Long MaxMediaFileDuration) Set 【仅当UniRecord=3时此参数有效】 单个文件录制时长，对应录制模板“单个录制文件时长”，单位：分钟。该值需大于等于 1，且小于等于 1440(24小时)，默认值为 1440。只对"mp4"或"aac"格式生效。实际单文件录制时长还受单文件大小不超过 2G 限制，超过2G则强制拆分。
void	setMcuStorageParams(McuStorageParams McuStorageParams) Set 【仅当UniRecord=3时此参数有效】 录制文件存储参数，对应控制台“存储位置”及相关参数。目前支持云点播VOD和对象存储COS两种存储方式，只能填写一种。
void	setRecordFormat(String[] RecordFormat) Set 【仅当UniRecord=3时此参数有效】 录制输出文件格式列表，对应录制模板“文件格式”，支持“hls”、"mp4"、"aac"三种格式，默认值为"mp4"。其中"mp4"和"aac"格式，不能同时指定。 只录制 mp4格式，示例值：["mp4"]。同时录制mp4 和 HLS 格式，示例值：["mp4","hls"]。
void	setRecordKey(String RecordKey) Set 录制任务 key，标识一个录制任务；您可以通过该参数，将多个转推任务录制成一个文件。不指定该参数时，只录制当前转推任务。 【限制长度为128字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】
void	setRecordWaitTime(Long RecordWaitTime) Set 【仅当UniRecord=3时此参数有效】 续录等待时间，对应录制模板“续录等待时长”，单位：秒。该值需大于等于 5，且小于等于 86400(24小时)，默认值为 30。启用续录时，录制任务空闲超过RecordWaitTime的时长，自动结束。
void	setStreamType(Long StreamType) Set 【仅当UniRecord=3时此参数有效】 录制的音视频类型，对应录制模板“录制格式”，0:音视频，1：纯音频，2：纯视频。最终录制文件内容是录制指定类型和转推内容的交集。
void	setUniRecord(Long UniRecord) Set 转推录制模式， 0/不填: 暂不支持，行为未定义； 1: 不开启录制； 2: 开启录制（使用控制台自动录制模板参数，参考：[跳转文档](https://cloud.tencent.com/document/product/647/111748#.E5.BD.95.E5.88.B6.E6.8E.A7.E5.88.B6.E6.96.B9.E6.A1.88)）； 3: 开启录制（使用API指定参数）。
void	setUserDefineRecordPrefix(String UserDefineRecordPrefix) Set 录制文件名前缀，不超过64字符。只有存储为vod时生效。 【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】
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 转推录制模式， 0/不填: 暂不支持，行为未定义； 1: 不开启录制； 2: 开启录制（使用控制台自动录制模板参数，参考：[跳转文档](https://cloud.tencent.com/document/product/647/111748#.E5.BD.95.E5.88.B6.E6.8E.A7.E5.88.B6.E6.96.B9.E6.A1.88)）； 3: 开启录制（使用API指定参数）。

Returns:

UniRecord 转推录制模式， 0/不填: 暂不支持，行为未定义； 1: 不开启录制； 2: 开启录制（使用控制台自动录制模板参数，参考：[跳转文档](https://cloud.tencent.com/document/product/647/111748#.E5.BD.95.E5.88.B6.E6.8E.A7.E5.88.B6.E6.96.B9.E6.A1.88)）； 3: 开启录制（使用API指定参数）。

setUniRecord

public void setUniRecord(Long UniRecord)

Set 转推录制模式， 0/不填: 暂不支持，行为未定义； 1: 不开启录制； 2: 开启录制（使用控制台自动录制模板参数，参考：[跳转文档](https://cloud.tencent.com/document/product/647/111748#.E5.BD.95.E5.88.B6.E6.8E.A7.E5.88.B6.E6.96.B9.E6.A1.88)）； 3: 开启录制（使用API指定参数）。

Parameters:

UniRecord - 转推录制模式， 0/不填: 暂不支持，行为未定义； 1: 不开启录制； 2: 开启录制（使用控制台自动录制模板参数，参考：[跳转文档](https://cloud.tencent.com/document/product/647/111748#.E5.BD.95.E5.88.B6.E6.8E.A7.E5.88.B6.E6.96.B9.E6.A1.88)）； 3: 开启录制（使用API指定参数）。

getRecordKey

public String getRecordKey()

Get 录制任务 key，标识一个录制任务；您可以通过该参数，将多个转推任务录制成一个文件。不指定该参数时，只录制当前转推任务。 【限制长度为128字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】

Returns:

RecordKey 录制任务 key，标识一个录制任务；您可以通过该参数，将多个转推任务录制成一个文件。不指定该参数时，只录制当前转推任务。 【限制长度为128字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】

setRecordKey

public void setRecordKey(String RecordKey)

Set 录制任务 key，标识一个录制任务；您可以通过该参数，将多个转推任务录制成一个文件。不指定该参数时，只录制当前转推任务。 【限制长度为128字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】

Parameters:

RecordKey - 录制任务 key，标识一个录制任务；您可以通过该参数，将多个转推任务录制成一个文件。不指定该参数时，只录制当前转推任务。 【限制长度为128字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】

getRecordWaitTime

public Long getRecordWaitTime()

Get 【仅当UniRecord=3时此参数有效】 续录等待时间，对应录制模板“续录等待时长”，单位：秒。该值需大于等于 5，且小于等于 86400(24小时)，默认值为 30。启用续录时，录制任务空闲超过RecordWaitTime的时长，自动结束。

Returns:

RecordWaitTime 【仅当UniRecord=3时此参数有效】 续录等待时间，对应录制模板“续录等待时长”，单位：秒。该值需大于等于 5，且小于等于 86400(24小时)，默认值为 30。启用续录时，录制任务空闲超过RecordWaitTime的时长，自动结束。

setRecordWaitTime

public void setRecordWaitTime(Long RecordWaitTime)

Set 【仅当UniRecord=3时此参数有效】 续录等待时间，对应录制模板“续录等待时长”，单位：秒。该值需大于等于 5，且小于等于 86400(24小时)，默认值为 30。启用续录时，录制任务空闲超过RecordWaitTime的时长，自动结束。

Parameters:

RecordWaitTime - 【仅当UniRecord=3时此参数有效】 续录等待时间，对应录制模板“续录等待时长”，单位：秒。该值需大于等于 5，且小于等于 86400(24小时)，默认值为 30。启用续录时，录制任务空闲超过RecordWaitTime的时长，自动结束。

getRecordFormat

public String[] getRecordFormat()

Get 【仅当UniRecord=3时此参数有效】 录制输出文件格式列表，对应录制模板“文件格式”，支持“hls”、"mp4"、"aac"三种格式，默认值为"mp4"。其中"mp4"和"aac"格式，不能同时指定。 只录制 mp4格式，示例值：["mp4"]。同时录制mp4 和 HLS 格式，示例值：["mp4","hls"]。

Returns:

RecordFormat 【仅当UniRecord=3时此参数有效】 录制输出文件格式列表，对应录制模板“文件格式”，支持“hls”、"mp4"、"aac"三种格式，默认值为"mp4"。其中"mp4"和"aac"格式，不能同时指定。 只录制 mp4格式，示例值：["mp4"]。同时录制mp4 和 HLS 格式，示例值：["mp4","hls"]。

setRecordFormat

public void setRecordFormat(String[] RecordFormat)

Set 【仅当UniRecord=3时此参数有效】 录制输出文件格式列表，对应录制模板“文件格式”，支持“hls”、"mp4"、"aac"三种格式，默认值为"mp4"。其中"mp4"和"aac"格式，不能同时指定。 只录制 mp4格式，示例值：["mp4"]。同时录制mp4 和 HLS 格式，示例值：["mp4","hls"]。

Parameters:

RecordFormat - 【仅当UniRecord=3时此参数有效】 录制输出文件格式列表，对应录制模板“文件格式”，支持“hls”、"mp4"、"aac"三种格式，默认值为"mp4"。其中"mp4"和"aac"格式，不能同时指定。 只录制 mp4格式，示例值：["mp4"]。同时录制mp4 和 HLS 格式，示例值：["mp4","hls"]。

getMaxMediaFileDuration

public Long getMaxMediaFileDuration()

Get 【仅当UniRecord=3时此参数有效】 单个文件录制时长，对应录制模板“单个录制文件时长”，单位：分钟。该值需大于等于 1，且小于等于 1440(24小时)，默认值为 1440。只对"mp4"或"aac"格式生效。实际单文件录制时长还受单文件大小不超过 2G 限制，超过2G则强制拆分。

Returns:

MaxMediaFileDuration 【仅当UniRecord=3时此参数有效】 单个文件录制时长，对应录制模板“单个录制文件时长”，单位：分钟。该值需大于等于 1，且小于等于 1440(24小时)，默认值为 1440。只对"mp4"或"aac"格式生效。实际单文件录制时长还受单文件大小不超过 2G 限制，超过2G则强制拆分。

setMaxMediaFileDuration

public void setMaxMediaFileDuration(Long MaxMediaFileDuration)

Set 【仅当UniRecord=3时此参数有效】 单个文件录制时长，对应录制模板“单个录制文件时长”，单位：分钟。该值需大于等于 1，且小于等于 1440(24小时)，默认值为 1440。只对"mp4"或"aac"格式生效。实际单文件录制时长还受单文件大小不超过 2G 限制，超过2G则强制拆分。

Parameters:

MaxMediaFileDuration - 【仅当UniRecord=3时此参数有效】 单个文件录制时长，对应录制模板“单个录制文件时长”，单位：分钟。该值需大于等于 1，且小于等于 1440(24小时)，默认值为 1440。只对"mp4"或"aac"格式生效。实际单文件录制时长还受单文件大小不超过 2G 限制，超过2G则强制拆分。

getStreamType

public Long getStreamType()

Get 【仅当UniRecord=3时此参数有效】 录制的音视频类型，对应录制模板“录制格式”，0:音视频，1：纯音频，2：纯视频。最终录制文件内容是录制指定类型和转推内容的交集。

Returns:

StreamType 【仅当UniRecord=3时此参数有效】 录制的音视频类型，对应录制模板“录制格式”，0:音视频，1：纯音频，2：纯视频。最终录制文件内容是录制指定类型和转推内容的交集。

setStreamType

public void setStreamType(Long StreamType)

Set 【仅当UniRecord=3时此参数有效】 录制的音视频类型，对应录制模板“录制格式”，0:音视频，1：纯音频，2：纯视频。最终录制文件内容是录制指定类型和转推内容的交集。

Parameters:

StreamType - 【仅当UniRecord=3时此参数有效】 录制的音视频类型，对应录制模板“录制格式”，0:音视频，1：纯音频，2：纯视频。最终录制文件内容是录制指定类型和转推内容的交集。

getUserDefineRecordPrefix

public String getUserDefineRecordPrefix()

Get 录制文件名前缀，不超过64字符。只有存储为vod时生效。 【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】

Returns:

UserDefineRecordPrefix 录制文件名前缀，不超过64字符。只有存储为vod时生效。 【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】

setUserDefineRecordPrefix

public void setUserDefineRecordPrefix(String UserDefineRecordPrefix)

Set 录制文件名前缀，不超过64字符。只有存储为vod时生效。 【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】

Parameters:

UserDefineRecordPrefix - 录制文件名前缀，不超过64字符。只有存储为vod时生效。 【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线(_)和连词符(-)】

getMcuStorageParams

public McuStorageParams getMcuStorageParams()

Get 【仅当UniRecord=3时此参数有效】 录制文件存储参数，对应控制台“存储位置”及相关参数。目前支持云点播VOD和对象存储COS两种存储方式，只能填写一种。

Returns:

McuStorageParams 【仅当UniRecord=3时此参数有效】 录制文件存储参数，对应控制台“存储位置”及相关参数。目前支持云点播VOD和对象存储COS两种存储方式，只能填写一种。

setMcuStorageParams

public void setMcuStorageParams(McuStorageParams McuStorageParams)

Set 【仅当UniRecord=3时此参数有效】 录制文件存储参数，对应控制台“存储位置”及相关参数。目前支持云点播VOD和对象存储COS两种存储方式，只能填写一种。

Parameters:

McuStorageParams - 【仅当UniRecord=3时此参数有效】 录制文件存储参数，对应控制台“存储位置”及相关参数。目前支持云点播VOD和对象存储COS两种存储方式，只能填写一种。

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel