更新日志

更新时间: 2024/07/12 17:35:28

本文介绍 NERoom 房间组件 Android 端的更新日志。

1.29.0 (2024-06-12)

新增特性

  • 新增获取 SDK 日志路径能力。
  • 新增音视频多房间能力,包括加入/离开音视频子房间,开启/关闭音视频房间音频模块,以及对音视频房间中的音频管理等功能。
  • 新增批注白板能力,用于观看 PC 端发起的透明白板批注。
  • 支持音视频房间最大人数的设置与获取能力。
  • 支持获取等候室中的主持人信息。

新增 API

类/方法/回调/错误码 说明
NERoomKit.getSDKLogPath 新增方法,用于获取 SDK 日志路径。
NERoomRtcController.joinRtcChannel 新增方法,用于加入指定的音视频子房间。
NERoomRtcController.leaveRtcChannel 新增方法,用于离开指定的音视频子房间。
NERoomRtcController.enableMediaPub 新增方法,用于开启/关闭指定音视频房间的音频流发布。
NERoomRtcController.adjustChannelPlaybackSignalVolume 新增方法,用于调整指定音视频房间的混音播放音量。
NERoomRtcController.enableAudioVolumeIndication 新增方法,用于开启/关闭音视频房间的音量数据回调。
NERoomRtcController.enableLocalAudio 新增方法,用于开启/关闭音视频房间的音频模块。
NERoomContext.NERoomAnnotationController 新增类,批注白板控制器,用于观看 PC 端发起的透明白板批注。
NERoomAnnotationController.setEnableDraw 新增方法,用于设置批注是否可绘制。
NERoomAnnotationController.setupCanvas 新增方法,用于设置批注视图。
NERoomAnnotationController.resetCanvas 新增方法,用于重置批注白板。
NERoomAnnotationController.lockCameraWithContent 新增方法,用于将批注白板与被标注物的坐标进行绑定。
NERoomAnnotationController.isAnnotationEnabled 新增属性,表示当前批注是否开启。
NERoomAnnotationController.isSupported 新增属性,表示是否支持批注功能。
NERoomListener.onRoomAnnotationEnableChanged 在房间回调中新增 “房间批注状态变更” 事件的回调。
NERoomListener.onRtcChannelDisconnect 在房间回调中新增 “RTC 频道断连” 事件的回调。
NERoomListener.onRtcChannelError 在房间回调中新增 “RTC 频道错误” 事件的回调。
NERoomListener.onRtcLocalAudioVolumeIndication 在房间回调中新增 “RTC 频道本端音量” 事件的回调。
NERoomListener.onRtcRemoteAudioVolumeIndication 在房间回调中新增 “RTC 频道远端音量” 事件的回调。
NECreateRoomParams.maxMembers 新增属性,表示在创建房间时指定房间的最大人数。
NERoomListener.onRoomMaxMembersChanged 在房间回调中新增 “房间最大人数变更” 事件的回调。
NEWaitingRoomController.getWaitingRoomManagerList 新增方法,用于主动查询等候室中的主持人以及联席主持人的信息。
NEWaitingRoomListener.onManagersUpdated 在等候室回调中新增 “主持人或联席主持人信息变更” 事件的回调。

变更 API

  • NERoomCustomSessionMessage 重命名为 NERoomSessionMessage,其中的字段不变。
  • 删除 NERoomMessageSessionListener
  • NEMessageChannelService 中删除 addSessionMessageListenerremoveSessionMessageListener
  • NEMessageChannelListener 中新增以下回调:
    • onSessionMessageReceived:接收到自定义会话消息。
    • onSessionMessageDeleted:自定义消息被删除。
    • onSessionMessageRecentChanged:最近会话列表变更。
    • onSessionMessageAllDeleted:自定义消息被清空。

问题修复

修复 IMChatroomCustomMessage 转化时,attachStr 空指针问题。

兼容版本

  • 兼容 NIMSDK 9.16.0 版本
  • 兼容 NERtcSDK 5.5.40 版本
  • 兼容 Common 1.3.3 版本
  • 兼容 CoreKit 1.4.11 版本
  • 兼容 CoreKit-IM 1.14.11 版本
  • 兼容 NEWhiteboard 3.9.6 版本

1.28.1 (2024-05-14)

修复断网重连触发房间异常断开问题。

兼容版本

  • 兼容 NIMSDK 9.16.0 版本
  • 兼容 NERtcSDK 5.5.40 版本
  • 兼容 Common 1.3.3 版本
  • 兼容 CoreKit 1.4.11 版本
  • 兼容 CoreKit-IM 1.14.11 版本
  • 兼容 NEWhiteboard 3.9.6 版本

1.28.0 (2024-05-09)

新增特性

  • 新增 SIP 外呼能力。
  • 新增 APP 内呼叫能力。
  • 新增获取聊天室成员信息功能。

变更 API

