客户端纯呼叫 API 参考

  • iOS

更新时间

本页提供声网灵隼客户端 iOS API 参考。

类描述
IAgoraIotAppSdk提供总的服务接口,各子功能通过 getInstance 方法获取
IAccountMgr账号注册、登录与登出
ICallkitMgr来电呼叫管理,包括拨号、接听、挂断等
INotificationMgr消息通知管理
ErrCodeIot SDK 在使用过程中的报错信息
表格内容超出当前宽度,可横向滚动查看更多列。

IAgoraIotAppSdk

SDK 引擎接口。

getMqttIsConnected

Swift
func getMqttIsConnected() -> Bool

获取当前 MQTT(消息队列遥测传输协议)模块的连接状态。

返回

  • true: 已连接。
  • false: 已断开连接。

initialize

Swift
func initialize(initParam: InitParam,sdkStatus:@escaping(SdkStatus,String)->Void,callbackFilter:@escaping(Int,String)->(Int,String)) -> Int

初始化 SDK。

参数

参数描述
initParamSDK 初始化参数,详见 InitParam。
sdkStatusSDK 状态,详见 SdkStatus。
callbackFilter回调函数返回错误码/错误消息的集中过滤。所有带有 result 回调的接口,都会在调用 result 回调前触发该回调,返回 (ErrCode,ErrMessage)。
表格内容超出当前宽度,可横向滚动查看更多列。

release

Swift
func release()

释放 SDK 所有资源。

accounrMgr

Swift
var accountMgr: IAccountMgr{get}

获取账号管理接口。

返回

callkitMgr

Swift
var callkitMgr: ICallkitMgr{get}

获取呼叫系统接口。

返回

deviceMgr

Swift
var deviceMgr: IDeviceMgr{get}

获取设备管理接口。

返回

alarmMgr

Swift
var alarmMgr: IAlarmMgr{get}

获取告警信息管理接口。

返回

notificationMgr

Swift
var notificationMgr: INotificationMgr{get}

获取通知信息管理接口。

返回

IAccountMgr

账号管理接口。

logout

Swift
func logout(result:@escaping (Int,String)->Void)

登出当前账号。

返回

getUserId

Swift
func getUserId()->String

获取当前用户 ID。

返回

  • user ID。

  • 错误码,详见 ErrCode。

getAccountInfo

Swift
func getAccountInfo(result:@escaping(Int,String,AccountInfo?)->Void)

获取当前用户账号信息。

返回

  • 账户信息,类型为 AccountInfo。

  • 错误码,详见 ErrCode。

updateAccountInfo

Swift
func updateAccountInfo(info:AccountInfo,result:@escaping(Int,String)->Void)

更新当前用户账号信息。

参数

参数描述
infoAccountInfo 类型的账号信息。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

updateHeadIcon

Swift
func updateHeadIcon(image:UIImage,result:@escaping(Int,String,String?)->Void)

上传用户头像。

参数

参数描述
image头像图片文件。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

  • 头像的 URL 地址。

  • 错误码,详见 ErrCode。

login

Swift
func login(param:LoginParam,result:@escaping(Int,String)->Void)

通过第三方账号的登陆参数登陆用户账号。

该方法适用于用户已经自行实现第三方账号管理系统的情况。用户可以直接通过该方法登陆灵隼物联网平台。

参数

参数描述
param第三方登陆参数。详见 LoginParam。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

publicKeySet

Swift
func publicKeySet(publicKey:String, _ result:@escaping (Int,String)->Void)

设置云存储视频加密的公钥。

为加强云存储视频加密的安全性,你可以在应用层自行生成公钥、私钥,再通过该方法将公钥传入 SDK。例如,只有 SDK 的公钥和你 app 的私钥都正确,用户才能查看加密视频。

注意

声网不会保存你传入的公钥,你需要自行保存并管理。

参数

参数描述
publicKey待设置的公钥。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

ICallkitMgr

呼叫系统管理接口。

register

Swift
func register(incoming: @escaping (String,String, ActionAck) -> Void,memberState:((MemberState,[UInt])->Void)?)

注册来电通知。

通过该方法定义 incoming 和 memberState 回调函数后,如果你收到来电,SDK 会通过 incoming 和 memberState 回调通知你来电的设备、用户 ID 等相关信息。

声网推荐你在 login 之后调用该方法。

参数

参数描述
incoming

