com.tencentcloudapi.tiw.v20190919.models

Class StartOnlineRecordRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.tiw.v20190919.models.StartOnlineRecordRequest

public class StartOnlineRecordRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
StartOnlineRecordRequest()
StartOnlineRecordRequest(StartOnlineRecordRequest 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
Boolean	getAudioFileNeeded() Get 是否需要在结果回调中返回各路流的纯音频录制文件，文件格式为mp3
Long	getAutoStopTimeout() Get 自动停止录制超时时间，单位秒，取值范围[300, 86400], 默认值为300秒。 当超过设定时间房间内没有音视频上行且没有白板操作的时候，录制服务会自动停止当前录制任务。
String	getChatGroupId() Get 聊天群组ID，此字段仅适用于`视频生成模式` 在`视频生成模式`下，默认会记录白板群组内的非白板信令消息，如果指定了`ChatGroupId`，则会记录指定群ID的聊天消息。
Concat	getConcat() Get 录制视频拼接参数
String	getExtraData() Get 内部参数，可忽略
String[]	getExtras() Get 使用到的高级功能列表 可以选值列表： MIX_STREAM - 混流功能
String	getGroupId() Get 白板进行信令同步的 IM 群组 ID。 在没有指定`GroupId`的情况下，实时录制服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。 在指定了`GroupId`的情况下，实时录制将优先使用`GroupId`作为同步白板信令的群组ID。请在开始录制前确保相应的IM群组已创建完成，否则会导致录制失败。
MixStream	getMixStream() Get 录制混流参数 特别说明： 1.
RecordControl	getRecordControl() Get 录制控制参数，用于更精细地指定需要录制哪些流，某一路流是否禁用音频，是否只录制小画面等
String	getRecordMode() Get 录制模式 REALTIME_MODE - 实时录制模式（默认） VIDEO_GENERATION_MODE - 视频生成模式（内测中，需邮件申请开通）
String	getRecordUserId() Get 用于录制服务进房的用户ID，最大长度不能大于60个字节，格式为`tic_record_user_${RoomId}_${Random}`，其中 `${RoomId} `与录制房间号对应，`${Random}`为一个随机字符串。 该ID必须是一个单独的未在SDK中使用的ID，录制服务使用这个用户ID进入房间进行音视频与白板录制，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常录制。
String	getRecordUserSig() Get 与`RecordUserId`对应的IM签名
Long	getRoomId() Get 需要录制的白板房间号，取值范围: (1, 4294967295)。 1.
Long	getSdkAppId() Get 客户的SdkAppId
Long	getTRTCRoomId() Get TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。 当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。
String	getTRTCRoomIdStr() Get TRTC字符串类型房间号。 在指定了`TRTCRoomIdStr`的情况下，会优先使用`TRTCRoomIdStr`作为实时录制拉TRTC流的TRTC房间号。
Whiteboard	getWhiteboard() Get 录制白板参数，例如白板宽高等
void	setAudioFileNeeded(Boolean AudioFileNeeded) Set 是否需要在结果回调中返回各路流的纯音频录制文件，文件格式为mp3
void	setAutoStopTimeout(Long AutoStopTimeout) Set 自动停止录制超时时间，单位秒，取值范围[300, 86400], 默认值为300秒。 当超过设定时间房间内没有音视频上行且没有白板操作的时候，录制服务会自动停止当前录制任务。
void	setChatGroupId(String ChatGroupId) Set 聊天群组ID，此字段仅适用于`视频生成模式` 在`视频生成模式`下，默认会记录白板群组内的非白板信令消息，如果指定了`ChatGroupId`，则会记录指定群ID的聊天消息。
void	setConcat(Concat Concat) Set 录制视频拼接参数
void	setExtraData(String ExtraData) Set 内部参数，可忽略
void	setExtras(String[] Extras) Set 使用到的高级功能列表 可以选值列表： MIX_STREAM - 混流功能
void	setGroupId(String GroupId) Set 白板进行信令同步的 IM 群组 ID。 在没有指定`GroupId`的情况下，实时录制服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。 在指定了`GroupId`的情况下，实时录制将优先使用`GroupId`作为同步白板信令的群组ID。请在开始录制前确保相应的IM群组已创建完成，否则会导致录制失败。
void	setMixStream(MixStream MixStream) Set 录制混流参数 特别说明： 1.
void	setRecordControl(RecordControl RecordControl) Set 录制控制参数，用于更精细地指定需要录制哪些流，某一路流是否禁用音频，是否只录制小画面等
void	setRecordMode(String RecordMode) Set 录制模式 REALTIME_MODE - 实时录制模式（默认） VIDEO_GENERATION_MODE - 视频生成模式（内测中，需邮件申请开通）
void	setRecordUserId(String RecordUserId) Set 用于录制服务进房的用户ID，最大长度不能大于60个字节，格式为`tic_record_user_${RoomId}_${Random}`，其中 `${RoomId} `与录制房间号对应，`${Random}`为一个随机字符串。 该ID必须是一个单独的未在SDK中使用的ID，录制服务使用这个用户ID进入房间进行音视频与白板录制，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常录制。
void	setRecordUserSig(String RecordUserSig) Set 与`RecordUserId`对应的IM签名
void	setRoomId(Long RoomId) Set 需要录制的白板房间号，取值范围: (1, 4294967295)。 1.
void	setSdkAppId(Long SdkAppId) Set 客户的SdkAppId
void	setTRTCRoomId(Long TRTCRoomId) Set TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。 当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。
void	setTRTCRoomIdStr(String TRTCRoomIdStr) Set TRTC字符串类型房间号。 在指定了`TRTCRoomIdStr`的情况下，会优先使用`TRTCRoomIdStr`作为实时录制拉TRTC流的TRTC房间号。
void	setWhiteboard(Whiteboard Whiteboard) Set 录制白板参数，例如白板宽高等
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

StartOnlineRecordRequest

public StartOnlineRecordRequest()

StartOnlineRecordRequest

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

getSdkAppId

public Long getSdkAppId()

Get 客户的SdkAppId

Returns:

SdkAppId 客户的SdkAppId

setSdkAppId

public void setSdkAppId(Long SdkAppId)

Set 客户的SdkAppId

Parameters:

SdkAppId - 客户的SdkAppId

getRoomId

public Long getRoomId()

Get 需要录制的白板房间号，取值范围: (1, 4294967295)。 1. 在没有指定`GroupId`的情况下，实时录制默认以`RoomId`的字符串表达形式作为同步白板信令的IM群组ID（比如`RoomId`为12358，则IM群组ID为"12358"），并加群进行信令同步，请在开始录制前确保相应IM群组已创建完成，否则会导致录制失败。 2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下，默认会以`RoomId`作为TRTC房间号进房拉流进行录制。

Returns:

RoomId 需要录制的白板房间号，取值范围: (1, 4294967295)。 1. 在没有指定`GroupId`的情况下，实时录制默认以`RoomId`的字符串表达形式作为同步白板信令的IM群组ID（比如`RoomId`为12358，则IM群组ID为"12358"），并加群进行信令同步，请在开始录制前确保相应IM群组已创建完成，否则会导致录制失败。 2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下，默认会以`RoomId`作为TRTC房间号进房拉流进行录制。

setRoomId

public void setRoomId(Long RoomId)

Set 需要录制的白板房间号，取值范围: (1, 4294967295)。 1. 在没有指定`GroupId`的情况下，实时录制默认以`RoomId`的字符串表达形式作为同步白板信令的IM群组ID（比如`RoomId`为12358，则IM群组ID为"12358"），并加群进行信令同步，请在开始录制前确保相应IM群组已创建完成，否则会导致录制失败。 2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下，默认会以`RoomId`作为TRTC房间号进房拉流进行录制。

Parameters:

RoomId - 需要录制的白板房间号，取值范围: (1, 4294967295)。 1. 在没有指定`GroupId`的情况下，实时录制默认以`RoomId`的字符串表达形式作为同步白板信令的IM群组ID（比如`RoomId`为12358，则IM群组ID为"12358"），并加群进行信令同步，请在开始录制前确保相应IM群组已创建完成，否则会导致录制失败。 2. 在没有指定`TRTCRoomId`和`TRTCRoomIdStr`的情况下，默认会以`RoomId`作为TRTC房间号进房拉流进行录制。

getRecordUserId

public String getRecordUserId()

Get 用于录制服务进房的用户ID，最大长度不能大于60个字节，格式为`tic_record_user_${RoomId}_${Random}`，其中 `${RoomId} `与录制房间号对应，`${Random}`为一个随机字符串。 该ID必须是一个单独的未在SDK中使用的ID，录制服务使用这个用户ID进入房间进行音视频与白板录制，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常录制。

Returns:

RecordUserId 用于录制服务进房的用户ID，最大长度不能大于60个字节，格式为`tic_record_user_${RoomId}_${Random}`，其中 `${RoomId} `与录制房间号对应，`${Random}`为一个随机字符串。 该ID必须是一个单独的未在SDK中使用的ID，录制服务使用这个用户ID进入房间进行音视频与白板录制，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常录制。

setRecordUserId

public void setRecordUserId(String RecordUserId)

Set 用于录制服务进房的用户ID，最大长度不能大于60个字节，格式为`tic_record_user_${RoomId}_${Random}`，其中 `${RoomId} `与录制房间号对应，`${Random}`为一个随机字符串。 该ID必须是一个单独的未在SDK中使用的ID，录制服务使用这个用户ID进入房间进行音视频与白板录制，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常录制。

Parameters:

RecordUserId - 用于录制服务进房的用户ID，最大长度不能大于60个字节，格式为`tic_record_user_${RoomId}_${Random}`，其中 `${RoomId} `与录制房间号对应，`${Random}`为一个随机字符串。 该ID必须是一个单独的未在SDK中使用的ID，录制服务使用这个用户ID进入房间进行音视频与白板录制，若该ID和SDK中使用的ID重复，会导致SDK和录制服务互踢，影响正常录制。

getRecordUserSig

public String getRecordUserSig()

Get 与`RecordUserId`对应的IM签名

Returns:

RecordUserSig 与`RecordUserId`对应的IM签名

setRecordUserSig

public void setRecordUserSig(String RecordUserSig)

Set 与`RecordUserId`对应的IM签名

Parameters:

RecordUserSig - 与`RecordUserId`对应的IM签名

getGroupId

public String getGroupId()

Get 白板进行信令同步的 IM 群组 ID。 在没有指定`GroupId`的情况下，实时录制服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。 在指定了`GroupId`的情况下，实时录制将优先使用`GroupId`作为同步白板信令的群组ID。请在开始录制前确保相应的IM群组已创建完成，否则会导致录制失败。

Returns:

GroupId 白板进行信令同步的 IM 群组 ID。 在没有指定`GroupId`的情况下，实时录制服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。 在指定了`GroupId`的情况下，实时录制将优先使用`GroupId`作为同步白板信令的群组ID。请在开始录制前确保相应的IM群组已创建完成，否则会导致录制失败。

setGroupId

public void setGroupId(String GroupId)

Set 白板进行信令同步的 IM 群组 ID。 在没有指定`GroupId`的情况下，实时录制服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。 在指定了`GroupId`的情况下，实时录制将优先使用`GroupId`作为同步白板信令的群组ID。请在开始录制前确保相应的IM群组已创建完成，否则会导致录制失败。

Parameters:

GroupId - 白板进行信令同步的 IM 群组 ID。 在没有指定`GroupId`的情况下，实时录制服务将使用 `RoomId` 的字符串形式作为同步白板信令的IM群组ID。 在指定了`GroupId`的情况下，实时录制将优先使用`GroupId`作为同步白板信令的群组ID。请在开始录制前确保相应的IM群组已创建完成，否则会导致录制失败。

getConcat

public Concat getConcat()

Get 录制视频拼接参数

Returns:

Concat 录制视频拼接参数

setConcat

public void setConcat(Concat Concat)

Set 录制视频拼接参数

Parameters:

Concat - 录制视频拼接参数

getWhiteboard

public Whiteboard getWhiteboard()

Get 录制白板参数，例如白板宽高等

Returns:

Whiteboard 录制白板参数，例如白板宽高等

setWhiteboard

public void setWhiteboard(Whiteboard Whiteboard)

Set 录制白板参数，例如白板宽高等

Parameters:

Whiteboard - 录制白板参数，例如白板宽高等

getMixStream

public MixStream getMixStream()

Get 录制混流参数 特别说明： 1. 混流功能需要根据额外开通， 请联系腾讯云互动白板客服人员 2. 使用混流功能，必须提供 Extras 参数，且 Extras 参数中必须包含 "MIX_STREAM"

Returns:

MixStream 录制混流参数 特别说明： 1. 混流功能需要根据额外开通， 请联系腾讯云互动白板客服人员 2. 使用混流功能，必须提供 Extras 参数，且 Extras 参数中必须包含 "MIX_STREAM"

setMixStream

public void setMixStream(MixStream MixStream)

Set 录制混流参数 特别说明： 1. 混流功能需要根据额外开通， 请联系腾讯云互动白板客服人员 2. 使用混流功能，必须提供 Extras 参数，且 Extras 参数中必须包含 "MIX_STREAM"

Parameters:

MixStream - 录制混流参数 特别说明： 1. 混流功能需要根据额外开通， 请联系腾讯云互动白板客服人员 2. 使用混流功能，必须提供 Extras 参数，且 Extras 参数中必须包含 "MIX_STREAM"

getExtras

public String[] getExtras()

Get 使用到的高级功能列表 可以选值列表： MIX_STREAM - 混流功能

Returns:

Extras 使用到的高级功能列表 可以选值列表： MIX_STREAM - 混流功能

setExtras

public void setExtras(String[] Extras)

Set 使用到的高级功能列表 可以选值列表： MIX_STREAM - 混流功能

Parameters:

Extras - 使用到的高级功能列表 可以选值列表： MIX_STREAM - 混流功能

getAudioFileNeeded

public Boolean getAudioFileNeeded()

Get 是否需要在结果回调中返回各路流的纯音频录制文件，文件格式为mp3

Returns:

AudioFileNeeded 是否需要在结果回调中返回各路流的纯音频录制文件，文件格式为mp3

setAudioFileNeeded

public void setAudioFileNeeded(Boolean AudioFileNeeded)

Set 是否需要在结果回调中返回各路流的纯音频录制文件，文件格式为mp3

Parameters:

AudioFileNeeded - 是否需要在结果回调中返回各路流的纯音频录制文件，文件格式为mp3

getRecordControl

public RecordControl getRecordControl()

Get 录制控制参数，用于更精细地指定需要录制哪些流，某一路流是否禁用音频，是否只录制小画面等

Returns:

RecordControl 录制控制参数，用于更精细地指定需要录制哪些流，某一路流是否禁用音频，是否只录制小画面等

setRecordControl

public void setRecordControl(RecordControl RecordControl)

Set 录制控制参数，用于更精细地指定需要录制哪些流，某一路流是否禁用音频，是否只录制小画面等

Parameters:

RecordControl - 录制控制参数，用于更精细地指定需要录制哪些流，某一路流是否禁用音频，是否只录制小画面等

getRecordMode

public String getRecordMode()

Get 录制模式 REALTIME_MODE - 实时录制模式（默认） VIDEO_GENERATION_MODE - 视频生成模式（内测中，需邮件申请开通）

Returns:

RecordMode 录制模式 REALTIME_MODE - 实时录制模式（默认） VIDEO_GENERATION_MODE - 视频生成模式（内测中，需邮件申请开通）

setRecordMode

public void setRecordMode(String RecordMode)

Set 录制模式 REALTIME_MODE - 实时录制模式（默认） VIDEO_GENERATION_MODE - 视频生成模式（内测中，需邮件申请开通）

Parameters:

RecordMode - 录制模式 REALTIME_MODE - 实时录制模式（默认） VIDEO_GENERATION_MODE - 视频生成模式（内测中，需邮件申请开通）

getChatGroupId

public String getChatGroupId()

Get 聊天群组ID，此字段仅适用于`视频生成模式` 在`视频生成模式`下，默认会记录白板群组内的非白板信令消息，如果指定了`ChatGroupId`，则会记录指定群ID的聊天消息。

Returns:

ChatGroupId 聊天群组ID，此字段仅适用于`视频生成模式` 在`视频生成模式`下，默认会记录白板群组内的非白板信令消息，如果指定了`ChatGroupId`，则会记录指定群ID的聊天消息。

setChatGroupId

public void setChatGroupId(String ChatGroupId)

Set 聊天群组ID，此字段仅适用于`视频生成模式` 在`视频生成模式`下，默认会记录白板群组内的非白板信令消息，如果指定了`ChatGroupId`，则会记录指定群ID的聊天消息。

Parameters:

ChatGroupId - 聊天群组ID，此字段仅适用于`视频生成模式` 在`视频生成模式`下，默认会记录白板群组内的非白板信令消息，如果指定了`ChatGroupId`，则会记录指定群ID的聊天消息。

getAutoStopTimeout

public Long getAutoStopTimeout()

Get 自动停止录制超时时间，单位秒，取值范围[300, 86400], 默认值为300秒。 当超过设定时间房间内没有音视频上行且没有白板操作的时候，录制服务会自动停止当前录制任务。

Returns:

AutoStopTimeout 自动停止录制超时时间，单位秒，取值范围[300, 86400], 默认值为300秒。 当超过设定时间房间内没有音视频上行且没有白板操作的时候，录制服务会自动停止当前录制任务。

setAutoStopTimeout

public void setAutoStopTimeout(Long AutoStopTimeout)

Set 自动停止录制超时时间，单位秒，取值范围[300, 86400], 默认值为300秒。 当超过设定时间房间内没有音视频上行且没有白板操作的时候，录制服务会自动停止当前录制任务。

Parameters:

AutoStopTimeout - 自动停止录制超时时间，单位秒，取值范围[300, 86400], 默认值为300秒。 当超过设定时间房间内没有音视频上行且没有白板操作的时候，录制服务会自动停止当前录制任务。

getExtraData

public String getExtraData()

Get 内部参数，可忽略

Returns:

ExtraData 内部参数，可忽略

setExtraData

public void setExtraData(String ExtraData)

Set 内部参数，可忽略

Parameters:

ExtraData - 内部参数，可忽略

getTRTCRoomId

public Long getTRTCRoomId()

Get TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。 当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。

Returns:

TRTCRoomId TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。 当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。

setTRTCRoomId

public void setTRTCRoomId(Long TRTCRoomId)

Set TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。 当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。

Parameters:

TRTCRoomId - TRTC数字类型房间号，取值范围: (1, 4294967295)。 在同时指定了`RoomId`与`TRTCRoomId`的情况下，优先使用`TRTCRoomId`作为实时录制拉TRTC流的TRTC房间号。 当指定了`TRTCRoomIdStr`的情况下，此字段将被忽略。

getTRTCRoomIdStr

public String getTRTCRoomIdStr()

Get TRTC字符串类型房间号。 在指定了`TRTCRoomIdStr`的情况下，会优先使用`TRTCRoomIdStr`作为实时录制拉TRTC流的TRTC房间号。

Returns:

TRTCRoomIdStr TRTC字符串类型房间号。 在指定了`TRTCRoomIdStr`的情况下，会优先使用`TRTCRoomIdStr`作为实时录制拉TRTC流的TRTC房间号。

setTRTCRoomIdStr

public void setTRTCRoomIdStr(String TRTCRoomIdStr)

Set TRTC字符串类型房间号。 在指定了`TRTCRoomIdStr`的情况下，会优先使用`TRTCRoomIdStr`作为实时录制拉TRTC流的TRTC房间号。

Parameters:

TRTCRoomIdStr - TRTC字符串类型房间号。 在指定了`TRTCRoomIdStr`的情况下，会优先使用`TRTCRoomIdStr`作为实时录制拉TRTC流的TRTC房间号。

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.