IM 即时通讯(增强版)
Web
动态与公告
IM UIKit 更新日志
NIM SDK 更新日志
新手接入指南
产品介绍
简介
产品优势
主要功能
功能介绍
账号集成与登录
基础消息功能
群组功能
聊天室功能
圈组功能
多端登录与互踢策略
海外数据中心
IM 平滑迁移方案
接口及业务限制
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
实现聊天室登录(不含 UI)
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能列表
快速集成 IM UIKit
非React框架快速集成
非React框架集成 IM UIKit
非 React 框架自定义示渲染
组件导入
初始化
全局上下文
登录相关
会话列表相关
集成会话列表界面
自定义会话列表界面 UI
会话消息相关
集成会话界面
实现自定义消息收发
自定义会话界面 UI
用户资料相关
集成用户资料组件
通讯录相关
集成通讯录界面
自定义通讯录界面 UI
搜素组件相关
集成搜索组件
自定义搜索组件 UI
主题样式设置
语言设置
初始化(兼容 NIM SDK)
常见问题
如何解决样式冲突
不含 UI 集成
集成 SDK
IM 登录与初始化相关
初始化并登录 IM
注销登录与销毁实例
多端登录与互踢
消息收发
历史消息
消息扩展
最近会话
服务端会话服务
用户资料托管
好友关系托管
在线状态订阅
系统通知
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
超大群概述
超大群管理
超大群成员管理
超大群消息管理
反垃圾
聊天室功能
聊天室概述
聊天室初始化与登录相关
初始化并登录聊天室
注销登录与销毁实例
聊天室标签功能
聊天室消息管理
聊天室成员管理
聊天室信息管理
聊天室队列服务
圈组功能
圈组概述
初始化与登录
通用接口校验说明
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
频道分组
频道分组黑白名单
频道未读数管理
实时互动频道
搜索服务器与频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
频道用户定制权限
频道分组身份组
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
圈组消息收发
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
获取频道最后一条消息
会话消息回复(Thread)
圈组快捷评论
圈组消息搜索
查询历史消息
查询@我的消息
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组内容审核
圈组第三方回调
圈组相关抄送
圈组各端接口命名差异
融合存储方案
最佳实践
聊天室重要消息投递
API 参考
NIM SDK API 参考
状态码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
服务协议

实时互动频道

更新时间: 2023/03/14 14:33:43

实时互动频道,是基于圈组,在文字基础上新增的,用于提供产品能力、丰富社区运营、提升用户活跃的,适用于百万用户量级、多场景、多能力的在线实时互动的多媒体插件。

网易云信 NIM SDK 通过插件的方式引入实时互动频道模块,通过接口的融合,帮助用户在圈组中实现在线实时互动,用户无需独立对接。

实时互动频道模块(QChatMedia)主要通过 QChatMediaServiceInterface 接口实现实时互动频道模块的初始化、登录、连接以及频道内多样的音视频通话能力。

实时互动频道相关能力为增值服务,需单独开通,您可通过云信官网提供的联系方式咨询商务经理开通。

本文介绍如何在圈组中引入实时互动频道模块,并在实时互动频道中实现实时音视频通话功能。

技术原理

图中的圈组服务器并非传统意义上的服务器,它是社群本身。所有的内容、兴趣、话题、关系都是以此为基础进行发展的。在圈组的场景下,任何行为的开始前都应该先创建一个圈组服务器。圈组详细信息,请参见圈组介绍

实时互动频道与频道的关联逻辑

实时互动频道是频道的一种类型,通过参数 EChannelInfoType 来区分(media = 1)。

频道的管理需要在 QChatChannelServiceInterface 中进行,包括创建、删除实时互动频道等,具体请参见频道管理

实时互动频道内的音视频相关功能需要在实时互动频道模块( QChatMedia )中实现。

使用实时互动频道相关接口,需要拥有实时互动相关权限(具体权限类型请参见 QChatRoleAuth),可通过更新身份组来实现。

实时互动频道可见机制

实时互动频道的可见机制与频道相同,分为以下两种情况:

  • 如果实时互动频道为公开频道,那么只要用户未被加入频道黑名单,实时互动频道就对其可见。
  • 如果实时互动频道为私密频道,那么用户需被加入频道白名单,实时互动频道才对其可见。

