以下為 Kalay SDK 的 iOS 版本開放的所有 API 列表及相關(guān)功能說明：
一、初始化接口
| API | 功能說明 |
|---|---|
| KY_InitIOTC | IOTC模塊 初始化 |
| KY_UninitIOTC | IOTC模塊 反初始化 |
| KY_SetMasterRegion | 對P2P服務(wù)區(qū)域進(jìn)行分區(qū)分流設(shè)置 |
| KY_LanSearch | 搜索局域網(wǎng)內(nèi)的設(shè)備 |
| KY_GetSDKVersion | 獲取SDK的版本號信息 |
| KY_setLogEnable | 設(shè)置日志記錄 |
二、P2P連線
| API | 功能說明 |
|---|---|
| KY_Connect | 開始連接設(shè)備并解碼出圖 |
| KY_Disconnect | 停止解碼出圖，關(guān)閉已開啟的通道，并斷開連線 |
| KY_DisconnectAll | 停止并關(guān)閉所有已開啟的通道，并斷開所有連線 |
三、音視頻處理
| API | 功能說明 |
|---|---|
| KY_SetHWDecode | 切換指定通道的解碼方式 |
| KY_setDecocdeDelayTime | 設(shè)置最大延遲時(shí)間，調(diào)整解碼每幀時(shí)間間隔 |
| KY_StartListen | 打開或關(guān)閉監(jiān)聽功能 |
| KY_StartTalk | 打開或關(guān)閉對講功能 |
| KY_setVideoDropModeWithChannel | 設(shè)置視頻解碼達(dá)到最大緩存時(shí)的丟幀模式 |
| KY_StartRecording | 打開/關(guān)閉 本地錄像功能 |
| KY_Snapshot | 截取一張liveview顯示的圖片并保存 |
四、上傳/下載
| API | 功能說明 |
|---|---|
| KY_startDownload | 開始文件下載 |
| KY_stopDownload | 停止文件下載 |
| KY_startUpload | 開始文件上傳 |
| KY_stopUpload | 停止文件上傳 |
五、控制協(xié)議
| API | 功能說明 |
|---|---|
| KY_SendIOCtrlToChannel | 向設(shè)備發(fā)送指定command的數(shù)據(jù) |
六、回調(diào)接口
| API | 功能說明 |
|---|---|
| KY_SetDelegate | 注冊/反注冊 監(jiān)聽回調(diào)接口 |
| KY_DeviceStatus | 指定通道的連線狀態(tài) 回調(diào) |
| KY_StartTalkSuccess | 對講通道建立成功 回調(diào) |
| KY_StartListenSuccess | 監(jiān)聽通道建立成功 回調(diào) |
| KY_UpdateDecodedImage | 當(dāng)前設(shè)備指定通道 解碼后的數(shù)據(jù) 回調(diào) |
| KY_DecodeVideoFramInfo | 指定通道的 視頻寬高/FPS/BPS/在線人數(shù)/幀數(shù)/丟幀率等調(diào)試信息 回調(diào) |
| KY_DidReceiveIOCtrlWithUid | 設(shè)備回復(fù)command的數(shù)據(jù)信息 回調(diào) |
七、Nebula接口
| API | 功能說明 |
|---|---|
| KY_nebulaStartBind | Nebula bind設(shè)備 |
| KY_nebulaConnect | Nebula 連線設(shè)備 |
| KY_nebulaConnect(簡化) | Nebula 連線設(shè)備 |
| KY_nebulaSendData | Nebula 發(fā)送指令及回調(diào) |
| KY_nebulaLanSearchTimeout | Nebula 局域網(wǎng)掃描設(shè)備 |
| KY_nebulaSsidListReq | Nebula AP模式獲取設(shè)備ssid list |
| KY_nebulaSetWifiReq | Nebula 設(shè)置wifi |
| KY_nebulaSetRegionReq | Nebula 設(shè)置region |
八、其他
| API | 功能說明 |
|---|---|
| KY_RegisterClientWithDeviceToken | Client端向KPNS Server進(jìn)行注冊 |
| KY_MappingWithUID | 將設(shè)備UID與KPNS Server進(jìn)行綁定 |
| KY_UnmappingWithUID | 將設(shè)備UID與KPNS Server進(jìn)行解綁 |
| KYPushError | KPNS Server返回的錯誤碼結(jié)構(gòu)體 |
