tencentcloud-sdk-python 3.0.1491__py2.py3-none-any.whl → 3.1.6__py2.py3-none-any.whl

tencentcloud/vclm/v20240523/models.py

@@ -183,6 +183,130 @@ class CheckAnimateImageJobResponse(AbstractModel):
         self._RequestId = params.get("RequestId")
 
 
+class DescribeHumanActorJobRequest(AbstractModel):
+    r"""DescribeHumanActorJob请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _JobId: 任务ID。
+        :type JobId: str
+        """
+        self._JobId = None
+
+    @property
+    def JobId(self):
+        r"""任务ID。
+        :rtype: str
+        """
+        return self._JobId
+
+    @JobId.setter
+    def JobId(self, JobId):
+        self._JobId = JobId
+
+
+    def _deserialize(self, params):
+        self._JobId = params.get("JobId")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class DescribeHumanActorJobResponse(AbstractModel):
+    r"""DescribeHumanActorJob返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Status: 任务状态。  WAIT：等待中，RUN：执行中，FAIL：任务失败，DONE：任务成功
+        :type Status: str
+        :param _ResultVideoUrl: 结果视频URL。有效期 24 小时。
+        :type ResultVideoUrl: str
+        :param _ErrorCode: 任务执行错误码。当任务状态不为 FAIL 时，该值为""。
+        :type ErrorCode: str
+        :param _ErrorMessage: 任务执行错误信息。当任务状态不为 FAIL 时，该值为""。
+        :type ErrorMessage: str
+        :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._Status = None
+        self._ResultVideoUrl = None
+        self._ErrorCode = None
+        self._ErrorMessage = None
+        self._RequestId = None
+
+    @property
+    def Status(self):
+        r"""任务状态。  WAIT：等待中，RUN：执行中，FAIL：任务失败，DONE：任务成功
+        :rtype: str
+        """
+        return self._Status
+
+    @Status.setter
+    def Status(self, Status):
+        self._Status = Status
+
+    @property
+    def ResultVideoUrl(self):
+        r"""结果视频URL。有效期 24 小时。
+        :rtype: str
+        """
+        return self._ResultVideoUrl
+
+    @ResultVideoUrl.setter
+    def ResultVideoUrl(self, ResultVideoUrl):
+        self._ResultVideoUrl = ResultVideoUrl
+
+    @property
+    def ErrorCode(self):
+        r"""任务执行错误码。当任务状态不为 FAIL 时，该值为""。
+        :rtype: str
+        """
+        return self._ErrorCode
+
+    @ErrorCode.setter
+    def ErrorCode(self, ErrorCode):
+        self._ErrorCode = ErrorCode
+
+    @property
+    def ErrorMessage(self):
+        r"""任务执行错误信息。当任务状态不为 FAIL 时，该值为""。
+        :rtype: str
+        """
+        return self._ErrorMessage
+
+    @ErrorMessage.setter
+    def ErrorMessage(self, ErrorMessage):
+        self._ErrorMessage = ErrorMessage
+
+    @property
+    def RequestId(self):
+        r"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :rtype: str
+        """
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        self._Status = params.get("Status")
+        self._ResultVideoUrl = params.get("ResultVideoUrl")
+        self._ErrorCode = params.get("ErrorCode")
+        self._ErrorMessage = params.get("ErrorMessage")
+        self._RequestId = params.get("RequestId")
+
+
 class DescribeImageAnimateJobRequest(AbstractModel):
     r"""DescribeImageAnimateJob请求参数结构体
 
@@ -876,6 +1000,42 @@ JobSuccess: "处理完成"。
         self._RequestId = params.get("RequestId")
 
 
+class ExtraParam(AbstractModel):
+    r"""扩展字段。
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _UserDesignatedUrl: 预签名的上传url，支持把视频直接传到客户指定的地址。
+        :type UserDesignatedUrl: str
+        """
+        self._UserDesignatedUrl = None
+
+    @property
+    def UserDesignatedUrl(self):
+        r"""预签名的上传url，支持把视频直接传到客户指定的地址。
+        :rtype: str
+        """
+        return self._UserDesignatedUrl
+
+    @UserDesignatedUrl.setter
+    def UserDesignatedUrl(self, UserDesignatedUrl):
+        self._UserDesignatedUrl = UserDesignatedUrl
+
+
+    def _deserialize(self, params):
+        self._UserDesignatedUrl = params.get("UserDesignatedUrl")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
 class Image(AbstractModel):
     r"""图片
 
