美摄SDK For Android  3.10.0
美摄影集技术文档

美摄影集使用说明

1、功能描述

根据影集模板要求,用户选择一定数量的图片,把影集素材的文件地址、授权文件地址、影集模板目录和图片列表等参数传入美摄提供的接口中,得到一个有影集效果的timeline,然后使用livewindow就可以预览效果。

2、模板主要文件介绍

info.json:模板描述信息,可以获取模板名称和需要替换的图片的最小数量和最大数量;

cover.jpg:影集封面图;

cover.mp4:影集封面视频;

fx9v16.msphotoalbum:影集模板文件;

368a621a-0d67-2a8a-d2d4-33fe1848b77c.lic:影集模板授权文件;

3、接入方法(以android为例)

  1. 把美摄提供的NvPhotoAlbumHelperLib.jar放入android工程的app/libs目录下;
  1. 用户需要读取info.json文件获取需要替换的图片的最小数量和最大数量,然后根据数量去选择图片,选择完图片之后,根据需求调用如下的任何一个接口:

接口一:

说明:图片Crop方式9:16显示;如果图片数量小于最大数量,会循环利用这些图片,例如最多可以选5张,用户选了3张,显示结果是1,2,3,1,2。

createPhotoAlbumTimeline(Context context, String filePath, String licFile, String resourceDir, ArrayList<String> replaceFileList)接口:

参数说明:

Context:activity的context就可以;

filePath:fx9v16.msphotoalbum文件地址;

licFile:后缀是lic的文件地址;

resourceDir:影集模板解压缩之后的目录;

replaceFileList: 选择的需要替换的图片列表;

接口二:

说明:图片Crop方式9:16显示;图片数量处理逻辑同接口一,这个接口只是增加了字幕list,用户可以在影集模板中显示一些字幕。

createPhotoAlbumTimeline(Context context, String filePath, String licFile, String resourceDir, ArrayList<String> replaceFileList, ArrayList<String> captionList)接口:

参数说明:

Context:activity的context就可以;

filePath:fx9v16.msphotoalbum文件地址;

licFile:后缀是lic的文件地址;

resourceDir:影集模板解压缩之后的目录;

replaceFileList: 选择的需要替换的图片列表;

captionList: 需要替换的文字列表;

接口三:

说明:图片Crop方式9:16显示;图片数量处理逻辑与前两个接口不同,如果图片数量超过最大数量,会循环使用模板,例如最多可以选3张,用户选了8张,显示结果是123,456,787,其中123、456和787都是同样的模板效果。

createIgnoreMaxPhotoNumberLimitPhotoAlbumTimeline(Context context, String filePath, String licFile, String resourceDir, ArrayList<String> replaceFileList, ArrayList<String> captionList,

boolean ignoreMaxPhotoNumberLimit)接口:

参数说明:

Context:activity的context就可以;

filePath:fx9v16.msphotoalbum文件地址;

licFile:后缀是lic的文件地址;

resourceDir:影集模板解压缩之后的目录;

replaceFileList: 选择的需要替换的图片列表;

captionList: 需要替换的文字列表;

ignoreMaxPhotoNumberLimit:是否忽略照片最大数量限制,如果是,才说本接口说明的方式处理,反之则用接口一中的图片数量处理逻辑;

接口四:

**说明:图片Fit方式9:16显示;**图片数量处理逻辑与接口一相同,图片需要全图显示,内部会根据用户输入的一个照片截取一张9:16全图显示的图片,所以需要外界传入一个图片缓存目录,交由用户去管理缓存目录。

createPhotoAlbumLetterBoxTimeline(Context context, String filePath, String licFile, String resourceDir, ArrayList<String> replaceFileList, String cacheImagePath)接口:

参数说明:

Context:activity的context就可以;

filePath:fx9v16.msphotoalbum文件地址;

licFile:后缀是lic的文件地址;

resourceDir:影集模板解压缩之后的目录;

replaceFileList: 选择的需要替换的图片列表;

cacheImagePath: 截取图片的缓存路径;

3)接口返回一个NvsTimeline,用户拿到timeline之后连接livewindow即可预览影集效果;