客户端实现

本文介绍如何通过环信 IM SDK 和 Agora RTC SDK 在 Android 项目里实现语聊房的主要功能。

语聊房 Demo 内部依赖环信 IM 聊天室与 Agora RTC 频道。

以下为房间管理流程图。

Demo 中创建或加入语聊房的流程如下：

1. 启动 Demo。在 application 中调用 ChatroomConfigManager.getInstance.initRoomConfig 方法初始化环信 IM SDK。
2. 利用手机号和验证码登录环信 IM。
3. 登录 IM 后，通过 App Server 创建语聊房。成功后，房间创建者成为房主自动加入语聊房并跳转至语聊房页面。
4. 进入房间后加入环信 IM 聊天室和 RTC 频道。 首先检查是否具有 RTC 所需权限。获取到所需权限并得到授权后执行 onPermissionGrant 方法，调用 initSdkJoin 进行 RTC 初始化（初始化 RTC 加入频道需要的参数由登录时由 App Server 返回）。
5. 检查是否成功加入环信 IM 聊天室 和 RTC 频道。
   • 若成功加入，房主可以发送本地音频流和消息，观众可以发消息。
   • 若未成功加入，则退出房间，返回房间列表页面。
6. 退出房间。

语聊房的用户角色如下表所示：

语聊房的相关操作如下表所示：

麦位管理流程图如下所示：

麦位相关操作如下表所示：

邀请用户上麦的流程如下：

1. 房主调用 RESTFul API 邀请用户上麦。
2. App Server 收到邀请消息后，利用房主角色向用户发送该消息。
3. 用户同意邀请后调用 RESTful API 上麦。
4. App Server 设置聊天室属性通知房间全员刷新房间设置。

用户申请上麦的流程如下：

1. 用户调用 RESTful 接口申请上麦。
2. App Server 收到上麦申请消息后以用户角色向房主发送该消息。
3. 房主收到上麦申请后调用 RESTful API 同意上麦。
4. App Server 设置聊天室属性通知房间全员刷新房间设置。

发送礼物消息的流程如下：

1. 用户 A 发送礼物详情到 App Server。
2. App Server 统计礼物信息后对用户 A 返回响应。
3. SDK 将礼物消息发送到语聊房。

• Android Studio 3.0 或以上版本；
• Android SDK API 等级 23 或以上；
• Android 6.0 或以上版本的设备；
• 有效的环信 IM 开发者账号和 App key，详见环信即时通讯云控制台；
• 有效的 Agora 项目，获取项目的 App ID 以及一个 RTC Token，实现语音通话；
• 如果你的网络环境部署了防火墙，请联系环信技术支持设置白名单。

下表提供环信 IM SDK 和 Agora RTC SDK 的基本 API 参考。

加入语聊房前，进行环信 IM SDK 初始化和 Agora RTC 初始化设置。

以下表格为 App Server 的基础 API。

房间管理 API 如下表所示：

麦位管理 API 如下表所示：

礼物榜单 API 如下表所示：

其他 API，详见声网官网。

Easemob IM SDK 的 API 如下表所示：

初始化 SDK（ChatroomConfigManager.getInstance.initRoomConfig）时已注册了连接监听、消息监听、聊天室监听，可以实现 ChatroomListener 接口。

主播调用以下方法设置音频流：

设置最佳音效，示例代码如下：

annotation class SoundSelection {
                    companion object {
                        const val SocialChat = 0        //社交语聊

                        const val Karaoke = 1           //在线 K 歌

                        const val GamingBuddy = 2       //游戏陪玩

                        const val SoundCardHQ = 3       //专业主播
                    }
                }

                 rtcEngine?.apply {
            when (config.soundType) {
                SoundSelection.SocialChat, SoundSelection.Karaoke -> { // 社交语聊，KTV
                    setChannelProfile(Constants.CHANNEL_PROFILE_LIVE_BROADCASTING)
                    setAudioProfile(Constants.AUDIO_PROFILE_MUSIC_HIGH_QUALITY)
                    setAudioScenario(Constants.AUDIO_SCENARIO_GAME_STREAMING)
                }
                SoundSelection.GamingBuddy -> { // 游戏陪玩
                    setChannelProfile(Constants.CHANNEL_PROFILE_COMMUNICATION)
                }
                else -> { //专业主播
                    setAudioProfile(Constants.AUDIO_PROFILE_MUSIC_HIGH_QUALITY)
                    setAudioScenario(Constants.AUDIO_SCENARIO_GAME_STREAMING)
                    setParameters("{\"che.audio.custom_payload_type\":73}")
                    setParameters("{\"che.audio.custom_bitrate\":128000}")
                    // setRecordingDeviceVolume(128) 4.0.1 上才支持
                    setParameters("{\"che.audio.input_channels\":2}")
                }
            }
        }

AI 降噪插件使用声网人工智能噪声消除算法，能够让远程交流和面对面交谈一样实时。

可以开启或关闭 AI 降噪以及设置中级降噪和高级降噪。示例代码如下：

internal class AgoraRtcDeNoiseEngine : RtcBaseDeNoiseEngine<RtcEngineEx>() {

    override fun closeDeNoise(): Boolean {
        engine?.apply {
            setParameters("{\"che.audio.ains_mode\":0}")
            setParameters("{\"che.audio.nsng.lowerBound\":80}")
            setParameters("{\"che.audio.nsng.lowerMask\":50}")
            setParameters("{\"che.audio.nsng.statisticalbound\":5}")
            setParameters("{\"che.audio.nsng.finallowermask\":30}")
            setParameters("{\"che.audio.nsng.enhfactorstastical\":200}")
        }
        return true
    }

    override fun openMediumDeNoise(): Boolean {
        engine?.apply {
            setParameters("{\"che.audio.ains_mode\":2}")
            setParameters("{\"che.audio.nsng.lowerBound\":80}")
            setParameters("{\"che.audio.nsng.lowerMask\":50}")
            setParameters("{\"che.audio.nsng.statisticalbound\":5}")
            setParameters("{\"che.audio.nsng.finallowermask\":30}")
            setParameters("{\"che.audio.nsng.enhfactorstastical\":200}")
        }
        return true
    }

    override fun openHeightDeNoise(): Boolean {
        engine?.apply {
            setParameters("{\"che.audio.ains_mode\":2}")
            setParameters("{\"che.audio.nsng.lowerBound\":10}")
            setParameters("{\"che.audio.nsng.lowerMask\":10}")
            setParameters("{\"che.audio.nsng.statisticalbound\":0}")
            setParameters("{\"che.audio.nsng.finallowermask\":8}")
            setParameters("{\"che.audio.nsng.enhfactorstastical\":200}")
        }
        return true
    }
}