com.tencentcloudapi.trtc.v20190722.models

Class RecordParams

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.trtc.v20190722.models.RecordParams

public class RecordParams
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
RecordParams()
RecordParams(RecordParams 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	getAvMerge() Get Whether to merge the audio and video of a user in the single-stream recording mode.
Long	getMaxIdleTime() Get The time period (seconds) to wait to automatically stop recording after there are no anchors (users who publish streams) in a room.
Long	getMaxMediaFileDuration() Get The maximum file duration allowed (minutes).
Long	getMediaId() Get The type of stream to record.
Long	getOutputFormat() Get The output format.
Long	getRecordMode() Get The recording mode.
Long	getStreamType() Get The media type of the streams to record.
SubscribeStreamUserIds	getSubscribeStreamUserIds() Get The allowlist/blocklist for stream subscription.
void	setAvMerge(Long AvMerge) Set Whether to merge the audio and video of a user in the single-stream recording mode.
void	setMaxIdleTime(Long MaxIdleTime) Set The time period (seconds) to wait to automatically stop recording after there are no anchors (users who publish streams) in a room.
void	setMaxMediaFileDuration(Long MaxMediaFileDuration) Set The maximum file duration allowed (minutes).
void	setMediaId(Long MediaId) Set The type of stream to record.
void	setOutputFormat(Long OutputFormat) Set The output format.
void	setRecordMode(Long RecordMode) Set The recording mode.
void	setStreamType(Long StreamType) Set The media type of the streams to record.
void	setSubscribeStreamUserIds(SubscribeStreamUserIds SubscribeStreamUserIds) Set The allowlist/blocklist for stream subscription.
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

RecordParams

public RecordParams()

RecordParams

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

getRecordMode

public Long getRecordMode()

Get The recording mode. 1: Single-stream recording. Records the audio and video of each subscribed user (`UserId`) in a room and saves the recording files to the cloud. 2: Mixed-stream recording. Mixes the audios and videos of subscribed users (`UserId`) in a room, records the mixed stream, and saves the recording files to the cloud.

Returns:

RecordMode The recording mode. 1: Single-stream recording. Records the audio and video of each subscribed user (`UserId`) in a room and saves the recording files to the cloud. 2: Mixed-stream recording. Mixes the audios and videos of subscribed users (`UserId`) in a room, records the mixed stream, and saves the recording files to the cloud.

setRecordMode

public void setRecordMode(Long RecordMode)

Set The recording mode. 1: Single-stream recording. Records the audio and video of each subscribed user (`UserId`) in a room and saves the recording files to the cloud. 2: Mixed-stream recording. Mixes the audios and videos of subscribed users (`UserId`) in a room, records the mixed stream, and saves the recording files to the cloud.

Parameters:

RecordMode - The recording mode. 1: Single-stream recording. Records the audio and video of each subscribed user (`UserId`) in a room and saves the recording files to the cloud. 2: Mixed-stream recording. Mixes the audios and videos of subscribed users (`UserId`) in a room, records the mixed stream, and saves the recording files to the cloud.

getMaxIdleTime

public Long getMaxIdleTime()

Get The time period (seconds) to wait to automatically stop recording after there are no anchors (users who publish streams) in a room. Value range: 5-86400 (max 24 hours). Default value: 30.

Returns:

MaxIdleTime The time period (seconds) to wait to automatically stop recording after there are no anchors (users who publish streams) in a room. Value range: 5-86400 (max 24 hours). Default value: 30.

setMaxIdleTime

public void setMaxIdleTime(Long MaxIdleTime)

Set The time period (seconds) to wait to automatically stop recording after there are no anchors (users who publish streams) in a room. Value range: 5-86400 (max 24 hours). Default value: 30.

Parameters:

MaxIdleTime - The time period (seconds) to wait to automatically stop recording after there are no anchors (users who publish streams) in a room. Value range: 5-86400 (max 24 hours). Default value: 30.

getStreamType

public Long getStreamType()

Get The media type of the streams to record. 0: Audio and video streams (default) 1: Audio streams only 2: Video streams only

Returns:

StreamType The media type of the streams to record. 0: Audio and video streams (default) 1: Audio streams only 2: Video streams only

setStreamType

public void setStreamType(Long StreamType)

Set The media type of the streams to record. 0: Audio and video streams (default) 1: Audio streams only 2: Video streams only

Parameters:

StreamType - The media type of the streams to record. 0: Audio and video streams (default) 1: Audio streams only 2: Video streams only

getSubscribeStreamUserIds

public SubscribeStreamUserIds getSubscribeStreamUserIds()

Get The allowlist/blocklist for stream subscription.

Returns:

SubscribeStreamUserIds The allowlist/blocklist for stream subscription.

setSubscribeStreamUserIds

public void setSubscribeStreamUserIds(SubscribeStreamUserIds SubscribeStreamUserIds)

Set The allowlist/blocklist for stream subscription.

Parameters:

SubscribeStreamUserIds - The allowlist/blocklist for stream subscription.

getOutputFormat

public Long getOutputFormat()

Get The output format. `0` (default): HLS; `1`: HLS + MP4; `2`: HLS + AAC. This parameter is invalid if you save recording files to VOD. To specify the format of files saved to VOD, use `MediaType` of `TencentVod`.

Returns:

OutputFormat The output format. `0` (default): HLS; `1`: HLS + MP4; `2`: HLS + AAC. This parameter is invalid if you save recording files to VOD. To specify the format of files saved to VOD, use `MediaType` of `TencentVod`.

setOutputFormat

public void setOutputFormat(Long OutputFormat)

Set The output format. `0` (default): HLS; `1`: HLS + MP4; `2`: HLS + AAC. This parameter is invalid if you save recording files to VOD. To specify the format of files saved to VOD, use `MediaType` of `TencentVod`.

Parameters:

OutputFormat - The output format. `0` (default): HLS; `1`: HLS + MP4; `2`: HLS + AAC. This parameter is invalid if you save recording files to VOD. To specify the format of files saved to VOD, use `MediaType` of `TencentVod`.

getAvMerge

public Long getAvMerge()

Get Whether to merge the audio and video of a user in the single-stream recording mode. 0 (default): Do not mix the audio and video; 1: Mix the audio and video into one TS file. You don’t need to specify this parameter for mixed-stream recording, which merges audios and videos by default.

Returns:

AvMerge Whether to merge the audio and video of a user in the single-stream recording mode. 0 (default): Do not mix the audio and video; 1: Mix the audio and video into one TS file. You don’t need to specify this parameter for mixed-stream recording, which merges audios and videos by default.

setAvMerge

public void setAvMerge(Long AvMerge)

Set Whether to merge the audio and video of a user in the single-stream recording mode. 0 (default): Do not mix the audio and video; 1: Mix the audio and video into one TS file. You don’t need to specify this parameter for mixed-stream recording, which merges audios and videos by default.

Parameters:

AvMerge - Whether to merge the audio and video of a user in the single-stream recording mode. 0 (default): Do not mix the audio and video; 1: Mix the audio and video into one TS file. You don’t need to specify this parameter for mixed-stream recording, which merges audios and videos by default.

getMaxMediaFileDuration

public Long getMaxMediaFileDuration()

Get The maximum file duration allowed (minutes). If the output format is AAC or MP4, and the maximum file duration is exceeded, the file will be segmented. Value range: 1-1440. Default value: 1440 (24 hours). The maximum file size allowed is 2 GB. If the file size exceeds 2 GB, or the file duration exceeds 24 hours, the file will also be segmented. This parameter is invalid if the output format is HLS.

Returns:

MaxMediaFileDuration The maximum file duration allowed (minutes). If the output format is AAC or MP4, and the maximum file duration is exceeded, the file will be segmented. Value range: 1-1440. Default value: 1440 (24 hours). The maximum file size allowed is 2 GB. If the file size exceeds 2 GB, or the file duration exceeds 24 hours, the file will also be segmented. This parameter is invalid if the output format is HLS.

setMaxMediaFileDuration

public void setMaxMediaFileDuration(Long MaxMediaFileDuration)

Set The maximum file duration allowed (minutes). If the output format is AAC or MP4, and the maximum file duration is exceeded, the file will be segmented. Value range: 1-1440. Default value: 1440 (24 hours). The maximum file size allowed is 2 GB. If the file size exceeds 2 GB, or the file duration exceeds 24 hours, the file will also be segmented. This parameter is invalid if the output format is HLS.

Parameters:

MaxMediaFileDuration - The maximum file duration allowed (minutes). If the output format is AAC or MP4, and the maximum file duration is exceeded, the file will be segmented. Value range: 1-1440. Default value: 1440 (24 hours). The maximum file size allowed is 2 GB. If the file size exceeds 2 GB, or the file duration exceeds 24 hours, the file will also be segmented. This parameter is invalid if the output format is HLS.

getMediaId

public Long getMediaId()

Get The type of stream to record. `0`: The primary stream and substream; `1`: The primary stream; `2`: The substream. Note: This field may return null, indicating that no valid values can be obtained.

Returns:

MediaId The type of stream to record. `0`: The primary stream and substream; `1`: The primary stream; `2`: The substream. Note: This field may return null, indicating that no valid values can be obtained.

setMediaId

public void setMediaId(Long MediaId)

Set The type of stream to record. `0`: The primary stream and substream; `1`: The primary stream; `2`: The substream. Note: This field may return null, indicating that no valid values can be obtained.

Parameters:

MediaId - The type of stream to record. `0`: The primary stream and substream; `1`: The primary stream; `2`: The substream. Note: This field may return null, indicating that no valid values can be 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