来电设备的信息,包含以下内容:

  • 第一个参数:来电设备的名称。
  • 第二个参数:来电时附带的信息。
  • 第三个参数:来电时产生的事件,详见 ActionAck。
memberState

来电用户的信息,包含以下内容:

  • 第一个参数:来电用户的状态,详见 MemberState。
  • 第二个参数:来电用户的用户 ID。
表格内容超出当前宽度,可横向滚动查看更多列。

callDial

Swift
func callDial(
    device: IotDevice,
    attachMsg: String,
    result:@escaping(Int,String)->Void,
    actionAck:@escaping(ActionAck)->Void,
    memberState:((_ state:MemberState,_ uid:[UInt])->Void)?)

呼叫设备。

参数

参数描述
device要呼叫的设备,详见 IotDevice。
attachMsg呼叫时附带的信息。
actionAck通话中产生的事件,详见 ActionAck。
memberState

其他用户的信息。

  • state: 其他用户的状态,详见 MemberState。
  • uid: 其他用户的用户 ID。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

callHangup

Swift
func callHangup(result:@escaping(Int,String)->Void)

挂断当前通话。

返回

callAnswer

Swift
func callAnswer(result:@escaping(Int,String)->Void,
                actionAck:@escaping(ActionAck)->Void,
                memberState:((_ state:MemberState,_ uid:[UInt])->Void)?)

接听当前来电。

参数

参数描述
actionAck通话中产生的事件。
memberState

其他用户的信息。

  • state: 其他用户的状态,详见 MemberState。
  • uid: 其他用户的用户 ID。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

setLocalVideoView

Swift
func setLocalVideoView(localView: UIView?) -> Int

设置本地视频显示控件。如果不设置则不显示本地视频。

参数

参数描述
localView本地视频显示控件。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

setPeerVideoView

Swift
func setPeerVideoView(peerView: UIView?) -> Int

设置对端视频显示控件。如果不设置则不显示对端视频。

参数

参数描述
localView本地视频显示控件。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

muteLocalVideo

Swift
func muteLocalVideo(mute: Bool,result:@escaping(Int,String)->Void)

停止/恢复发布本地视频流。

参数

参数描述
mute

是否停止发布本地视频流:

  • true: 是
  • false: 否
表格内容超出当前宽度,可横向滚动查看更多列。

返回

muteLocalAudio

Swift
func muteLocaAudio(mute: Bool,result:@escaping(Int,String)->Void)

停止/恢复发布本地音频流。

参数

参数描述
mute

是否停止发布本地音频流:

  • true: 是
  • false: 否
表格内容超出当前宽度,可横向滚动查看更多列。

返回

mutePeerVideo

Swift
func mutePeerVideo(mute: Bool,result:@escaping(Int,String)->Void)

停止/恢复订阅远端视频流。

参数

参数描述
mute

是否停止发布远端视频流:

  • true: 是
  • false: 否
表格内容超出当前宽度,可横向滚动查看更多列。

返回

mutePeerAudio

Swift
func mutePeerAudio(mute: Bool,result:@escaping(Int,String)->Void)

停止/恢复订阅远端音频流。

参数

参数描述
mute

是否停止发布远端音频流:

  • true: 是
  • false: 否
表格内容超出当前宽度,可横向滚动查看更多列。

返回

setVolume

Swift
func setVolume(volumeLevel: Int,result:@escaping(Int,String)->Void)

设置音频播放的音量。

参数

参数描述
volumeLevel音量级别,取值范围为 [0,100]。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

setVolumeEffect

Swift
func setAudioEffect(effectId: AudioEffectId,result:@escaping(Int,String)->Void)

设置音效效果(通常是变声等音效)。

参数

参数描述
effectId音效文件的 ID。详见 AudioEffectId。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

talkingRecordStart

Swift
func talkingRecordStart(result:@escaping(Int,String)->Void)

开始录制当前通话(包括音视频流),仅在通话状态下才能调用。

返回

talkingRecordStop

Swift
func talkingRecordStop(result:@escaping(Int,String)->Void)

停止录制当前通话,仅在通话状态下才能调用。

返回

capturePeerVideoFrame

Swift
func capturePeerVideoFrame(result:@escaping(Int,String,UIImage?)->Void)

截屏对端视频帧图像,仅在通话状态下才能调用。

返回

  • 截取到的视频帧图像。

  • 错误码,详见 ErrCode。