类/方法/回调/错误码 说明
NERoomContext.sipController 新增属性,用于发起 SIP 外呼。
NERoomContext.appInviteController 新增属性,用于发起 APP 应用内呼叫。
NERoomContext.maxMembers 新增属性,表示房间最大人数,-1 表示房间内无人数限制。
NERoomContext.inSIPInvitingMembers 新增属性,表示正在 SIP 外呼邀请中的成员列表。
NERoomContext.inAppInvitingMembers 新增属性,表示正在 App 内呼叫邀请中的成员列表。
NERoomListener.onMemberSIPInviteStateChanged 在房间回调中新增“成员SIP邀请状态变更”事件的回调。
NERoomListener.onMemberAppInviteStateChanged 在房间回调中新增“成员APP邀请状态变更”事件的回调。
NERoomMember.isSIPInviting 新增属性,表示成员是否正在 SIP 外呼邀请中。
NERoomMember.isAppInviting 新增属性,表示成员是否正在 App 内呼叫邀请中。
NERoomMember.inviteState 新增属性,表示用于标记成员被邀请中的状态。
NERoomSIPController.callByNumber 新增方法,支持根据手机号码进行 SIP 外呼。
NERoomSIPController.callByUserUuid 新增方法,支持根据用户 uuid 进行 SIP 外呼。
NERoomSIPController.callByUserUuids 新增方法,支持根据用户 uuid 列表进行批量 SIP 外呼。
NERoomSIPController.cancelCall 新增方法,支持取消 SIP 外呼。
NERoomSIPController.removeCall 新增方法,支持移除 SIP 外呼。
NERoomSIPController.hangUpCall 新增方法,支持挂断 SIP 外呼。
NERoomAppInviteController.callByUserUuid 新增方法,支持根据用户 uuid 进行 APP 内呼。
NERoomAppInviteController.callByUserUuids 新增方法,支持根据用户 uuid 列表进行批量 APP 内呼。
NERoomAppInviteController.cancelCall 新增方法,支持取消 APP 内呼。
NERoomAppInviteController.removeCall 新增方法,支持移除 APP 内呼。
NERoomChatController.fetchChatroomMembers 新增方法,表示获取聊天室成员信息。
NEAuthEvent.RECONNECTED 新增事件,表示 IM 重连成功。

兼容版本

  • 兼容 NIMSDK 9.16.0 版本
  • 兼容 NERtcSDK 5.5.40 版本
  • 兼容 Common 1.3.3 版本
  • 兼容 CoreKit 1.4.11 版本
  • 兼容 CoreKit-IM 1.14.11 版本
  • 兼容 NEWhiteboard 3.9.6 版本

1.27.0 (2024-04-03)

新增特性

  • 新增消息监听回调功能。
  • 新增消息操作相关功能。
    • 新增消息未读数管理功能,包括清理和查询消息未读数。
    • 新增会话历史消息管理功能,包括删除和查询会话历史消息。
  • 支持管理全量的等候室成员,包括全部准入和全部移除功能。
  • 新增房间黑名单功能。
  • 修改准入等候室接口,支持配置是否本次房间自动准入。
  • 支持私有化配置 RTC 的 LBS 地址。
  • 调整日志的默认级别为 Info。

变更 API