频道黑白名单相关操作,请参见频道管理

实现方法

本节以实时互动频道创建者与实时互动频道成员之间的交互为例,介绍在圈组中实现音视频通话功能的流程。

前提条件

  • 已开通实时互动频道相关服务,若未开通,可通过云信官网提供的联系方式咨询商务经理开通。
  • 已接入圈组,并创建或加入圈组服务器和身份组。
  • 已创建或加入实时互动频道。具体请参见频道管理

时序图

uml diagram

实现流程

  1. 引入实时互动频道功能插件(QChatMedia)。

需要在初始化参数中注入 neroom-web-sdkneroom-web-sdk 以 npm 包的形式提供,请先使用 npm 命令安装。 示例代码如下:

   import QChatSDK from 'nim-web-sdk-ng/dist/QCHAT_BROWSER_SDK'
   import WebRoomkit from 'neroom-web-sdk'
   const qchat = new QChatSDK({
       appkey: '{{YOUR_APP_KEY}}',
       token: '{{YOUR_TOKEN}}',
       account: '{{YOUR_ACCOUNT}}',
       linkAddresses: ['{{YOUR_ADDRESSES}}'],
       debugLevel: 'debug'
   },{QChatMedia:{neroom: WebRoomkit}})
  1. 调用 QChatInterfacelogin方法登录圈组服务端。示例代码如下:
  await qchat.login()

3.实时互动频道创建者通过调用 updateServerRole 方法修改服务器身份组并设置实时互动相关权限。示例代码如下:

   await qchat.qchatRole.updateServerRole({
       serverId:'{{YOUR_SERVERID}}',
       roleId:'{{ROLEID}}',
       auths:{
           manageRole:'allow',
           RTCChannelConnect:'allow',
           RTCChannelOpenMicrophone:'allow',
           ...
       }
   })

实时互动频道创建者需要拥有管理身份组的权限(manageRole)。具体请参见身份组管理

  1. 调用 initQChatMedia 方法初始化 QChatMedia 模块并通过 loginByIM 登录 QChatMedia 模块。示例代如下:
 await qchat.qchatMedia.initQChatMedia()
 await qchat.qchatMedia.loginByIM()
  1. 调用 connectChannel 方法连接已创建的实时互动频道。示例代码如下:
 await qchat.qchatMedia.connectChannel({
   channelId:'{{YOUR_SERVERID}}',
   channelId:'{{YOUR_CHANNELID}}',
 })
  1. 在实时互动频道中实现具体的音视频功能(以打开音频为例)。

    a. 在已连接实时互动频道的前提下调用 addRTCChannelListener 方法添加成员音频状态(memberAudioMuteChanged )监听事件。

    b. 确认当前账号有权限后调用 unMuteAudio 方法打开成员音频。

    c. 触发回调,服务器返回成员音频状态信息。

 await qchat.qchatMedia.addRTCChannelListener()
 qchat.on('memberAudioMuteChanged',(data)=>{
   const {memberAccId,mute,operateByAccId} = data
 })
 await qchat.qchatMedia.unMuteAudio({accid:'ACCID'})
  1. 调用 disconnectChannel 方法与实时互动频道断开连接。示例代码如下:
await qchat.qchatMedia.disconnectChannel()

API 参考

以下为本文涉及的实时互动频道相关相关 API。

API
说明
initQChatMedia 初始化实时互动频道模块
loginByIM 登录实时互动频道模块
connectChannel 连接实时互动频道
disconnectChannel 取消连接实时互动频道
addRTCChannelListener 添加实时互动频道事件监听
removeRTCChannelListener 移除实时互动频道监听
unMuteAudio 打开成员音频
muteAudio 关闭成员音频

更多实时互动频道相关接口请参见QChatMediaServiceInterface

此文档是否对你有帮助?
有帮助
我要吐槽
  • 技术原理
  • 实时互动频道与频道的关联逻辑
  • 实时互动频道可见机制
  • 实现方法
  • 前提条件
  • 时序图
  • 实现流程
  • API 参考