tencentcloud-sdk-trtc 3.0.787 → 3.0.788

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8721de48a4b2925ff4c986ec1f455e5d9b8a55d4
-  data.tar.gz: 90dc6f3caffecd1f11e4d28711dc6893aefb8585
+  metadata.gz: 084d59dc824a1338344a18bcda0ba9f5b8e7fb9c
+  data.tar.gz: e11527bf797eeb68573d3d2fda1fab42e72f65fe
 SHA512:
-  metadata.gz: fae2cd69eec441c3f5e7a393b8699f0367ccaf78034daa0646c22bd82a5b147b7b97447afb033b4f0d6f2d7de655d1c1bda310151f3a8e256fd67238f3463453
-  data.tar.gz: 5e98289c88778911ce7ebdbe2fbdf9976cc880323df1f2834ecfcf1bdcbe83d6329063af45b6263f74febb11ac4a28045b8e10871f652e5dc433cd9284fe4c34
+  metadata.gz: 24aef9268d26ea62ebe4631994152f8a519d755a8c0fdc6447cea90310a3dc7d043e4653efc64ad8e576fb053b6767f81aa59bb94ec33f4db755db2b44075255
+  data.tar.gz: 020840c6112fc699fc16bc2705b5aa00d1d0c4acebe7853b34d1687773a924d765f75ba907b4a3256f156b081ca9e30c7ad7f676fcdf15f9cf6501d8ce64a057

data/lib/VERSION

@@ -1 +1 @@
-3.0.787
+3.0.788

data/lib/v20190722/client.rb

