上篇文章:Swift 极光IM聊天-解析消息
这一篇主要来说一下音视频
的功能。
导入SDK
pod 'AgoraRtcEngine_iOS'
创建音视频通话
- 批量获取用户信息
/*!
* @abstract 批量获取用户信息
*
* @param usernameArray 用户名列表。NSArray 里的数据类型为 NSString
* @param handler 结果回调。正常返回时 resultObject 的类型为 NSArray,数组里的数据类型为 JMSGUser
*
* @discussion 这是一个批量接口。
*/
+ (void)userInfoArrayWithUsernameArray:(NSArray JMSG_GENERIC(__kindof NSString *)*)usernameArray
completionHandler:(JMSGCompletionHandler)handler;
/*!
* @abstract 批量获取跨应用的用户信息
*/
+ (void)userInfoArrayWithUsernameArray:(NSArray JMSG_GENERIC(__kindof NSString *)*)usernameArray
appKey:( NSString *JMSG_NULLABLE)userAppKey
completionHandler:(JMSGCompletionHandler)handler;
上面两个方法一个是针对同一个项目下的通话,另一个是针对跨应用App的音视频通话。根据需要大家可以自行的去选择对应的方法就可以了
- 获取用户信息并创建通话实体
let session = JMRTCClient.currentCallSession()
if (session != nil) {
return //当前有通话实体
}
let invitUserName = "用户名"
let array = invitUserName.components(separatedBy: ",")
//此处是一个Array数组,所以可以实现多人通话。此处我只设置一个用户即单人通话
JMSGUser.userInfoArray(withUsernameArray: array, appKey: "appKey") { resultObject, error in
if resultObject != nil{
let invitUserList = resultObject as! [JMSGUser]
var isContinue = true
for user in invitUserList{
if user.uid == JMSGUser.myInfo().uid {
isContinue = false
break
}
}
if !isContinue {
return
}
let session = JMRTCClient.currentCallSession()
if (session == nil) {
此处如果当前没有通话实体存在则可以去创建通话实体进行通话了。
}
}
}
- 创建语音或者是视频通话
func startCallWithUsers(users: [JMSGUser] , tempType : JMRTCMediaType){
let type = tempType
//发起视频通话
JMRTCClient.initializeEngine { resultObject, error in
if error == nil{
if type == JMRTCMediaType.video {//如果是视频通话设置一下视频的像素
JMRTCClient.setVideoProfile(JMRTCVideoProfile._VIDEO_PROFILE_360P)
}
JMRTCClient.startCall(users, mediaType: type) { [weak self] resultObject, error in
if error == nil{
self?.callSession = resultObject as? JMRTCSession
//此处是已经创建好了视频通话了。注意此处只有你在视频通话中,邀请的人还未加入视频通话。
}
}
}
}
}
正常的创建好视频通话后不管被邀请人是否接收邀请正常都应该显示自己的视频信息的。关于这个视频信息的显示实现方法在这里统一的说一下(自己或者是被邀请人的视频信息实现都是一样的)
,后面就不在去说这个问题了。
class VideoView: UIImageView {
var user : JMSGUser?
}
上面的类就是用来显示视频信息的,说白了就是使用一个ImageView不停的在刷新信息。user:
你传入的是谁的信息到时候就会显示谁的视频信息。需要注意当视频通话结束以后一定要将user
设置为nil
。
大概的显示视频信息的伪代码方法如下:
self?.callSession = resultObject as? JMRTCSession
if type == JMRTCMediaType.video {
self?.meVideoView.user = self?.currentUser
self?.meVideoView.isHidden = false
if self?.currentUser != nil {
self?.callSession?.setVideoView(self!.meVideoView, user: (self?.currentUser)!)
}
}
callSession:
这个参数是在你创建语音或者是视频消息的时候会返回给你的,在上面的方法中也有关于这个参数的设置,最好将此参数保存成全局变量。
meVideoView:
我自己创建的一个ImageView
,用于显示我自己的视频信息。在我的项目中是只有单聊的功能所以将显示自己
信息的View
和显示被邀请人
信息的View
设置成了两个实体类
。而在官方的demo
中他的实现思路是设置一个最多的显示人数
,然后创建对应的ImageView
并保存在数组中,然后通过数组去寻找哪个View
还没有使用到就直接使用哪一个。这个完全可以根据自己的需求去设计
-
被邀请人接通消息
从此处开始往下要说的东西都是和delegate
相关的方法了
/*!
* @abstract 有用户加入通话
*
* @param joinUser 加入的用户的用户信息
*/
- (void)onCallMemberJoin:(JMSGUser *)joinUser;
func onCallMemberJoin(_ joinUser: JMSGUser!) {
print("有用户接入聊天了")
if self.callSession?.mediaType == .video {
self.statusView.type = .video
userVideoView.user = joinUser
userVideoView.isHidden = false
self.addSubview(self.meVideoView)
self.meVideoView.frame = self.userVideoView.frame
self.userVideoView.frame = self.bounds
self.addSubview(statusView)
self.callSession?.setVideoView(userVideoView, user: joinUser)
}else{
self.statusView.type = .audio
self.audioView.type = .audio
}
}
有用户加入时就会走此方法,此时只需要将用户的视频流显示出来即可,具体实现请参看上面说到的显示自己的视频流的设置即可。
- 通话结束
/*!
* @abstract 通话断开
*
* @param callSession 通话实体对象
* @param reason 断开原因
*
* @discussion 连接主动断开或异常断开时会触发此回调,断开原因请查看的 JMRTCDisconnectReason
*/
- (void)onCallDisconnect:(JMRTCSession *)callSession disconnectReason:(JMRTCDisconnectReason)reason;
/*!
* @abstract 挂断通话
*
* ### 调用成功后,挂断方会触发 [JMRTCDelegate onCallDisconnect::disconnectReason:]通知上层连接断开,通话结束;
*
* ### 其他用户会触发 [JMRTCDelegate onCallMemberLeave:reason:]通知上层有用户离开.
*
* @discussion 注意:SDK 一般情况不会主动调用 hangup,挂断通话操作由上层决定。此接口可以在邀请阶段以及通话阶段由任意通话中用户发起
*/
- (void)hangup:(JMRTCCompletionHandler _Nullable)handler;
通话挂断首先会走第一个方法,然后自己主动去调用第二个方法即可。在调用第二个方法的时候需要将一些控件或者是属性给设置成nil
//挂断通话
private func hangupAction(){
callSession?.hangup({[weak self] resultObject, error in
if error == nil{
print("挂断通话")
self?.callSession = nil//通话实体设置成nil
self?.meVideoView.user = nil//显示我自己信息的View的user设置成nil
self?.userVideoView.user = nil//显示别人信息的View的user设置成nil
self?.removeFromSuperview()
}
})
}
- 收到通话邀请
/*!
* @abstract 收到通话邀请
*
* @param callSession 通话实体对象
*
* @discussion 被邀请者收到通话邀请,会触发此回调
*/
- (void)onCallReceiveInvite:(JMRTCSession *)callSession;
在此方法中我是做的一些View上的显示操作,比如显示我的视频流,显示接通按钮
func onCallReceiveInvite(_ callSession: JMRTCSession!) {
print("收到通话邀请")
self.show()
let session = JMRTCClient.currentCallSession()
if session?.mediaType == .video {
self.statusView.type = .videoIn
JMRTCClient.setVideoProfile(JMRTCVideoProfile._VIDEO_PROFILE_360P)
DispatchQueue.main.async {
self.callSession = callSession
self.meVideoView.user = self.currentUser
self.meVideoView.isHidden = false
self.statusView.type = .videoIn
self.callSession?.setVideoView(self.meVideoView, user: (self.currentUser)!)
}
}else{
self.statusView.type = .audioIn
DispatchQueue.main.async {
self.audioView.isHidden = false
self.audioView.type = .audioIn
}
}
}
上面的方法我只是做的UI的一些显示或者是隐藏,并没有建立起通话来,需要调用如下的方法才可以建立通话
/**
* @abstract 接听来电
*
* ### 此接口只能在收到通话邀请回调 [JMRTCDelegate onCallReceiveInvite:] 之后才能调用;
*
* ### 调用成功后,双方都会触发 [JMRTCDelegate onCallConnected:] 回调,通知上层通话连接已建立;
*
* ### 并且 SDK 会触发 [JMRTCDelegate onCallMemberJoin:] 通知当前已经在通话频道内的用户有新用户加入。
*/
open func accept(_ handler: JMRTCCompletionHandler? = nil)
private func acceptAction(){
if callSession == nil {//首先要有会话实体信息。在你收到视频邀请的时候会给到你
return
}
callSession?.accept({[weak self] resultObject, error in
// if self?.callSession?.mediaType == .video{
此处不需要去显示对方的信息。当此处视频通话建立后会自动的去走**有用户接入的呢个方法**
// }
})
}
- 其他的一些参数设置
/**
* @abstract 静音状态
*/
open var isMuted: Bool { get }
/**
* @abstract 设置静音状态
*
* @param muted 是否静音
*/
open func setMuted(_ muted: Bool) -> Bool
/**
* @abstract扬声器状态,是否开启扬声器
*
* @discussion 音频通话的默认值为NO,视频通话的默认值为YES。
*/
open var isSpeakerphoneEnabled: Bool { get }
/**
* @abstract 设置扬声器状态
*
* @param enabled 是否开启扬声器,音频通话默:NO,视频通话默认:YES
*
* @discussion 只在视频或语音通话连接建立之后调用有效
*/
open func setSpeakerEnabled(_ enabled: Bool) -> Bool
/**
* @abstract 是否开启视频流输出
*/
open var isVideoStreamEnabled: Bool { get }
/**
* @abstract 设置视频流状态
*
* @param enabled 开启/关闭,音频通话默:NO,视频通话默认:YES
*
* @discussion 该方法不影响本地视频流获取,没有禁用摄像头,只是暂停发送本地视频流,只在视频通话连接建立之后调用有效。
*
* 通话中的其他用户,会触发 [JMRTCDelegate onCallUserVideoStreamEnabled:byUser:] 回调
*/
open func setVideoStreamEnabled(_ enabled: Bool) -> Bool
/**
* @abstract 切换前后摄像头
*/
open func switchCameraMode() -> Bool
到此音视频的通话基本上就差不多全说完了。其实主要是在于视频通话,而语音通话只是在视频通话的基础上去掉了视频流这一部分。所以主要还是讲视频相关的东西。
上篇文章:Swift 极光IM聊天-解析消息
至此整个的极光IM相关能用到的东西就全都说完了。