getNetworkStatus

Swift
func getNetworkStatus()->RtcNetworkStatus

获取当前通话的统计信息。

返回

当前通话的统计信息。详见 RtcNetworkStatus。

INotificationMgr

通知消息管理接口。

updateToken

Swift
func updateToken(_ deviceToken:Data)

离线推送时需要更新 Token。

参数

参数描述
deviceToken设备 Token。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

queryAll

Swift
func queryAll(result:@escaping(Int,String)->Void)

查询所有通知消息。

查询成功会触发 onAllNotificationQueryDone 回调。

返回

queryByDevice

Swift
func queryByDevice(productKey: String, deviceId: String,result:@escaping(Int,String)->Void)

查询指定设备的所有通知消息。

查询成功会触发 onDeviceNotificationQueryDone 回调。

参数

参数描述
productKey产品编号。
deviceId设备 ID。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

delete

Swift
func delete(notificationIdList: [String],result:@escaping(Int,String)->Void)

删除多条通知消息。

删除成功会触发 onNotificationDeleteDone 回调。

参数

参数描述
notificationIdList要删除的通知消息 ID 列表。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

mark

Swift
func mark(markFlag: Int, notificationIdList: [String],result:@escaping(Int,String)->Void)

标记多条通知消息。

标记成功会触发 onNotificationMarkDone 回调。

参数

参数描述
notificationIdList要删除的通知消息 ID 列表。
markFlag标记信息。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

enableNotify

Swift
func enableNotify(enable:Bool,result:@escaping(Int,String)->Void)

开启/关闭接收推送消息。

参数

参数描述
bool

是否要接收推送消息。

  • true: 接收。
  • false: 不接收。
表格内容超出当前宽度,可横向滚动查看更多列。

返回

notifyEnabled

Swift
func notifyEnabled()->Bool

查询推送消息接收状态。

返回

  • true: 接收。
  • false: 不接收。

getEid

Swift
func getEid()->String

查询推送 eid。

返回

eid。

ErrCode

全局错误

错误码错误代码描述
0XERR_NONG无错误。
0XOK无错误。
-3XERR_TOKEN_INVALIDToken 过期。
表格内容超出当前宽度,可横向滚动查看更多列。

通用错误

错误码错误代码描述
-10000XERR_BASE通用错误。
-10001XERR_UNKNOWN未知错误。
-10002XERR_INVALID_PARAM参数错误。
-10003XERR_UNSUPPORTED当前操作不支持。
-10004XERR_BAD_STATE当前状态不正确,无法操作。
-10005XERR_NOT_FOUND没有找到相关数据。
-10006XERR_NO_MEMORY内存不足。
-10007XERR_BUFFER_OVERFLOW缓冲区中数据不足。
-10008XERR_BUFFER_UNDERFLOW缓冲区中数据过多。
-10009XERR_TIMEOUT操作超时。
-10012XERR_NETWORK网络错误。
-10015XERR_TOKEN_INVALIDToken 无效。
表格内容超出当前宽度,可横向滚动查看更多列。

呼叫系统相关错误

错误码错误代码描述
-40000XERR_CALLKIT_BASE呼叫系统相关错误。
-40001XERR_CALLKIT_TIMEOUT呼叫超时无响应。
-40002XERR_CALLKIT_DIAL呼叫拨号失败。
-40003XERR_CALLKIT_HANGUP呼叫挂断失败。
-40004XERR_CALLKIT_ANSWER呼叫接听失败。
-40005XERR_CALLKIT_REJECT呼叫拒绝失败。
-40006XERR_CALLKIT_PEER_BUSY对端忙。
-40007XERR_CALLKIT_PEERTIMEOUT对端超时无响应。
-40008XERR_CALLKIT_LOCAL_BUSY本地端忙。
-40009XERR_CALLKIT_ERR_OPT不支持的错误操作。
-40010XERR_CALLKIT_PEER_UNREG对端未注册。
-40011XERR_CALLKIT_NO_APPID未上报 App ID。
-40012XERR_CALLKIT_SAME_ID主叫和被叫同一个 ID。
-4001XERR_CALLKIT_APPID_DIFF客户端和设备端使用的 App ID 不一致。
表格内容超出当前宽度,可横向滚动查看更多列。

数据类型

InitParam

Iot SDK 初始化参数。