@@ -809,6 +809,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 查询页面录制任务
+
+        # @param request: Request instance for DescribeWebRecord.
+        # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeWebRecordRequest`
+        # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeWebRecordResponse`
+        def DescribeWebRecord(request)
+          body = send_request('DescribeWebRecord', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeWebRecordResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 接口说明：把房间所有用户从房间移出，解散房间。支持所有平台，Android、iOS、Windows 和 macOS 需升级到 TRTC SDK 6.6及以上版本。
 
         # @param request: Request instance for DismissRoom.
@@ -1186,6 +1210,31 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 通过此接口可以发起 WEB 页面录制任务，在接口参数中指定录制 URL，录制分辨率，录制结果存储等参数。
+        # 因为参数或API逻辑问题会立即返回结果。而因为页面问题，如页面无法访问，会在回调中返回结果，请关注。
+
+        # @param request: Request instance for StartWebRecord.
+        # @type request: :class:`Tencentcloud::trtc::V20190722::StartWebRecordRequest`
+        # @rtype: :class:`Tencentcloud::trtc::V20190722::StartWebRecordResponse`
+        def StartWebRecord(request)
+          body = send_request('StartWebRecord', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = StartWebRecordResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 接口说明：结束云端混流
 
         # @param request: Request instance for StopMCUMixTranscode.
@@ -1282,6 +1331,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 停止页面录制任务
+
+        # @param request: Request instance for StopWebRecord.
+        # @type request: :class:`Tencentcloud::trtc::V20190722::StopWebRecordRequest`
+        # @rtype: :class:`Tencentcloud::trtc::V20190722::StopWebRecordResponse`
+        def StopWebRecord(request)
+          body = send_request('StopWebRecord', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = StopWebRecordResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 更新转推任务。
         # 注：请参见启动转推任务的接口说明和使用说明。
 

data/lib/v20190722/models.rb

@@ -1876,6 +1876,43 @@ module TencentCloud
         end
       end
 
+      # DescribeWebRecord请求参数结构体
+      class DescribeWebRecordRequest < TencentCloud::Common::AbstractModel
+        # @param TaskId: 开始页面录制时返回的任务id
+        # @type TaskId: String
+
+        attr_accessor :TaskId
+
+        def initialize(taskid=nil)
+          @TaskId = taskid
+        end
+
+        def deserialize(params)
+          @TaskId = params['TaskId']
+        end
+      end
+
+      # DescribeWebRecord返回参数结构体
+      class DescribeWebRecordResponse < TencentCloud::Common::AbstractModel
+        # @param Status: 1: 正在录制中
+        # 2: 任务不存在
+        # @type Status: Integer
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :Status, :RequestId
+
+        def initialize(status=nil, requestid=nil)
+          @Status = status
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @Status = params['Status']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DismissRoomByStrRoomId请求参数结构体
       class DismissRoomByStrRoomIdRequest < TencentCloud::Common::AbstractModel
         # @param SdkAppId: TRTC的SDKAppId。
@@ -3934,6 +3971,69 @@ module TencentCloud
         end
       end
 
+      # StartWebRecord请求参数结构体
+      class StartWebRecordRequest < TencentCloud::Common::AbstractModel
+        # @param RecordUrl: 需要录制的网页URL
+        # @type RecordUrl: String
+        # @param MaxDurationLimit: 录制最大时长限制， 单位 s, 合法取值范围[0, 36000], 默认 36000s(10 小时)
+        # @type MaxDurationLimit: Integer
+        # @param StorageParams: 云存储相关的参数，目前支持腾讯云对象存储，不支持第三方云存储以及VOD
+        # @type StorageParams: :class:`Tencentcloud::Trtc.v20190722.models.StorageParams`
+        # @param WebRecordVideoParams: 页面录制视频参数
+        # @type WebRecordVideoParams: :class:`Tencentcloud::Trtc.v20190722.models.WebRecordVideoParams`
+        # @param SdkAppId: TRTC的SdkAppId
+        # @type SdkAppId: Integer
+        # @param RecordId: 当对重复任务敏感时，请关注此值： 为了避免任务在短时间内重复发起，导致任务重复
+        # 传入录制RecordId来标识此次任务， 小于32字节，若携带RecordId发起两次以上的开始录制请求，任务只会启动一个，第二个报错FailedOperation.TaskExist。注意StartWebRecord调用失败时而非FailedOperation.TaskExist错误，请更换RecordId重新发起。
+        # @type RecordId: String
+
+        attr_accessor :RecordUrl, :MaxDurationLimit, :StorageParams, :WebRecordVideoParams, :SdkAppId, :RecordId
+
+        def initialize(recordurl=nil, maxdurationlimit=nil, storageparams=nil, webrecordvideoparams=nil, sdkappid=nil, recordid=nil)
+          @RecordUrl = recordurl
+          @MaxDurationLimit = maxdurationlimit
+          @StorageParams = storageparams
+          @WebRecordVideoParams = webrecordvideoparams
+          @SdkAppId = sdkappid
+          @RecordId = recordid
+        end
+
+        def deserialize(params)
+          @RecordUrl = params['RecordUrl']
+          @MaxDurationLimit = params['MaxDurationLimit']
+          unless params['StorageParams'].nil?
+            @StorageParams = StorageParams.new
+            @StorageParams.deserialize(params['StorageParams'])
+          end
+          unless params['WebRecordVideoParams'].nil?
+            @WebRecordVideoParams = WebRecordVideoParams.new
+            @WebRecordVideoParams.deserialize(params['WebRecordVideoParams'])
+          end
+          @SdkAppId = params['SdkAppId']
+          @RecordId = params['RecordId']
+        end
+      end
+
+      # StartWebRecord返回参数结构体
+      class StartWebRecordResponse < TencentCloud::Common::AbstractModel
+        # @param TaskId: 录制任务的唯一Id
+        # @type TaskId: String
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :TaskId, :RequestId
+
+        def initialize(taskid=nil, requestid=nil)
+          @TaskId = taskid
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @TaskId = params['TaskId']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # StopMCUMixTranscodeByStrRoomId请求参数结构体
       class StopMCUMixTranscodeByStrRoomIdRequest < TencentCloud::Common::AbstractModel
         # @param SdkAppId: TRTC的SDKAppId。
@@ -4082,6 +4182,38 @@ module TencentCloud
         end
       end
 
+      # StopWebRecord请求参数结构体
+      class StopWebRecordRequest < TencentCloud::Common::AbstractModel
+        # @param TaskId: 需要停止的任务Id
+        # @type TaskId: String
+
+        attr_accessor :TaskId
+
+        def initialize(taskid=nil)
+          @TaskId = taskid
+        end
+
+        def deserialize(params)
+          @TaskId = params['TaskId']
+        end
+      end
+
+      # StopWebRecord返回参数结构体
+      class StopWebRecordResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
       # 云端录制查询接口，录制文件的信息
       class StorageFile < TencentCloud::Common::AbstractModel
         # @param UserId: 录制文件对应的UserId，如果是混流的话的这里返回的是空串。
@@ -4257,7 +4389,7 @@ module TencentCloud
         # @param MediaType: 上传到vod平台的录制文件格式类型，0：mp4(默认), 1: hls, 2:aac(StreamType=1纯音频录制时有效),
         # 3: hls+mp4, 4: hls+aac(StreamType=1纯音频录制时有效)。
         # @type MediaType: Integer
-        # @param UserDefineRecordId: 仅支持API录制上传vod，该参数表示用户可以自定义录制文件名前缀，【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符】。前缀与自动生成的录制文件名之间用__UserDefine_u_分开。
+        # @param UserDefineRecordId: 仅支持API录制上传vod，该参数表示用户可以自定义录制文件名前缀，【限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符】。前缀与自动生成的录制文件名之间用`__UserDefine_u_` 分开。
         # @type UserDefineRecordId: String
 
         attr_accessor :Procedure, :ExpireTime, :StorageRegion, :ClassId, :SubAppId, :SessionContext, :SourceContext, :MediaType, :UserDefineRecordId
@@ -4769,6 +4901,30 @@ module TencentCloud
         end
       end
 
+      # 页面录制视频参数
+      class WebRecordVideoParams < TencentCloud::Common::AbstractModel
+        # @param Width: 录制画面宽度，默认为1280，取值范围[0, 1920]
+        # @type Width: Integer
+        # @param Height: 录制画面高度，默认为720，取值范围[0, 1080]
+        # @type Height: Integer
+        # @param Format: 指定输出格式，可选hls,mp4
+        # @type Format: String
+
+        attr_accessor :Width, :Height, :Format
+
+        def initialize(width=nil, height=nil, format=nil)
+          @Width = width
+          @Height = height
+          @Format = format
+        end
+
+        def deserialize(params)
+          @Width = params['Width']
+          @Height = params['Height']
+          @Format = params['Format']
+        end
+      end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-trtc
 version: !ruby/object:Gem::Version
-  version: 3.0.787
+  version: 3.0.788
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-03-20 00:00:00.000000000 Z
+date: 2024-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common