集成 TUICalling (Android)

最近更新时间:2022-06-23 17:13:41

组件介绍

TUICalling 是一个开源的音视频 UI 组件,通过在项目中集成 TUICalling 组件,您只需要编写几行代码就可以为您的 App 添加“一对一音视频通话”场景,并且支持离线唤起能力。TUICalling 同时支持 iOS、Web、小程序、Flutter、UniApp 等平台,基本功能如下图所示:

说明:

TUIKit 系列组件同时使用了腾讯云 实时音视频 TRTC即时通信 IM 两个基础 PaaS 服务,开通实时音视频后会同步开通即时通信IM服务。即时通信 IM 服务详细计费规则请参见 即时通信 - 价格说明,TRTC 开通会默认关联开通 IM SDK 的体验版,仅支持100个 DAU。

说明:

TUICalling 组件同时使用了腾讯云 实时音视频 TRTC即时通信 IM 两个基础 PaaS 服务,开通实时音视频后会同步开通即时通信 IM 服务。即时通信 IM 服务详细计费规则请参见 即时通信 - 价格说明,TRTC 开通会默认关联开通 IM SDK 的体验版,仅支持100个 DAU。

组件集成

步骤一:下载并导入 TUICalling 组件

单击进入 Github ,选择克隆/下载代码,然后拷贝 Android 目录下的 tuicalling 和 debug 目录到您的工程的 app 同一级目录,并完成如下导入动作:

  • setting.gradle 中完成导入,参考如下:
    include ':tuicalling'
    include ':debug'
  • 在 app 的 build.gradle 文件中添加对 tuicalling 的依赖:
    api project(':tuicalling')
  • 在根目录的 build.gradle 文件中添加 TRTC SDKIM SDK 的依赖:
    ext {
        liteavSdk = "com.tencent.liteav:LiteAVSDK_TRTC:latest.release"
        imSdk = "com.tencent.imsdk:imsdk-plus:latest.release"
    }

步骤二:配置权限及混淆规则

  1. 在 AndroidManifest.xml 中配置 App 的权限,SDK 需要以下权限(6.0以上的 Android 系统需要动态申请相机、麦克风、读取存储权限等):
    <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />        // 使用场景:悬浮窗、应用在后台时拉起通话界面时需要此权限;
    <uses-permission android:name="android.permission.INTERNET" />              
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
    <uses-permission android:name="android.permission.RECORD_AUDIO" />
    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
    <uses-permission android:name="android.permission.BLUETOOTH" />                  // 使用场景:使用蓝牙耳机时需要此权限;
    <uses-permission android:name="android.permission.READ_PHONE_STATE" />           // 使用场景:判断是否是系统来电打断时需要此权限;
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-feature android:name="android.hardware.camera"/>
    <uses-feature android:name="android.hardware.camera.autofocus" />
  2. 在 proguard-rules.pro 文件,将 SDK 相关类加入不混淆名单:
    -keep class com.tencent.** { *; }

步骤三:创建并初始化组件

// 1.添加事件监听及登录
TUILogin.addLoginListener(new TUILoginListener() {
    @Override
    public void onConnecting() {      // 正在连接中
        super.onConnecting();
    }
    @Override
    public void onConnectSuccess() {  // 连接成功通知
        super.onConnectSuccess();
    }
    @Override
    public void onConnectFailed(int errorCode, String errorMsg) {  // 连接失败通知
        super.onConnectFailed(errorCode, errorMsg);
    }
    @Override
    public void onKickedOffline() {  // 登录被踢下线通知(示例:账号在其他设备登录)
        super.onKickedOffline();
    }
    @Override
    public void onUserSigExpired() { // userSig过期通知
        super.onUserSigExpired();
    }
});
TUILogin.login(mContext, "Your SDKAppID", "Your userId", "Your userSig", new TUICallback() {
    @Override
    public void onSuccess() {
    }
    @Override
    public void onError(int errorCode, String errorMsg) {
        Log.d(TAG, "errorCode: " + errorCode + " errorMsg:" + errorMsg);
    }
});
// 2.初始化TUICalling实例
TUICalling callingImpl = TUICallingImpl.sharedInstance(context);
参数说明

  • SDKAppIDTRTC 应用ID,如果您未开通腾讯云 TRTC 服务,可进入 腾讯云实时音视频控制台,创建一个新的 TRTC 应用后,单击应用信息,SDKAppID 信息如下图所示:
  • SecretkeyTRTC 应用密钥,和 SDKAppId 对应,进入 TRTC 应用管理 后,SecretKey 信息如上图所示。
  • userId:当前用户的 ID,字符串类型,长度不超过32字节,不支持使用特殊字符,建议使用英文或数字,可结合业务实际账号体系自行设置。
  • userSig:根据 SDKAppId、userId,Secretkey 等信息计算得到的安全保护签名,您可以单击 这里 直接在线生成一个调试的 UserSig,也可以参照我们的 TUICalling示例工程自行计算,更多信息请参见 如何计算及使用 UserSig

