# frozen_string_literal: true # Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved. # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. require 'json' module TencentCloud module Trtc module V20190722 class Client < TencentCloud::Common::AbstractClient def initialize(credential, region, profile = nil) api_version = '2019-07-22' api_endpoint = 'trtc.tencentcloudapi.com' sdk_version = 'TRTC_' + File.read(File.expand_path('../VERSION', __dir__)).strip super(credential, region, api_version, api_endpoint, sdk_version, profile) end # 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁新增自定义背景图或水印,可通过此接口上传新的图片素材。无需频繁新增图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。 # @param request: Request instance for CreatePicture. # @type request: :class:`Tencentcloud::trtc::V20190722::CreatePictureRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::CreatePictureResponse` def CreatePicture(request) body = send_request('CreatePicture', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreatePictureResponse.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 CreateTroubleInfo. # @type request: :class:`Tencentcloud::trtc::V20190722::CreateTroubleInfoRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::CreateTroubleInfoResponse` def CreateTroubleInfo(request) body = send_request('CreateTroubleInfo', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = CreateTroubleInfoResponse.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 # 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁删除自定义背景图或水印,可通过此接口删除已上传的图片。无需频繁删除图片的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。 # @param request: Request instance for DeletePicture. # @type request: :class:`Tencentcloud::trtc::V20190722::DeletePictureRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DeletePictureResponse` def DeletePicture(request) body = send_request('DeletePicture', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DeletePictureResponse.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 # 查询SDKAppID下用户的异常体验事件,返回异常体验ID与可能产生异常体验的原因。可查询15天内数据,查询起止时间不超过1个小时。支持跨天查询。异常体验ID映射见:https://cloud.tencent.com/document/product/647/44916 # @param request: Request instance for DescribeAbnormalEvent. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeAbnormalEventRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeAbnormalEventResponse` def DescribeAbnormalEvent(request) body = send_request('DescribeAbnormalEvent', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeAbnormalEventResponse.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 # 查询指定时间内的用户列表及用户通话质量数据,可查询14天内数据。DataType 不为null,查询起止时间不超过1个小时,查询用户不超过6个,支持跨天查询。DataType,UserIds为null时,查询起止时间不超过4个小时, 默认查询6个用户,同时支持每页查询100以内用户个数(PageSize不超过100)。接口用于查询质量问题,不推荐作为计费使用。 # **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。 # @param request: Request instance for DescribeCallDetail. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeCallDetailRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeCallDetailResponse` def DescribeCallDetail(request) body = send_request('DescribeCallDetail', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeCallDetailResponse.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 # 查询用户某次通话内的进退房,视频开关等详细事件。可查询14天内数据。 # @param request: Request instance for DescribeDetailEvent. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeDetailEventRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeDetailEventResponse` def DescribeDetailEvent(request) body = send_request('DescribeDetailEvent', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeDetailEventResponse.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 # 可查询sdkqppid 每天的房间数和用户数,每分钟1次,可查询最近14天的数据。当天未结束,无法查到当天的房间数与用户数。 # @param request: Request instance for DescribeHistoryScale. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeHistoryScaleRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeHistoryScaleResponse` def DescribeHistoryScale(request) body = send_request('DescribeHistoryScale', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeHistoryScaleResponse.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 # 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁查找自定义背景图或水印信息,可通过此接口查找已上传的图片信息。无需频繁查找图片信息的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中查看。 # @param request: Request instance for DescribePicture. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribePictureRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribePictureResponse` def DescribePicture(request) body = send_request('DescribePicture', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribePictureResponse.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天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 # - 单次查询统计区间最多不能超过31天。 # - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。 # - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。 # @param request: Request instance for DescribeRecordStatistic. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeRecordStatisticRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeRecordStatisticResponse` def DescribeRecordStatistic(request) body = send_request('DescribeRecordStatistic', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeRecordStatisticResponse.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 # 查询sdkappid下的房间列表。默认返回10条通话,一次最多返回100条通话。可查询14天内的数据。 # **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。 # @param request: Request instance for DescribeRoomInformation. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeRoomInformationRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeRoomInformationResponse` def DescribeRoomInformation(request) body = send_request('DescribeRoomInformation', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeRoomInformationResponse.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天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 # - 单次查询统计区间最多不能超过31天。 # - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。 # - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。 # @param request: Request instance for DescribeTrtcInteractiveTime. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeTrtcInteractiveTimeRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeTrtcInteractiveTimeResponse` def DescribeTrtcInteractiveTime(request) body = send_request('DescribeTrtcInteractiveTime', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeTrtcInteractiveTimeResponse.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天时,返回每5分钟粒度的数据;查询时间大于1天时,返回按天汇总的数据。 # - 单次查询统计区间最多不能超过31天。 # - 若查询当天用量,由于统计延迟等原因,返回数据可能不够准确。 # - 日结后付费将于次日上午推送账单,建议次日上午9点以后再来查询前一天的用量。 # @param request: Request instance for DescribeTrtcMcuTranscodeTime. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeTrtcMcuTranscodeTimeRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeTrtcMcuTranscodeTimeResponse` def DescribeTrtcMcuTranscodeTime(request) body = send_request('DescribeTrtcMcuTranscodeTime', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeTrtcMcuTranscodeTimeResponse.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 # 查询指定时间内的用户列表,可查询14天内数据,查询起止时间不超过4小时。默认每页查询6个用户,支持每页最大查询100个用户PageSize不超过100)。 # **注意**:该接口只用于历史数据统计或核对数据使用,实时类关键业务逻辑不能使用。 # @param request: Request instance for DescribeUserInformation. # @type request: :class:`Tencentcloud::trtc::V20190722::DescribeUserInformationRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DescribeUserInformationResponse` def DescribeUserInformation(request) body = send_request('DescribeUserInformation', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DescribeUserInformationResponse.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. # @type request: :class:`Tencentcloud::trtc::V20190722::DismissRoomRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DismissRoomResponse` def DismissRoom(request) body = send_request('DismissRoom', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DismissRoomResponse.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 DismissRoomByStrRoomId. # @type request: :class:`Tencentcloud::trtc::V20190722::DismissRoomByStrRoomIdRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::DismissRoomByStrRoomIdResponse` def DismissRoomByStrRoomId(request) body = send_request('DismissRoomByStrRoomId', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = DismissRoomByStrRoomIdResponse.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 # 如果您需要在 [云端混流转码](https://cloud.tencent.com/document/product/647/16827) 时频繁修改自定义背景图或水印素材,可通过此接口修改已上传的图片。无需频繁修改图片素材的场景,建议直接在 [控制台 > 应用管理 > 素材管理](https://cloud.tencent.com/document/product/647/50769) 中操作。 # @param request: Request instance for ModifyPicture. # @type request: :class:`Tencentcloud::trtc::V20190722::ModifyPictureRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::ModifyPictureResponse` def ModifyPicture(request) body = send_request('ModifyPicture', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = ModifyPictureResponse.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 RemoveUser. # @type request: :class:`Tencentcloud::trtc::V20190722::RemoveUserRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::RemoveUserResponse` def RemoveUser(request) body = send_request('RemoveUser', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = RemoveUserResponse.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 RemoveUserByStrRoomId. # @type request: :class:`Tencentcloud::trtc::V20190722::RemoveUserByStrRoomIdRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::RemoveUserByStrRoomIdResponse` def RemoveUserByStrRoomId(request) body = send_request('RemoveUserByStrRoomId', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = RemoveUserByStrRoomIdResponse.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 # 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。 # TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。房间销毁后混流自动结束。 # 您可以通过此接口实现如下目标: # - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。 # - 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。 # - 设置录制文件名,用于二次回放。 # - 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。 # 目前已经支持了如下几种布局模板: # - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。 # - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。 # - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。 # - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置,最多支持2个画面。 # - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。 # 注意: # 1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。** # 2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。 # 3、客户端混流和服务端混流不能混用。 # @param request: Request instance for StartMCUMixTranscode. # @type request: :class:`Tencentcloud::trtc::V20190722::StartMCUMixTranscodeRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::StartMCUMixTranscodeResponse` def StartMCUMixTranscode(request) body = send_request('StartMCUMixTranscode', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = StartMCUMixTranscodeResponse.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 # 接口说明:启动云端混流,并指定混流画面中各路画面的布局位置。 # TRTC 的一个房间中可能会同时存在多路音视频流,您可以通过此 API 接口,通知腾讯云服务端将多路视频画面合成一路,并指定每一路画面的位置,同时将多路声音进行混音,最终形成一路音视频流,以便用于录制和直播观看。 # 您可以通过此接口实现如下目标: # - 设置最终直播流的画质和音质,包括视频分辨率、视频码率、视频帧率、以及声音质量等。 # - 设置各路画面的位置和布局,您只需要在启动时设置一次,排版引擎会自动完成后续的画面排布。 # - 设置录制文件名,用于二次回放。 # - 设置 CDN 直播流 ID,用于在 CDN 进行直播观看。 # 目前已经支持了如下几种布局模板: # - 悬浮模板:第一个进入房间的用户的视频画面会铺满整个屏幕,其他用户的视频画面从左下角依次水平排列,显示为小画面,最多4行,每行4个,小画面悬浮于大画面之上。最多支持1个大画面和15个小画面,如果用户只发送音频,仍然会占用画面位置。 # - 九宫格模板:所有用户的视频画面大小一致,平分整个屏幕,人数越多,每个画面的尺寸越小。最多支持16个画面,如果用户只发送音频,仍然会占用画面位置。 # - 屏幕分享模板:适合视频会议和在线教育场景的布局,屏幕分享(或者主讲的摄像头)始终占据屏幕左侧的大画面位置,其他用户依次垂直排列于右侧,最多两列,每列最多8个小画面。最多支持1个大画面和15个小画面。若上行分辨率宽高比与画面输出宽高比不一致时,左侧大画面为了保持内容的完整性采用缩放方式处理,右侧小画面采用裁剪方式处理。 # - 画中画模板:适用于混合大小两路视频画面和其他用户混音,或者混合一路大画面和其他用户混音的场景。小画面悬浮于大画面之上,可以指定大小画面的用户以及小画面的显示位置。 # - 自定义模板:适用于在混流中指定用户的画面位置,或者预设视频画面位置的场景。当预设位置指定用户时,排版引擎会该用户预留位置;当预设位置未指定用户时,排版引擎会根据进房间顺序自动填充。预设位置填满时,不再混合其他用户的画面和声音。自定义模板启用占位图功能时(LayoutParams中的PlaceHolderMode设置成1),在预设位置的用户没有上行视频时可显示对应的占位图(PlaceImageId)。 # 注意: # 1、**混流转码为收费功能,调用接口将产生云端混流转码费用,详见[云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。** # 2、2020年1月9号及以后创建的应用才能直接调用此接口。2020年1月9日之前创建的应用默认使用云直播的云端混流,如需切换至MCU混流,请[提交工单](https://console.cloud.tencent.com/workorder/category)寻求帮助。 # 3、客户端混流和服务端混流不能混用。 # @param request: Request instance for StartMCUMixTranscodeByStrRoomId. # @type request: :class:`Tencentcloud::trtc::V20190722::StartMCUMixTranscodeByStrRoomIdRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::StartMCUMixTranscodeByStrRoomIdResponse` def StartMCUMixTranscodeByStrRoomId(request) body = send_request('StartMCUMixTranscodeByStrRoomId', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = StartMCUMixTranscodeByStrRoomIdResponse.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. # @type request: :class:`Tencentcloud::trtc::V20190722::StopMCUMixTranscodeRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::StopMCUMixTranscodeResponse` def StopMCUMixTranscode(request) body = send_request('StopMCUMixTranscode', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = StopMCUMixTranscodeResponse.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 StopMCUMixTranscodeByStrRoomId. # @type request: :class:`Tencentcloud::trtc::V20190722::StopMCUMixTranscodeByStrRoomIdRequest` # @rtype: :class:`Tencentcloud::trtc::V20190722::StopMCUMixTranscodeByStrRoomIdResponse` def StopMCUMixTranscodeByStrRoomId(request) body = send_request('StopMCUMixTranscodeByStrRoomId', request.serialize) response = JSON.parse(body) if response['Response'].key?('Error') == false model = StopMCUMixTranscodeByStrRoomIdResponse.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 end end end end