@@ -1076,6 +1236,228 @@ class LogoRect(AbstractModel):
         
 
 
+class SubmitHumanActorJobRequest(AbstractModel):
+    r"""SubmitHumanActorJob请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Prompt: 文本提示词，不能超过5000字符。
+提示词支持全局和局部控制：
+
+- 全局控制：正常输入提示词即可
+- 局部控制：可用双井号进行特定时间的提示词约束，例如： "画面中的人物正在对着镜头讲话，偶尔做些手势匹配说话的内容。镜头保持固定。#3#画面中的人物正在对着镜头讲话，同时做出单手做向左方引导的手势。镜头保持固定。"（意思是第三秒的时候让人物做出左方引导手势）
+ -- 局部控制时间建议整数，最大可读小数点后两位。
+        :type Prompt: str
+        :param _AudioUrl: 传入音频URL地址，音频要求：
+- 音频时长：2秒 - 60秒
+- 音频格式：mp3、wav
+- 音频大小：10M以内
+        :type AudioUrl: str
+        :param _ImageUrl: 传入图片URL地址，图片要求：
+- 图片格式：jpg、jpeg、png、bmp、webp
+- 图片分辨率：192～4096
+- 图片大小：不超过10M
+- 图片宽高比：图片【宽：高】在1:4到4:1范围内
+- 图片内容：避免上传无人脸、无宠物脸或脸部过小、不完整、不清晰、偏转角度过大、嘴部被遮挡的图片。
+        :type ImageUrl: str
+        :param _ImageBase64: 传入图片Base64编码，编码后请求体大小不超过10M。
+图片Base64编码与URL地址必传其一，如果都传以ImageUrl为准。
+        :type ImageBase64: str
+        :param _Resolution: 生成视频分辨率
+枚举值：720p，1080p
+默认1080p
+        :type Resolution: str
+        :param _FrameRate: 生成视频帧数，单位fps。
+枚举值：25，50
+默认50帧
+        :type FrameRate: int
+        :param _LogoAdd: 为生成视频添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。 其他数值：默认按1处理。 建议您使用显著标识来提示，该视频是 AI 生成的视频。
+        :type LogoAdd: int
+        :param _LogoParam: 标识内容设置。 默认在生成视频的右下角添加“视频由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。
+        :type LogoParam: :class:`tencentcloud.vclm.v20240523.models.LogoParam`
+        """
+        self._Prompt = None
+        self._AudioUrl = None
+        self._ImageUrl = None
+        self._ImageBase64 = None
+        self._Resolution = None
+        self._FrameRate = None
+        self._LogoAdd = None
+        self._LogoParam = None
+
+    @property
+    def Prompt(self):
+        r"""文本提示词，不能超过5000字符。
+提示词支持全局和局部控制：
+
+- 全局控制：正常输入提示词即可
+- 局部控制：可用双井号进行特定时间的提示词约束，例如： "画面中的人物正在对着镜头讲话，偶尔做些手势匹配说话的内容。镜头保持固定。#3#画面中的人物正在对着镜头讲话，同时做出单手做向左方引导的手势。镜头保持固定。"（意思是第三秒的时候让人物做出左方引导手势）
+ -- 局部控制时间建议整数，最大可读小数点后两位。
+        :rtype: str
+        """
+        return self._Prompt
+
+    @Prompt.setter
+    def Prompt(self, Prompt):
+        self._Prompt = Prompt
+
+    @property
+    def AudioUrl(self):
+        r"""传入音频URL地址，音频要求：
+- 音频时长：2秒 - 60秒
+- 音频格式：mp3、wav
+- 音频大小：10M以内
+        :rtype: str
+        """
+        return self._AudioUrl
+
+    @AudioUrl.setter
+    def AudioUrl(self, AudioUrl):
+        self._AudioUrl = AudioUrl
+
+    @property
+    def ImageUrl(self):
+        r"""传入图片URL地址，图片要求：
+- 图片格式：jpg、jpeg、png、bmp、webp
+- 图片分辨率：192～4096
+- 图片大小：不超过10M
+- 图片宽高比：图片【宽：高】在1:4到4:1范围内
+- 图片内容：避免上传无人脸、无宠物脸或脸部过小、不完整、不清晰、偏转角度过大、嘴部被遮挡的图片。
+        :rtype: str
+        """
+        return self._ImageUrl
+
+    @ImageUrl.setter
+    def ImageUrl(self, ImageUrl):
+        self._ImageUrl = ImageUrl
+
+    @property
+    def ImageBase64(self):
+        r"""传入图片Base64编码，编码后请求体大小不超过10M。
+图片Base64编码与URL地址必传其一，如果都传以ImageUrl为准。
+        :rtype: str
+        """
+        return self._ImageBase64
+
+    @ImageBase64.setter
+    def ImageBase64(self, ImageBase64):
+        self._ImageBase64 = ImageBase64
+
+    @property
+    def Resolution(self):
+        r"""生成视频分辨率
+枚举值：720p，1080p
+默认1080p
+        :rtype: str
+        """
+        return self._Resolution
+
+    @Resolution.setter
+    def Resolution(self, Resolution):
+        self._Resolution = Resolution
+
+    @property
+    def FrameRate(self):
+        r"""生成视频帧数，单位fps。
+枚举值：25，50
+默认50帧
+        :rtype: int
+        """
+        return self._FrameRate
+
+    @FrameRate.setter
+    def FrameRate(self, FrameRate):
+        self._FrameRate = FrameRate
+
+    @property
+    def LogoAdd(self):
+        r"""为生成视频添加标识的开关，默认为1。 1：添加标识。 0：不添加标识。 其他数值：默认按1处理。 建议您使用显著标识来提示，该视频是 AI 生成的视频。
+        :rtype: int
+        """
+        return self._LogoAdd
+
+    @LogoAdd.setter
+    def LogoAdd(self, LogoAdd):
+        self._LogoAdd = LogoAdd
+
+    @property
+    def LogoParam(self):
+        r"""标识内容设置。 默认在生成视频的右下角添加“视频由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。
+        :rtype: :class:`tencentcloud.vclm.v20240523.models.LogoParam`
+        """
+        return self._LogoParam
+
+    @LogoParam.setter
+    def LogoParam(self, LogoParam):
+        self._LogoParam = LogoParam
+
+
+    def _deserialize(self, params):
+        self._Prompt = params.get("Prompt")
+        self._AudioUrl = params.get("AudioUrl")
+        self._ImageUrl = params.get("ImageUrl")
+        self._ImageBase64 = params.get("ImageBase64")
+        self._Resolution = params.get("Resolution")
+        self._FrameRate = params.get("FrameRate")
+        self._LogoAdd = params.get("LogoAdd")
+        if params.get("LogoParam") is not None:
+            self._LogoParam = LogoParam()
+            self._LogoParam._deserialize(params.get("LogoParam"))
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class SubmitHumanActorJobResponse(AbstractModel):
+    r"""SubmitHumanActorJob返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _JobId: 任务ID。
+        :type JobId: str
+        :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._JobId = None
+        self._RequestId = None
+
+    @property
+    def JobId(self):
+        r"""任务ID。
+        :rtype: str
+        """
+        return self._JobId
+
+    @JobId.setter
+    def JobId(self, JobId):
+        self._JobId = JobId
+
+    @property
+    def RequestId(self):
+        r"""唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :rtype: str
+        """
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        self._JobId = params.get("JobId")
+        self._RequestId = params.get("RequestId")
+
+
 class SubmitImageAnimateJobRequest(AbstractModel):
     r"""SubmitImageAnimateJob请求参数结构体
 
