视频加水印贴纸
描述
本接口用于在云端为视频添加水印贴纸。
版本
1.0
图片要求
视频要求：
- 格式：MP4
- 大小：小于 3GB
贴纸要求：
- 格式：JPG、PNG、GIF
- 大小：小于 10MB
调用 URL
正式环境：https://openapi.meitu.com
任务提交接口：https://openapi.meitu.com/api/v1/sdk/sync/push
任务名称(task)：/v1/Video_watermark_sticker/487154
任务类型(task_type)：formula调用方法
POST
Content-Type: application/json
权限
请求参数
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | params | string | 算法参数（JSON 字符串） |
| 必选 | init_images | object[] | 多媒体文件列表；第一个元素为视频，第二个元素为水印贴纸 |
| 必选 | task | string | 固定 /v1/Video_watermark_sticker/487154 |
| 必选 | task_type | string | 固定 formula |
| 可选 | sync_timeout | int | 默认 30，同步超时时间 |
init_images 多媒体文件参数，结构说明如下
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | url | string | 视频或水印贴纸的 URL 或 base64 |
| 必选 | profile | object | 属性信息描述 |
profile 属性信息描述
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | media_profiles | object | 媒体属性信息 |
| 必选 | version | string | 固定 v1 |
media_profiles 媒体属性信息
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | media_data_type | string | url 表示 URL；对应媒体类型表示 base64 |
params 推理参数是 JSON 字符串，其结构说明如下
| 是否必选 | 字段 | 类型 | 说明 |
|---|---|---|---|
| 可选 | rsp_media_type | string | 默认 url；jpg 表示 base64 |
| 必选 | parameter | object | 算法核心参数对象 |
parameter 算法参数详情
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | watermark | object | 水印贴纸参数对象 |
watermark 参数详情
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | gravity | string | 水印类型，sticker 表示贴纸水印 |
| 可选 | opacity | float | 水印透明度，取值范围 0～1 |
| 可选 | offsetx | int | 水印在 X 轴方向的偏移量（像素） |
| 可选 | offsety | int | 水印在 Y 轴方向的偏移量（像素） |
| 可选 | sticker_cropped | boolean | 是否裁剪贴纸水印，默认 false |
输入值示例
{
"task": "/v1/Video_watermark_sticker/487154",
"task_type": "formula",
"init_images": [
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4",
"profile": {
"media_profiles": {
"media_data_type": "url"
},
"version": "v1"
}
},
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif",
"profile": {
"media_profiles": {
"media_data_type": "url"
},
"version": "v1"
}
}
],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"watermark\":{\"gravity\":\"sticker\",\"opacity\":1,\"offsetx\":50,\"offsety\":10,\"sticker_cropped\":false}}}",
"sync_timeout": 30
}返回值说明
注意，生成的结果，会定期清理，请及时下载保存| 字段 | 类型 | 说明 |
|---|---|---|
| request_id | string | 请求标识 |
| trace_id | string | 链路追踪标识 |
| code | int | 业务状态码，0 表示请求受理成功 |
| error_code | int | 错误码，成功时为 0 |
| message | string | 业务信息 |
| tips | any | 补充提示，可为 null |
| data | object | 任务状态和算法结果 |
data 中单个元素的字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| status | int | 状态码：-1 未找到任务；0 创建成功；1 执行中；2 失败；9 超时，使用查询接口查询；10 成功 |
| result | object | 算法结果 |
| progress | number | 任务进度，取值范围 0～1 |
| predict_elapsed | int | 预计耗时，毫秒 |
| create_time | int64 | 创建时间戳，毫秒 |
| task_id | string | 任务 ID |
| custom_task_id | string | 客户自定义任务 ID |
| trace_id | string | data 内链路标识 |
| client_info | string | 客户端信息 |
| init_images | object[]/null | 输入媒体回显 |
result 中单个元素的字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 任务唯一标识 |
| urls | array | 输出结果媒体 URL 列表 |
| images | array | 输出媒体列表（与 urls 含义一致） |
| parameters | object | 输出参数信息 |
| data | object | 算法返回的详细数据 |
| msg | string | 返回信息 |
| msg_id | string | 消息 ID |
| mtlab_res | object | 算法底层返回结果 |
| media_info_list | array | 输出媒体信息列表 |
result.parameters 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| rsp_media_type | string | 返回媒体类型，url 表示返回 URL 地址 |
result.data 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| duration | object | 各阶段耗时统计 |
| error_code | int | 算法错误码，0 表示成功 |
| error_msg | string | 算法错误信息 |
| extra | object | 扩展字段 |
| media_info_list | array | 媒体信息列表 |
| msg_id | string | 消息 ID |
| parameter | object | 参数回显 |
duration 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| alg_process_time | number | 算法处理耗时（毫秒） |
| created_timestamp | number | 任务创建时间戳（秒） |
| pull_timestamp | number | 拉取资源时间戳（秒） |
| repost_time | number | 重试耗时 |
| upload_time | number | 上传耗时（毫秒） |
| waiting_time | number | 排队等待耗时（毫秒） |
media_info_list 媒体信息说明
| 字段 | 类型 | 说明 |
|---|---|---|
| media_data | string | 媒体数据地址 |
| media_extra | object | 媒体扩展信息 |
| media_profiles | object | 媒体属性信息 |
media_profiles 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| media_data_type | string | 媒体数据类型，url 表示媒体数据为 URL 地址 |
mtlab_res 字段说明
| 字段 | 类型 | 说明 |
|---|---|---|
| ErrorCode | int | 底层错误码 |
| ErrorMsg | string | 底层错误信息 |
| error_code | int | 错误码（兼容字段） |
| error_msg | string | 错误信息（兼容字段） |
| media_info_list | array | 媒体信息列表 |
| msg_id | string | 消息 ID |
| parameter | object | 参数信息 |
当前 API 特有的错误代码与信息
| ErrorCode 状态代码 | 错误信息 | 说明 |
|---|---|---|
| 20001 | PROCESS_ERROR | 处理错误 |
| 21105 | INVALID_NUMBER_OF_PARAMETERS | 参数个数错误 |
| 21202 | INPUT_FILE_DOWNLOAD_FAILED | 输入文件下载失败 |
| 21205 | VIDEO_FILE_NOT_FOUND | 视频文件未找到 |
| 21206 | WATERMARK_FILE_NOT_FOUND | 水印文件未找到 |
| 21207 | INVALID_OR_UNSUPPORTED_INPUT_VIDEO | 无效或不支持的输入视频 |
| 21208 | INVALID_OR_UNSUPPORTED_WATERMARK_IMAGE | 无效或不支持的水印图片 |
| 22202 | INVALID_OUTPUT_VIDEO_LINK | 无效的输出视频链接 |
| 25201 | INPUT_FILE_EXCEEDS_MAX_SIZE | 输入文件超过最大大小 |
| 29001 | VIDEO_PROCESSING_ERROR | 视频处理错误 |
| 29002 | INVALID_WATERMARK_OPACITY | 无效的水印透明度 |
| 29003 | INVALID_WATERMARK_SCALE_FACTOR | 无效的水印缩放比例 |
| 29004 | INVALID_WATERMARK_POSITION | 无效的水印位置 |
| 29005 | INVALID_OR_UNSUPPORTED_VIDEO_CODEC | 无效或不支持的视频编码器 |
| 29006 | INVALID_VIDEO_CODEC_PRESET | 无效的视频编码预设 |
| 29007 | INVALID_STICKER_CROPPING | 无效的贴纸裁剪 |
| 29008 | INVALID_STICKER_HORIZONTAL_OFFSET | 无效的贴纸水平偏移 |
| 29009 | INVALID_STICKER_VERTICAL_OFFSET | 无效的贴纸垂直偏移 |
返回值示例
请求成功返回示例
{
"request_id": "",
"trace_id": "",
"code": 0,
"error_code": 0,
"message": "success",
"tips": null,
"data": {
"status": 10,
"result": {
"id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97",
"urls": [
"https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d19663bc-2f09-4d08-4c12-76ba9d9dd7b6.mp4"
],
"parameters": {
"rsp_media_type": "url"
},
"data": {
"duration": {
"alg_process_time": 112500,
"created_timestamp": 1770276512,
"pull_timestamp": 1770276512,
"repost_time": 0,
"upload_time": 207,
"waiting_time": 57
},
"error_code": 0,
"error_msg": "success",
"extra": {},
"media_info_list": [
{
"media_data": "https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d19663bc-2f09-4d08-4c12-76ba9d9dd7b6.mp4",
"media_extra": null,
"media_profiles": {
"media_data_type": "url"
}
}
],
"msg_id": "88633f1f-xxxx-4a19-6a91-r0099cf15af6",
"parameter": {
"rsp_media_type": "url"
}
},
"msg": "success",
"msg_id": "88633f1f-xxxx-4a19-6a91-r0099cf15af6",
"images": [
"https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d19663bc-2f09-4d08-4c12-76ba9d9dd7b6.mp4"
],
"mtlab_res": {
"ErrorCode": 0,
"ErrorMsg": "",
"error_code": 0,
"error_msg": "",
"media_info_list": null,
"msg_id": "88633f1f-xxxx-4a19-6a91-r0099cf15af6",
"parameter": null
},
"media_info_list": [
{
"media_data": "https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d19663bc-2f09-4d08-4c12-76ba9d9dd7b6.mp4",
"media_extra": null,
"media_profiles": {
"media_data_type": "url"
}
}
]
},
"progress": 1,
"predict_elapsed": 10000,
"create_time": 1770276512525,
"task_id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97",
"custom_task_id": "",
"trace_id": "",
"client_info": "",
"init_images": null
}
}需要查询返回示例
使用 查询接口 接口查询
Response Status：200
content-type 为 application/json; charset=utf-8
{
"request_id": "",
"trace_id": "",
"code": 0,
"error_code": 0,
"message": "success",
"tips": null,
"data": {
"status": 9,
"result": {
"id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97"
},
"progress": 0,
"predict_elapsed": 10000,
"create_time": 1770276512525,
"task_id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97",
"custom_task_id": "",
"trace_id": "ec2460cf-xxxx-48ed-9a97-32596617c779",
"client_info": "",
"init_images": null
}
}请求失败返回示例
Response Status：400
content-type 为 application/json; charset=utf-8
{
"request_id": "",
"trace_id": "",
"code": 0,
"error_code": 0,
"message": "success",
"tips": null,
"data": {
"status": 2,
"result": {
"error_code": 20001,
"error_msg": "PROCESS_ERROR"
},
"progress": 0,
"predict_elapsed": 0,
"create_time": 1770276512525,
"task_id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97",
"custom_task_id": "",
"trace_id": "ec2460cf-xxxx-48ed-9a97-32596617c779",
"client_info": "",
"init_images": null
}
}通用的错误代码与信息
详见 API 错误码
SDK 调用示例
Python
import json
import requests
from sign_sdk import sign
def api_call_example():
key = "your_api_key"
secret = "your_api_secret"
url = "https://openapi.meitu.com/api/v1/sdk/sync/push"
method = "POST"
headers = {
"Content-Type": "application/json",
sign.HeaderHost: "openapi.meitu.com",
}
inner_params = {
"rsp_media_type": "url",
"parameter": {
"watermark": {
"gravity": "sticker",
"opacity": 1,
"offsetx": 50,
"offsety": 10,
"sticker_cropped": False,
}
},
}
payload = {
"task": "/v1/Video_watermark_sticker/487154",
"task_type": "formula",
"init_images": [
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1",
},
},
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1",
},
},
],
"params": json.dumps(inner_params, ensure_ascii=False),
"sync_timeout": 30,
}
body = json.dumps(payload, ensure_ascii=False)
signer = sign.Signer(key, secret)
signed_request = signer.sign(url, method, headers, body)
response = requests.Session().send(signed_request)
print(f"Status: {response.status_code}")
print(f"Response: {response.text}")
if __name__ == "__main__":
api_call_example()Go
package main
import (
"fmt"
"io"
"net/http"
"github.com/mtlab/api/signer"
)
func main() {
key := "your_api_key"
secret := "your_api_secret"
signObj := signer.NewSigner(key, secret)
url := "https://openapi.meitu.com/api/v1/sdk/sync/push"
method := http.MethodPost
headers := make(http.Header)
headers.Set(signer.HeaderHost, "openapi.meitu.com")
headers.Set("Content-Type", "application/json")
body := `{
"task": "/v1/Video_watermark_sticker/487154",
"task_type": "formula",
"init_images": [
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1"
}
},
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1"
}
}
],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"watermark\":{\"gravity\":\"sticker\",\"opacity\":1,\"offsetx\":50,\"offsety\":10,\"sticker_cropped\":false}}}",
"sync_timeout": 30
}`
req, err := signObj.Sign(url, method, headers, body)
if err != nil {
fmt.Println("Failed to sign request:", err)
return
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
fmt.Println("Failed to send request:", err)
return
}
defer resp.Body.Close()
responseBody, err := io.ReadAll(resp.Body)
if err != nil {
fmt.Println("Read response failed:", err)
return
}
fmt.Println("Response:", resp.StatusCode, string(responseBody))
}PHP
<?php
require 'signer.php';
$key = 'your_api_key';
$secret = 'your_api_secret';
$signer = new Signer($key, $secret);
$url = 'https://openapi.meitu.com/api/v1/sdk/sync/push';
$method = 'POST';
$headers = ['Content-Type' => 'application/json'];
$innerParams = json_encode([
'rsp_media_type' => 'url',
'parameter' => [
'watermark' => [
'gravity' => 'sticker',
'opacity' => 1,
'offsetx' => 50,
'offsety' => 10,
'sticker_cropped' => false,
],
],
]);
$body = json_encode([
'task' => '/v1/Video_watermark_sticker/487154',
'task_type' => 'formula',
'init_images' => [
[
'url' => 'https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4',
'profile' => [
'media_profiles' => ['media_data_type' => 'url'],
'version' => 'v1',
],
],
[
'url' => 'https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif',
'profile' => [
'media_profiles' => ['media_data_type' => 'url'],
'version' => 'v1',
],
],
],
'params' => $innerParams,
'sync_timeout' => 30,
]);
$curl = $signer->sign($url, $method, $headers, $body);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($status === 0) {
echo 'Error: ' . curl_error($curl);
} else {
echo "Status: {$status}\n";
echo "Response: {$response}\n";
}
curl_close($curl);
?>Java
package com.meitu.openai.common;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
public class Main {
public static void main(String[] args) throws Exception {
Signer signer = new Signer("your_api_key", "your_api_secret");
String url = "https://openapi.meitu.com/api/v1/sdk/sync/push";
String method = "POST";
Map<String, String> headers = new HashMap<>();
headers.put("Content-Type", "application/json");
headers.put(Signer.HeaderHost, "openapi.meitu.com");
String body = "{\n" +
" \"task\": \"/v1/Video_watermark_sticker/487154\",\n" +
" \"task_type\": \"formula\",\n" +
" \"init_images\": [\n" +
" {\n" +
" \"url\": \"https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4\",\n" +
" \"profile\": {\n" +
" \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
" \"version\": \"v1\"\n" +
" }\n" +
" },\n" +
" {\n" +
" \"url\": \"https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif\",\n" +
" \"profile\": {\n" +
" \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
" \"version\": \"v1\"\n" +
" }\n" +
" }\n" +
" ],\n" +
" \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"watermark\\\":{\\\"gravity\\\":\\\"sticker\\\",\\\"opacity\\\":1,\\\"offsetx\\\":50,\\\"offsety\\\":10,\\\"sticker_cropped\\\":false}}}\",\n" +
" \"sync_timeout\": 30\n" +
"}";
Map<String, String> signedHeaders = signer.sign(url, method, headers, body);
HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
connection.setRequestMethod(method);
for (Map.Entry<String, String> entry : signedHeaders.entrySet()) {
connection.setRequestProperty(entry.getKey(), entry.getValue());
}
connection.setDoOutput(true);
connection.getOutputStream().write(body.getBytes(StandardCharsets.UTF_8));
int status = connection.getResponseCode();
InputStream stream = status >= 400
? connection.getErrorStream()
: connection.getInputStream();
try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream))) {
StringBuilder response = new StringBuilder();
String line;
while ((line = reader.readLine()) != null) {
response.append(line);
}
System.out.println("Response: " + status + " " + response);
}
}
}