[TOC]

Android接口索引

一、IOTCamera

1.1 初始化接口

API	功能说明
TK_initIOTC	IOTC初始化
TK_unInitIOTC	IOTC反初始化
TK_setMasterRegion	P2P分区分流
TK_getIOTCameraVersion	获取IOTCamera版本号
TK_getIOTCAPIsVerion	返回IOTCAPI的版本号
TK_getAVAPIsVersion	返回AVAPI的版本号
TK_LanSearch	本地搜索设备

1.2 回调接口

1.2.1 P2P回调接口

API	功能说明
TK_registerIOTCListener	注册IOTC回调

1.2.2 音视频回调接口

API	功能说明
TK_registerMediaDataListener	注册音视频数据回调

1.3 连线处理

1.3.1 P2P

API	功能说明
TK_connect	连线Device

1.3.2 Nebula

API	功能说明
TK_nebulaStartBind	Nebula开始绑定设备
TK_nebulaStopBind	Nebula停止绑定设备
TK_nebulaConnect	Nebula连线设备
TK_nebulaLanSearch	Nebula AP模式添加时，搜索本地udid列表
TK_nebulaSsidListReq	Nebula AP模式添加时，发送本地指令，获取设备wifi列表
TK_nebulaSetWifiReq	Nebula AP模式添加时，发送本地指令，给设备设置wifi
TK_nebulaSetRegionReq	Nebula AP模式添加时，发送本地指令，给设备设置P2P分区分流

1.3.3 共有

API	功能说明
TK_disconnect	断线Device，同时断开内部所有AV通道
TK_start	连线AV通道
TK_stop	断线AV通道
TK_changeAuthKey	修改AuthKey,返回修改后的AuthKey
TK_isSessionConnected	Device是否连线
TK_isChannelConnected	AV通道是否连线
TK_getAVChannelCount	获取已经开启的AV通道数
TK_getServiceTypeOfChannel	获取相应通道ServiceTYpe

1.4 视频处理

API	功能说明
TK_startShow	开启视频接收、解码、播放
TK_stopShow	停止所有AV通道的视频接收、解码、播放
TK_getVideoCodecId	获取当前视频格式
TK_setAVFilter	是否开启解码滤镜
TK_setDecocdeDelayTime	设置最大延迟时间，调整解码每帧时间间隔

1.5 音频处理

API	功能说明
TK_startSoundToDevice	开始音频采集、编码、发送
TK_stopSoundToDevice	停止音频采集、编码、发送
TK_startSoundToPhone	开始音频接收、解码、播放
TK_stopSoundToPhone	停止音频接收、解码、播放
TK_setAudioPlayTheWay	设置音频播放模式
TK_startAcousticEchoCanceler	开启消回音功能
TK_stopAcousticEchoCanceler	停止消回音功能
TK_setAcousticEchoCancelerDelaySize	设置消噪，消回音的参数
TK_setAudioOutput	是否需要自行播放或发送音频，一般用于第三方回音消除功能
TK_playAudio	播放回音消除后的音频数据，一般用于第三方回音消除功能
TK_sendAudio	发送回音消除后的音频数据，一般用于第三方回音消除功能
TK_setAudioSpeakFormats	设置音频对讲格式、采样率等
TK_setAudioInputCodecId	设置音频对讲格式
TK_getAudioInputCodecId	获取音频对讲格式
TK_getAudioOutputCodecId	获取音频监听格式

1.6 录像与截图

API	功能说明
TK_startRecording	开始录像
TK_stopRecording	停止录像
TK_snapshot	视频截图

1.7 指令发送

1.7.1 P2P

API	功能说明
TK_sendIOCtrlToChannel	发送命令到Device
TK_sendJsonCtrlToChannel	发送json字串命令给设备
TK_removeAllCmd	清除command队列

1.7.2 Nebula

API	功能说明
TK_nebulaSendData	Nebula发送json command

二、KalayCameraControl（指令封装）