类/方法/回调/错误码 说明
NEMessageChannelService.addReceiveSessionMessageListener 添加消息监听的回调。
NEMessageChannelService.removeReceiveSessionMessageListener 移除消息监听的回调。
NERoomMessageSessionListener 新增消息监听的回调事件。具体包括以下事件:
  • onReceiveSessionMessage:接收到自定义消息
  • onChangeRecentSession:最近会话聊天记录变更
  • onDeleteSessionMessage:自定义消息被删除
  • onDeleteAllSessionMessage:自定义消息全部被删除
  • NEMessageChannelService.clearUnreadCount 新增清理未读数的方法。
    NEMessageChannelService.queryUnreadMessageList 新增查询未读数的方法。
    NEMessageChannelService.deleteSessionMessage 新增删除会话消息的方法。
    NEMessageChannelService.deleteAllSessionMessage 新增删除所有会话消息的方法。
    NEMessageChannelService.getSessionMessagesHistory 新增获取会话消息历史记录的方法。
    NERoomContext.changeMembersRole 新增批量修改房间成员角色的方法,仅房间创建者和管理员可修改。
    NERoomContext.kickMemberOut 在该方法中新增toBlacklist参数,表示移除人员时是否将其加入黑名单。
    NERoomContext.enableRoomBlacklist 新增开启/关闭黑名单功能方法。
    NERoomContext.isRoomBlackListEnabled 新增获取黑名单状态方法,查看是否开启黑名单功能。
    NEWaitingRoomController.admitAllMembers 新增准入等候室全部成员的方法。
    NEWaitingRoomController.expelAllMembers 新增移除等候室全部成员的方法。在移除时可以设置是否允许被移除的成员重新加入房间。
    NEWaitingRoomListener 在等候室回调中新增“全部等候室成员”事件的回调(onAllMembersKicked)。
    NERoomListener 在房间回调中新增“黑名单状态”事件的回调(onRoomBlacklistStateChanged)。
    NERtcServerConfig 在该类中新增lbsServer属性,支持私有化配置 RTC 的 LBS 地址。
    NEWaitingRoomController.admitMember 在该方法中新增autoAdmit参数,设置是否本次房间自动准入。
    NEErrorCode.CHATROOM_NOT_EXISTS 新增“聊天室不存在”的错误码。

    兼容版本

    • 兼容 NIMSDK 9.15.0 版本
    • 兼容 NERtcSDK 5.5.33 版本
    • 兼容 Common 1.3.3 版本
    • 兼容 CoreKit 1.4.10 版本
    • 兼容 CoreKit-IM 1.14.10 版本
    • 兼容 NEWhiteboard 3.9.6 版本

    1.26.0 (2024-03-06)

    新增特性

    • 支持音频连接/断开功能。
    • 支持管理员修改房间成员名称。
    • 聊天室消息支持获取发送端头像。

    变更 API

    接口/类/枚举 说明
    NERoomRtcController.reconnectMyAudio 新增方法,通过该方法重连本地音频。
    NERoomRtcController.disconnectMyAudio 新增方法,通过该方法断开本地音频。
    NERoomMember.isAudioConnected 新增方法,通过该方法查询成员的音频连接状态。
    NERoomListener.onMemberAudioConnectStateChanged 新增回调,监听成员音频连接状态的变更。
    NERoomListener.onMemberNameChanged 修改回调,用于上报成员名称被修改的通知,且带有操作者信息。
    NEWaitingRoomListener.onMemberNameChanged 修改回调,用于上报成员名称被修改的通知,且带有操作者信息。
    NERoomContext.changeMemberName 新增方法,通过该方法修改房间成员名称。
    NERoomChatMessage.fromAvatar 新增方法,通过该方法获取聊天室消息的发送端头像。

    兼容版本

    • 兼容 NIMSDK 9.14.2 版本
    • 兼容 NERtcSDK 5.5.22 版本
    • 兼容 Common 1.3.3 版本
    • 兼容 CoreKit 1.4.7 版本
    • 兼容 CoreKit-IM 1.4.7 版本

    1.25.2 (2024-01-25)

    升级

    升级 NERtcSDK 至 5.5.21 版本。

    兼容版本

    • 兼容 NIMSDK 9.14.1 版本
    • 兼容 NERtcSDK 5.5.21 版本
    • 兼容 Common 1.3.2 版本
    • 兼容 CoreKit 1.4.6 版本
    • 兼容 CoreKit-IM 1.4.6 版本

    1.25.1 (2024-01-15)

    升级

    升级 NERtc-SNAPSHOT 至 5.5.207 版本,以解决海外 LBS 引起的加入房间失败问题。

    兼容版本

    • 兼容 NIMSDK 9.14.1 版本
    • 兼容 NERtc-SNAPSHOT 5.5.207 版本
    • 兼容 Common 1.3.2 版本
    • 兼容 CoreKit 1.4.6 版本
    • 兼容 CoreKit-IM 1.4.6 版本

    1.25.0 (2024-01-10)

    兼容版本

    • 兼容 NIMSDK 9.14.1 版本
    • 兼容 NERtc-SNAPSHOT 5.5.203 版本
    • 兼容 Common 1.3.2 版本
    • 兼容 CoreKit 1.4.6 版本
    • 兼容 CoreKit-IM 1.4.6 版本

    新增特性

    • 新增等候室功能。

      • 创建聊天室时,支持两种聊天室类型:主聊天室和等候室聊天室。
      • 创建房间时,可设置是否开启等候室。
      • 可以在等候聊天室中,向所有成员或指定成员发送消息。
    • 新增聊天室消息记录预览功能。

    变更 API

    接口/类/枚举
    接口说明
    NEChatroomType 新增 NEChatroomType 枚举,分为主聊天室和等候室聊天室两种类型。
    NERoomChatMessage NERoomChatMessage 对象新增 chatroomType 属性,区分主聊天室消息和等候室消息。
    NERoomChatController.joinChatroom 该方法新增 chatroomType 入参,可配置该参数加入不同类型的聊天室。
    NERoomChatController.leaveChatroom 该方法新增 chatroomType 入参,可配置该参数离开不同类型的聊天室。
    NERoomChatController.sendBroadcastTextMessage NERoomChatController 中的所有发送消息方法都新增 chatroomType 入参,可配置该参数发送消息至不同的聊天室类型。
    NERoomChatController.sendGroupTextMessage
    NERoomChatController.sendDirectTextMessage
    NERoomChatController.sendImageMessage
    NERoomChatController.sendFileMessage
    NERoomChatController.fetchChatroomMembers 该方法新增 chatroomype 入参,可配置该参数获取不同类型的聊天室成员。
    NERoomChatController.fetchChatroomHistoryMessages 该方法新增 chatroomType 入参,可配置该参数在房间内获取不同类型的聊天室消息记录。
    NERoomChatController.recallChatroomMessage 该方法新增 chatroomType 入参,可配置该参数撤回不同类型的聊天室消息记录。
    NERoomService.fetchChatroomHistoryMessages 新增预览聊天室消息记录方法,可配置 chatroomType 参数获取不同类型的聊天室消息记录。该方法支持在房间外调用,当房间销毁归档后,可通过该接口来预览聊天室消息记录。
    NECreateRoomOptions.enableWaitingRoom NECreateRoomOptions 中新增 enableWaitingRoom 属性,创建房间时可设置是否开启等候室,true,开启;false,关闭(默认)。
    NERoomContext.isInWaitingRoom 新增查询是否在等候室方法。加入房间后,通过该方法可查询当前是否在等候室。
    NERoomContext.waitingRoomController 新增等候室控制器,包含开启/关闭等候室、成员管理、等候室信息查询等功能。
    NEWaitingRoomListener 新增 NEWaitingRoomController.addListenerNEWaitingRoomListener)事件监听器,可监听等候室成员(包括本端)加入、离开、准入、等候室信息变更等事件。
    NERoomContext.rejoinAfterAdmittedToRoom 新增重新正式加入房间方法。等候室中的成员需要管理员准入才能加入房间,成员在监听到被管理员准入后,可重新正式加入房间。

    修复

    修复部分已知问题。

    1.23.0 (2023-11-30)

    兼容版本

    • 兼容 NIMSDK 9.12.0 版本
    • 兼容 NERtc-SNAPSHOT 5.5.203 版本
    • 兼容 NEWhiteboard 3.9.6 版本

    新增特性

    • 支持在房间中查询历史消息和撤回消息。
    • 新增云端录制会议能力,具体请参考 云端录制

    新增 API

    接口名称 接口说明
    NERoomContext.startCloudRecord 开始云端录制。
    NERoomContext.stopCloudRecord 停止云端录制。
    NERoomService.getRoomCloudRecordList 获取房间中的云端录制列表。
    NERoomChatController.fetchChatroomHistoryMessages 查询房间中的历史消息。
    NERoomChatController.recallChatroomMessage 在房间中撤回指定消息。

    变更 API

    接口/类/枚举
    接口说明
    NERoomListener 房间监听器中 NERoomListener 新增 onRoomCloudRecordStateChanged 事件,监听云端录制的开始和结束。事件中包含 state(云端录制状态)和 operateBy(状态变更操作者信息)。
    NERoomContext 房间上下文中的房间属性 roomProperties 新增 roomProperties.record.recordId 属性,表示录制状态。属性变更会触发 onRoomPropertiesChanged 事件。
    NERoomContext 房间上下文 NERoomContext 中新增 isCloudRecording 属性,可用于查询是否在云端录制中。
    NERoomChatNotificationMessage 聊天室通知消息 NERoomChatNotificationMessage 中新增 recalledMessageId 属性,可用来获取被撤回的消息 ID。
    NERoomChatEventType 房间操作 NERoomChatEventType 中新增枚举 RECALL,表示消息撤回操作。

    修改 NERoomChatController 接口中的发送消息接口,将 callback 类型为 NECallback<NERoomChatMessage>

    这里以给单人定向发送消息方法为例,将 public func sendDirectTextMessage(userUuid: String, message: String, callback: NECallback<AnyObject>? = nil) 改造成 public func sendDirectTextMessage(userUuid: String, message: String, callback: NECallback<NERoomChatMessage>? = nil)

    1.22.2 (2023-11-08)

    兼容版本

    • 兼容 NIMSDK 9.12.0 版本
    • 兼容 NERtc-SNAPSHOT 5.5.203 版本
    • 兼容 NEWhiteboard 3.9.6 版本

    新增特性

    新增特性
    特性描述
    相关文档
    房间禁言 允许房间创建者或管理员在房间内将所有成员禁言,同时也禁止所有成员开启音频和视频功能。 房间禁言
    黑名单 允许房间创建者或管理员将房间内的指定成员添加到黑名单,黑名单中的成员将被移除出房间且无法重新加入房间。 黑名单
    成员禁言 允许房间创建者或管理员设置指定成员禁言或使用音频和视频功能。当成员被禁言时,将无法在房间内发消息,使用音频和视频功能。 成员禁言

    新增 API

    接口名称 接口说明
    banRoomChat 设置房间禁言。
    unbanRoomChat 取消房间禁言。
    banRoomAudio 设置房间禁用音频功能。
    unbanRoomAudio 取消房间禁用音频功能。
    banRoomVideo 设置房间禁用视频功能。
    unbanRoomVideo 取消房间禁用视频功能。
    addToBlacklist 添加成员到黑名单。
    removeFromBlacklist 移除成员出黑名单。
    getBlacklist 获取房间黑名单成员列表。
    banMemberChat 设置成员禁言。
    unbanMemberChat 取消成员禁言。
    banMemberAudio 设置成员禁用音频功能。
    unbanMemberAudio 允许成员使用音频功能。
    banMemberVideo 设置成员禁用视频功能。
    unbanMemberVideo 允许成员使用视频功能。
    getChatBannedMembers 获取房间内被禁言的成员列表。
    getAudioBannedMembers 获取禁止使用音频功能的成员列表。
    getVideoBannedMembers 获取禁止使用视频功能的成员列表。
    onRoomChatBanStateChanged 房间禁言回调。
    onRoomAudioBanStateChanged 房间音频功能禁用回调。
    onRoomVideoBanStateChanged 房间视频功能禁用回调。
    onMemberChatBanStateChanged 成员禁言回调。
    onMemberAudioBanStateChanged 成员音频功能禁用回调。
    onMemberVideoBanStateChanged 成员视频功能禁用回调。
    onMemberAddToBlacklist 成员被拉黑回调。
    onMemberRemoveFromBlacklist 成员被取消拉黑回调。

    1.20.0 (2023-09-05)

    兼容版本

    • 兼容 NIMSDK 9.12.0 版本
    • 兼容 NERtc 5.4.8 版本
    • 兼容 NEWhiteboard 3.9.6 版本

    新增 API

    接口名称 接口说明
    NERoomContext.roomExt 获取当前房间的扩展信息
    NERoomContext.changeRoomName 修改房间的名称
    NERoomContext.changeRoomExt 修改房间的扩展信息
    NERoomContext.changeMyExt 修改自己的扩展信息
    NERoomListener.onRoomNameChanged 房间名称已变更的回调
    NERoomListener.onRoomExtChanged 房间扩展信息变更的回调
    NERoomListener.onRoomConnectStateChanged 房间连接状态改变的回调。IM 或 RTC 断开时,触发 disconnect 状态,IM 和 RTC 重连成功后,触发 reconnect 状态
    NERoomListener.onMemberExtChanged 成员扩展信息变更的回调
    NESeatEventListenerExt.onSeatRequestSubmittedonSeatRequestCancelledonSeatRequestApprovedonSeatRequestRejected 原来的同名回调保留,新回调新增 ext 参数,用于获取申请上麦时设置的自定义信息

    变更 API

    接口名称 接口说明
    NECreateRoomParams 新增 roomExt 参数,支持房主在创建房间的时候就设置房间的扩展信息
    NEJoinRoomParams 新增 ext 参数,支持房主在加入房间的时候就设置房间的扩展信息
    NERoomMember 新增 ext 参数,支持获取成员的扩展信息
    NESeatItem 新增 ext 参数,用于获取申请上麦时设置的自定义信息
    NESeatRequestItem 新增 ext 参数,用于获取申请上麦时设置的自定义信息
    NESeatController.submitSeatRequest 新增 ext 参数,用于设置申请上麦时的自定义信息
    NERoomContext.changeMyName 接口行为变更。修改昵称时,回调不再关注修改聊天室昵称成功与否,以兼容在不加聊天室的使用场景

    1.19.0 (2023-08-14)

    兼容版本

    • 兼容 NIMSDK 9.12.0 版本
    • 兼容 NERtc 5.4.3 版本
    • 兼容 NEWhiteboard 3.9.6 版本

    改进优化

    优化并提升加入房间的速度。

    新增 API

    接口名称 接口说明
    NERoomListener.onRoomRemainingSecondsRenewed 当房间剩余时长更新时触发此回调。
    NERoomRtcController.enableEncryption 开启媒体流加密。
    NERoomRtcController.disableEncryption 关闭媒体流加密。

    更新 API

    接口名称 接口说明
    NERtcServerConfig 新增 RTC 私有化配置地址:sdkConfigServerstatisticsDispatchServerstatisticsBackupServer
    NERoomContext.remainingSeconds 房间剩余时长字段的类型修改为 Long 类型

    1.18.0 (2023-07-31)

    兼容版本

    • 兼容 NIMSDK 9.12.0 版本
    • 兼容 NERtc 5.4.0 版本
    • 兼容 NEWhiteboard 3.9.6 版本

    新增 API

    接口名称 接口说明
    changeSeatIndex 切换麦位

    1.17.0 (2023-07-04)

    兼容版本

    • 兼容 NIMSDK 9.10.0 版本
    • 兼容 NERtc 5.3.7 版本
    • 兼容 NEWhiteboard 3.7.2 版本

    改进优化

    优化大房间场景下,SDK 与服务端的信令交互。

    更新 API

    接口名称 接口说明
    NERoomRole 删除 superRole 参数,该参数已废弃
    新增 hide 参数,用于设置角色的成员是否需要在成员列表中展示

    1.16.0 (2023-06-20)

    兼容版本

    • 兼容 NIMSDK 9.10.0 版本
    • 兼容 NERtc 5.3.7 版本
    • 兼容 NEWhiteboard 3.7.2 版本

    新增特性

    新增特性
    特性描述
    支持 AI 降噪 NERoom SDK 为您提供网易云信自研 AI 算法降噪功能,可智能分析环境音成分,自动甄别并过滤环境噪声。开启 AI 降噪之后,在嘈杂的环境中可以针对背景人声、键盘声等非稳态噪声进行定向降噪,同时也会提升对于环境稳态噪声的抑制,保留更纯粹的人声。
    支持音频共享 在屏幕共享或共享本地播放的音乐文件等场景中,用户常常需要将本地系统音频发送至远端。NERoom 提供了音频共享功能,帮助您在共享屏幕的同时也能播放本地背景音,或者共享本地视频文件或音乐文件的声音,为您规避播放在线音乐文件可能会遇到的版权问题。

    新增 API

    所属类 接口名称 接口说明
    NERoomRtcController enableAudioAINS 开启/关闭音频智能降噪
    enableLoopbackRecording 在屏幕共享时,支持开启/关闭音频共享

    1.15.0 (2023-06-02)

    兼容版本

    • 兼容 NIMSDK 9.10.0 版本
    • 兼容 NERtc 4.6.50 版本
    • 兼容 NEWhiteboard 3.7.2 版本

    新增特性

    新增特性
    特性描述
    相关文档
    支持使用 IM 账号登录 NERoom 如果您的 App 之前已集成了 IM SDK,已经存在 IM 账号,可以用 IMKitClient.init 替换原先的 NIMClient.init,再通过 NERoom 提供的 loginByIM 接口登录 NERoom。 复用 IM 的账号

    改进优化

    onDisconnect 不再触发 NERoomListeneronRtcChannelError 回调,改为内部处理直接销毁 roomContext

    新增 API

    所属类 接口名称 接口说明
    NEAuthService loginByIM IM 账号鉴权

    变更 API

    所属类 接口说明
    NERoomKitOptions 移除 reuseIM 参数。复用逻辑改为 SDK 内部完成。如果已经登录过 NIM,则内部直接复用。

    1.14.0 (2023-04-27)

    兼容版本

    • 兼容 NIMSDK 9.8.0 版本
    • 兼容 NERtc 4.6.50 版本
    • 兼容 NEWhiteboard 3.7.2 版本

    新增 API

    所属类 接口名称 接口说明
    NERoomWhiteboardController setCanvasBackgroundColor 设置白板的画布背景颜色。
    lockCameraWithContent 将白板和被标注物(例如电子文档、PPT等)的坐标信息绑定。防止多端进行协作编辑时,其他端的用户对白板进行放大或缩小,而导致标注内容大小不一致等问题。

    1.13.0 (2023-04-11)

    兼容版本

    • 兼容 NIMSDK 9.8.0 版本
    • 兼容 NERtc 4.6.50 版本
    • 兼容 NEWhiteboard 3.7.2 版本

    新增 API

    所属类 接口名称 接口说明
    NEPreviewRoomRtcController stopPreview(Boolean) 关闭预览时,销毁 RTC 实例。

    改进优化

    优化在弱网或无网络情况下,关闭本端音视频的操作。

    1.12.0 (2023-03-03)

    兼容版本

    • 兼容 NIMSDK 9.6.4 版本
    • 兼容 NERtc 4.6.43 版本
    • 兼容 NEWhiteboard 3.7.2 版本

    新增 API

    所属类 接口名称 接口说明
    NERoomRtcController pauseLocalAudioRecording 暂停本地麦克风采集,调用后远端用户听不到本端声音。
    resumeLocalAudioRecording 恢复本地麦克风采集,调用后远端用户可以听到本端声音。
    pauseLocalVideoCapture 暂停本地视频采集。
    resumeLocalVideoCapture 恢复本地视频采集。
    enableAudioVolumeIndication 启用说话者音量提示。 App 通过此接口可以获取当前谁在说话以及说话者的音量。
    adjustPlaybackSignalVolume 调节所有远端用户在本地播放的混音音量。
    enableMediaPub 开启或关闭本地媒体流(主流)的发送。
    NERoomListener onRtcLocalAudioVolumeIndication 提示房间内本地用户瞬时音量的回调。 该回调默认为关闭状态。

    更新 API

    接口名称 接口说明
    NERoomListener.onRtcRemoteAudioVolumeIndication 命名变更:onRtcAudioVolumeIndication 变更为 onRtcRemoteAudioVolumeIndication
    行为变更:该回调不再包含本地用户的音量回调,本地用户音量回调提供了单独的接口。

    1.11.0 (2023-01-09)

    兼容版本

    • 兼容 NIMSDK 9.6.4 版本
    • 兼容 NERtc 4.6.29 版本
    • 兼容 NEWhiteboard 3.7.2 版本

    新增特性

    新增特性
    特性描述
    支持配置私有化服务器地址 通过 NERoomKitOptions.serverUrl 接口配置私有化地址,可下载对应的私有化配置,并在初始化时使用相应配置。

    更新 API

    接口名称 接口说明
    NERoomRtcController.setAudioProfile setLocalAudioProfile 接口名称修改为 setAudioProfile

    1.10.0 (2022-12-06)

    兼容版本

    • 兼容 NIMSDK 9.6.4 版本
    • 兼容 NERtc 4.6.29 版本
    • 兼容 NEWhiteboard 3.7.2 版本

    新增特性

    新增特性
    特性描述
    聊天室消息新增通知消息类型 新增 NERoomChatNotificationMessage,用于接收聊天室内的通知消息,例如成员进出
    支持创建通话类型房间与直播类型房间 NERoomService.createRoom 接口创建房间时,可通过 NECreateRoomParams.roomProfile 参数指定房间类型
    支持以观众角色加入房间 通过 NERoomService.joinRoom 加入类型为 NERoomProfile.LIVE_BROADCASTING 的房间时,可设置 NEJoinRoomParams.roleNERoomBuiltinRole.OBSERVER,实现以观众角色进入房间,适用于PK直播等场景
    支持切换语言类型 通过 NERoomKit.switchLanguage 接口可将 SDK 的语言类型切换为中文、英文或日语

    新增 API

    所属类 接口名称 接口说明
    NERoomChatMessage NERoomChatNotificationMessage 消息通知
    NERoomKit switchLanguage 切换语言类型

    变更 API

    接口名称 接口说明
    NERoomService.createRoom 增加 NECreateRoomParams.roomProfile 参数,用于创建房间时指定房间类型。

    1.8.0 (2022-09-27)

    新增特性

    新增特性
    特性描述
    支持成员头像。 支持设置用户的头像。
    麦位管理。 支持上麦、下麦、锁麦、强制下麦等功能。

    新增 API

    所属类 接口名称 接口说明
    NEBaseController NESeatController 麦位管理
    NEBaseController NESeatEventListener 麦位管理相关事件通知
    NEBaseController NESeatInitParams 创建房间时可以设置麦位功能相关的初始化参数

    变更 API

    接口名称 接口说明
    NEJoinRoomParams 增加 avatar 参数,加入房间时可以设置临时的用户头像。
    NERoomMember 增加 avatar 参数,获取当前房间中成员的临时头像。

    1.7.0 (2022-08-31)

    兼容版本

    • 兼容 NIMSDK 8.11.11 版本
    • 兼容 NERtc 4.6.13 版本

    新增特性

    新增特性
    特性描述
    相关文档
    支持多媒体消息 支持发送与接收图片消息和文件消息 消息发送
    消息接收

    新增 API

    所属类 接口名称 接口说明
    NERoomChatFileMessage - 文件消息
    NERoomChatImageMessage - 图片消息
    NERoomListener onReceiveChatroomMessages 接收到消息的回调
    onChatroomMessageAttachmentProgress 监听图片、文件消息的附件下载进度
    NERoomChatController sendImageMessage 发送图片消息
    sendFileMessage 发送文件消息
    downloadAttachment 下载图片、文件消息的附件
    cancelDownloadAttachment 取消下载图片、文件消息的附件

    1.3.0 (2022-06-30)

    新增特性

    新增特性
    特性描述
    相关文档
    虚拟背景 NERoom SDK 通过自动识别用户人像,虚化用户周围的真实环境,或者以指定颜色的图片或自定义图像替代真实背景,从而实现设置虚拟背景。 虚拟背景
    云信美颜 云信自研的基础美颜和高级美颜功能,支持在音视频通话或互动直播场景中,对人脸进行美肤、美型等美颜调整,或通过画面滤镜改变视频的色调与氛围。 云信美颜

    新增 API

    所属类 接口名称 接口说明
    NERoomRtcBaseController enableVirtualBackground 启动虚拟背景
    startBeauty 开启美颜功能模块
    stopBeauty 结束美颜功能模块
    enableBeauty 暂停或恢复美颜效果
    setBeautyEffect 设置美颜效果
    addBeautyFilter 添加滤镜效果
    setBeautyFilterLevel 设置滤镜强度
    removeBeautyFilter 移除滤镜
    NERoomListener onRtcVirtualBackgroundSourceEnabled 虚拟背景开启和关闭的通知事件
    NERoomKit authService 获取鉴权服务
    roomService 获取房间服务
    messageChannelService 获取消息通道服务

    1.1.0 (2022-05-18)

    新增特性

    新增特性
    特性描述
    相关文档
    耳返 耳返即耳机采集监听,在设备上插入耳机或耳麦后,可以从耳机侧听到本设备麦克风采集到的声音,主要用来监听本地采集的音频。耳返音频具备低延时、高音质等特征,可以实时向主播等参与音频互动的成员反馈本端的声音数据,让主播可以实时听到本端的声音。耳返功能一般用于在线 KTV、连麦 PK、演唱会等娱乐场景。 耳返
    伴音和音效 支持通过混音功能播放掌声、口哨等短时音效,或者为人声添加背景音乐、伴奏音乐或其他场景效果,并将合成后的声音播放给房间内其他成员。在音视频通话或直播场景中,可以更好的烘托气氛、营造多样化语音环境。 伴音和音效
    房间属性设置和更新 房间属性是附加到当前房间上的一系列 key-value键值对, key为属性唯一名称, value 为当前属性值。 NERoom 允许开发者自定义房间属性,并在房间生命周期内对属性进行添加、更新、删除操作,同时还可以监听属性变更通知。 房间属性
    成员属性设置和更新 成员属性是附加到房间特定成员上的一系列 key-value键值对, key为属性唯一名称, value为当前属性值。 NERoom允许开发者自定义成员属性,并在房间生命周期内对成员属性进行添加、更新、删除操作,同时还可以监听属性变更通知。 成员属性
    静音和取消静音房间内其他成员 拥有相应权限的角色,可以静音或取消静音房间内某个成员。 静音和取消静音
    开启和关闭房间内其他成员的视频 拥有相应权限的角色,可以开启和关闭房间内某个成员的视频。 开启和关闭视频
    设置本地视图 在视频通话前,可以设置本地视图。 本地视频预览
    关闭某成员的屏幕共享 拥有相应权限的角色,可以关闭某个成员的屏幕共享。 屏幕共享
    关闭某成员的白板共享 拥有相应权限的角色,可以关闭某个成员的白板共享。 互动白板
    直播 NERoom 的直播基于专业的跨平台视频编解码技术和大规模视频内容分发网络,提供稳定流畅、高可靠、高并发的直播服务,助力轻松打造企业级在线直播平台。 直播

    新增 API

    所属类 接口名称 接口说明
    NERoomKit sdkVersions 获取 SDK 版本信息
    NERoomContext password 获取房间密码
    rtcStartTime 房间 RTC 开始时间,单位ms
    getMember) 根据 uuid 查询成员对象
    liveController 直播功能控制器,可开启、关闭、更新直播
    properties 获取当前房间的所有属性
    updateRoomProperty 更新房间属性,房间属性是房间的一个 key/value 键值对
    deleteRoomProperty 删除房间属性
    updateMemberProperty 更新成员属性,成员属性为成员的一个 key/value 键值对
    deleteMemberProperty 删除成员属性
    handOverMyRole 将自身当前的角色转移给对应的用户,自身会恢复到默认的房间角色。只有授权角色才能执行该操作
    changeMyName 修改自己房间内昵称
    isRoomLocked 查询房间当前锁定状态
    lockRoom 锁定房间。锁定后成员无法加入
    unlockRoom 解除锁定房间。解除锁定后成员可以加入该房间
    NEPreviewRoomRtcController startPreview 开启预览
    setupLocalVideoRender 设置本地视图
    getEglContext 获取外部纹理的 Context
    NERoomRtcController muteMemberAudio 关闭成员音频,会进行权限校验
    unmuteMemberAudio 打开成员音频,会进行权限校验
    muteMemberVideo 关闭成员视频,会进行权限校验
    unmuteMemberVideo 打开成员视频,会进行权限校验
    stopMemberScreenShare 关闭房间内成员的屏幕共享,会进行权限校验
    setupRemoteVideoRender 设置远端用户视频渲染对象
    setupRemoteSubStreamVideoRender 设置远端的辅流视频渲染对象
    startChannelMediaRelay 开始跨房间媒体流转发
    stopChannelMediaRelay 停止跨房间媒体流转发
    setSpeakerphoneOn 打开或关闭扬声器
    isSpeakerphoneOn 查询扬声器是否开启
    startAudioDump 打开音频 dump
    stopAudioDump 停止音频 dump
    enableAudioVolumeIndication 启用说话者音量提示
    enableEarBack 开启或关闭耳返功能
    startAudioMixing 开始播放音乐文件
    stopAudioMixing 停止播放音乐文件
    playEffect 播放指定音效文件
    stopEffect 停止播放指定音效文件
    setAudioMixingSendVolume 调节伴奏发送音量
    setAudioMixingPlaybackVolume 调节伴奏播放音量
    setEffectSendVolume 设置音效文件发送音量
    setEffectPlaybackVolume 设置音效文件播放音量
    stopAllEffects 停止播放所有音效文件
    NERoomLiveController startLive 开启直播
    stopLive 停止直播
    updateLive 更新直播
    getLiveInfo 获取直播信息
    NEWhiteboardController stopMemberWhiteboardShare 关闭房间内成员的白板共享,会进行权限校验
    NERoomListener onRoomPropertiesChanged 房间属性更新事件回调
    onRoomPropertiesDeleted 房间属性删除事件回调
    onMemberNameChanged 成员昵称变更事件回调
    onMemberPropertiesChanged 成员属性更新事件回调
    onMemberPropertiesDeleted 成员属性删除事件回调
    onRoomLockStateChanged 房间锁定状态变更事件回调
    onRtcAudioVolumeIndication RTC 成员音量大小事件回调
    onRtcAudioOutputDeviceChanged RTC 音频输出设备变更事件回调
    onRoomLiveStateChanged 直播状态变更事件回调
    NEMessageService sendPassThroughMessage 给房间内的用户发送透传消息,如房间内信令;如果对应用户不在线,信令可能丢失
    NERoomEndReason SELF_KICK 当相同账号在其他端加入会议时,会把其他端从正在进行的会议中踢出
    NERoomMessage fromNick] 发送端昵称
    NECreateRoomParams password 设置当前房间的密码
    initialProperties 设置房间属性
    NEJoinRoomParams password 输入当前房间的密码
    initialProperties 设置成员属性

    1.0.0 (2022-03-31)

    网易云信 NERoom SDK 的首次发布!

    主要包括房间管理、成员管理、文字聊天室、音视频通话、麦位管理、互动白板、直播等模块化功能。

    此文档是否对你有帮助?
    有帮助
    去反馈
    • 1.29.0 (2024-06-12)
    • 1.28.1 (2024-05-14)
    • 1.28.0 (2024-05-09)
    • 1.27.0 (2024-04-03)
    • 1.26.0 (2024-03-06)
    • 1.25.2 (2024-01-25)
    • 1.25.1 (2024-01-15)
    • 1.25.0 (2024-01-10)
    • 1.23.0 (2023-11-30)
    • 1.22.2 (2023-11-08)
    • 1.20.0 (2023-09-05)
    • 1.19.0 (2023-08-14)
    • 1.18.0 (2023-07-31)
    • 1.17.0 (2023-07-04)
    • 1.16.0 (2023-06-20)
    • 1.15.0 (2023-06-02)
    • 1.14.0 (2023-04-27)
    • 1.13.0 (2023-04-11)
    • 1.12.0 (2023-03-03)
    • 1.11.0 (2023-01-09)
    • 1.10.0 (2022-12-06)
    • 1.8.0 (2022-09-27)
    • 1.7.0 (2022-08-31)
    • 1.3.0 (2022-06-30)
    • 1.1.0 (2022-05-18)
    • 1.0.0 (2022-03-31)