tencentcloud-sdk-live 3.0.949 → 3.0.951

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4e4bfac03cf893eafbc97e32c2576c4a8b63afc9
-  data.tar.gz: 16a1c13b157730401e00ad8686de435a91fd7b29
+  metadata.gz: 2d1dd7018bc02eb8887040927c766d85691b5303
+  data.tar.gz: e68a480f9d9d90a2aee6190fb58bf32ef31b3d81
 SHA512:
-  metadata.gz: 8b35980d406660cf8ca81983af0050232b6da0d8208645bfa7bebb187f32fb6790d57fc1f44d804c0c0d301439aa578298589bc4f5c19f64d979d5fb0a574a22
-  data.tar.gz: a2acc77c760f7a4edc127fd3cd6919a16669623051fd5b2e7f4a4d19c0ca69a8a653a4848ec04144946c663f4f532bde72f42cf477a5e0bf5d518c8869401338
+  metadata.gz: 5923a4363f8c2d5a8c7c3156842fda6f644fe6de210b4d59a1706311301c41b805db232fef460f385343b2890ee88b3fd47bb0dbd126cc3e95dcf70dd7d3d804
+  data.tar.gz: aa3c16a065752b3232d7a79f8cc29aadb5394ad5501fda05745e80f9d91e4d3f02546f6a080b7ecaafad4b593637c5d91a61a5ed06c5cc5ced6d19677821869a

data/lib/VERSION

@@ -1 +1 @@
-3.0.949
+3.0.951

data/lib/v20180801/client.rb

