tencentcloud-sdk-live 1.0.263 → 1.0.264

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5209db79c2dfb41a0294170719db007144301c30
-  data.tar.gz: 8cb9d25aa49e4bcf3ceb215af3f462a7ca89832b
+  metadata.gz: c1292fad391504611eb5f3f6eb12a3bd7c408512
+  data.tar.gz: 77cb773f777f0c34eeffb4b314afa76e61a1267f
 SHA512:
-  metadata.gz: 44136df6de0976d7fbb595f89fccfab667e566189e220b9058b8b974437db214fe8fbbfe6aacd3613647bde3f451927fe210fd4bfedb41266a15e8e7256ea803
-  data.tar.gz: b427b651d25af13e6ec34efbd88d2cc56dc6ce2f7397956a94657e21d23e86d20f1c67ed5e577a0bcb8237fec9d681f545751eb5b08d5d4eabb0219f996fce7f
+  metadata.gz: eb323445fcb9d762e6e1bb0277557f3abe6d3303e7dd92f7f2e3fecc9c137c39f67d805934e72f5ba295ac487f18dde4dcf1f8bcff72cc5c4a90915799b74875
+  data.tar.gz: 21f2b74324344ad875b02b894d33592e0536917f47174e39566ccdbddec41eb96d2edebc2e220b2d05401ac329e91e5e96cf621464fb58ad95aae3277f898a8d

data/lib/VERSION

@@ -1 +1 @@
-1.0.263
+1.0.264

data/lib/v20180801/client.rb