API	功能说明
TK_commandSetRecord	设定设备SD卡录像模式
TK_commandGetRecord	获取设备目前SD卡录像模式
TK_commandListEvent	获取设备事件列表
TK_commandRecordPlayControl	事件回播控制播放
TK_commandSetStreamCtrl	设置设备解析度
TK_commandGetStreamCtrl	获取设备目前解析度
TK_commandSetMotionDetect	设置设备位移侦测之灵敏度
TK_commandGetMotionDetect	获取设备目前位移侦测之灵敏度
TK_commandGetSupportStream	获取目前设备通道数
TK_commandGetAudioOutFormat	获取设备音讯格式
TK_commandSetPassword	变更设备密码
TK_commandGetRecordDuration	获取sd卡事件总时长
TK_commandSetRecordProgress	设置回放事件进度
TK_commandListWifiAp	获取设备周围Wifi列表
TK_commandSetWifi	设定设备的Wifi网络
TK_commandGetWifi	获取设备目前所设置的WiFi
TK_commandSetVideoMode	设置画面镜像/翻转状态
TK_commandGetVideoMode	获取画面镜像/翻转设置状态
TK_commandFormatExtStorage	格式化SD卡
TK_commandGetChannelName	获取所有通道名称
TK_commandSetChannelName	设置通道名称
TK_commandXmCall	门铃接听，当收到设备门铃呼叫command，使用此api进行回复
TK_commandSetName	设置设备名称
TK_commandSetTimeSync	同步手机时间给设备
TK_commandSetPtz	云台控制
TK_commandOta	OTA升级
TK_commandDeviceInfo	获取设备信息
TK_commandDeviceSupportOta	获取设备是否支持OTA升级
TK_commandDeviceSupportCloud	获取设备是否支持云存储
TK_commandDeviceSetCloud	设置设备云存储录像状态
TK_commandDeviceGetCloud	获取设备云存储录像状态
TK_commandGetEventDate	获取有SD卡事件的日期
TK_commandGetHumanDetection	获取设备人形侦测开关
TK_commandSetHumanDetection	设置设备人形侦测开关
TK_commandGetNightVision	获取设备夜视开关
TK_commandSetNightVision	设置设备夜视开关
TK_commandGetSummerTime	获取设备夏令时开关
TK_commandSetSummerTime	设置设备夏令时开关

三、Command使用以及封装示例

四、VideoMonitor（播放器）

4.1 Method

API	功能说明
TK_attachCamera	为播放器绑定Camera实例
TK_deattachCamera	播放器解绑Camera
setScaleType	选择控件自动缩放方式，默认为SCALE_ASPECT

4.2 回调接口

API	功能说明
TK_setMonitorListener	播放器状态监听

五、Demo

iOS接口索引

一、IOTCamera

1.1 初始化接口

API	功能说明
TK_initIOTC	IOTC初始化
TK_unInitIOTC	IOTC反初始化
TK_setMasterRegion	P2P分区分流
TK_getIOTCameraVersion	获取IOTCamera版本号
TK_getIOTCAPIsVerion	返回IOTCAPI的版本号
TK_getAVAPIsVersion	返回AVAPI的版本号
TK_LanSearch	本地搜索设备

1.2 回调接口

1.2.1 P2P回调接口

API	功能说明
p2pDelegate	注册IOTC回调

1.2.2 音视频回调接口

API	功能说明
MediaDelegate	注册音视频数据回调

1.3 连线处理

1.3.1 P2P

API	功能说明
TK_connect	连线Device

1.3.2 Nebula

API	功能说明
TK_nebulaStartBind	Nebula开始绑定设备
TK_nebulaStopBind	Nebula停止绑定设备
TK_nebulaConnect	Nebula连线设备
TK_nebulaLanSearch	Nebula AP模式添加时，搜索本地udid列表
TK_nebulaSsidListReq	Nebula AP模式添加时，发送本地指令，获取设备wifi列表
TK_nebulaSetWifiReq	Nebula AP模式添加时，发送本地指令，给设备设置wifi
TK_nebulaSetRegionReq	Nebula AP模式添加时，发送本地指令，给设备设置P2P分区分流

1.3.3 共有

API	功能说明
TK_disconnect	断线Device，同时断开内部所有AV通道
TK_start	连线AV通道
TK_stop	断线AV通道
TK_changeAuthKey	修改AuthKey,返回修改后的AuthKey
TK_isSessionConnected	Device是否连线
TK_isChannelConnected	AV通道是否连线
TK_getAVChannelCount	获取已经开启的AV通道数
TK_getServiceTypeOfChannel	获取相应通道ServiceTYpe

1.4 视频处理

API	功能说明
TK_startShow	开启视频接收、解码、播放
TK_stopShow	停止所有AV通道的视频接收、解码、播放
TK_getVideoCodecId	获取当前视频格式
TK_StartAVFilterWithChannel	是否开启解码滤镜
TK_setDecocdeDelayTime	设置最大延迟时间，调整解码每帧时间间隔

1.5 音频处理

