You need to enable JavaScript to run this app.
导航
集成准备
最近更新时间:2024.03.07 14:37:43首次发布时间:2021.11.23 11:56:31

注意

本文档将不再进行维护。

本文档为您介绍集成 Android 加载 SDK 前的准备工作。

发布历史

发版日期版本号功能描述

2023-01-04

1.4.0-tob

  • 升级 heif 解码库
  • 支持大图监控埋点上报
2023-11-231.3.0-tob完善上报字段及控制台监控指标

功能说明

功能列表描述内容
图片格式支持JPEG、PNG、BMP、WEBP 静图、HEIC、GIF、HEIF 动静图等格式解码。
圆角设置支持。
高效网络库支持支持 TTNet 网络库,基于 cronet 内核改造的移动端网络库,支持 HTTP1.x、HTTP2 以及 websocket 等多种网络协议,内部包含 DNS、链接以及协议层多种优化策略。
清除缓存支持用户清除缓存。
动图循环播放支持暂停、继续播放等能力。
缓存控制支持包括忽略内存缓存、忽略磁盘缓存、下载后不存内存缓存。
APPLog 打点上报支持用户感知失败率、解码失败率、解码耗时、排队耗时、加载耗时、文件大小等指标打点上报。您可以在下行网络监控客户端状态监控以及感知指标监控中查看各场景下的指标数据相关说明。
客户端远程云控配置用户登录控制台SDK配置下发自行完成指定 AppID 下对应服务的采样率配置。说明具体配置参数说明请参考客户端配置下发。仅支持设置采样率。

适用版本

本文档适用于 Android 2.3 及以上开发版本。

开发环境

推荐您使用 Android Studio 作为开发工具,本开发文档基于 Android Studio开发环境进行编写。

添加 maven 仓库

确保 project 根目录下的build.gradle下配置服务,代码示例如下所示:

maven {
    url 'https://artifact.bytedance.com/repository/Volcengine/'  
}

获取 SDK 最新版本

请参考版本发布历史,获取 SDK 最新版本信息。

添加 SDK 依赖

在 module 目录下的build.gradle 文件中的dependencies中添加 SDK 依赖,代码示例如下所示:

implementation 'com.volcengine.glide:glide:1.4.0-tob'
annotationProcessor 'com.volcengine.glide:compiler:1.4.0-tob'
implementation 'com.volcengine.glide:statistics:1.4.0-tob'//数据监控
// SDK 支持日志上报扩展功能,且该能力依赖于 Applog 模块,为实现该功能 Applog 会采集用户的 IMEI、MEID、硬件序列号、Android ID、OAID、MAC 等信息(详见隐私政策)。
// 如您无需使用日志上报功能或不想隐私数据被收集,请在添加依赖时剔除 AppLog 模块
//implementation "com.bytedance.glide:statistics:1.4.0-tob" {     
//    exclude group:"com.bytedance.applog", module:"RangersAppLog-Lite-cn"
//}
implementation 'com.volcengine.glide:animated-heif:1.4.0-tob'//heif动图解码
implementation 'com.volcengine.glide:ttnet:1.4.0-tob'//ttnet网络库,可选
implementation 'com.volcengine.glide:nativeheif:1.4.0-tob'//heif解码

注意

您可根据实际情况自主选择是否接入 SDK 的日志上报扩展功能。若不接入,将无法使用日志上报。同时,导致 veImageX 控制台的下行网络监控客户状态监控感知指标监控告警管理无相关数据展示。

后续操作

请参考快速开始完成 SDK 初始化和基本使用。