Swift
public class InitParam : NSObject{
    @objc public var rtcAppId: String = ""
    @objc public var logFilePath : String? = nil
    @objc public var publishAudio = true
    @objc public var publishVideo = true
    @objc public var subscribeAudio = true
    @objc public var subscribeVideo = true
    @objc public var ntfAppKey: String = ""
    @objc public var ntfApnsCertName:String = ""
    @objc public var masterServerUrl:String = ""
    @objc public var slaveServerUrl:String = ""
    @objc public var projectId:String = ""
}
参数描述
rtcAppId声网的 App ID。
logFilePath日志文件路径。如果不设置该参数,则日志不会输出到本地文件。
publishAudio

通话时是否自动发布本地音频:

  • true: 是
  • false: 否
publishVideo

通话时是否自动发布本地视频:

  • true: 是
  • false: 否
subscribeAudio

通话时是否自动订阅对端音频:

  • true: 是
  • false: 否
subscribeVideo

通话时是否自动订阅对端视频:

  • true: 是
  • false: 否
ntfAppKey离线推送使用的 AppKey。
ntfApnsCertName离线推送使用的 ApnsCertName。
masterServerUrl主服务器后台地址。
slaveServerUrl副服务器后台地址。
projectId项目 ID,作为查询产品列表的过滤条件。
表格内容超出当前宽度,可横向滚动查看更多列。

LoginParam

Swift
public class LoginParam : NSObject{

    public var tokenType:String = ""
    public var accessToken:String = ""
    public var refreshToken:String = ""
    public var expireIn:UInt = 0
    public var scope:String = ""

    public var grawin_token:String = ""
    public var expiration : UInt64 = 0
    public var endPoint:String = ""
    public var region:String = ""
    public var account:String = ""

    public var proof_sessionToken:String = ""
    public var proof_secretKey:String = ""
    public var proof_accessKeyId:String = ""
    public var proof_sessionExpiration:UInt64 = 0

    public var pool_token:String = ""
    public var pool_identityId:String = ""
    public var pool_identityPoolId:String = ""
    public var pool_identifier = ""
}

第三方账号的登陆参数。

参数

参数描述
tokenType预留字段。
accessToken灵隼平台账号的 Token。
refreshToken更新 Token。
expireInToken 过期时间。
scope预留字段。
grawin_token第三方平台的 Token。
expirationgrawin_token 的过期时间。
endPoint灵隼服务器的边缘节点。
region灵隼服务器所在区域。
account用户的第三方账号。
proof_sessionTokenIOT 临时账号的 Token。
proof_secretKeyIOT 临时账号的密钥。
proof_accessKeyIdIOT 临时账号的凭证。
proof_sessionExpirationproof_sessionToken 的过期时间
pool_token用户身份 Token。
pool_identityId用户身份 ID。
pool_identityPoolId用户身份池 ID。
pool_identifier用户身份。
表格内容超出当前宽度,可横向滚动查看更多列。

ProductInfo

Swift
public class ProductInfo:NSObject{
    @objc public var alias : String = ""
    @objc public var bindType:UInt = 0
    @objc public var connectType : UInt = 0
    @objc public var createTime : UInt64 = 0
    @objc public var deleted : UInt = 0
    @objc public var id : String = ""
    @objc public var imgBig : String = ""
    @objc public var imgSmall : String = ""
    @objc public var merchantId : UInt64 = 0
    @objc public var merchantName : String = ""
    @objc public var name : String = ""
    @objc public var productKey : String = ""
    @objc public var productTypeId : UInt64  = 0
    @objc public var productTypeName : String = ""
    @objc public var status : UInt = 0
    public var updateBy : UInt64 = 0
    public var updateTime : UInt64 = 0
    public init(alias:String,
                bindType:UInt,
                connectType:UInt,
                createTime:UInt64,
                deleted:UInt,
                id:String,
                imgBig:String,
                imgSmall:String,
                merchantId:UInt64,
                merchantName:String,
                name:String,
                productKey:String,
                productTypeId:UInt64,
                productTypeName:String,
                status:UInt,
                updateBy:UInt64,
                updateTime:UInt64) {
        self.alias = alias
        self.bindType = bindType
        self.connectType = connectType
        self.createTime = createTime
        self.deleted = deleted
        self.id = id
        self.imgBig = imgBig
        self.imgSmall = imgSmall
        self.merchantId = merchantId
        self.merchantName = merchantName
        self.name = name
        self.productKey = productKey
        self.productTypeId = productTypeId
        self.productTypeName = productTypeName
        self.status = status
        self.updateBy = updateBy
        self.updateTime = updateTime
    }
}