@@ -561,6 +561,36 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 创建一个在指定时间启动、结束的截图任务，并使用指定截图模板ID对应的配置进行截图。
+        # - 注意事项
+        # 1. 断流会结束当前截图。在结束时间到达之前任务仍然有效，期间只要正常推流都会正常截图，与是否多次推、断流无关。
+        # 2. 使用上避免创建时间段相互重叠的截图任务。若同一条流当前存在多个时段重叠的任务，为避免重复系统将启动最多3个截图任务。
+        # 3. 创建的截图任务记录在平台侧只保留3个月。
+        # 4. 当前截图任务管理API（CreateScreenshotTask/StopScreenshotTask/DeleteScreenshotTask）与旧API（CreateLiveInstantSnapshot/StopLiveInstantSnapshot）不兼容，两套接口不能混用。
+        # 5. 避免 创建截图任务 与 推流 操作同时进行，可能导致因截图任务未生效而引起任务延迟启动问题，两者操作间隔建议大于3秒。
+
+        # @param request: Request instance for CreateScreenshotTask.
+        # @type request: :class:`Tencentcloud::live::V20180801::CreateScreenshotTaskRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::CreateScreenshotTaskResponse`
+        def CreateScreenshotTask(request)
+          body = send_request('CreateScreenshotTask', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateScreenshotTaskResponse.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 DeleteLiveCallbackRule.
@@ -949,6 +979,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 删除截图任务配置。删除操作不影响正在运行当中的任务，仅对删除之后新的推流有效。
+
+        # @param request: Request instance for DeleteScreenshotTask.
+        # @type request: :class:`Tencentcloud::live::V20180801::DeleteScreenshotTaskRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::DeleteScreenshotTaskResponse`
+        def DeleteScreenshotTask(request)
+          body = send_request('DeleteScreenshotTask', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DeleteScreenshotTaskResponse.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
+
         # 输入某个时间点（1分钟维度），查询该时间点所有流的下行信息。
 
         # @param request: Request instance for DescribeAllStreamPlayInfoList.
@@ -2228,6 +2282,33 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 查询指定时间段范围内启动和结束的截图任务列表。
+        # - 使用前提
+        # 1. 仅用于查询由 CreateScreenshotTask接口创建的截图任务。
+        # 2. 不能查询被 DeleteScreenshotTask接口删除以及已过期（平台侧保留3个月）的截图任务。
+
+        # @param request: Request instance for DescribeScreenshotTask.
+        # @type request: :class:`Tencentcloud::live::V20180801::DescribeScreenshotTaskRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::DescribeScreenshotTaskResponse`
+        def DescribeScreenshotTask(request)
+          body = send_request('DescribeScreenshotTask', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeScreenshotTaskResponse.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 DescribeStreamDayPlayInfoList.
@@ -2880,6 +2961,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 提前结束截图，中止运行中的截图任务。任务被成功终止后，本次任务将不再启动。
+
+        # @param request: Request instance for StopScreenshotTask.
+        # @type request: :class:`Tencentcloud::live::V20180801::StopScreenshotTaskRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::StopScreenshotTaskResponse`
+        def StopScreenshotTask(request)
+          body = send_request('StopScreenshotTask', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = StopScreenshotTaskResponse.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 UnBindLiveDomainCert.

data/lib/v20180801/models.rb

@@ -1962,6 +1962,72 @@ module TencentCloud
         end
       end
 
+      # CreateScreenshotTask请求参数结构体
+      class CreateScreenshotTaskRequest < TencentCloud::Common::AbstractModel
+        # @param StreamName: 流名称。
+        # @type StreamName: String
+        # @param DomainName: 推流域名。
+        # @type DomainName: String
+        # @param AppName: 推流路径。
+        # @type AppName: String
+        # @param EndTime: 截图任务结束时间，Unix时间戳。设置时间必须大于StartTime及当前时间，且EndTime - StartTime不能超过24小时。
+        # @type EndTime: Integer
+        # @param TemplateId: 截图模板ID，CreateLiveSnapshotTemplate 返回值。如果传入错误ID，则不拉起截图。
+        # @type TemplateId: Integer
+        # @param StartTime: 截图任务开始时间，Unix时间戳。如果不填表示立即启动截图。StartTime不能超过当前时间+6天。
+        # @type StartTime: Integer
+        # @param StreamType: 推流类型，默认0。取值：
+        # 0-直播推流。
+        # 1-合成流，即 A+B=C 类型混流。
+        # @type StreamType: Integer
+        # @param Extension: 扩展字段，暂无定义。默认为空。
+        # @type Extension: String
+
+        attr_accessor :StreamName, :DomainName, :AppName, :EndTime, :TemplateId, :StartTime, :StreamType, :Extension
+        
+        def initialize(streamname=nil, domainname=nil, appname=nil, endtime=nil, templateid=nil, starttime=nil, streamtype=nil, extension=nil)
+          @StreamName = streamname
+          @DomainName = domainname
+          @AppName = appname
+          @EndTime = endtime
+          @TemplateId = templateid
+          @StartTime = starttime
+          @StreamType = streamtype
+          @Extension = extension
+        end
+
+        def deserialize(params)
+          @StreamName = params['StreamName']
+          @DomainName = params['DomainName']
+          @AppName = params['AppName']
+          @EndTime = params['EndTime']
+          @TemplateId = params['TemplateId']
+          @StartTime = params['StartTime']
+          @StreamType = params['StreamType']
+          @Extension = params['Extension']
+        end
+      end
+
+      # CreateScreenshotTask返回参数结构体
+      class CreateScreenshotTaskResponse < TencentCloud::Common::AbstractModel
+        # @param TaskId: 任务ID，全局唯一标识截图任务。返回TaskId字段说明截图任务创建成功。
+        # @type TaskId: String
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 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
+
       # 流播放信息
       class DayStreamPlayInfo < TencentCloud::Common::AbstractModel
         # @param Time: 数据时间点，格式：yyyy-mm-dd HH:MM:SS。
@@ -2618,6 +2684,38 @@ module TencentCloud
         end
       end
 
+      # DeleteScreenshotTask请求参数结构体
+      class DeleteScreenshotTaskRequest < TencentCloud::Common::AbstractModel
+        # @param TaskId: 任务ID，CreateScreenshotTask返回。删除TaskId指定的截图任务。
+        # @type TaskId: String
+
+        attr_accessor :TaskId
+        
+        def initialize(taskid=nil)
+          @TaskId = taskid
+        end
+
+        def deserialize(params)
+          @TaskId = params['TaskId']
+        end
+      end
+
+      # DeleteScreenshotTask返回参数结构体
+      class DeleteScreenshotTaskResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+        
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeAllStreamPlayInfoList请求参数结构体
       class DescribeAllStreamPlayInfoListRequest < TencentCloud::Common::AbstractModel
         # @param QueryTime: 查询时间点，精确到分钟粒度，支持最近1个月的数据查询，数据延迟为5分钟左右，如果要查询实时的数据，建议传递5分钟前的时间点，格式为yyyy-mm-dd HH:MM:00。（只精确至分钟，秒数填00）。
@@ -5716,6 +5814,73 @@ module TencentCloud
         end
       end
 
+      # DescribeScreenshotTask请求参数结构体
+      class DescribeScreenshotTaskRequest < TencentCloud::Common::AbstractModel
+        # @param StartTime: 查询任务开始时间，Unix 时间戳。设置时间不早于当前时间之前90天的时间，且查询时间跨度不超过一周。
+        # @type StartTime: Integer
+        # @param EndTime: 查询任务结束时间，Unix 时间戳。EndTime 必须大于 StartTime，设置时间不早于当前时间之前90天的时间，且查询时间跨度不超过一周。（注意：任务开始结束时间必须在查询时间范围内）。
+        # @type EndTime: Integer
+        # @param StreamName: 流名称。
+        # @type StreamName: String
+        # @param DomainName: 推流域名。
+        # @type DomainName: String
+        # @param AppName: 推流路径。
+        # @type AppName: String
+        # @param ScrollToken: 翻页标识，分批拉取时使用：当单次请求无法拉取所有数据，接口将会返回 ScrollToken，下一次请求携带该 Token，将会从下一条记录开始获取。
+        # @type ScrollToken: String
+
+        attr_accessor :StartTime, :EndTime, :StreamName, :DomainName, :AppName, :ScrollToken
+        
+        def initialize(starttime=nil, endtime=nil, streamname=nil, domainname=nil, appname=nil, scrolltoken=nil)
+          @StartTime = starttime
+          @EndTime = endtime
+          @StreamName = streamname
+          @DomainName = domainname
+          @AppName = appname
+          @ScrollToken = scrolltoken
+        end
+
+        def deserialize(params)
+          @StartTime = params['StartTime']
+          @EndTime = params['EndTime']
+          @StreamName = params['StreamName']
+          @DomainName = params['DomainName']
+          @AppName = params['AppName']
+          @ScrollToken = params['ScrollToken']
+        end
+      end
+
+      # DescribeScreenshotTask返回参数结构体
+      class DescribeScreenshotTaskResponse < TencentCloud::Common::AbstractModel
+        # @param ScrollToken: 翻页标识，当请求未返回所有数据，该字段表示下一条记录的 Token。当该字段为空，说明已无更多数据。
+        # @type ScrollToken: String
+        # @param TaskList: 截图任务列表。当该字段为空，说明已返回所有数据。
+        # @type TaskList: Array
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :ScrollToken, :TaskList, :RequestId
+        
+        def initialize(scrolltoken=nil, tasklist=nil, requestid=nil)
+          @ScrollToken = scrolltoken
+          @TaskList = tasklist
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @ScrollToken = params['ScrollToken']
+          unless params['TaskList'].nil?
+            @TaskList = []
+            params['TaskList'].each do |i|
+              screenshottask_tmp = ScreenshotTask.new
+              screenshottask_tmp.deserialize(i)
+              @TaskList << screenshottask_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeStreamDayPlayInfoList请求参数结构体
       class DescribeStreamDayPlayInfoListRequest < TencentCloud::Common::AbstractModel
         # @param DayTime: 日期，格式：YYYY-mm-dd。
@@ -8681,6 +8846,50 @@ module TencentCloud
         end
       end
 
+      # 截图任务
+      class ScreenshotTask < TencentCloud::Common::AbstractModel
+        # @param TaskId: 截图任务ID。
+        # @type TaskId: String
+        # @param DomainName: 推流域名。
+        # @type DomainName: String
+        # @param AppName: 推流路径。
+        # @type AppName: String
+        # @param StreamName: 流名称。
+        # @type StreamName: String
+        # @param StartTime: 任务开始时间，Unix时间戳。
+        # @type StartTime: Integer
+        # @param EndTime: 任务结束时间，Unix时间戳。
+        # @type EndTime: Integer
+        # @param TemplateId: 截图模板ID。
+        # @type TemplateId: Integer
+        # @param Stopped: 调用 StopScreenshotTask 停止任务时间，Unix时间戳。值为0表示未曾调用接口停止任务。
+        # @type Stopped: Integer
+
+        attr_accessor :TaskId, :DomainName, :AppName, :StreamName, :StartTime, :EndTime, :TemplateId, :Stopped
+        
+        def initialize(taskid=nil, domainname=nil, appname=nil, streamname=nil, starttime=nil, endtime=nil, templateid=nil, stopped=nil)
+          @TaskId = taskid
+          @DomainName = domainname
+          @AppName = appname
+          @StreamName = streamname
+          @StartTime = starttime
+          @EndTime = endtime
+          @TemplateId = templateid
+          @Stopped = stopped
+        end
+
+        def deserialize(params)
+          @TaskId = params['TaskId']
+          @DomainName = params['DomainName']
+          @AppName = params['AppName']
+          @StreamName = params['StreamName']
+          @StartTime = params['StartTime']
+          @EndTime = params['EndTime']
+          @TemplateId = params['TemplateId']
+          @Stopped = params['Stopped']
+        end
+      end
+
       # 截图模板信息。
       class SnapshotTemplateInfo < TencentCloud::Common::AbstractModel
         # @param TemplateId: 模板 ID。
@@ -8813,6 +9022,38 @@ module TencentCloud
         end
       end
 
+      # StopScreenshotTask请求参数结构体
+      class StopScreenshotTaskRequest < 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
+
+      # StopScreenshotTask返回参数结构体
+      class StopScreenshotTaskResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+        
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
       # 推断流事件信息。
       class StreamEventInfo < TencentCloud::Common::AbstractModel
         # @param AppName: 应用名称。

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-live
 version: !ruby/object:Gem::Version
-  version: 1.0.263
+  version: 1.0.264
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-23 00:00:00.000000000 Z
+date: 2022-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common