NIMSDK-AOS  10.5.0
Public 成员函数 | 所有成员列表
com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService接口 参考

Public 成员函数

void call (V2NIMSignallingCallParams params, V2NIMSuccessCallback< V2NIMSignallingCallResult > success, V2NIMFailureCallback failure)
 直接呼叫对方加入房间 信令正常流程: 创建房间(createRoom),房间创建默认有效时间2个小时, 自己加入房间(join) 邀请对方加入房间(invite) 上述的房间是信令的房间,不是音视频的房间,因此需要三次向服务器交互才能建立相关流程 call接口同时由服务器实现了上述三个接口的功能, 可以加速呼叫流程, 如果你需要精确控制每一步,则需要调用上述每一个接口 更多...
 
void callSetup (V2NIMSignallingCallSetupParams params, V2NIMSuccessCallback< V2NIMSignallingCallSetupResult > success, V2NIMFailureCallback failure)
 呼叫建立, 包括加入信令频道房间, 同时接受对方呼叫 组合接口(join+accept) 如果需要详细处理每一步骤, 则可以单独调用join接口,之后再调用accept接口 更多...
 
void createRoom (V2NIMSignallingChannelType channelType, String channelName, String channelExtension, V2NIMSuccessCallback< V2NIMSignallingChannelInfo > success, V2NIMFailureCallback failure)
 创建信令房间 频道与房间一一对应, 可以理解为同一个东西 相同的频道名,在服务器同时只能存在一个 房间创建默认有效时间2个小时 更多...
 