产品信息。

参数描述
alias产品别名。
bindType

绑定类型:

  • 1: 可重复绑定。
  • 2: 不可重复绑定。
connectType

网络连接类型:

  • 1: WiFi 连接。
  • 2: 蜂窝连接。
createTime创建时间。
deleted

是否已删除。

  • true: 是
  • false: 否
id产品 ID。
imgBig产品大图。
imgSmall产品小图。
merchantId商户 ID。
merchantName商户名称。
name产品名称
productKey产品编号,即作为产品唯一标识的数字。
productTypeId产品型号 ID。
productTypeName产品型号名称。
status

产品状态:

  • 1: 正常。
  • 0: 停用。
updateBy更新人 ID。
updateTime最后更新时间。
表格内容超出当前宽度,可横向滚动查看更多列。

DeviceShare

Swift
public class DeviceShare : NSObject{
    @objc public var nickName:String = ""
    @objc public var count:Int = 0
    @objc public var time:UInt64 = 0
    @objc public var deviceNumber:String = ""
    @objc public var deviceId:String = ""
}

分享的设备信息。

参数描述
nickName设备昵称。
count设备被分享次数。
time创建时间。
deviceNumber设备编号。
deviceId设备 ID,必须是唯一的。
表格内容超出当前宽度,可横向滚动查看更多列。

DeviceCancelable

Swift
public class DeviceCancelable : NSObject{
    @objc public var appuserId:String  = ""
    @objc public var avatar:String = ""
    @objc public var connect:Bool = false
    @objc public var createTime:UInt64 = 0
    @objc public var deviceNumber:String = ""
    @objc public var deviceNickname:String = ""
    @objc public var email:String = ""
    @objc public var deviceId:String = ""
    @objc public var nickName:String = ""
    @objc public var phone:String = ""
    @objc public var productId:String = ""
    @objc public var productKey:String = ""
    @objc public var sharer:String = ""
    @objc public var uType:String = ""
    @objc public var updateTime:UInt64 = 0
}

分享给他人设备详情。

参数描述
appuserId用户 ID。
avatar用户头像。
connect

是否在线。

  • true:在线。
  • false:离线。
createTime创建时间。
deviceNumber设备编号。
deviceNickname设备昵称。
email用户邮箱.
deviceId设备 ID,必须是唯一的。
nickName用户昵称。
phone用户手机。
productId产品 ID。
productKey产品编号。
sharer分享人 ID。
uType

用户角色:

  • 1:所有者。
  • 2:管理员。
  • 3:成员。
updateTime更新时间。
表格内容超出当前宽度,可横向滚动查看更多列。

ShareDetail

Swift
public class ShareDetial : NSObject{
    @objc public var auditStatus:Bool = false
    @objc public var content:String = ""
    @objc public var createBy:UInt64 = 0
    @objc public var createTime:UInt64 = 0
    @objc public var deleted:Int = 0
    @objc public var id:UInt64 = 0
    @objc public var merchantId:UInt64 = 0
    @objc public var merchantName:String = ""
    @objc public var msgType:Int = 0
    @objc public var para:String = ""
    @objc public var permission:Int = 0
    @objc public var status:Int = 0
    @objc public var title:String = ""
    @objc public var type:Int = 0
    @objc public var updateBy:UInt64 = 0
    @objc public var updateTime:UInt64 = 0
    @objc public var userId:UInt64 = 0
}

分享详情。

参数描述
auditStatus

消息处理状态:

  • t: 已处理。
  • f: 未处理。
content推送内容。
createBy创建人 ID。
createTime创建时间。
deleted

是否已删除。

  • 1: 已删除。
  • 0: 未删除。
id该条消息 ID。
merchantId商户 ID。
merchantName商户名称。
msgType

消息类型:

  • 1: 设备分享消息。
para分享口令。
permission

推送权限:

  • 2:管理员。
  • 3:成员。
status

状态:

  • 1:发送成功。
  • 2:发送失败。
  • 3:待发送。
title推送标题。
type

推送类型:

  • 1:App 消息。
  • 2:短信消息。
  • 3:邮箱信息。
updateBy更新人 ID。
updateTime更新时间。
userId被分享者 ID。
表格内容超出当前宽度,可横向滚动查看更多列。

