CLImSdk简版Android接口说明书

文档编号：15009B1-DD6-1

隐私政策说明

修订历史

1. 概述 ( Overview )

1.1 范围 ( Scope )

此文档适用于对接Android版IM聊天。

1.2 发布 ( Issue )

本文档发布于GtIm技术部、产品部及此项目合作公司相关人员。本文档不属于客户契约性文档，不能发布予客户。

1.3 综述 ( Brief )

2. 定义 ( Definition )

2.1 术语 ( Terminologies )

表格 1    术语表

2.2 约束 ( Constraints )

3.运行环境

Android 2.3及以上、真机环境

4.集成指南

4.1 参数准备

1)  向CLIm申请appId，否则使用会失效；

4.2 SDK集成

4.2.1 申请appid

4.2.2 导入jar包和so库

1)  将jar包添加到工程libs目录
2)  添加so库
将armeabi-v7a文件夹里所有的so文件放至工程armeabi-v7a目录下,例如eclipse的so文件目录通常为libs/armeabi-v7a/。
注意：如果应用本身libs目录里还有其他CPU架构的，需要将相应的so文件放到相应的目录.

4.2.3 配置AndroidManifest.xml

1.添加SDK相关权限

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.CHANGE_WIFI_STATE" />
<uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.READ_PHONE_STATE" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />

4.2.4 添加混淆配置

-keep class com.chuanglan.** { ; }
-keep class com.volley.* {*;}

5. 接口设计

5.1 注册/移除监听

5.1.1 注册监听

5.1.1.1 注册某个接口监听

1.addLinstener(Integer bCode, MessageEventListener listener)

5.1.2 移除监听

5.1.2.1 移除某个接口的监听

removeLinstener(Integer bCode, MessageEventListener listener)

5.1.2.2 移除该页面实现监听（使用于退出界面时）

removeLinstener(MessageEventListener listener)

5.1.2.3 移除所有监听

removeAllListener()

5.1.2.4 代码示例：

//注册登陆授权响应事件
//第一步：注册具体响应监听事件（比如登陆请求，其对应的是登陆响应事件；如果一个请求有多个响应则需要注册添加多个监听）
MessageEventSource.getSingleton().addLinstener(MessageType.IM_THIRD_LOGIN_RESP, this);
//第二步：实现 MessageEventListener （响应事件接口）并实现其方法
              // implements MessageEventListener …
        //handleMessageEvent(MessageEvent event)
 //第三步：在页面销毁或者退出时需要把注册移除掉 释放内存，请调用
代码示例：
          @Override
       protected void onDestroy() {
              super.onDestroy();
              //界面退出时移除该界面的所有监听
              MessageEventSource.getSingleton().removeLinstener(this);
       }

5.1.3 回应监听接口MessageEventListener说明

5.1.3.1 方法说明：

handleMessageEvent(MessageEvent event);
回应MessageEvent结构说明

5.1.3.2 回应数据 RespInfo说明

注意：之后接口回应结果只说明RespInfo中的resultBody对象

5.2 初始化

注：游戏初始化时调用此接口 保证后续能够安全使用语音功能；

5.2.1 如需使用代理功能，需在初始化前调用
GTImSdk.getInstance().setProxy(isProxy);

5.2.2 调用接口

public boolean init(Context context, String appId, String path,
boolean isTest ，boolean isOversea)

5.2.3 无回应

5.2.4 代码示例

//cp 的应用ID ,此ID是申请而来的
              String appId=“300000”;  
      //是否测试环境     
              boolean isTest=true; 
              // 第一步：初始化获得imsdk 实例  ,一定要先调用init() 
           //是否是海外版本
        boolean isOversea = false;   
 GTImSdk.getInstance().init(this, appId, path, isTest, isOversea);      

6. 登陆与注销

6.1 注销

public void release()
     注：与初始化对应，退出程序时调用此方法。

6.2 登陆

6.2.1 登陆接口

6.2.1.1 调用cp授权登陆 （绑定cp登陆）

绑定登陆是常用的登陆，即将游戏账号和云娃账号 建立账户关系，在聊天的时候显示游戏内的角色信息。
public boolean Binding(String tt,String gameServiceId,List channelList)

注：目前tt  为 {“uid”:“账号”,“nickname”:“昵称”}  该json格式，由游戏/应用账号和游戏角色名称来进行绑定；如有新需求可和GT商定
java代码示例：
String tt=“{“uid”:”“+user2.userID+”“,“nickname”:”“+user2.userName+”“}”;
C#代码示例：
string tt = string.Format(“{{“nickname:”:”{0}“, “uid”:”{1}“}}”, “name54321”, “test”); 