@@ -295,6 +295,79 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 该接口用来启动主监任务，并将获取主监画面的播放地址。
+
+        # @param request: Request instance for CreateCasterPgm.
+        # @type request: :class:`Tencentcloud::live::V20180801::CreateCasterPgmRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::CreateCasterPgmResponse`
+        def CreateCasterPgm(request)
+          body = send_request('CreateCasterPgm', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateCasterPgmResponse.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 CreateCasterPgmFromPvw.
+        # @type request: :class:`Tencentcloud::live::V20180801::CreateCasterPgmFromPvwRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::CreateCasterPgmFromPvwResponse`
+        def CreateCasterPgmFromPvw(request)
+          body = send_request('CreateCasterPgmFromPvw', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateCasterPgmFromPvwResponse.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 CreateCasterPvw.
+        # @type request: :class:`Tencentcloud::live::V20180801::CreateCasterPvwRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::CreateCasterPvwResponse`
+        def CreateCasterPvw(request)
+          body = send_request('CreateCasterPvw', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateCasterPvwResponse.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
+
         # 该接口用来创建通用混流。用法与旧接口 mix_streamv2.start_mix_stream_advanced 基本一致。
         # 注意：当前最多支持16路混流。
         # 最佳实践：https://cloud.tencent.com/document/product/267/45566
@@ -4187,6 +4260,32 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 调用该接口，释放导播台实例，但保留所有的配置。
+        # 执行该接口，预监与主监画面停止，第三方推流停止。
+        # 点播文件与直播地址将停止展示，客户自行推到导播台的流需要手动停止。
+
+        # @param request: Request instance for ReleaseCaster.
+        # @type request: :class:`Tencentcloud::live::V20180801::ReleaseCasterRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::ReleaseCasterResponse`
+        def ReleaseCaster(request)
+          body = send_request('ReleaseCaster', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ReleaseCasterResponse.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. 重启任务会造成推流中断。
@@ -4286,6 +4385,55 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 该接口用来停止导播台的主监输出。
+        # 停止主监后，对应的推流到腾讯云直播源站和推流到其他第三方平台均将会停止。
+
+        # @param request: Request instance for StopCasterPgm.
+        # @type request: :class:`Tencentcloud::live::V20180801::StopCasterPgmRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::StopCasterPgmResponse`
+        def StopCasterPgm(request)
+          body = send_request('StopCasterPgm', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = StopCasterPgmResponse.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 StopCasterPvw.
+        # @type request: :class:`Tencentcloud::live::V20180801::StopCasterPvwRequest`
+        # @rtype: :class:`Tencentcloud::live::V20180801::StopCasterPvwResponse`
+        def StopCasterPvw(request)
+          body = send_request('StopCasterPvw', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = StopCasterPvwResponse.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 StopLivePadProcessor.

data/lib/v20180801/models.rb

@@ -1713,6 +1713,173 @@ module TencentCloud
         end
       end
 
+      # CreateCasterPgmFromPvw请求参数结构体
+      class CreateCasterPgmFromPvwRequest < TencentCloud::Common::AbstractModel
+        # @param CasterId: 导播台ID。
+        # @type CasterId: Integer
+
+        attr_accessor :CasterId
+
+        def initialize(casterid=nil)
+          @CasterId = casterid
+        end
+
+        def deserialize(params)
+          @CasterId = params['CasterId']
+        end
+      end
+
+      # CreateCasterPgmFromPvw返回参数结构体
+      class CreateCasterPgmFromPvwResponse < TencentCloud::Common::AbstractModel
+        # @param PgmPlayUrl: 主监任务的rtmp协议预览地址。
+        # 注：该地址仅供预览，不可分发。
+        # @type PgmPlayUrl: String
+        # @param CdnPlayUrl: 注：该字段已废弃，请结合腾讯云直播播放地址生成策略生成cdn播放地址
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CdnPlayUrl: String
+        # @param CdnStreamId: 主监任务在腾讯云直播侧的流ID。
+        # @type CdnStreamId: String
+        # @param PgmWebRTCPlayUrl: 主监任务的webrtc协议播放地址。
+        # 注：
+        # 1.该预览地址仅作为预览，不可分发。
+        # 2.webrtc播放地址需配合腾讯云快直播播放sdk使用。
+        # @type PgmWebRTCPlayUrl: String
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :PgmPlayUrl, :CdnPlayUrl, :CdnStreamId, :PgmWebRTCPlayUrl, :RequestId
+
+        def initialize(pgmplayurl=nil, cdnplayurl=nil, cdnstreamid=nil, pgmwebrtcplayurl=nil, requestid=nil)
+          @PgmPlayUrl = pgmplayurl
+          @CdnPlayUrl = cdnplayurl
+          @CdnStreamId = cdnstreamid
+          @PgmWebRTCPlayUrl = pgmwebrtcplayurl
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @PgmPlayUrl = params['PgmPlayUrl']
+          @CdnPlayUrl = params['CdnPlayUrl']
+          @CdnStreamId = params['CdnStreamId']
+          @PgmWebRTCPlayUrl = params['PgmWebRTCPlayUrl']
+          @RequestId = params['RequestId']
+        end
+      end
+
+      # CreateCasterPgm请求参数结构体
+      class CreateCasterPgmRequest < TencentCloud::Common::AbstractModel
+        # @param PgmDisplayInfo: 导播台展示信息参数。
+        # @type PgmDisplayInfo: :class:`Tencentcloud::Live.v20180801.models.CasterDisplayInfo`
+        # @param CasterId: 导播台ID。
+        # @type CasterId: Integer
+
+        attr_accessor :PgmDisplayInfo, :CasterId
+
+        def initialize(pgmdisplayinfo=nil, casterid=nil)
+          @PgmDisplayInfo = pgmdisplayinfo
+          @CasterId = casterid
+        end
+
+        def deserialize(params)
+          unless params['PgmDisplayInfo'].nil?
+            @PgmDisplayInfo = CasterDisplayInfo.new
+            @PgmDisplayInfo.deserialize(params['PgmDisplayInfo'])
+          end
+          @CasterId = params['CasterId']
+        end
+      end
+
+      # CreateCasterPgm返回参数结构体
+      class CreateCasterPgmResponse < TencentCloud::Common::AbstractModel
+        # @param PgmPlayUrl: 主监任务的rtmp协议预览地址。
+        # 注：该地址仅供预览，不可分发。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type PgmPlayUrl: String
+        # @param CdnPlayUrl: 注：该字段已废弃，请结合腾讯云直播播放地址生成策略生成cdn播放地址。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CdnPlayUrl: String
+        # @param CdnStreamId: 主监任务在腾讯云直播侧的流ID。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type CdnStreamId: String
+        # @param PgmWebRTCPlayUrl: 主监任务的webrtc协议播放地址。
+        # 注：
+        # 1. 该预览地址仅作为预览，不可分发。
+        # 2. webrtc播放地址需配合腾讯云快直播播放sdk使用。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type PgmWebRTCPlayUrl: String
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :PgmPlayUrl, :CdnPlayUrl, :CdnStreamId, :PgmWebRTCPlayUrl, :RequestId
+
+        def initialize(pgmplayurl=nil, cdnplayurl=nil, cdnstreamid=nil, pgmwebrtcplayurl=nil, requestid=nil)
+          @PgmPlayUrl = pgmplayurl
+          @CdnPlayUrl = cdnplayurl
+          @CdnStreamId = cdnstreamid
+          @PgmWebRTCPlayUrl = pgmwebrtcplayurl
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @PgmPlayUrl = params['PgmPlayUrl']
+          @CdnPlayUrl = params['CdnPlayUrl']
+          @CdnStreamId = params['CdnStreamId']
+          @PgmWebRTCPlayUrl = params['PgmWebRTCPlayUrl']
+          @RequestId = params['RequestId']
+        end
+      end
+
+      # CreateCasterPvw请求参数结构体
+      class CreateCasterPvwRequest < TencentCloud::Common::AbstractModel
+        # @param PvwDisplayInfo: 导播台预监展示信息参数
+        # @type PvwDisplayInfo: :class:`Tencentcloud::Live.v20180801.models.CasterDisplayInfo`
+        # @param CasterId: 导播台ID。
+        # @type CasterId: Integer
+
+        attr_accessor :PvwDisplayInfo, :CasterId
+
+        def initialize(pvwdisplayinfo=nil, casterid=nil)
+          @PvwDisplayInfo = pvwdisplayinfo
+          @CasterId = casterid
+        end
+
+        def deserialize(params)
+          unless params['PvwDisplayInfo'].nil?
+            @PvwDisplayInfo = CasterDisplayInfo.new
+            @PvwDisplayInfo.deserialize(params['PvwDisplayInfo'])
+          end
+          @CasterId = params['CasterId']
+        end
+      end
+
+      # CreateCasterPvw返回参数结构体
+      class CreateCasterPvwResponse < TencentCloud::Common::AbstractModel
+        # @param PvwPlayUrl: 预监任务的画面rtmp协议预览地址。
+        # 注：该预览地址仅供画面预览，不可分发。
+        # @type PvwPlayUrl: String
+        # @param PvwWebRTCPlayUrl: 预监任务的webrtc协议预览画面。
+        # 注：
+        # 1. 该预览地址仅供预览，不可分发。
+        # 2. webrtc播放地址，需配合腾讯云快直播播放sdk使用
+        # @type PvwWebRTCPlayUrl: String
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :PvwPlayUrl, :PvwWebRTCPlayUrl, :RequestId
+
+        def initialize(pvwplayurl=nil, pvwwebrtcplayurl=nil, requestid=nil)
+          @PvwPlayUrl = pvwplayurl
+          @PvwWebRTCPlayUrl = pvwwebrtcplayurl
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @PvwPlayUrl = params['PvwPlayUrl']
+          @PvwWebRTCPlayUrl = params['PvwWebRTCPlayUrl']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # CreateCaster请求参数结构体
       class CreateCasterRequest < TencentCloud::Common::AbstractModel
         # @param CasterName: 导播台名称
@@ -3793,17 +3960,21 @@ module TencentCloud
         # @type TaskId: String
         # @param Operator: 操作人姓名。
         # @type Operator: String
+        # @param SpecifyTaskId: 指定任务 ID。注意：用于删除使用自定义任务 ID 创建的任务。
+        # @type SpecifyTaskId: String
 
-        attr_accessor :TaskId, :Operator
+        attr_accessor :TaskId, :Operator, :SpecifyTaskId
 
-        def initialize(taskid=nil, operator=nil)
+        def initialize(taskid=nil, operator=nil, specifytaskid=nil)
           @TaskId = taskid
           @Operator = operator
+          @SpecifyTaskId = specifytaskid
         end
 
         def deserialize(params)
           @TaskId = params['TaskId']
           @Operator = params['Operator']
+          @SpecifyTaskId = params['SpecifyTaskId']
         end
       end
 
@@ -13178,6 +13349,38 @@ module TencentCloud
         end
       end
 
+      # ReleaseCaster请求参数结构体
+      class ReleaseCasterRequest < TencentCloud::Common::AbstractModel
+        # @param CasterId: 导播台ID。
+        # @type CasterId: Integer
+
+        attr_accessor :CasterId
+
+        def initialize(casterid=nil)
+          @CasterId = casterid
+        end
+
+        def deserialize(params)
+          @CasterId = params['CasterId']
+        end
+      end
+
+      # ReleaseCaster返回参数结构体
+      class ReleaseCasterResponse < 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
+
       # RestartLivePullStreamTask请求参数结构体
       class RestartLivePullStreamTaskRequest < TencentCloud::Common::AbstractModel
         # @param TaskId: 任务 Id。
@@ -13478,6 +13681,70 @@ module TencentCloud
         end
       end
 
+      # StopCasterPgm请求参数结构体
+      class StopCasterPgmRequest < TencentCloud::Common::AbstractModel
+        # @param CasterId: 导播台ID。
+        # @type CasterId: Integer
+
+        attr_accessor :CasterId
+
+        def initialize(casterid=nil)
+          @CasterId = casterid
+        end
+
+        def deserialize(params)
+          @CasterId = params['CasterId']
+        end
+      end
+
+      # StopCasterPgm返回参数结构体
+      class StopCasterPgmResponse < 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
+
+      # StopCasterPvw请求参数结构体
+      class StopCasterPvwRequest < TencentCloud::Common::AbstractModel
+        # @param CasterId: 导播台ID。
+        # @type CasterId: Integer
+
+        attr_accessor :CasterId
+
+        def initialize(casterid=nil)
+          @CasterId = casterid
+        end
+
+        def deserialize(params)
+          @CasterId = params['CasterId']
+        end
+      end
+
+      # StopCasterPvw返回参数结构体
+      class StopCasterPvwResponse < 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
+
       # StopLivePadProcessor请求参数结构体
       class StopLivePadProcessorRequest < TencentCloud::Common::AbstractModel
         # @param AppName: 推流路径，与推流和播放地址中的AppName保持一致，默认为 live。

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-live
 version: !ruby/object:Gem::Version
-  version: 3.0.949
+  version: 3.0.951
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-26 00:00:00.000000000 Z
+date: 2024-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common