ShareItem

Swift
public class ShareItem : NSObject{
    @objc public var auditStatus:Bool = false
    @objc public var content:String = ""
    @objc public var createBy:UInt64 = 0
    @objc public var createTime:UInt64 = 0
    @objc public var deleted:Int = 0
    @objc public var deviceNumber:UInt64 = 0
    @objc public var id:UInt64 = 0
    @objc public var img:String = ""
    @objc public var merchantId:UInt64 = 0
    @objc public var merchantName:String = ""
    @objc public var msgType:Int = 0
    @objc public var para:String = ""
    @objc public var permission:Int = 0
    @objc public var productName:String = ""
    @objc public var pushTime:UInt64 = 0
    @objc public var shareName:String = ""
    @objc public var status:Int = 0
    @objc public var title:String = ""
    @objc public var type:Int = 0
    @objc public var userId:UInt64 = 0
}

分享条目。

参数描述
auditStatus

消息处理状态:

  • t: 已处理。
  • f: 未处理。
content推送内容。
createBy创建人 ID。
createTime创建时间。
deleted

是否已删除。

  • 1: 已删除。
  • 0: 未删除。
deviceNumber设备编号。
id该条消息 ID。
img产品图片地址。
merchantId商户 ID。
merchantName商户名称。
msgType

消息类型:

  • 1: 设备分享消息。
para分享口令。
permission

推送权限:

  • 2:管理员。
  • 3:成员。
productName产品名称。
pushTime推送时间。
shareName分享设备的名称。
status

状态:

  • 1:发送成功。
  • 2:发送失败。
  • 3:待发送。
title推送标题。
type

推送类型:

  • 1:App 消息。
  • 2:短信消息。
  • 3:邮箱信息。
userId被分享者 ID。
表格内容超出当前宽度,可横向滚动查看更多列。

PageTurn

Swift
public class PageTurn:NSObject{
    @objc var currentPage : Int = 0
    @objc var end : Int = 0
    @objc var firstPage : Int = 0
    @objc var nextPage : Int = 0
    @objc var page : Int = 0
    @objc var pageCount : Int = 0
    @objc var pageSize : Int = 0
    @objc var prevPage : Int = 0
    @objc var rowCount : Int = 0
    @objc var start : Int = 0
    @objc var startIndex : Int = 0
}

产品查询翻页信息。

参数描述
currentPage当前页码。
end当前页结束条数。
firstPage第一页页码。
nextPage下一页页码。
page查询的页码。
pageCount页数。
pageSize分页大小。
prevPage前一页页码。
rowCount条数
start当前页开始条数。
startIndex开始翻页的索引。
表格内容超出当前宽度,可横向滚动查看更多列。

SdkStatus 枚举

Objective-C
@objc public enum SdkStatus : Int{
    case NotReady
    case InitCallFail
    case InitMqttFail
    case InitPushFail
    case AllReady
    case Reconnected
    case Disconnected
}

SDK 状态。

参数

参数描述
NotReady登录成功,但还在初始化各个子模块中,处于未就绪状态。
InitCallFail登录成功后,初始化呼叫模块出错。
InitMqttFail登录成功后,初始化 MQTT 模块出错。
InitPushFail登录成功后,初始化推送模块出错。
AllReady登录成功后,初始化过程完毕,处于就绪状态。
Reconnected登录成功后,MQTT 重连成功。
Disconnected登录成功后,MQTT 断开连接。
表格内容超出当前宽度,可横向滚动查看更多列。

RtcNetworkStatus

Swift
public class RtcNetworkStatus : NSObject{
    public var isBusy : Bool             = false
    public var totalDuration : UInt      = 0
    public var txBytes : UInt            = 0
    public var rxBytes : UInt            = 0
    public var txKBitRate : UInt         = 0
    public var txAudioBytes : UInt       = 0
    public var rxAudioBytes : UInt       = 0
    public var txVideoBytes : UInt       = 0
    public var rxVideoBytes : UInt       = 0
    public var rxKBitRate : UInt         = 0
    public var txAudioKBitRate : UInt    = 0
    public var rxAudioKBitRate : UInt    = 0
    public var txVideoKBitRate : UInt    = 0
    public var rxVideoKBitRate : UInt    = 0
    public var lastmileDelay : UInt      = 0
    public var cpuTotalUsage : Double    = 0
    public var cpuAppUsage : Double      = 0
    public var users : UInt              = 0
    public var connectTimeMs : Int       = 0
    public var txPacketLossRate : Int    = 0
    public var rxPacketLossRate : Int    = 0
    public var memoryAppUsageRatio : Double = 0
    public var memoryTotalUsageRatio : Double = 0
    public var memoryAppUsageInKbytes : Int = 0
}

