APIs 说明
更新日期:2025/5/13
以下为Kalay SDK的iOS版本开放的所有API列表及相关功能说明:
初始化接口
API | 功能说明 |
---|---|
KY_InitIOTC | IOTC模块 初始化 |
KY_UninitIOTC | IOTC模块 反初始化 |
KY_SetMasterRegion | 对P2P服务区域进行分区分流设置 |
KY_LanSearch | 搜索局域网内的设备 |
KY_GetSDKVersion | 获取SDK的版本号信息 |
KY_setLogEnable | 设置日志记录 |
P2P连线
API | 功能说明 |
---|---|
KY_Connect | 开始连接设备并解码出图 |
KY_Disconnect | 停止解码出图,关闭已开启的通道,并断开连线 |
KY_DisconnectAll | 停止并关闭所有已开启的通道,并断开所有连线 |
音视频处理
API | 功能说明 |
---|---|
KY_SetHWDecode | 切换指定通道的解码方式 |
KY_setDecocdeDelayTime | 设置最大延迟时间,调整解码每帧时间间隔 |
KY_StartListen | 打开或关闭监听功能 |
KY_StartTalk | 打开或关闭对讲功能 |
KY_setVideoDropModeWithChannel | 设置视频解码达到最大缓存时的丢帧模式 |
KY_StartRecording | 打开/关闭 本地录像功能 |
KY_Snapshot | 截取一张liveview显示的图片并保存 |
上传/下载
API | 功能说明 |
---|---|
KY_startDownload | 开始文件下载 |
KY_stopDownload | 停止文件下载 |
KY_startUpload | 开始文件上传 |
KY_stopUpload | 停止文件上传 |
控制协议
API | 功能说明 |
---|---|
KY_SendIOCtrlToChannel | 向设备发送指定command的数据 |
回调接口
API | 功能说明 |
---|---|
KY_SetDelegate | 注册/反注册 监听回调接口 |
KY_DeviceStatus | 指定通道的连线状态 回调 |
KY_StartTalkSuccess | 对讲通道建立成功 回调 |
KY_StartListenSuccess | 监听通道建立成功 回调 |
KY_UpdateDecodedImage | 当前设备指定通道 解码后的数据 回调 |
KY_DecodeVideoFramInfo | 指定通道的 视频宽高/FPS/BPS/在线人数/帧数/丢帧率等调试信息 回调 |
KY_DidReceiveIOCtrlWithUid | 设备回复command的数据信息 回调 |
Nebula接口
API | 功能说明 |
---|---|
KY_nebulaStartBind | Nebula bind设备 |
KY_nebulaConnect | Nebula 连线设备 |
KY_nebulaConnect(简化) | Nebula 连线设备 |
KY_nebulaSendData | Nebula 发送指令及回调 |
KY_nebulaLanSearchTimeout | Nebula 局域网扫描设备 |
KY_nebulaSsidListReq | Nebula AP模式获取设备ssid list |
KY_nebulaSetWifiReq | Nebula 设置wifi |
KY_nebulaSetRegionReq | Nebula 设置region |
其他
API | 功能说明 |
---|---|
KY_RegisterClientWithDeviceToken | Client端向KPNS Server进行注册 |
KY_MappingWithUID | 将设备UID与KPNS Server进行绑定 |
KY_UnmappingWithUID | 将设备UID与KPNS Server进行解绑 |
KYPushError | KPNS Server返回的错误码结构体 |