@@ -1671,25 +2053,27 @@ class SubmitTemplateToVideoJobRequest(AbstractModel):
         r"""
         :param _Template: 特效模板名称。请在 [视频特效模板列表](https://cloud.tencent.com/document/product/1616/119194)  中选择想要生成的特效对应的 template 名称。
         :type Template: str
-        :param _Images: 参考图像，最多输入2张图。
+        :param _Images: 参考图像，不同特效输入图片的数量详见： [视频特效模板-图片要求说明](https://cloud.tencent.com/document/product/1616/119194)
 - 支持传入图片Base64编码或图片URL（确保可访问）
 - 图片格式：支持png、jpg、jpeg、webp、bmp、tiff
-- 图片文件：大小不能超过10MB（base64后），图片分辨率不小于300\*300px，不大于4096\*4096，图片宽高比应在1:4 ~ 4:1之间
-
+- 图片文件：大小不能超过10MB（base64后），图片分辨率不小于300*300px，不大于4096*4096，图片宽高比应在1:4 ~ 4:1之间
         :type Images: list of Image
-        :param _LogoAdd: 为生成视频添加标识的开关，默认为1。
-1：添加标识。
-0：不添加标识。
+        :param _LogoAdd: 为生成视频添加标识的开关，默认为1。传0 需前往  [控制台](https://console.cloud.tencent.com/vtc/setting) 申请开启显式标识自主完成后方可生效。
+1：添加标识；
+0：不添加标识；
 其他数值：默认按1处理。
 建议您使用显著标识来提示，该视频是 AI 生成的视频。
         :type LogoAdd: int
         :param _LogoParam: 标识内容设置。
-默认在生成视频的右下角添加“视频由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。
+默认在生成视频的右下角添加“ AI 生成”或“视频由 AI 生成”字样，如需替换为其他的标识图片，需前往  [控制台](https://console.cloud.tencent.com/vtc/setting) 申请开启显式标识自主完成。
+
         :type LogoParam: :class:`tencentcloud.vclm.v20240523.models.LogoParam`
-        :param _Resolution: 视频输出分辨率，默认值：360p  - 枚举值：  720p  360p。
+        :param _Resolution: 视频输出分辨率，默认值：360p 。不同特效支持的清晰度及消耗积分数详见：[视频特效模板-单次调用消耗积分数列](https://cloud.tencent.com/document/product/1616/119194 )
         :type Resolution: str
         :param _BGM: 是否为生成的视频添加背景音乐。默认：false，  传 true 时系统将从预设 BGM 库中自动挑选合适的音乐并添加；不传或为 false 则不添加 BGM。
         :type BGM: bool
+        :param _ExtraParam: 扩展字段。
+        :type ExtraParam: :class:`tencentcloud.vclm.v20240523.models.ExtraParam`
         """
         self._Template = None
         self._Images = None