步骤四:实现音视频通话

实现1对1视频通话/音频通话 TUICalling#call

// 发起1对1视频通话,假设userId为:1111;
callingImpl.call(["1111"], TUICalling.Type.VIDEO);

说明:

  • 当接收方完成步骤三后,即登录成功后,再收到通话请求后,TUICalling 组件会自动启动相应的接听界面。
  • 如果您想发起语音通话,更改类型为 TUICalling.Type.AUDIO 即可。

步骤五:离线推送(可选)

完成以上四个步骤,就可以实现音视频通话的拨打和接通,但如果您的业务场景需要在 App 的进程被杀死后或者APP 退到后台后,还可以正常接收到音视频通话请求,就需要为 TUICalling 组件增加离线推送功能,详情见 Android 离线推送接入指引

步骤六:状态监听(可选)

如果您的业务需要 监听通话的状态,例如通话开始、结束等,可以监听以下事件:

callingImpl.setCallingListener(new TUICalling.TUICallingListener() {
    @Override
    public boolean shouldShowOnCallView() {
        return true;
    }

    @Override
    public void onCallStart(String[] userIDs, TUICalling.Type type, TUICalling.Role role, View tuiCallingView) {

    }

    @Override
    public void onCallEnd(String[] userIDs, TUICalling.Type type, TUICalling.Role role, long totalTime) {

    }

    @Override
    public void onCallEvent(TUICalling.Event event, TUICalling.Type type, TUICalling.Role role, String message) {
        Log.d(TAG, "onCallEvent: event = " + event + " ,message = " + message);
    }
});

步骤七:悬浮窗功能(可选)

如果您的业务需要开启悬浮窗功能,您可以在 TUICalling 组件初始化时调用 callingImpl.enableFloatWindow(true) 开启该功能。

目前组件支持以下两种情况悬浮窗:

  • 系统悬浮窗(单击 home 键退到后台):需开启悬浮窗权限。
  • 应用内悬浮窗(最小化退到上一层界面):需开启悬浮窗权限,并设置要返回的上一层界面。
    其中开启悬浮窗权限方法:打开手机设置,找到应用管理,找到您的应用,单击权限,单击悬浮窗并允许(手机厂商、平台不同,该位置可能有差异)。

设置要返回的上一层界面,在AndroidManifest.xml为您需要跳转的界面配置跳转动作 com.tencent.trtc.tuicalling,例如:

<activity
    android:name="{packageName}.MainActivity"
    android:launchMode="singleTop">
    <intent-filter>
        <action android:name="com.tencent.trtc.tuicalling" /> 
        <category android:name="android.intent.category.DEFAULT" />
    </intent-filter>
</activity>

常见问题

TUICalling 组件支持自定义头像和昵称吗?

支持,调用 setUserNickname/setUserAvatar 即可。

TUICalling 组件支持自定义铃声吗?

支持,调用 setCallingBell 即可。

说明:

更多帮助信息,详情请参见 TUI 场景化解决方案常见问题。欢迎加入 QQ 群:592465424,进行技术交流和反馈。

目录