6.2.1.2  回应结果

返回标示码：MessageType.IM_THIRD_LOGIN_RESP
MessageEvent:   （注：message vent的结构都一致，以下省略说明）

回应数据 RespInfo说明

ImThirdLoginResp对象说明

6.2.2 注销登陆接口

6.2.2.1 调用接口

public boolean logout()

6.2.2.2 无回应

6.2.2.3  代码示例

GTImSdk.getInstance().Logout();

6.2.3 重连通知

6.2.3.1 回应结果

回应数据 RespInfo说明

ReconnectNotify对象说明:

6.3 语音相关接口

6.3.1 设置录音最大时长

6.3.1.1 调用接口

/**
        * 设置录音最长时长  单位：秒
        * @param times
*openVoume 是否开启录音大小回调  true 开启，false 关闭
        */
public boolean setRecordMaxDuration(int times, boolean openVolume)

6.3.1.2 无回应结果

6.3.2 开始录音

6.3.2.1 调用接口

public boolean startAudioRecord(String filePath, String ext, byte speech)
注意:filepath //录音文件保存路径(.amr), 为空则自动生成 
       ext   //扩展标记    
       speech  //0：为普通录音；1:录音完成上传和识别，停止录音时， 会收到上传                               //回调和识别回调；2：录音完成上传，停止录音时， 会收到上传回调

6.3.2.2 无回应结果

6.3.3 录音时声音大小通知

6.3.3.1 调用接口

调用录音接口后，主动回调

6.3.3.2 回应结果

返回标识码：MessageType.IM_RECORD_VOLUME_NOTIFY
返回RecordVolumeNotify对象说明

6.3.4 停止录音

6.3.4.1 调用接口

public boolean stopAudioRecord()

6.3.4.2 回应结果

返回标示码：MessageType .IM_RECORD_STOP_RESP
返回对象ImAudioRecordResp说明

6.3.5 播放语音

6.3.5.1 调用接口

/**
          * 播放录音
          * @param url 
          * @param filePath
          * @param ext 扩展，可用于标志何处触发的播放
          */
public boolean playAudio(String url,String filePath,String ext)

6.3.5.2 回应结果

在播放完成后返回
返回标识码：MessageType.IM_RECORD_FINISHPLAY_RESP
返回对象ImAudioPlayResp说明：

6.3.6 停止播放语音

6.3.6.1 调用接口

public boolean stopPlayAudio()

6.3.6.2 无回应

6.3.7 设置语音识别语言

6.3.7.1 调用接口

/**
        * type输入语音类型
        *im_speech_zn = 1, //中文
        *im_speech_ct = 2, //粤语
        *Im_speech_en = 3, //英语
         outType 输入语音类型
              im_speechout_simplified = 0, //简体中文
              im_speechout_traditional = 1, //繁体中文
        */
public boolean setSpeech_language(int type, int outType)

6.3.7.2 无回应结果

6.3.8 语音识别(已废弃此接口)

6.3.8.1 调用接口

接口1：
/** 开始语音识别本地语音 */
**public boolean startAudioRecognizeLocalFile(String filePath, String tag)；   **此接口调用的返回无url
接口2：
/*开始语音识别本地语音并返回服务器URL/
public boolean startAudioRecognizeAndReturnUrl(String filePath, String tag)
接口3：
/*开始识别网络URL语音/
public boolean startAudioRecognizeUrl(String url, String tag)

6.3.8.2 回应结果

返回标识码MessageType.IM_SPEECH_STOP_RESP
返回ImAudioRecognizeResp对象说明：

6.3.9 上传文件

6.3.9.1 调用接口

/**
        * 上传文件
        * @param filePath 图片路径
        * @param fileId  回应时返回
        */
       public boolean uploadFile(String picPath, String fileId)

6.3.9.2 回应结果

返回标识码：MessageType.IM_UPLOAD_FILE_RESP
返回对象ImUploadFileResp说明

6.3.10 下载文件

6.3.10.1 调用接口

/**
        * @param url 下载图片url
        * @param filePath 保存地址
        * @param fileId  文件标识
        */
public boolean downloadFileReq(String url, String filePath, String fileId)

6.3.10.2 回应结果

返回标识码：MessageType.IM_DOWNLOAD_FILE_RESP
返回对象DownloadFileResp说明

7.文档绑定

表格 2    文档绑定关系表