com.tencentcloudapi.trtc.v20190722.models.CreateCloudRecordingRequest Maven / Gradle / Ivy
/*
* Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.tencentcloudapi.trtc.v20190722.models;
import com.tencentcloudapi.common.AbstractModel;
import com.google.gson.annotations.SerializedName;
import com.google.gson.annotations.Expose;
import java.util.HashMap;
public class CreateCloudRecordingRequest extends AbstractModel{
/**
* TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和录制的房间所对应的SdkAppId相同。
*/
@SerializedName("SdkAppId")
@Expose
private Long SdkAppId;
/**
* TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。
*/
@SerializedName("RoomId")
@Expose
private String RoomId;
/**
* 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid)，注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分，即录制机器人进入房间的userid应保证独立且唯一。
*/
@SerializedName("UserId")
@Expose
private String UserId;
/**
* 录制机器人用于进入TRTC房间拉流的用户签名，当前 UserId 对应的验证签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
*/
@SerializedName("UserSig")
@Expose
private String UserSig;
/**
* 云端录制控制参数。
*/
@SerializedName("RecordParams")
@Expose
private RecordParams RecordParams;
/**
* 云端录制文件上传到云存储的参数(目前只支持使用腾讯云点播作为存储)。
*/
@SerializedName("StorageParams")
@Expose
private StorageParams StorageParams;
/**
* TRTC房间号的类型，必须和录制的房间所对应的RoomId类型相同:
0: 字符串类型的RoomId
1: 32位整型的RoomId（默认）
*/
@SerializedName("RoomIdType")
@Expose
private Long RoomIdType;
/**
* 混流的转码参数，录制模式为混流的时候可以设置。
*/
@SerializedName("MixTranscodeParams")
@Expose
private MixTranscodeParams MixTranscodeParams;
/**
* 混流的布局参数，录制模式为混流的时候可以设置。
*/
@SerializedName("MixLayoutParams")
@Expose
private MixLayoutParams MixLayoutParams;
/**
* 接口可以调用的时效性，从成功开启录制并获得任务ID后开始计算，超时后无法调用查询、更新和停止等接口，但是录制任务不会停止。 参数的单位是小时，默认72小时（3天），最大可设置720小时（30天），最小设置6小时。举例说明：如果不设置该参数，那么开始录制成功后，查询、更新和停止录制的调用时效为72个小时。
*/
@SerializedName("ResourceExpiredHour")
@Expose
private Long ResourceExpiredHour;
/**
* TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey]（https://cloud.tencent.com/document/product/647/32240） 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。
*/
@SerializedName("PrivateMapKey")
@Expose
private String PrivateMapKey;
/**
* Get TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和录制的房间所对应的SdkAppId相同。
* @return SdkAppId TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和录制的房间所对应的SdkAppId相同。
*/
public Long getSdkAppId() {
return this.SdkAppId;
}
/**
* Set TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和录制的房间所对应的SdkAppId相同。
* @param SdkAppId TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid)，和录制的房间所对应的SdkAppId相同。
*/
public void setSdkAppId(Long SdkAppId) {
this.SdkAppId = SdkAppId;
}
/**
* Get TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。
* @return RoomId TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。
*/
public String getRoomId() {
return this.RoomId;
}
/**
* Set TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。
* @param RoomId TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid)，录制的TRTC房间所对应的RoomId。
*/
public void setRoomId(String RoomId) {
this.RoomId = RoomId;
}
/**
* Get 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid)，注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分，即录制机器人进入房间的userid应保证独立且唯一。
* @return UserId 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid)，注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分，即录制机器人进入房间的userid应保证独立且唯一。
*/
public String getUserId() {
return this.UserId;
}
/**
* Set 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid)，注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分，即录制机器人进入房间的userid应保证独立且唯一。
* @param UserId 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid)，注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复，建议可以把房间ID作为userId的标识的一部分，即录制机器人进入房间的userid应保证独立且唯一。
*/
public void setUserId(String UserId) {
this.UserId = UserId;
}
/**
* Get 录制机器人用于进入TRTC房间拉流的用户签名，当前 UserId 对应的验证签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
* @return UserSig 录制机器人用于进入TRTC房间拉流的用户签名，当前 UserId 对应的验证签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
*/
public String getUserSig() {
return this.UserSig;
}
/**
* Set 录制机器人用于进入TRTC房间拉流的用户签名，当前 UserId 对应的验证签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
* @param UserSig 录制机器人用于进入TRTC房间拉流的用户签名，当前 UserId 对应的验证签名，相当于登录密码，具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
*/
public void setUserSig(String UserSig) {
this.UserSig = UserSig;
}
/**
* Get 云端录制控制参数。
* @return RecordParams 云端录制控制参数。
*/
public RecordParams getRecordParams() {
return this.RecordParams;
}
/**
* Set 云端录制控制参数。
* @param RecordParams 云端录制控制参数。
*/
public void setRecordParams(RecordParams RecordParams) {
this.RecordParams = RecordParams;
}
/**
* Get 云端录制文件上传到云存储的参数(目前只支持使用腾讯云点播作为存储)。
* @return StorageParams 云端录制文件上传到云存储的参数(目前只支持使用腾讯云点播作为存储)。
*/
public StorageParams getStorageParams() {
return this.StorageParams;
}
/**
* Set 云端录制文件上传到云存储的参数(目前只支持使用腾讯云点播作为存储)。
* @param StorageParams 云端录制文件上传到云存储的参数(目前只支持使用腾讯云点播作为存储)。
*/
public void setStorageParams(StorageParams StorageParams) {
this.StorageParams = StorageParams;
}
/**
* Get TRTC房间号的类型，必须和录制的房间所对应的RoomId类型相同:
0: 字符串类型的RoomId
1: 32位整型的RoomId（默认）
* @return RoomIdType TRTC房间号的类型，必须和录制的房间所对应的RoomId类型相同:
0: 字符串类型的RoomId
1: 32位整型的RoomId（默认）
*/
public Long getRoomIdType() {
return this.RoomIdType;
}
/**
* Set TRTC房间号的类型，必须和录制的房间所对应的RoomId类型相同:
0: 字符串类型的RoomId
1: 32位整型的RoomId（默认）
* @param RoomIdType TRTC房间号的类型，必须和录制的房间所对应的RoomId类型相同:
0: 字符串类型的RoomId
1: 32位整型的RoomId（默认）
*/
public void setRoomIdType(Long RoomIdType) {
this.RoomIdType = RoomIdType;
}
/**
* Get 混流的转码参数，录制模式为混流的时候可以设置。
* @return MixTranscodeParams 混流的转码参数，录制模式为混流的时候可以设置。
*/
public MixTranscodeParams getMixTranscodeParams() {
return this.MixTranscodeParams;
}
/**
* Set 混流的转码参数，录制模式为混流的时候可以设置。
* @param MixTranscodeParams 混流的转码参数，录制模式为混流的时候可以设置。
*/
public void setMixTranscodeParams(MixTranscodeParams MixTranscodeParams) {
this.MixTranscodeParams = MixTranscodeParams;
}
/**
* Get 混流的布局参数，录制模式为混流的时候可以设置。
* @return MixLayoutParams 混流的布局参数，录制模式为混流的时候可以设置。
*/
public MixLayoutParams getMixLayoutParams() {
return this.MixLayoutParams;
}
/**
* Set 混流的布局参数，录制模式为混流的时候可以设置。
* @param MixLayoutParams 混流的布局参数，录制模式为混流的时候可以设置。
*/
public void setMixLayoutParams(MixLayoutParams MixLayoutParams) {
this.MixLayoutParams = MixLayoutParams;
}
/**
* Get 接口可以调用的时效性，从成功开启录制并获得任务ID后开始计算，超时后无法调用查询、更新和停止等接口，但是录制任务不会停止。 参数的单位是小时，默认72小时（3天），最大可设置720小时（30天），最小设置6小时。举例说明：如果不设置该参数，那么开始录制成功后，查询、更新和停止录制的调用时效为72个小时。
* @return ResourceExpiredHour 接口可以调用的时效性，从成功开启录制并获得任务ID后开始计算，超时后无法调用查询、更新和停止等接口，但是录制任务不会停止。 参数的单位是小时，默认72小时（3天），最大可设置720小时（30天），最小设置6小时。举例说明：如果不设置该参数，那么开始录制成功后，查询、更新和停止录制的调用时效为72个小时。
*/
public Long getResourceExpiredHour() {
return this.ResourceExpiredHour;
}
/**
* Set 接口可以调用的时效性，从成功开启录制并获得任务ID后开始计算，超时后无法调用查询、更新和停止等接口，但是录制任务不会停止。 参数的单位是小时，默认72小时（3天），最大可设置720小时（30天），最小设置6小时。举例说明：如果不设置该参数，那么开始录制成功后，查询、更新和停止录制的调用时效为72个小时。
* @param ResourceExpiredHour 接口可以调用的时效性，从成功开启录制并获得任务ID后开始计算，超时后无法调用查询、更新和停止等接口，但是录制任务不会停止。 参数的单位是小时，默认72小时（3天），最大可设置720小时（30天），最小设置6小时。举例说明：如果不设置该参数，那么开始录制成功后，查询、更新和停止录制的调用时效为72个小时。
*/
public void setResourceExpiredHour(Long ResourceExpiredHour) {
this.ResourceExpiredHour = ResourceExpiredHour;
}
/**
* Get TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey]（https://cloud.tencent.com/document/product/647/32240） 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。
* @return PrivateMapKey TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey]（https://cloud.tencent.com/document/product/647/32240） 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。
*/
public String getPrivateMapKey() {
return this.PrivateMapKey;
}
/**
* Set TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey]（https://cloud.tencent.com/document/product/647/32240） 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。
* @param PrivateMapKey TRTC房间权限加密串，只有在TRTC控制台启用了高级权限控制的时候需要携带，在TRTC控制台如果开启高级权限控制后，TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey]（https://cloud.tencent.com/document/product/647/32240） 的“权限票据”，权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId，所以只提供了 UserSig 没有提供 PrivateMapKey 时，并不能进入指定的房间。
*/
public void setPrivateMapKey(String PrivateMapKey) {
this.PrivateMapKey = PrivateMapKey;
}
public CreateCloudRecordingRequest() {
}
/**
* 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.
*/
public CreateCloudRecordingRequest(CreateCloudRecordingRequest source) {
if (source.SdkAppId != null) {
this.SdkAppId = new Long(source.SdkAppId);
}
if (source.RoomId != null) {
this.RoomId = new String(source.RoomId);
}
if (source.UserId != null) {
this.UserId = new String(source.UserId);
}
if (source.UserSig != null) {
this.UserSig = new String(source.UserSig);
}
if (source.RecordParams != null) {
this.RecordParams = new RecordParams(source.RecordParams);
}
if (source.StorageParams != null) {
this.StorageParams = new StorageParams(source.StorageParams);
}
if (source.RoomIdType != null) {
this.RoomIdType = new Long(source.RoomIdType);
}
if (source.MixTranscodeParams != null) {
this.MixTranscodeParams = new MixTranscodeParams(source.MixTranscodeParams);
}
if (source.MixLayoutParams != null) {
this.MixLayoutParams = new MixLayoutParams(source.MixLayoutParams);
}
if (source.ResourceExpiredHour != null) {
this.ResourceExpiredHour = new Long(source.ResourceExpiredHour);
}
if (source.PrivateMapKey != null) {
this.PrivateMapKey = new String(source.PrivateMapKey);
}
}
/**
* Internal implementation, normal users should not use it.
*/
public void toMap(HashMap map, String prefix) {
this.setParamSimple(map, prefix + "SdkAppId", this.SdkAppId);
this.setParamSimple(map, prefix + "RoomId", this.RoomId);
this.setParamSimple(map, prefix + "UserId", this.UserId);
this.setParamSimple(map, prefix + "UserSig", this.UserSig);
this.setParamObj(map, prefix + "RecordParams.", this.RecordParams);
this.setParamObj(map, prefix + "StorageParams.", this.StorageParams);
this.setParamSimple(map, prefix + "RoomIdType", this.RoomIdType);
this.setParamObj(map, prefix + "MixTranscodeParams.", this.MixTranscodeParams);
this.setParamObj(map, prefix + "MixLayoutParams.", this.MixLayoutParams);
this.setParamSimple(map, prefix + "ResourceExpiredHour", this.ResourceExpiredHour);
this.setParamSimple(map, prefix + "PrivateMapKey", this.PrivateMapKey);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy