tencentcloud-sdk-live 3.0.1074 → 3.0.1086

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 717096b1e74047f1cc8526c9a0321b40fe724a65
-  data.tar.gz: 243025b236b18619f34a8ca8b72450698b952999
+  metadata.gz: c13ab1fe109b69efec540c42a20fbe1e5567d34c
+  data.tar.gz: 735051ab8bc115d2ea34c2f6c07a34cf4b5ce6d9
 SHA512:
-  metadata.gz: d5dbad4330ba6e3086389fc9033970e80f5a70889f853fbd4655a685bc6057e3c3b5eb34b8bd38aeebdaa204bfe93462e6c511f8ba1ec30d11ccc3ec2730f9be
-  data.tar.gz: f749ee16d90e5ba203c76ec137e6514f6d54ade8d543604df24482f442b916f38d87cd3dece7bee12dd8b1d1ae05292cfecff626517330a1c57aefa2ab639d8d
+  metadata.gz: fe4671ffa70942044cc5691d6c5208ca0297605d129ef98e423d18f07ea0ae03b1eb8193c6825ce3f7a50d842085564ed75e1d0c0a89532873a8baba429af07f
+  data.tar.gz: 45133810bea38ca713f22ab71047d955289392e6a26e854f7ac2de52d983ed932602d5fb881e01564275199cd927844335c04b8bf4387a3981f8f7ceeaabd65b

data/lib/VERSION

@@ -1 +1 @@
-3.0.1074
+3.0.1086

data/lib/v20180801/client.rb