void closeRoom (String channelId, boolean offlineEnabled, String serverExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 关闭信令房间 该接口调用后会触发关闭通知给房间内所有人 房间内的所有人均可以调用该接口 信令房间如果没有主动调用接口关闭,会等待2个小时,2个小时没有新的用户加入,则服务器自行销毁对应的信令房间 更多...
 
void joinRoom (V2NIMSignallingJoinParams params, V2NIMSuccessCallback< V2NIMSignallingRoomInfo > success, V2NIMFailureCallback failure)
 加入信令房间 该接口调用后会触发加入通知给房间内所有人 默认有效期为5分钟 更多...
 
void leaveRoom (String channelId, boolean offlineEnabled, String serverExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 离开信令房间 该接口调用后会触发离开通知给房间内所有人 更多...
 
void invite (V2NIMSignallingInviteParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 邀请他人加入信令房间 该接口调用后会触发邀请通知给对方, 发送方可以配置是否需要发送推送 默认不推送 如果不配置推送相关信息, 则服务器回填默认内容 音频: xx邀请你进行语音通话 视频:xx邀请你进行视频通话 其它: xx邀请你进行音视频通话 房间内的人均可以发送邀请 更多...
 
void cancelInvite (V2NIMSignallingCancelInviteParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 取消邀请 更多...
 
void rejectInvite (V2NIMSignallingRejectInviteParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 拒绝别人的邀请加入信令房间请求 该接口调用后会触发拒绝邀请通知给对方 更多...
 
void acceptInvite (V2NIMSignallingAcceptInviteParams params, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 接受别人的邀请加入信令房间请求 该接口调用后会触发接受邀请通知给对方 更多...
 
void sendControl (String channelId, String receiverAccountId, String serverExtension, V2NIMSuccessCallback< Void > success, V2NIMFailureCallback failure)
 发送控制消息 发送自定义控制指令,可以实现自定义相关的业务逻辑 可以发送给指定用户, 如果不指定, 则发送给信令房间内的所有人 该接口不做成员校验, 允许非频道房间内的成员调用, 但是接受者必须在频道房间内或者是创建者 接口调用后会发送一个控制通知 如果指定了接受者: 则通知发送给接受者 如果未指定接受者:则发送给房间内的所有人 通知仅发在线 更多...
 
void getRoomInfoByChannelName (String channelName, V2NIMSuccessCallback< V2NIMSignallingRoomInfo > success, V2NIMFailureCallback failure)
 根据频道名称查询频道房间信息 相同的频道名,在服务器同时只能存在一个 更多...
 
void addSignallingListener (V2NIMSignallingListener listener)
 添加信令监听器 更多...
 
void removeSignallingListener (V2NIMSignallingListener listener)
 移除信令监听器 更多...
 

详细描述

在文件 V2NIMSignallingService.java18 行定义.

成员函数说明

◆ acceptInvite()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.acceptInvite ( V2NIMSignallingAcceptInviteParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

接受别人的邀请加入信令房间请求 该接口调用后会触发接受邀请通知给对方

参数
params接受邀请参数
success成功回调
failure失败回调

◆ addSignallingListener()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.addSignallingListener ( V2NIMSignallingListener  listener)

添加信令监听器

参数
listener信令监听器

◆ call()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.call ( V2NIMSignallingCallParams  params,
V2NIMSuccessCallback< V2NIMSignallingCallResult success,
V2NIMFailureCallback  failure 
)

直接呼叫对方加入房间 信令正常流程: 创建房间(createRoom),房间创建默认有效时间2个小时, 自己加入房间(join) 邀请对方加入房间(invite) 上述的房间是信令的房间,不是音视频的房间,因此需要三次向服务器交互才能建立相关流程 call接口同时由服务器实现了上述三个接口的功能, 可以加速呼叫流程, 如果你需要精确控制每一步,则需要调用上述每一个接口

参数
params呼叫参数
success成功回调
failure失败回调

◆ callSetup()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.callSetup ( V2NIMSignallingCallSetupParams  params,
V2NIMSuccessCallback< V2NIMSignallingCallSetupResult success,
V2NIMFailureCallback  failure 
)

呼叫建立, 包括加入信令频道房间, 同时接受对方呼叫 组合接口(join+accept) 如果需要详细处理每一步骤, 则可以单独调用join接口,之后再调用accept接口

参数
params接受呼叫参数
success成功回调
failure失败回调

◆ cancelInvite()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.cancelInvite ( V2NIMSignallingCancelInviteParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

取消邀请

参数
params取消邀请参数
success成功回调
failure失败回调

◆ closeRoom()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.closeRoom ( String  channelId,
boolean  offlineEnabled,
String  serverExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

关闭信令房间 该接口调用后会触发关闭通知给房间内所有人 房间内的所有人均可以调用该接口 信令房间如果没有主动调用接口关闭,会等待2个小时,2个小时没有新的用户加入,则服务器自行销毁对应的信令房间

参数
channelId频道ID
offlineEnabled是否需要存离线消息。如果存离线,则用户离线再上线会收到该通知
serverExtension服务端扩展字段, 长度限制4096
success成功回调
failure失败回调

◆ createRoom()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.createRoom ( V2NIMSignallingChannelType  channelType,
String  channelName,
String  channelExtension,
V2NIMSuccessCallback< V2NIMSignallingChannelInfo success,
V2NIMFailureCallback  failure 
)

创建信令房间 频道与房间一一对应, 可以理解为同一个东西 相同的频道名,在服务器同时只能存在一个 房间创建默认有效时间2个小时

参数
channelType频道类型
channelName频道名称
channelExtension频道扩展字段
success成功回调
failure失败回调

◆ getRoomInfoByChannelName()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.getRoomInfoByChannelName ( String  channelName,
V2NIMSuccessCallback< V2NIMSignallingRoomInfo success,
V2NIMFailureCallback  failure 
)

根据频道名称查询频道房间信息 相同的频道名,在服务器同时只能存在一个

参数
channelName房间名称
success成功回调
failure失败回调

◆ invite()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.invite ( V2NIMSignallingInviteParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

邀请他人加入信令房间 该接口调用后会触发邀请通知给对方, 发送方可以配置是否需要发送推送 默认不推送 如果不配置推送相关信息, 则服务器回填默认内容 音频: xx邀请你进行语音通话 视频:xx邀请你进行视频通话 其它: xx邀请你进行音视频通话 房间内的人均可以发送邀请

参数
params邀请参数
success成功回调
failure失败回调

◆ joinRoom()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.joinRoom ( V2NIMSignallingJoinParams  params,
V2NIMSuccessCallback< V2NIMSignallingRoomInfo success,
V2NIMFailureCallback  failure 
)

加入信令房间 该接口调用后会触发加入通知给房间内所有人 默认有效期为5分钟

参数
params加入房间参数
success成功回调
failure失败回调

◆ leaveRoom()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.leaveRoom ( String  channelId,
boolean  offlineEnabled,
String  serverExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

离开信令房间 该接口调用后会触发离开通知给房间内所有人

参数
channelId频道ID
offlineEnabled是否需要存离线消息。如果存离线,则用户离线再上线会收到该通知
serverExtension服务端扩展字段, 长度限制4096
success成功回调
failure失败回调

◆ rejectInvite()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.rejectInvite ( V2NIMSignallingRejectInviteParams  params,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

拒绝别人的邀请加入信令房间请求 该接口调用后会触发拒绝邀请通知给对方

参数
params拒绝邀请参数
success成功回调
failure失败回调

◆ removeSignallingListener()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.removeSignallingListener ( V2NIMSignallingListener  listener)

移除信令监听器

参数
listener信令监听器

◆ sendControl()

void com.netease.nimlib.sdk.v2.avsignalling.V2NIMSignallingService.sendControl ( String  channelId,
String  receiverAccountId,
String  serverExtension,
V2NIMSuccessCallback< Void >  success,
V2NIMFailureCallback  failure 
)

发送控制消息 发送自定义控制指令,可以实现自定义相关的业务逻辑 可以发送给指定用户, 如果不指定, 则发送给信令房间内的所有人 该接口不做成员校验, 允许非频道房间内的成员调用, 但是接受者必须在频道房间内或者是创建者 接口调用后会发送一个控制通知 如果指定了接受者: 则通知发送给接受者 如果未指定接受者:则发送给房间内的所有人 通知仅发在线

参数
channelId频道ID
receiverAccountId接收者账号ID, 如果为空,则发送给房间内所有人
serverExtension服务端扩展字段, 长度限制4096,自定义控制数据,建议json格式
success成功回调
failure失败回调

该接口的文档由以下文件生成: