Class CreateCloudRecordingRequest

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      MixLayoutParams getMixLayoutParams()
      Get 混流的布局参数,录制模式为混流的时候可以设置。
      MixTranscodeParams getMixTranscodeParams()
      Get 混流的转码参数,录制模式为混流的时候可以设置。
      String getPrivateMapKey()
      Get TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
      RecordParams getRecordParams()
      Get 云端录制控制参数。
      Long getResourceExpiredHour()
      Get 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
      String getRoomId()
      Get TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
      Long getRoomIdType()
      Get TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认)
      Long getSdkAppId()
      Get TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
      StorageParams getStorageParams()
      Get 云端录制文件上传到云存储的参数(目前支持云点播VOD和对象存储COS)。点播和对象存储的参数必填其中之一,不支持同时设置点播和对象存储。
      String getUserId()
      Get 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分,即录制机器人进入房间的userid应保证独立且唯一。
      String getUserSig()
      Get 录制机器人用于进入TRTC房间拉流的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
      void setMixLayoutParams​(MixLayoutParams MixLayoutParams)
      Set 混流的布局参数,录制模式为混流的时候可以设置。
      void setMixTranscodeParams​(MixTranscodeParams MixTranscodeParams)
      Set 混流的转码参数,录制模式为混流的时候可以设置。
      void setPrivateMapKey​(String PrivateMapKey)
      Set TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
      void setRecordParams​(RecordParams RecordParams)
      Set 云端录制控制参数。
      void setResourceExpiredHour​(Long ResourceExpiredHour)
      Set 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
      void setRoomId​(String RoomId)
      Set TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
      void setRoomIdType​(Long RoomIdType)
      Set TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认)
      void setSdkAppId​(Long SdkAppId)
      Set TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
      void setStorageParams​(StorageParams StorageParams)
      Set 云端录制文件上传到云存储的参数(目前支持云点播VOD和对象存储COS)。点播和对象存储的参数必填其中之一,不支持同时设置点播和对象存储。
      void setUserId​(String UserId)
      Set 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分,即录制机器人进入房间的userid应保证独立且唯一。
      void setUserSig​(String UserSig)
      Set 录制机器人用于进入TRTC房间拉流的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.
    • Constructor Detail

      • CreateCloudRecordingRequest

        public CreateCloudRecordingRequest()
      • CreateCloudRecordingRequest

        public CreateCloudRecordingRequest​(CreateCloudRecordingRequest 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 TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
        Returns:
        SdkAppId TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
      • setSdkAppId

        public void setSdkAppId​(Long SdkAppId)
        Set TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
        Parameters:
        SdkAppId - TRTC的[SdkAppId](https://cloud.tencent.com/document/product/647/46351#sdkappid),和录制的房间所对应的SdkAppId相同。
      • getRoomId

        public String getRoomId()
        Get TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
        Returns:
        RoomId TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
      • setRoomId

        public void setRoomId​(String RoomId)
        Set TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
        Parameters:
        RoomId - TRTC的[RoomId](https://cloud.tencent.com/document/product/647/46351#roomid),录制的TRTC房间所对应的RoomId。
      • getUserId

        public String getUserId()
        Get 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分,即录制机器人进入房间的userid应保证独立且唯一。
        Returns:
        UserId 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分,即录制机器人进入房间的userid应保证独立且唯一。
      • setUserId

        public void setUserId​(String UserId)
        Set 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分,即录制机器人进入房间的userid应保证独立且唯一。
        Parameters:
        UserId - 录制机器人用于进入TRTC房间拉流的[UserId](https://cloud.tencent.com/document/product/647/46351#userid),注意这个UserId不能与其他TRTC房间内的主播或者其他录制任务等已经使用的UserId重复,建议可以把房间ID作为userId的标识的一部分,即录制机器人进入房间的userid应保证独立且唯一。
      • getUserSig

        public String getUserSig()
        Get 录制机器人用于进入TRTC房间拉流的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
        Returns:
        UserSig 录制机器人用于进入TRTC房间拉流的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
      • setUserSig

        public void setUserSig​(String UserSig)
        Set 录制机器人用于进入TRTC房间拉流的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
        Parameters:
        UserSig - 录制机器人用于进入TRTC房间拉流的用户签名,当前 UserId 对应的验证签名,相当于登录密码,具体计算方法请参考TRTC计算[UserSig](https://cloud.tencent.com/document/product/647/45910#UserSig)的方案。
      • getRecordParams

        public RecordParams getRecordParams()
        Get 云端录制控制参数。
        Returns:
        RecordParams 云端录制控制参数。
      • setRecordParams

        public void setRecordParams​(RecordParams RecordParams)
        Set 云端录制控制参数。
        Parameters:
        RecordParams - 云端录制控制参数。
      • getStorageParams

        public StorageParams getStorageParams()
        Get 云端录制文件上传到云存储的参数(目前支持云点播VOD和对象存储COS)。点播和对象存储的参数必填其中之一,不支持同时设置点播和对象存储。
        Returns:
        StorageParams 云端录制文件上传到云存储的参数(目前支持云点播VOD和对象存储COS)。点播和对象存储的参数必填其中之一,不支持同时设置点播和对象存储。
      • setStorageParams

        public void setStorageParams​(StorageParams StorageParams)
        Set 云端录制文件上传到云存储的参数(目前支持云点播VOD和对象存储COS)。点播和对象存储的参数必填其中之一,不支持同时设置点播和对象存储。
        Parameters:
        StorageParams - 云端录制文件上传到云存储的参数(目前支持云点播VOD和对象存储COS)。点播和对象存储的参数必填其中之一,不支持同时设置点播和对象存储。
      • getRoomIdType

        public Long getRoomIdType()
        Get TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认)
        Returns:
        RoomIdType TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认)
      • setRoomIdType

        public void setRoomIdType​(Long RoomIdType)
        Set TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认)
        Parameters:
        RoomIdType - TRTC房间号的类型,必须和录制的房间所对应的RoomId类型相同: 0: 字符串类型的RoomId 1: 32位整型的RoomId(默认)
      • getMixTranscodeParams

        public MixTranscodeParams getMixTranscodeParams()
        Get 混流的转码参数,录制模式为混流的时候可以设置。
        Returns:
        MixTranscodeParams 混流的转码参数,录制模式为混流的时候可以设置。
      • setMixTranscodeParams

        public void setMixTranscodeParams​(MixTranscodeParams MixTranscodeParams)
        Set 混流的转码参数,录制模式为混流的时候可以设置。
        Parameters:
        MixTranscodeParams - 混流的转码参数,录制模式为混流的时候可以设置。
      • getMixLayoutParams

        public MixLayoutParams getMixLayoutParams()
        Get 混流的布局参数,录制模式为混流的时候可以设置。
        Returns:
        MixLayoutParams 混流的布局参数,录制模式为混流的时候可以设置。
      • setMixLayoutParams

        public void setMixLayoutParams​(MixLayoutParams MixLayoutParams)
        Set 混流的布局参数,录制模式为混流的时候可以设置。
        Parameters:
        MixLayoutParams - 混流的布局参数,录制模式为混流的时候可以设置。
      • getResourceExpiredHour

        public Long getResourceExpiredHour()
        Get 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
        Returns:
        ResourceExpiredHour 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
      • setResourceExpiredHour

        public void setResourceExpiredHour​(Long ResourceExpiredHour)
        Set 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
        Parameters:
        ResourceExpiredHour - 接口可以调用的时效性,从成功开启录制并获得任务ID后开始计算,超时后无法调用查询、更新和停止等接口,但是录制任务不会停止。 参数的单位是小时,默认72小时(3天),最大可设置720小时(30天),最小设置6小时。举例说明:如果不设置该参数,那么开始录制成功后,查询、更新和停止录制的调用时效为72个小时。
      • getPrivateMapKey

        public String getPrivateMapKey()
        Get TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
        Returns:
        PrivateMapKey TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
      • setPrivateMapKey

        public void setPrivateMapKey​(String PrivateMapKey)
        Set TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。
        Parameters:
        PrivateMapKey - TRTC房间权限加密串,只有在TRTC控制台启用了高级权限控制的时候需要携带,在TRTC控制台如果开启高级权限控制后,TRTC 的后台服务系统会校验一个叫做 [PrivateMapKey] 的“权限票据”,权限票据中包含了一个加密后的 RoomId 和一个加密后的“权限位列表”。由于 PrivateMapKey 中包含 RoomId,所以只提供了 UserSig 没有提供 PrivateMapKey 时,并不能进入指定的房间。