@@ -2238,6 +2238,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 使用该接口查询云端特效列表，特效列表中包含一部分官方精品特效，同时包含用户自定义生成的特效。
+
+        # @param request: Request instance for DescribeLiveCloudEffectList.
+        # @type request: :class:`Tencentcloud::live::V20180801::DescribeLiveCloudEffectListRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::DescribeLiveCloudEffectListResponse`
+        def DescribeLiveCloudEffectList(request)
+          body = send_request('DescribeLiveCloudEffectList', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeLiveCloudEffectListResponse.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 DescribeLiveDelayInfoList.
@@ -2530,6 +2554,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 使用该接口查询垫片流列表。垫片流状态更新存在一定延迟，可间隔30秒以上查询，避免频繁查询该接口。
+
+        # @param request: Request instance for DescribeLivePadStreamList.
+        # @type request: :class:`Tencentcloud::live::V20180801::DescribeLivePadStreamListRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::DescribeLivePadStreamListResponse`
+        def DescribeLivePadStreamList(request)
+          body = send_request('DescribeLivePadStreamList', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = DescribeLivePadStreamListResponse.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 DescribeLivePadTemplate.
@@ -4578,6 +4626,54 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 使用该接口发送云端特效到线上正活跃的直播流，观众可在播放端看到特效从直播流画面中展示。
+
+        # @param request: Request instance for SendLiveCloudEffect.
+        # @type request: :class:`Tencentcloud::live::V20180801::SendLiveCloudEffectRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::SendLiveCloudEffectResponse`
+        def SendLiveCloudEffect(request)
+          body = send_request('SendLiveCloudEffect', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = SendLiveCloudEffectResponse.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 StartLivePadStream.
+        # @type request: :class:`Tencentcloud::live::V20180801::StartLivePadStreamRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::StartLivePadStreamResponse`
+        def StartLivePadStream(request)
+          body = send_request('StartLivePadStream', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = StartLivePadStreamResponse.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 StartLiveStreamMonitor.
@@ -4675,6 +4771,30 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 使用该接口将直播流停止切入垫片。
+
+        # @param request: Request instance for StopLivePadStream.
+        # @type request: :class:`Tencentcloud::live::V20180801::StopLivePadStreamRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::StopLivePadStreamResponse`
+        def StopLivePadStream(request)
+          body = send_request('StopLivePadStream', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = StopLivePadStreamResponse.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 StopLiveRecord.

data/lib/v20180801/models.rb

@@ -1536,6 +1536,49 @@ module TencentCloud
         end
       end
 
+      # 云端特效信息。
+      class CloudEffectInfo < TencentCloud::Common::AbstractModel
+        # @param Id: 云端特效 ID。
+        # @type Id: String
+        # @param Prompt: 云端特效描述词。
+        # @type Prompt: String
+        # @param Flag: 云端特效标签。
+        # @type Flag: String
+        # @param PreviewImageUrl: 云端特效预览图片。
+        # @type PreviewImageUrl: String
+        # @param Type: 云端特效类型。
+        # PGC : 官方精品特效。
+        # AIGC : AI生成的特效。
+        # UGC : 用户上传特效。
+        # @type Type: String
+        # @param CreateTime: 云端特效创建时间。
+        # @type CreateTime: String
+        # @param UpdateTime: 云端特效更新时间。
+        # @type UpdateTime: String
+
+        attr_accessor :Id, :Prompt, :Flag, :PreviewImageUrl, :Type, :CreateTime, :UpdateTime
+
+        def initialize(id=nil, prompt=nil, flag=nil, previewimageurl=nil, type=nil, createtime=nil, updatetime=nil)
+          @Id = id
+          @Prompt = prompt
+          @Flag = flag
+          @PreviewImageUrl = previewimageurl
+          @Type = type
+          @CreateTime = createtime
+          @UpdateTime = updatetime
+        end
+
+        def deserialize(params)
+          @Id = params['Id']
+          @Prompt = params['Prompt']
+          @Flag = params['Flag']
+          @PreviewImageUrl = params['PreviewImageUrl']
+          @Type = params['Type']
+          @CreateTime = params['CreateTime']
+          @UpdateTime = params['UpdateTime']
+        end
+      end
+
       # 通用混流控制参数
       class CommonMixControlParams < TencentCloud::Common::AbstractModel
         # @param UseMixCropCenter: 取值范围[0,1]。
@@ -6114,6 +6157,61 @@ module TencentCloud
         end
       end
 
+      # DescribeLiveCloudEffectList请求参数结构体
+      class DescribeLiveCloudEffectListRequest < TencentCloud::Common::AbstractModel
+        # @param Id: 云端特效ID。
+        # @type Id: String
+        # @param Prompt: 云端特效描述词。由用户原始输入的描述词。
+        # @type Prompt: String
+        # @param Flag: 云端特效标签。对云端特效进行分类标签，可用于分类搜索。
+        # @type Flag: String
+        # @param Type: 云端特效类型, 默认不填，返回全部。PGC: 特效库中的特效；AICG : AI生成的特效；UGC：用户自定义上传的特效；
+        # @type Type: String
+
+        attr_accessor :Id, :Prompt, :Flag, :Type
+
+        def initialize(id=nil, prompt=nil, flag=nil, type=nil)
+          @Id = id
+          @Prompt = prompt
+          @Flag = flag
+          @Type = type
+        end
+
+        def deserialize(params)
+          @Id = params['Id']
+          @Prompt = params['Prompt']
+          @Flag = params['Flag']
+          @Type = params['Type']
+        end
+      end
+
+      # DescribeLiveCloudEffectList返回参数结构体
+      class DescribeLiveCloudEffectListResponse < TencentCloud::Common::AbstractModel
+        # @param InfoList: 云端特效信息列表。
+        # @type InfoList: Array
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :InfoList, :RequestId
+
+        def initialize(infolist=nil, requestid=nil)
+          @InfoList = infolist
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          unless params['InfoList'].nil?
+            @InfoList = []
+            params['InfoList'].each do |i|
+              cloudeffectinfo_tmp = CloudEffectInfo.new
+              cloudeffectinfo_tmp.deserialize(i)
+              @InfoList << cloudeffectinfo_tmp
+            end
+          end
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeLiveDelayInfoList请求参数结构体
       class DescribeLiveDelayInfoListRequest < TencentCloud::Common::AbstractModel
 
@@ -6807,6 +6905,81 @@ module TencentCloud
         end
       end
 
+      # DescribeLivePadStreamList请求参数结构体
+      class DescribeLivePadStreamListRequest < TencentCloud::Common::AbstractModel
+        # @param AppName: 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。
+        # @type AppName: String
+        # @param DomainName: 您的推流域名。
+        # @type DomainName: String
+        # @param StreamName: 流名称。
+        # @type StreamName: String
+        # @param PageNum: 分页页数。
+        # @type PageNum: Integer
+        # @param PageSize: 每页个数。
+        # @type PageSize: Integer
+
+        attr_accessor :AppName, :DomainName, :StreamName, :PageNum, :PageSize
+
+        def initialize(appname=nil, domainname=nil, streamname=nil, pagenum=nil, pagesize=nil)
+          @AppName = appname
+          @DomainName = domainname
+          @StreamName = streamname
+          @PageNum = pagenum
+          @PageSize = pagesize
+        end
+
+        def deserialize(params)
+          @AppName = params['AppName']
+          @DomainName = params['DomainName']
+          @StreamName = params['StreamName']
+          @PageNum = params['PageNum']
+          @PageSize = params['PageSize']
+        end
+      end
+
+      # DescribeLivePadStreamList返回参数结构体
+      class DescribeLivePadStreamListResponse < TencentCloud::Common::AbstractModel
+        # @param StreamInfoList: 当前正在拉取垫片的流信息列表。
+        # @type StreamInfoList: Array
+        # @param PageNum: 传入的分页页数。
+        # @type PageNum: Integer
+        # @param PageSize: 传入的分页个数。
+        # @type PageSize: Integer
+        # @param TotalNum: 查询到的总个数。
+        # @type TotalNum: Integer
+        # @param TotalPage: 可以分的总页数。
+        # @type TotalPage: Integer
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :StreamInfoList, :PageNum, :PageSize, :TotalNum, :TotalPage, :RequestId
+
+        def initialize(streaminfolist=nil, pagenum=nil, pagesize=nil, totalnum=nil, totalpage=nil, requestid=nil)
+          @StreamInfoList = streaminfolist
+          @PageNum = pagenum
+          @PageSize = pagesize
+          @TotalNum = totalnum
+          @TotalPage = totalpage
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          unless params['StreamInfoList'].nil?
+            @StreamInfoList = []
+            params['StreamInfoList'].each do |i|
+              padstreaminfo_tmp = PadStreamInfo.new
+              padstreaminfo_tmp.deserialize(i)
+              @StreamInfoList << padstreaminfo_tmp
+            end
+          end
+          @PageNum = params['PageNum']
+          @PageSize = params['PageSize']
+          @TotalNum = params['TotalNum']
+          @TotalPage = params['TotalPage']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # DescribeLivePadTemplate请求参数结构体
       class DescribeLivePadTemplateRequest < TencentCloud::Common::AbstractModel
         # @param TemplateId: 模板id。
@@ -12746,6 +12919,40 @@ module TencentCloud
         end
       end
 
+      # 查询当前垫片流的信息
+      class PadStreamInfo < TencentCloud::Common::AbstractModel
+        # @param StreamName: 流名称。
+        # @type StreamName: String
+        # @param AppName: 应用名称。
+        # @type AppName: String
+        # @param DomainName: 推流域名。
+        # @type DomainName: String
+        # @param PadStreamType: 垫片流类型。
+        # 0-自动垫片；
+        # 1-手动切入垫片。
+        # @type PadStreamType: String
+        # @param PublishTime: 垫片流开始时间。UTC时间，示例：2025-04-10T00:01:00Z。注意：该时间与北京时间相差八小时。
+        # @type PublishTime: String
+
+        attr_accessor :StreamName, :AppName, :DomainName, :PadStreamType, :PublishTime
+
+        def initialize(streamname=nil, appname=nil, domainname=nil, padstreamtype=nil, publishtime=nil)
+          @StreamName = streamname
+          @AppName = appname
+          @DomainName = domainname
+          @PadStreamType = padstreamtype
+          @PublishTime = publishtime
+        end
+
+        def deserialize(params)
+          @StreamName = params['StreamName']
+          @AppName = params['AppName']
+          @DomainName = params['DomainName']
+          @PadStreamType = params['PadStreamType']
+          @PublishTime = params['PublishTime']
+        end
+      end
+
       # 直播垫片模板。
       class PadTemplate < TencentCloud::Common::AbstractModel
         # @param TemplateId: 模板id。
@@ -14079,6 +14286,69 @@ module TencentCloud
         end
       end
 
+      # SendLiveCloudEffect请求参数结构体
+      class SendLiveCloudEffectRequest < TencentCloud::Common::AbstractModel
+        # @param AppName: 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。
+        # @type AppName: String
+        # @param PushDomainName: 您的推流域名。
+        # @type PushDomainName: String
+        # @param StreamName: 流名称。
+        # @type StreamName: String
+        # @param Id: 云端特效 ID。
+        # @type Id: String
+        # @param Operator: 操作人备注信息。
+        # @type Operator: String
+        # @param ZoomFactor: 缩小比例，默认0 不缩放。
+        # 可选值：0-9， 值越大，越缩小。
+        # @type ZoomFactor: Integer
+        # @param XPosition: 指定云端特效渲染位置百分比。默认居中显示。
+        # 原点为画面左上角，该参数指定特效渲染离原点的横向比例，可选值 0 - 100。
+        # @type XPosition: String
+        # @param YPosition: 指定云端特效渲染位置百分比。默认居中显示。
+        # 原点为画面左上角，该参数指定特效渲染离原点的纵向比例，可选值 0 - 100。
+        # @type YPosition: String
+
+        attr_accessor :AppName, :PushDomainName, :StreamName, :Id, :Operator, :ZoomFactor, :XPosition, :YPosition
+
+        def initialize(appname=nil, pushdomainname=nil, streamname=nil, id=nil, operator=nil, zoomfactor=nil, xposition=nil, yposition=nil)
+          @AppName = appname
+          @PushDomainName = pushdomainname
+          @StreamName = streamname
+          @Id = id
+          @Operator = operator
+          @ZoomFactor = zoomfactor
+          @XPosition = xposition
+          @YPosition = yposition
+        end
+
+        def deserialize(params)
+          @AppName = params['AppName']
+          @PushDomainName = params['PushDomainName']
+          @StreamName = params['StreamName']
+          @Id = params['Id']
+          @Operator = params['Operator']
+          @ZoomFactor = params['ZoomFactor']
+          @XPosition = params['XPosition']
+          @YPosition = params['YPosition']
+        end
+      end
+
+      # SendLiveCloudEffect返回参数结构体
+      class SendLiveCloudEffectResponse < 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 SnapshotTemplateInfo < TencentCloud::Common::AbstractModel
         # @param TemplateId: 模板 ID。
@@ -14143,6 +14413,50 @@ module TencentCloud
         end
       end
 
+      # StartLivePadStream请求参数结构体
+      class StartLivePadStreamRequest < TencentCloud::Common::AbstractModel
+        # @param AppName: 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。
+        # @type AppName: String
+        # @param PushDomainName: 您的推流域名。
+        # @type PushDomainName: String
+        # @param StreamName: 流名称。
+        # @type StreamName: String
+        # @param Operator: 操作人备注信息。
+        # @type Operator: String
+
+        attr_accessor :AppName, :PushDomainName, :StreamName, :Operator
+
+        def initialize(appname=nil, pushdomainname=nil, streamname=nil, operator=nil)
+          @AppName = appname
+          @PushDomainName = pushdomainname
+          @StreamName = streamname
+          @Operator = operator
+        end
+
+        def deserialize(params)
+          @AppName = params['AppName']
+          @PushDomainName = params['PushDomainName']
+          @StreamName = params['StreamName']
+          @Operator = params['Operator']
+        end
+      end
+
+      # StartLivePadStream返回参数结构体
+      class StartLivePadStreamResponse < 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
+
       # StartLiveStreamMonitor请求参数结构体
       class StartLiveStreamMonitorRequest < TencentCloud::Common::AbstractModel
         # @param MonitorId: 监播ID。
@@ -14293,6 +14607,50 @@ module TencentCloud
         end
       end
 
+      # StopLivePadStream请求参数结构体
+      class StopLivePadStreamRequest < TencentCloud::Common::AbstractModel
+        # @param AppName: 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。
+        # @type AppName: String
+        # @param PushDomainName: 您的推流域名。
+        # @type PushDomainName: String
+        # @param StreamName: 流名称。
+        # @type StreamName: String
+        # @param Operator: 操作人备注信息。
+        # @type Operator: String
+
+        attr_accessor :AppName, :PushDomainName, :StreamName, :Operator
+
+        def initialize(appname=nil, pushdomainname=nil, streamname=nil, operator=nil)
+          @AppName = appname
+          @PushDomainName = pushdomainname
+          @StreamName = streamname
+          @Operator = operator
+        end
+
+        def deserialize(params)
+          @AppName = params['AppName']
+          @PushDomainName = params['PushDomainName']
+          @StreamName = params['StreamName']
+          @Operator = params['Operator']
+        end
+      end
+
+      # StopLivePadStream返回参数结构体
+      class StopLivePadStreamResponse < 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
+
       # StopLiveRecord请求参数结构体
       class StopLiveRecordRequest < TencentCloud::Common::AbstractModel
         # @param StreamName: 流名称。

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-live
 version: !ruby/object:Gem::Version
-  version: 3.0.1074
+  version: 3.0.1086
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-06-04 00:00:00.000000000 Z
+date: 2025-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common