1 概念说明

频道：聊天、文档服务，依赖于频道。例如在使用文档演示时，需要先通过基础通讯服务创建一个频道。并将文档演示方与观看方连接至同一个频道。 消息发送也需要依赖频道的创建来进行消息传送。

智能垃圾过滤：开启智能垃圾过滤，可以为用户智能过滤掉聊天消息中的垃圾消息，帮助用户降低色情、暴恐、涉政等违规风险，节省人工审核成本。

2 接入准备

2.1 成为开发者

申请开通微吼云账号，提供用户资料，微吼服务人员在后台为用户开通平台账号，账号开通后，用户即可登录，成为一名开发者。

2.2 创建应用

登录微吼云平台后，控制台选择应用管理，进入应用管理页面点击创建应用，根据页面提示信息，完成应用创建。应用创建完成，您可以在控制台界面找到在应用管理界面您可以找到 AppID。

2.3 添加服务

应用创建完成后，选择添加服务，添加聊天服务，添加成功后可在聊天服务下聊天管理的【聊天配置】页面查看AppID

2.4 SDK下载

SDK下载

3 工程配置

3.1 开发环境

  • Android SDK Tools: android-sdk_22.0.|+
  • minSdkVersion: 16
  • targetSdkVersion: 22
  • Android Studio

3.2 系统要求

  • SDK 支持 在 Android 4.1（API 16）及以上系统上运行，但只有 ( Android 4.3) API 18 以上的系统才能开启硬件编码

3.3 接入流程

  • 新建gradle工程
  • 复制vhallframework1.0.jar到工程lab目录下
  • 复制jnilibs文件夹内容到appjni目录下

3.4 库简介

  • vhallframework1.0.jar：vhallsdk基础包，用户sdk基础通迅、全局配置、日志管理、权限控制等。
  • socket.io 一款公共I/O库，基础通讯功能使用，目前使用截止文档编写之日最新稳定版
   compile("io.socket:socket.io-client:0.9.0") {
        exclude group: 'org.json', module: 'json'
    }

3.5 配置权限

<uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.RECORD_AUDIO" />
    <uses-permission android:name="android.permission.RECORD_VIDEO" />
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.WRITE_SETTINGS" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.FLASHLIGHT" />
    <uses-permission android:name="android.permission.CHANGE_WIFI_MULTICAST_STATE" />
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

    <uses-feature android:name="android.hardware.camera" />
    <uses-feature android:name="android.hardware.camera.autofocus" />

3.6 接口简介

3.6.1 VhallSDK初始化

appid为注册应用时配置的应用ID 初始化操作为SDK的入口，一切SDK功能都在初始化成功后才能使用，建议在应用application启动时调用

VhallSDK.getInstance().init(Context context, String appid);

3.6.2 SDK信息配置

1、配置用户ID

用户ID为客户平台用户唯一标识，建议在用户登录之后配置

VhallSDK.getInstance().setUserId(String userid);

2、配置日志显示

设置SDK日志显示（警告和错误级别日志必打印，此开关控制debug/info/verbose级别日志

VhallSDK.getInstance().setLogEnable(boolean enable);

3.6.3 获取SDK状态

SDK是否初始化成功并处于可用状态，初始化操作会校验appid对应当前包名和签名，请确保配置正确

VhallSDK.getInstance().isEnable();

3.6.4 加入频道

加入频道并接收频道信息，channelid表示当前频道号，如果是lss服务，房间号即为频道号

VhallSDK.getInstance().join(String channelid,Callback callback);

3.6.5 离开频道

VhallSDK.getInstance().leave(String channelid);

4 功能使用

4.1 获取channel_id、access_token

获取channel_id、access_token

4.2 集成过程

  • 复制vhallims1.0.jar到工程lib目录下

4.3 创建VHIM实例

  • ChannelId 频道id 可以通过调用 api 创建
  • accessToken 可以通过调用 api 获得
im = new VHIM(mChannelId, mAccessToken);

4.4 添加监听

当VHIM创建完毕，需要添加监听消息，每当有消息推送会回调onMessage()，用户需要根据自己的场景解析数据

im.setOnMessageListener(new VHIM.OnMessageListener() {
            @Override
            public void onMessage(String msg) {
                TextView textView = new TextView(IMActivity.this);
                textView.setText(msg);
                ll_content.addView(textView);
            }
        });

4.5 进入聊天室

 void join();

4.6 发送消息及回调

  • message 需要发送的消息
  • callback 消息发送后的回调
 void sendMsg(String message ， Callback callback);

4.7 离开聊天室

 void leave();