文档

集成SDK

本文为您介绍iOS短视频SDK的pod集成和手动配置操作。

前提条件

开发前的环境要求如下表所示。

类别

说明

系统版本

支持iOS 9.0及以上版本。

macOS High Sierra版本

支持macOS High Sierra 10.13及以上版本。

Xcode版本

支持Xcode 9.0及以上版本,下载Xcode

背景信息

短视频SDK分为专业版,标准版和基础版,三个版本使用的库名分别为专业版/标准版(AliyunVideoSDKPro.framework)和基础版(AliyunVideoSDKBasic.framework)。

  • 基础版只包含录制与裁剪模块。

  • 专业版和标准版包含全功能模块,标准版的高级接口需要单独授权才能调用。

说明

短视频SDK的功能更新,请参见发布说明

集成说明

  • 如果有同时使用短视频SDK和播放器SDK的需求,建议您集成音视频一体化产品MediaBox音视频SDK,可有效解决单独集成多款SDK时引起的依赖库冲突问题。集成操作,请参见iOS端

  • 如需同时单独集成短视频SDK和播放器SDK,您需要关注短视频SDK、播放器SDK及AlivcFFmpeg的版本依赖关系,否则会导致短视频或播放器的功能使用失败,详细信息,请参见AlivcFFmpeg版本依赖

pod方式集成(推荐)

  1. 在Podfile文件中添加依赖,各版本依赖如下表所示

    重要
    • 如果使用短视频SDK 3.24.0及以上版本,请务必使用FFmpeg 4.3.0及以上版本。

    • 请确保网络环境可以访问更新pod仓库,并在pod install安装完成后检查framework版本号是否和官网最新版一致。

    • 使用最少依赖集成方式集成短视频SDK时,如果需要上传媒资文件到视频点播,请集成上传SDK上传,具体内容请参见上传SDK

    版本

    Podfile文件对应依赖

    专业版

    • 默认集成(默认集成方式,包含主库、资源包和上传SDK)

      # 默认的集成方式,除短视频SDK外,还会集成资源包和上传SDK。
      pod 'AliyunVideoSDKPro', '~> 6.7.0'
    • 全量集成(包含主库、剪同款引擎库、资源包和上传SDK)

      # 支持AE剪同款的集成方式
      pod 'AliyunVideoSDKPro/all', '~> 6.7.0
    • 最少依赖集成(不包含剪同款引擎库、资源包和上传SDK)

      # 仅集成短视频SDK,不会集成资源包和上传SDK
      pod 'AliyunVideoSDKPro/min', '~> 6.7.0'
      说明

      如需使用拍摄模块的人脸贴纸功能,则必须引入资源包(AliyunVideoSDKPro.bundle),引入方式请参见设置资源包引入路径

    标准版

    • 默认集成(默认集成方式,包含主库、资源包和上传SDK)

      # 默认的集成方式,除短视频SDK外,还会集成上传SDK。
      pod 'AliyunVideoSDKStd', '~> 6.7.0'
    • 最少依赖集成(不包含资源包和上传SDK)

      # 仅集成短视频SDK,不会集成上传SDK
      pod 'AliyunVideoSDKStd/min', '~> 6.7.0'

    基础版

    # 仅集成短视频SDK,不会集成上传SDK
    pod 'AliyunVideoSDKBasic', '~> 6.7.0'
  2. 更新pod repo。

    pod repo update
  3. 安装pod。

    pod install

手动方式集成(不推荐)

库和资源依赖说明

说明

手动方式集成不提供上传库,如果需要上传媒资文件到视频点播,请集成上传SDK上传,具体内容请参见上传SDK

  • 专业版

    需要手动下载集成相应版本的以下库和bundle资源包。

    库名

    描述

    下载地址

    AliyunVideoSDKPro.framework

    动态库

    V6.7.0专业版

    AETemplateEngune.framework

    动态库(非必须)

    说明

    当需要使用AE剪同款功能时,则必须引入该动态库。

    AliyunVideoSDKPro.bundle

    资源包(非必须)

    说明

    当需要使用拍摄模块的人脸贴纸功能时,则必须引入该资源包。

    alivcffmpeg

    动态库

    GitHub下载地址

  • 标准版

    需要手动下载集成相应版本的以下库。

    库名

    描述

    下载地址

    AliyunVideoSDKPro.framework

    动态库

    V6.7.0标准版

    alivcffmpeg

    动态库

    GitHub下载地址

  • 基础版

    需要手动下载集成相应版本的以下库。

    库名

    描述

    下载地址

    AliyunVideoSDKBasic.framework

    动态库

    V6.7.0基础版

    alivcffmpeg

    动态库

    GitHub下载地址

操作步骤

说明
  • 手动方式集成较为繁琐,并且提交到App Store时需要剥离模拟器版本(x86架构)的动态库,否则会被拒绝。因此推荐使用pod方式集成。剥离模拟器动态库的方式有如下两种:

    • 使用命令行工具lipo剥离模拟器架构的framework。

    • 通过pod方式集成,pod会在打包时自动剥离掉模拟器架构的framework。

  • 编译报错时,请修改Build Settings > Apple Clang - Language > Compile Sources As,修改为Objective-C++

  1. 添加动态库。

    单击General,选择Frameworks, Libraries, and Embedded Content。单击,然后单击Add Other…,导入上述动态库(例如AliyunVideoSDKPro.framework、alivcffmpeg.framework)。导入之后请选择Embed &Sign

  2. 添加其他库依赖。

    单击General,选择Frameworks, Libraries, and Embedded Content。单击,分别添加MobileCoreServices.framework、SystemConfiguration.framework和libresolv.tbd依赖。

  3. 可选:将AliyunVideoSDKPro.bundle依赖导入到工程。

    单击Build Phases,选择Copy Bundle Resources,单击,然后单击Add Other…,导入AliyunVideoSDKPro.bundle。

配置项目

SDK集成后,打开项目工程并修改以下配置:

  1. 配置Build Setting > Linking > Other Linker Flags ,添加-ObjC。

  2. 打开工程info.Plist,添加以下权限:

    Privacy - Camera Usage Description
    Privacy - Microphone Usage Description
    Privacy - Photo Library Usage Description

配置License

获取到License后,需要按以下操作配置License文件。License的获取及详细信息请参见获取短视频SDK License

把下载的License文件导入到App工程中,在Info.plist文件中添加两个key,第一个key为AlivcLicenseKey,value为LicenseKey的值;第二个key为AlivcLicenseFile,value为内置证书文件(相对于mainBundle)的路径。示例如下所示:

key

value

AlivcLicenseKey

LicenseKey的值。取值示例:MoCTfuQ391Z01mNqG8f8745e23c8a457a8ff8d5faedc1****

AlivcLicenseFile

内置证书文件(相对于mainBundle)的路径。

后续步骤

初始化SDK

相关文档

  • 本页导读 (1)