@@ -1697,6 +2081,7 @@ class SubmitTemplateToVideoJobRequest(AbstractModel):
         self._LogoParam = None
         self._Resolution = None
         self._BGM = None
+        self._ExtraParam = None
 
     @property
     def Template(self):
@@ -1711,11 +2096,10 @@ class SubmitTemplateToVideoJobRequest(AbstractModel):
 
     @property
     def Images(self):
-        r"""参考图像，最多输入2张图。
+        r"""参考图像，不同特效输入图片的数量详见： [视频特效模板-图片要求说明](https://cloud.tencent.com/document/product/1616/119194)
 - 支持传入图片Base64编码或图片URL（确保可访问）
 - 图片格式：支持png、jpg、jpeg、webp、bmp、tiff
-- 图片文件：大小不能超过10MB（base64后），图片分辨率不小于300\*300px，不大于4096\*4096，图片宽高比应在1:4 ~ 4:1之间
-
+- 图片文件：大小不能超过10MB（base64后），图片分辨率不小于300*300px，不大于4096*4096，图片宽高比应在1:4 ~ 4:1之间
         :rtype: list of Image
         """
         return self._Images
@@ -1726,9 +2110,9 @@ class SubmitTemplateToVideoJobRequest(AbstractModel):
 
     @property
     def LogoAdd(self):
-        r"""为生成视频添加标识的开关，默认为1。
-1：添加标识。
-0：不添加标识。
+        r"""为生成视频添加标识的开关，默认为1。传0 需前往  [控制台](https://console.cloud.tencent.com/vtc/setting) 申请开启显式标识自主完成后方可生效。
+1：添加标识；
+0：不添加标识；
 其他数值：默认按1处理。
 建议您使用显著标识来提示，该视频是 AI 生成的视频。
         :rtype: int
@@ -1742,7 +2126,8 @@ class SubmitTemplateToVideoJobRequest(AbstractModel):
     @property
     def LogoParam(self):
         r"""标识内容设置。
-默认在生成视频的右下角添加“视频由 AI 生成”字样，您可根据自身需要替换为其他的标识图片。
+默认在生成视频的右下角添加“ AI 生成”或“视频由 AI 生成”字样，如需替换为其他的标识图片，需前往  [控制台](https://console.cloud.tencent.com/vtc/setting) 申请开启显式标识自主完成。
+
         :rtype: :class:`tencentcloud.vclm.v20240523.models.LogoParam`
         """
         return self._LogoParam
@@ -1753,7 +2138,7 @@ class SubmitTemplateToVideoJobRequest(AbstractModel):
 
     @property
     def Resolution(self):
-        r"""视频输出分辨率，默认值：360p  - 枚举值：  720p  360p。
+        r"""视频输出分辨率，默认值：360p 。不同特效支持的清晰度及消耗积分数详见：[视频特效模板-单次调用消耗积分数列](https://cloud.tencent.com/document/product/1616/119194 )
         :rtype: str
         """
         return self._Resolution
@@ -1773,6 +2158,17 @@ class SubmitTemplateToVideoJobRequest(AbstractModel):
     def BGM(self, BGM):
         self._BGM = BGM
 
+    @property
+    def ExtraParam(self):
+        r"""扩展字段。
+        :rtype: :class:`tencentcloud.vclm.v20240523.models.ExtraParam`
+        """
+        return self._ExtraParam
+
+    @ExtraParam.setter
+    def ExtraParam(self, ExtraParam):
+        self._ExtraParam = ExtraParam
+
 
     def _deserialize(self, params):
         self._Template = params.get("Template")
@@ -1788,6 +2184,9 @@ class SubmitTemplateToVideoJobRequest(AbstractModel):
             self._LogoParam._deserialize(params.get("LogoParam"))
         self._Resolution = params.get("Resolution")
         self._BGM = params.get("BGM")
+        if params.get("ExtraParam") is not None:
+            self._ExtraParam = ExtraParam()
+            self._ExtraParam._deserialize(params.get("ExtraParam"))
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]

tencentcloud/vclm/v20240523/vclm_client.py

@@ -49,6 +49,29 @@ class VclmClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def DescribeHumanActorJob(self, request):
+        r"""通过JobId提交请求，获取人像驱动任务的结果信息。
+
+        :param request: Request instance for DescribeHumanActorJob.
+        :type request: :class:`tencentcloud.vclm.v20240523.models.DescribeHumanActorJobRequest`
+        :rtype: :class:`tencentcloud.vclm.v20240523.models.DescribeHumanActorJobResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("DescribeHumanActorJob", params, headers=headers)
+            response = json.loads(body)
+            model = models.DescribeHumanActorJobResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def DescribeImageAnimateJob(self, request):
         r"""用于查询图片跳舞任务。图片跳舞能力支持舞蹈动作结合图片生成跳舞视频，满足社交娱乐、互动营销等场景的需求。
 
@@ -165,6 +188,30 @@ class VclmClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def SubmitHumanActorJob(self, request):
+        r"""用于提交人像驱动任务
+        支持提交音频和图文来生成对应视频，满足动态交互、内容生产等场景需求。
+
+        :param request: Request instance for SubmitHumanActorJob.
+        :type request: :class:`tencentcloud.vclm.v20240523.models.SubmitHumanActorJobRequest`
+        :rtype: :class:`tencentcloud.vclm.v20240523.models.SubmitHumanActorJobResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("SubmitHumanActorJob", params, headers=headers)
+            response = json.loads(body)
+            model = models.SubmitHumanActorJobResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def SubmitImageAnimateJob(self, request):
         r"""用于提交图片跳舞任务。图片跳舞能力支持舞蹈动作结合图片生成跳舞视频，满足社交娱乐、互动营销等场景的需求。