标准模板(ui 1.0)结构及config说明

更新时间 : 2022-05-30 15:53:44

标准模板(ui 1.0) 结构及 config.json 说明

模板文件夹结构

1. assets：存放所有参与模板渲染资源文件
2. datas：存放所有动画数据文件
3. ui：存放ui界面设计所需配饰图文件
4. config.json：模板配置文件
5. music.mp3：音频文件

标准模板config文件介绍

{
    "settings": {
        "attr": 0 //属性设置 1:打开OIT渲染
    },
    "fps": 30, //模板的主帧速率
    "main": "comp0", //渲染使用的主合成的name属性，SDK支持预合成，所以导出的合层不止一个，这里定义的是主合成的name。
    "description": "合成 1", //模板的描述，对应AE中主合成的名称
    "version": "1.3.0.beta", //SDK内核版本号，与渲染效果息息相关
    "ui_version": "2.0", //编辑界面版本号目前分为1.0与2.0 2.0界面更加完善更加易懂
    "type": 1, //模版属性，按位设置，1: 普通模版， 2:动态模版，4:滤镜， 512:字符动画
                    // 请注意这是一个按位设置的值,如果普通模板中含有字符动画
                    // type 的二进制值为 1001, 也就是 1 + 512 = 513
                    // 所以判断模板类型不要通过 ==  去判断, 而是通过按位与去判断,
                    // 比如判断是不是标准模板  type & 1 != 0, 而不是 type == 1 
    "snap": [], //整型数组，要截图的帧索引号，目前尚无实现
    "comps": [{ //保存所有合成对象
        "name": "comp0", //合成名称
        "duration": 150, //总帧数
        "fps": 30, //帧率
        "size": [720, 1280], //合成大小，部分机型不支持超过4096
        "bg": "#ffffffff", //背景颜色
        "layers": [{ //合成中的所有层对象
            "uuid": "layer_2", //层的唯一ID
            "ui_key": "", //设计师界面中的由设计师设置的标记
            "ui_extra": "", //设计师界面中的由设计师设置的额外信息
            "source": "assetkey0", //层所对应的资源ID
            "type": 32769, //层的属性 如3D属性，层类型等
            "blend": 0, //混合模式
            "matte": 0, //trakmat类型
            "resample": 0, //
            "enabled": true, //是否可见
            "range": [0, 0, 149，30], //对应层的起点帧Start Time，可见的起点帧In Point，可见的持续帧数(Out Point - In Point)下文有详解, 第四个数据已废弃
            "mask": [], //蒙版数据
            "effects": [], //特效数据
            "transform": { //变换信息，3d层为三维数组
                "p": [360.0, 640.0],  //位置，[x 轴坐标， y 轴坐标]
                "a": [540.0, 960.0], //锚点，[x 轴坐标， y 轴坐标]
                "s": [1.0, 1.0], //缩放，[x 轴缩放， y 轴缩放]
                "t": 1.0, //透明度, 0 - 1.0
                "r": 0.0 //旋转角度
            }
        }]
    }],
    "assets": [{ //保存所有素材对象数组
        "key": "assetkey0", //素材的唯一ID
        "ui_key": "", //设计师在导出工具中为素材设置的标识key
        "ui_extra": "", //设计师在导出工具中为素材设置的附加数据
        "fps": 30, //在AE中解释素材选项中如果指定帧速率，则存在此key，否则为0或不存在
        "name": "asset1.mp4", //素材的名称，根据素材类型type的不同，name字段的作用也不同  
        "type": 1, //素材的类型 0:未知的素材类型 1:图片或视频或图片序列帧素材 2:OpenGL纹理素材 3:预合成素材 4:固态颜色素材 5:自定义素材
        "num": 0, //如果该素材为图片序列帧素材，那么这个num代表序列帧文件的数量，其他情况下num字段为0
        "text_anim":"data.json", //文字动画数据，仅开启高级字符动画时存在
        "size": [1080, 1920], //素材大小，ui 2.0 文字素材不再使用这个尺寸(参考 editSize)
        "ui":{//变换信息仅支持2D 图片与文字只同时存在一种
            "f":"a.png", //前景图（配饰图）
            "b":"b.png", //背景图
            //图片素材信息
            "group": 10, //组索引
            "index": 0, //组内索引
            "duration": 278, //持续帧数（以主合成帧率为基准的最大帧数）
            "accept": 0, //接受素材类型
            "type": 1, //可编辑类型 1:图片 2:文字 3: 高级字符动画文字
            "editSize": [100, 100], // 编辑区域，图片素材大小
            "p": [100.5, 38.0],  
            "a": [100.5, 38.0],
            "s": [1.0, 1.0],
            "t": 1.0,
            "r": 0.0，
            "area": [0, 0, 100, 100] // 设计师指定的点击选中区域， 分别是 x轴坐标, y轴坐标, width, height

            //文字素材信息
            "group": 9, //组索引
            "index": 0, //组内索引
            "duration": 348, //持续帧数（以主合成帧率为基准的最大帧数）
            "type": 2, //可编辑类型 1:图片 2:文字 3: 高级字符动画文字
            "default": "编辑文字", //默认文字
            "max": 4, //最大字数
            "font": "SimHei", //字体完整名称
            "font_style": "Regular", //字体样式（例如粗体、细体或斜体等）
            "font_family": "STSong",//字体系列名称
            "font_file": "Songti.ttc",//字体文件名称（不保证为所有字体类型返回字符串；对于某些类型的字体，返回值可能是空字符串）
            "size": 92, //字体大小
            "line_height": 110, //行高
            "fill": "#ffffff", //填充颜色
            "stroke": "#000000", //描边颜色
            "width": 0, //描边宽度
            "strokeOverFill": true, //描边是画在填充之上
            "align": 0, //排版方式 0:左对齐 1:右对齐 2:居中对齐
            "direction": 0,//文字方向 0:横向文字 1:纵向文字
            //--------------------------------------------------------------------------------
            //type=3类型文字可调用SDK绘制图片，需要用到以下信息
            "box_text":true, //是否是文本框类型文字（仅高级字符动画支持）
            "adapt":true, //是否开启自适应（仅高级字符动画支持）
            "bound":[-50,-50,100,100], //文本框[x,y,width,height]（仅高级字符动画支持）
            //--------------------------------------------------------------------------------
            "faux_bold":true, //是否使用仿粗体 （高级字符动画暂未支持）
            "faux_italic":true, //是否使用仿斜体 （高级字符动画暂未支持）
            "editSize": [100, 100], // 编辑区域，文字图片素材大小
            "p": [0.0, 0.0],
            "a": [0.0, 0.0],
            "s": [1.0, 1.0],
            "t": 1.0,
            "r": 0.0,
            "area": [0, 0, 100, 100] // 设计师指定的点击选中区域， 分别是 x轴坐标, y轴坐标, width, height
        }
    }],
        "ui_group": [ // 对应 assets->ui->group 
        {
            "size": [
                720,
                1080
            ]
        },
        {
            "size": [
                720,
                1080
            ]
        }
    ]
}

