媒体编辑器API参考

媒体编辑器API引用细节所有参数选项、类型和事件配置媒体编辑器部件

参数解析

下表列表所有可用参数(选项)配置媒体编辑器部件更新方法 :

所需参数

下图参数需要配置媒体编辑器部件时 :

参数	类型	描述性
云化Name	字符串	云化产品环境云名 示例:化石
公共标识	高山市资产类或公共标识	初始化媒体编辑程序注解:目前只支持单公共ID数组中的单个资产可用a描述资产类对象(视频和/或认证/私有资产所必需)或公共标识字符串(仅作为公共图像快捷键)。 示例:{publicId:sandy_Beach}类型:

部件参数

参数	类型	描述性
模式化	字符串	判定部件显示方式,或显示方式模式化或内联内页主体(或元素由附加程序参数)
语言类	对象类	文本字符串用于部件中, 包括所有“ 密钥 ” : “ 值” 双文本以覆盖部件默认文本标签看本地化样本参比实现
主题化	对象类	主题属性应用部件当前只支持定制显示部件左上角的标识 示例:theme: {logo: 'https://www.example.com/mylogo.png'}

图像参数

参数	类型	描述性
变换	对象类	云形变换应用到所有图像中任何变换、特效和其他云变选项都可应用并添加外加添加到媒体编辑器中的任何其他变换 示例:{效果:sepia}
最大width	整数	最大允许宽度最终图像
最大高度	整数	最大允许高度最终图像
阶梯	字符串[	数组嵌入部件中,按规定顺序可能的值:安卓重排,图像重叠,文本重叠,导出
安卓重排	缩放Props	缩放裁剪步骤属性仅在相关时安卓重排步骤包含
图像重叠	ImageOverlayProps	属性覆盖部件步仅在相关时图像重叠步骤包含
文本重叠	TextOverlaysProps	属性文本叠加部件仅在相关时文本重叠步骤包含
导出	导出Props	属性导出步部件仅在相关时导出步骤包含

视频参数

参数	类型	描述性
阶梯	字符串[	数组嵌入部件中,按规定顺序当前只支持修剪.
修剪	trimProps	属性修饰部件
变换	对象类	云形变换应用到所有视频任何操作、特效和其他云变选项都可应用并添加外加添加到修饰式的任何其他变换 示例:{效果:sepia}
最大width	整数	最大允许宽度最终视频
最大高度	整数	最大允许高度最终视频

类型类型

资产类

对象识别上传资产对象只需识别受限资产(私有/认证资产)。

参数	类型	描述性
公共标识	字符串	字符串值表示访问上传媒体资产时使用标识符
资源类型	字符串	文件类型资产可能的值:图像显示或视频播放
类型	字符串	交付类型上传资产可能的值:公共(默认),私有或验证

缩放Props

参数	类型	描述性
预置	高山市PredefinedPreset或自定义预设)[	数组预设选项供用户选择,其中对象识别预定义社交媒体预设或定制预设
交互裁剪	布林安	是否允许交互裁剪默认值 :真实性
分钟Width	整数	最小宽度允许裁剪
分钟高度	整数	最小高度允许裁剪
侧面拉迪欧Lock	布林安	是否锁定宽比假设正确,维比开始锁定默认值 :真实性
toggleAspectRatio	布林安	是否允许切换宽比 。假时, togle失效并置值RatioLock默认值 :真实性
翻转	布林安	是否显示翻转按钮,允许用户翻转图像默认值 :真实性
旋转	布林安	是否显示旋转按钮,允许用户旋转图像默认值 :真实性
指南Url	URL访问	URL信息图像显示方式右侧不提供参数则右手段不出现

ImageOverlayProps

参数	类型	描述性
叠加	重叠程序	数组叠加对象供用户选择,其中每个对象识别可能的图像叠加及其属性
指南Url	URL访问	URL信息图像显示器右侧

TextOverlaysProps

参数	类型	描述性
字体学	串或字体Props)[	数组供用户选择,数组中每个字体或预定义内建字体或定义内建字体自定义字体及其属性默认值(所有嵌入字体):Ariel Verdana,Helvetica,TrebuchetMS,TimesNew Roman,Georgia,CourierNew,Open Sants,Roboto,Montserrat
预置	高山市PredefinedTextPreset或CustomTextPreset)[	数组文本预置对象供用户选择,由对象识别初始文本叠加及其属性默认值 :标题 人 子标题 标题
指南Url	URL访问	URL信息图像显示器右侧
初始颜色	字符串[	数组预置颜色供用户初始选择可提供RGB或RGBA三重或四重、3或4位RGB/RGBBA六重或命名颜色默认值 :#ffffff,#000
显示ColorPicker	布林安	是否显示除预设颜色外的颜色选择器默认值 :真实性

TrimProps(Beta)

参数	类型	描述性
启动开关	浮点	初始裁剪柄几秒默认值 :0
端置	浮点	端端剪柄初始位置数秒默认值:视频全时性
minDuration语言	浮点	最小长度剪短视频默认值 :0
最大值	浮点	最长长度裁剪视频默认值:视频全时性

PredefinedTextPreset

以上为预定义文本预设值:

标签标签	预览图文	体积大小	字体显示
标题化	ABC测试	59号	佐治亚州
字幕编程	ABC测试	16	阿里尔
体质显示	ABC测试	14	机器人
字幕标题	ABC测试	12	蒙特塞拉特

CustomTextPreset

属性	类型	描述性
标签标签	字符串	标签预设
体积大小	整数	字体大小点数
字体显示	字符串	名字体
预览图文	字符串	预览文本展示文本叠加预设最大3字符默认值 :ABC
权值	enum大赛	中或常态或粗体.默认值 :常态
风格化	enum大赛	中或常态或斜体.默认值 :常态
颜色显示	字符串	文本颜色默认值 :万千
下划线	布林安	是否加下划线默认值 :虚伪

例举 :

字体Props

属性	类型	描述性
字体显示	字符串	自定义字体名
样式学	对象设置	对象详解自定义字体文件可加四个字体文件作为下列键的值:正则、粗体、斜体和粗体Italic,并包括是否支持下划线

例举 :

导出Props

参数	类型	描述性
格式化	字符串[	数组图像格式内含汽车)用户选择文件扩展未提供此参数, 默认原文件类型, 未向用户提供选项 。
质量问题	字符串[	数组图像性能用户从中选择 。不提供此参数则默认汽车,最优,好,生态学
下载	布尔	是否显示下载按钮默认真实性
共享分享	布尔	是否显示 HTTPS URL并启动 URL函数默认真实性

PredefinedPreset

值传	标签标签	维度
原创	原创性	{原创维度图像}
广场	广场	比率:1:1
风景16:9	风景	比率:16:9
风景4:3	风景	比率4:3
肖像-9:16	纵向图案	比率:9:16
肖像3:4	纵向图案	比率3:4
面书故事	脸书故事	1080x1920
facebookPost	脸书邮报	940x788
facebookCover	脸书封面	820x312
facebookAd	脸书ad	1200x628
面书Event	脸书事件	1920x1080
编程故事	内片故事	1080x1920
instagramPost	stagram邮报	1080x1080
Twitter微信	微信Tweet	1024x512
Twitterad	Twitterad	800x320
连通Cover	LinkedIn封面	1584x396
linkedInCompanyCover	LinkedIn公司覆盖	1536x768
连通ad	LinkedInad	1200x627
pinterestBoardCover	兴趣板覆盖	222x150
趣味Pin	兴趣宾	600x900

自定义预设

属性	类型	描述性
标签标签	字符串	标签预设
宽度	整数	期望宽度图像
高度显示	整数	图像期望高度
方面Ratio	字符串	图像期望侧比如果不能提供宽度或高度,则使用原创宽度画像和高度画像忽略此属性, 并给定宽度和高度 。

例举 :

重叠程序

参数	类型	描述性
公共标识	字符串	需要.图像标识叠加
公共标识	资产类或公共标识	图像置为叠加图像可用a描述资产类对象(验证/私有资产所必需)或公共标识字符串(仅作为公共图像快捷键)。 示例:{publicId:Corpit_logo}类型:
标签标签	字符串	标签叠加选项
变换	对象[	数组云变换对象应用叠加任何变换、特效和其他云变选项都可应用
placementOptions	高山市PredefinedPlacement或自定义定位)[	数组叠加定位选项供用户选择,其中对象识别预定义定位或自定义定位 示例: {{{{{{}}}:0.8,y}:0.8,wiright}:300,grigity:300:nord_west},{{}0,y:0,wirdth:200,h8:200,wordity:

自定义定位

参数	类型	描述性
宽度	内特或浮点	宽度叠加:整数定值像素(例如150定宽度至完全150像素)和浮点定值乘基图像宽度倍数(例如0.1定宽度至基图像宽度10%)。
高度显示	内特或浮点	叠加高度:整数定值像素值(例如100定高度为完全100像素)和浮点定值乘基图像高度倍数(例如0.2定高度为基图像高度20%)。
重力	字符串	指定上铺基图像的位置可能的值:东北,北边,西北部,西边,西南,南边,东南,东边,中心点
X级	内特或浮点	横向偏移定重力:整数定值像素(如10定横向偏移至完全10像素)和浮点定值乘基图像宽度倍数(如0.15定横向偏移至基图宽度15%)。
y市	内特或浮点	垂直偏移定重力:整数定值像素(如15定垂直偏移至完全15像素)和浮点定值乘基像高度倍数(如0.1定垂直偏移至基像高度10%)。

例举 :

PredefinedPlacement

值传	描述性
顶部	X度:0.05y度:0.05度,宽度:0.1度,高度:0.1度,重力度:北
上右	X度: 0.05y度: 0.05度,宽度: 0.1度,高度: 0.1度,重力度: 东北
右转	X度:0.05y度:0.05度,宽度:0.1度,高度:0.1度,重力度:东
底层右转	X度: 0.05y度: 0.05度,宽度: 0.1度,高度: 0.1度,重力度: 东南
底部	X值: 0.05y值: 0.05宽度: 0.1, 高度: 0.1, 重力: 南方
底部左转	X度: 0.05y度: 0.05度,宽度: 0.1度,高度: 0.1度,重力度:西南
左转	X值: 0.05y值: 0.05宽度: 0.1, 高度: 0.1, 重力: 西
上左	X度: 0.05y度: 0.05度,宽度: 0.1度,高度: 0.1度,重力度: 西北
中间	轴数:0,y数:0,宽数:0.1,高度数:0.1,重力数:中心数

实例方法

下方法可用与媒体编辑实例媒体编辑器初始化方法:

• 更新
• 显示显示
• 隐藏
• 毁灭
• 开
• 获取Config
• 获取Version
• 触发输出
• OnSign

更新

上头更新方法接受地图配置参数类更新初始化部件新建配置与现有配置合并,新值替换旧值包括数组,全数组由新数组取代

例举 :

显示显示

显示初始媒体编辑器部件对象或先前隐藏部件

例举 :

隐藏

隐藏先前显示部件而不从存储器中去除

例举 :

毁灭

使用毁灭方法去除媒体编辑器部件并从存储器和DOM删除它并关闭事件发布程序

例举 :

开

使用上方法注册特定事件全表可用事件见事件处理段内

例举 :

样本响应 :

获取Config

返回媒体编辑器部件当前配置

例举 :

获取Version

返回部件版本

例举 :

触发输出

触发导出函数(仿佛用户点击导出按钮)

例举 :

签名

使用签名方法解决交付签名受限资产或定制字体需求经认证访问媒体资产)提供代码形式允诺后端服务器请求交付URLURL带全交付图像URL的参数(包括签名构件或标识查询字符串,如果需要的话)。

例举 :

事件处理

下表列出了可注册事件上方法媒体编辑实例

事件处理	参数集	描述性
aspectratioclick		侧比对点点击
关闭		部件用X按钮闭合
拷贝机	资源类型	URL复制
裁剪点击	预置Name	作物预设点击
维度编辑	宽度高度	图像维度编辑化(宽度或高度)。
下载	资源类型	图像下载
格式点击	选择格式	格式选项点击
interactivecropresize		图像交互变换大小
interactivecropmove		图像交互移动
下一个	从Step到Step	用户移位到下一部件步
叠加点击	选择预置	叠加预设
overlayplacementclick		覆盖定位点击
预览	从Step到Step	用户移位前位元件
质量点击	选择质量	质量选项点击
旋转垂直		转垂直按钮已被点击
fliphorizontally		翻转横向按钮已被点击
时钟旋转		时钟旋转按钮已被点击
rotatecounterclockwise		逆时针旋转按钮已被点击
文本对称	类型	文本对齐类型画布文本层与中心对齐时(垂直或横向或同时对齐)或层积文本层对齐

事件触发时包含下列信息并存(数据)结构 :

• 动作化:触发事件动作
• 标签标签事件描述
• 参数解析:额外信息回传为密钥/值对(详情见上表)。

支持二大特殊事件

• 分析学注册所有事件,这对分析目的有用上头(数据)结构中也将包括事件处理触发器
• 导出用户点击导出按钮上头(数据)结构中还包含数组资产类并发URL,safell并下载Url.例举 :