API	功能说明
TK_startSoundToDevice	开始音频采集、编码、发送
TK_stopSoundToDevice	停止音频采集、编码、发送
TK_startSoundToPhone	开始音频接收、解码、播放
TK_stopSoundToPhone	停止音频接收、解码、播放
TK_setAudioPlayTheWay	设置音频播放模式
TK_startSendAudioChannel	开启对讲发送
TK_stopSendAudioChannel	关闭对讲发送
TK_setAudioSessionPlayMode	设置音频播放模式,默认为Speaker
TK_setAudioOutput	是否需要自行播放或发送音频，一般用于第三方回音消除功能
TK_playAECAudio	播放回音消除后的音频数据，一般用于第三方回音消除功能
TK_sendAecAudio	发送回音消除后的音频数据，一般用于第三方回音消除功能
TK_setAudioSpeakFormatsChannel	设置音频对讲格式、采样率等
TK_setAudioInputCodecId	设置音频对讲格式
TK_getAudioInputCodecId	获取音频对讲格式
TK_getAudioOutputCodecId	获取音频监听格式

1.6 录像与截图

API	功能说明
TK_startRecordingForChannel	开始录像
TK_stopRecording	停止录像
TK_getSnapShotImageWithChannel	视频截图
TK_getChannel	填充制定通道的视频数据

1.7 指令发送

1.7.1 P2P

API	功能说明
TK_sendIOCtrlToChannel	发送命令到Device
TK_sendJsonCtrlToChannel	发送json字串命令给设备

1.7.2 Nebula

API	功能说明
TK_nebulaSendData	Nebula发送json command

二、KalayCameraControl（指令封装）

API	功能说明
TK_commandNebulaSsidListReq	AP获取WiFi列表
TK_commandNebulaSetWifiReq	AP设置WiFi
TK_commandSupportStreamWithChannel	获取设备通道数
TK_commandListWifiWithChannel	获取WiFi列表
TK_commandSetWifiWithChannel	设置设备WiFi网络
TK_commandGetWifiWithChannel	获取设备当前WiFi网络
TK_commandGetAudioOutFormatWithChannel	获取设备音频格式
TK_commandCallWithChannel	获取门铃呼叫
TK_commandDeviceInfoWithChannel	获取设备信息
TK_commandGetRecordWithChannel	获取设备SD卡录像模式
TK_commandSetRecordWithChannel	设置设备SD卡录像模式
TK_commandGetStreamWithChannel	获取设备解析度
TK_commandSetStreamWithChannel	设置设备解析度
TK_commandGetMotionDetectWithChannel	获取设备位移侦测之灵敏度
TK_commandSetMotionDetectWithChannel	设置设备位移侦测之灵敏度
TK_commandSetPasswdWithChannel	设置设备密码
TK_commandSetVideoModeWithChannel	设置画面镜像/翻转状态
TK_commandGetVideoModeWithChannel	获取画面镜像/翻转状态
TK_commandFormatExtStorageWithChannel	格式化SD卡
TK_commandGetChannelNameWithChannel	获取通道名称
TK_commandSetChannelNameWithChannel	设置通道名称
TK_commandPushDeviceNameWithChannel	获取当前设备名称
TK_commandTimeSyncWithChannel	同步时间
TK_commandPtzWithChannel	设备云台控制
TK_commandOTAWithChannel	设备OTA升级
TK_commandDeviceSupportOTAWithChannel	获取设备是否支持OTA
TK_commandDeviceSupportCloudWithChannel	获取设备是否支持云存储
TK_commandSetCloudWithChannel	设置设备云存储录像状态
TK_commandGetCloudWithChannel	获取设备云存储录像状态
TK_commandSetHumanDetectionWithChannel	设置设备人形侦测开关
TK_commandGetHumanDetectionWithChannel	获取设备人形侦测开关
TK_commandSetNightVisionWithChannel	设置设备夜视开关
TK_commandGetNightVisionWithChannel	获取设备夜视开关
TK_commandSetSummerTimeWithChannel	设置设备夏令时开关
TK_commandGetSummerTimeWithChannel	获取设备夏令时开关
TK_commandListEventWithChannel	获取事件列表
TK_commandPlayRecordWithChannel	事件回播控制播放
TK_commandGetPlaybackWithChannel	获取事件回放进度控制
TK_commandSetRecordProgessWithChannel	设置事件回放进度控制
TK_commandGetEventDateWithChannel	获取有SD卡事件的日期
TK_commandGetStorageInfoWithChannel	获取SD内存大小（4x）使用