通话相关的统计信息。

参数描述
isBusy

是否在呼叫中:

  • true: 在呼叫中。
  • false: 未进行呼叫。
totalDuration本地用户通话时长(秒),累计值。
txBytes发送字节数(bytes)。
rxBytes接收字节数(bytes)。
txKBitRate发送码率(Kbps)。
txAudioBytes发送音频字节数(bytes),累计值。
rxAudioBytes接收音频字节数(bytes),累计值。
txVideoBytes发送视频字节数(bytes),累计值。
rxVideoBytes接收视频字节数(bytes),累计值。
rxKBitRate接收码率(Kbps)。
txAudioKBitRate音频发送码率 (Kbps)。
rxAudioKBitRate音频接收码率 (Kbps)。
txVideoKBitRate视频发送码率 (Kbps)。
rxVideoKBitRate视频接收码率 (Kbps)。
lastmileDelay客户端到接入服务器的延时 (毫秒)。
cpuTotalUsage当前系统的 CPU 使用率 (%)。
cpuAppUsage当前 App 的 CPU 使用率 (%)。
users当前频道内的用户人数。
connectTimeMs从开始建立连接到成功连接的时间(毫秒)。如报告 0,则表示无效。
txPacketLossRate使用抗丢包技术前,客户端上行发送到服务器丢包率 (%)。
rxPacketLossRate使用抗丢包技术前,服务器下行发送到客户端丢包率 (%)。
memoryAppUsageRatio当前 App 的内存占比 (%)。该值仅作参考。受系统限制可能无法获取。
memoryTotalUsageRatio当前系统的内存占比 (%)。该值仅作参考。受系统限制可能无法获取。
memoryAppUsageInKbytes当前 App 的内存大小 (KB)。该值仅作参考。受系统限制可能无法获取。
表格内容超出当前宽度,可横向滚动查看更多列。

MemberState

Swift
@objc public enum MemberState : Int{
    case Exist
    case Enter
    case Leave
}

用户状态。

参数描述
Exist当前通话中已有其他用户。
Enter其他用户加入通话。
Leave其他用户退出通话。
表格内容超出当前宽度,可横向滚动查看更多列。

ActionAck

通话中产生的事件。

Objective-C
@objc public enum ActionAck:Int{

    case StateInited
    case LocalHangup
    case LocalAnswer
    case RemoteHangup
    case RemoteAnswer
    case RemoteTimeout
    case RecordEnd
    case LocalTimeout

    case RemoteVideoReady
    case RemoteAudioReady

    case RemoteBusy
    case CallIncoming
    case CallForward
    case CallOutgoing
    case UnknownAction
}

参数

参数描述
StateInited初始化呼叫状态。
LocalHangup本地挂断。
LocalAnswer本地接听。
RemoteHangup设备挂断。
RemoteAnswer设备接听。
RemoteTimeout对端超时。
RecordEnd云录制停止。
LocalTimeout呼叫超时。
RemoteVideoReady首次收到设备视频。
RemoteAudioReady首次收到设备音频。
RemoteBusy设备忙。
CallIncoming设备来电振铃。
CallForward本地去电中继。
CallOutgoing本地去电振铃。
UnknownAction未知错误。
表格内容超出当前宽度,可横向滚动查看更多列。

AudioEffectId

音频特效。

Objective-C
@objc public enum AudioEffectId:Int{
    case NORMAL
    case OLDMAN
    case BABYBOY
    case BABYGIRL
    case ZHUBAJIE
    case ETHEREAL
    case HULK
}

参数

参数描述
NORMAL(默认)原声,即关闭本地语音的变声、美音或语聊美声效果。
OLDMAN变声:老男孩。
BABYBOY变声:小男孩。
BABYGIRL变声:小女孩。
ZHUBAJIE变声:猪八戒
ETHEREAL变声:空灵。
HULK变声:绿巨人。
表格内容超出当前宽度,可横向滚动查看更多列。

这个页面有帮助吗?