快速接入 - 开放平台

申请sdk登录帐号

确保您已完成sdk使用权限及账号的申请注册，未完成请先申请帐号

集成环境说明

一、开发环境：

Android SDK Tools: android-sdk_26.0.|+
minSdkVersion: 23
targetSdkVersion:29
Android Studio 3+

二、系统要求:

SDK 支持在 Android 6.0（API 23）及以上系统上运行
建议使用 Gradle版本4.x+
需要访问手机硬件,暂不支持模拟器开发
可以访问互联网的计算机。确保你的网络环境没有部署防火墙，否则无法正常使用 vhall 服务

三、Android SDK 支持如下 ABI：

armeabi-v7
aarm64-v8a

绑定应用信息

使用SDK前集成前，务必先配置好此签名信息，否则使用时会出现"身份验证失败"提示信息，配置信息流程如下

SHA1签名获取

SHA1分为Debug和Release版本如果绑定签名时使用的是Debug签名,运行时也要使用debug.keystore

点击任务
signingReport

signingReport

获取控制台配置信息

执行结果

设置 SHA1签名和包名

进入http://e.vhall.com/home/vhallapi/authlist
选择已开通的应用进行编辑操作
AppKey,SecretKey,AppSecretKey 自动生成,初始化SDK时需要传入(不能有空格)
Android 集成需要填写 SHA1 和包名 , 对应集成的App

项目设置

权限说明

备注：在 /app/Manifests/AndroidManifest.xml 文件中，在后面添加如下权限：

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

混淆设置

如果用户使用了混淆功能，可以加入如下的保持信息。

-dontwarn com.vhall.**
-keep class com.vhall.** {*;}

-dontwarn vhall.com.vss2.**
-keep class vhall.com.vss2.** {*;}

//互动用户需添加
//6.2.3之前的用户使用
-dontwarn org.webrtc.**
-keep class org.webrtc.** {*;}

注意 sdk6.2.3之后 更新了包名webrtc混淆需要修改
-dontwarn org.vhwebrtc.**
-keep class org.vhwebrtc.** {*;}

SDK集成准备

说明为了方便用户sdk版本管理，现sdk依赖方式由原来的aar文件依赖改为maven依赖

引入sdk

SaaS SDK 具体版本请参考

版本更新记录

远程依赖快速接入

备注： Suppot包中包含投屏功能,不需要的可以删掉,uilibs中注释掉投屏相关代码即可；

api 'com.github.vhall.android.library:vh-saas-sdk:6.17.1'
api 'com.github.vhall.android.library:vh-saas-interactive:6.17.1'
//投屏
api 'com.github.vhall.android.library:vh-saas-sdk-support:2.0.1'

//高级美颜相关
api 'com.github.vhall.android.base:vhall-beautify-faceunity:1.1.6'

//高级美颜demoUI 建议自己按照自己需求实现
api 'com.github.vhall.android.library:vhall-beautify-kit-support:1.1.0'

aar下载接入

aar下载地址

选择对应的版本

下载对应版本

查看有没有关联的aar、有则需要继续下载，没有则代表这个线下载完毕

没有关联

项目的 gradle 配置

repositories {
        maven{ url 'https://maven.aliyun.com/repository/central'}
        mavenCentral()
        google()
        jcenter()
    }

allprojects {
    repositories {
        maven{ url 'https://maven.aliyun.com/repository/central'}
        mavenCentral()
        google()
        jcenter()
//投屏使用
        maven {url 'http://4thline.org/m2'}
//高级美颜必须添加
        maven {
            url 'http://maven.faceunity.com/repository/maven-public/'
        }
    }
}

sdk初始化

在application 的oncreate 中进行初始化

接口API

VhallSDK.setLogEnable(false);
//RSA 校验 必须设置否则校验不通过 从控制台 获取
VhallSDK.setRsaPrivateKey(RSA_PRIVATE_KEY);
VhallSDK.init(this, "你们的appKey", "你们的appSecretKey");

接口入参

参数字段	描述
appKey	appKey （从控制台开发者设置获取）
appSecretKey	密钥（从控制台开发者设置获取）

setRsaPrivateKey 函数描述

参数字段	描述
RSA_PRIVATE_KEY	私钥（从控制台开发者设置获取）

需要删除复制的这一部分内容
"-----BEGIN PRIVATE KEY-----" +
"-----END PRIVATE KEY-----"

Demo下载

Github SDK demo

Gitee SDK demo