1. fps字段

模板的主帧速率

2. main字段

渲染使用的主合成的名称。
新版本SDK支持预合成，所以导出的合层不止一个，这里定义的是主合成的名称。

3. description字段

模板的描述。默认这里是主合成的名称

4. version字段

模板的版本号

5. type字段

模板的类型，1代表标准模板

6. snap字段

整型数组，要截图的帧索引号

7. comps字段

导出的所有合成对象

8. assets字段

导出的所有素材对象

9. range字段

Start Time, In Point, Out Point讲解

asset对象字段详解

1. key字段

素材的唯一标识

2. type字段

素材的类型。
0-> 未知的素材类型
1-> 图片或视频或图片序列帧素材
2-> OpenGL纹理素材
3-> 预合成素材
4-> 固态颜色素材
5-> 自定义素材

3. name字段

素材的名称，根据素材类型的不同，name字段的作用也不同

• 如果素材类型为1，name字段是素材文件名称，具体的素材文件都存储在assets文件夹里
• 如果素材类型为3，name字段是合成的名称
• 如果素材类型为4，那么字段是颜色的16进制字符串

4. num字段

如果该素材为图片序列帧素材，那么这个num代表序列帧文件的数量，其他情况下num字段为0

5. ui_key字段

设计师在导出工具中为素材设置的标识key

6. ui_extra字段

设计师在导出工具中为素材设置的附加数据

6. size字段

整型数组，该素材的宽高。

7. ui字段

如果这个素材是可编辑的，那么就会有ui字段。ui字段下存储的是编辑界面相关的数据
ui字段有两种结构，针对图片素材的结构和针对文字素材的结构

1. 图片素材ui对象结构
   f：该素材的配饰图文件名，如果没有配饰图，则没有该字段。配置图文件统一存储在ui文件夹内
   b：该素材的背景图文件名，如果没有背景图，则没有该字段。配置图文件统一存储在ui文件夹内
   group：该素材所在的编辑组
   index：该素材在其编辑组中的层级序列号。从0递增代表group里的层级从下往上
   duration：该素材在合成中的时长，帧为单位
   type：可编辑素材的类型，1代表图片素材
   accept：可接受的素材类型， 0代表只接受图片素材，1代表只接受视频素材，2代表可接受图片或视频素材。这只是编辑界面提示，在实际渲染时并没有限制
   link：整型数组，代表同一编辑组内，互相链接的素材的序列号
   p：编辑界面素材的默认位置
   a：编辑界面素材的默认锚点
   s：编辑界面素材的默认缩放
   r：编辑界面素材的默认旋转
   t：编辑界面素材的默认不透明度

2. 文字素材ui对象结构
   f：该素材的配饰图文件名，如果没有配饰图，则没有该字段。配置图文件统一存储在ui文件夹内
   b：该素材的背景图文件名，如果没有背景图，则没有该字段。配置图文件统一存储在ui文件夹内
   group：该素材所在的编辑组
   index：该素材在其编辑组中的层级序列号。从0递增代表group里的层级从下往上
   duration：该素材在合成中的时长，帧为单位，（以主合成帧率为基准的最大帧数）
   type：可编辑素材的类型，2代表文字素材 3代表高级字符动画文字
   default：默认文字内容
   max：最大输入的字符数量
   font: 字体完整名称
   font_style: 带样式信息的字符串（例如粗体或斜体）
   font_family: 带字体系列名称的字符串
   font_file: 带字体文件路径的字符串，从而提供它在磁盘上的位置（不保证为所有字体类型返回字符串；对于某些类型的字体，返回值可能是空字符串）
   size：字体大小
   fill：字体填充颜色的16进制字符串
   stroke：字体描边颜色的16进制字符串
   width：字体描边的宽度
   align：文字对齐方式，0代表左对齐，1代表右对齐，2代表居中对齐
   shadow：文字投影颜色的16进制字符串
   s_alpha：文字投影不透明度
   s_angle：文字投影的角度
   s_dist：文字投影的距离
   s_size：文字投影的大小
   area：整型数组，文字输入框的范围，分别代表【左上角x坐标，左上角y坐标，输入框宽度，输入框高度】