Index
<p>[TOC]</p>
<h1>iOS接口索引</h1>
<h1>一、IOTCamera</h1>
<h2>1.1 初始化接口</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_initIOTC</td>
<td style="text-align: left;">IOTC初始化</td>
</tr>
<tr>
<td style="text-align: left;">TK_InitIOTCWithLiceseKey</td>
<td style="text-align: left;">IOTC初始化</td>
</tr>
<tr>
<td style="text-align: left;">TK_unInitIOTC</td>
<td style="text-align: left;">IOTC反初始化</td>
</tr>
<tr>
<td style="text-align: left;">TK_initWithName</td>
<td style="text-align: left;">初始化Camera</td>
</tr>
<tr>
<td style="text-align: left;">TK_getIOTCameraVersion</td>
<td style="text-align: left;">获取IOTCamera版本号</td>
</tr>
<tr>
<td style="text-align: left;">TK_getIOTCAPIsVerion</td>
<td style="text-align: left;">返回IOTCAPI的版本号</td>
</tr>
<tr>
<td style="text-align: left;">TK_getAVAPIsVersion</td>
<td style="text-align: left;">返回AVAPI的版本号</td>
</tr>
<tr>
<td style="text-align: left;">TK_setMasterRegion</td>
<td style="text-align: left;">设置分区分流方案的地区</td>
</tr>
<tr>
<td style="text-align: left;">TK_setLogEnable</td>
<td style="text-align: left;">设置Log记录</td>
</tr>
</tbody>
</table>
<h2>1.2 回调接口</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">didChangeSessionStatus</td>
<td style="text-align: left;">指定通道的连线状态回调</td>
</tr>
<tr>
<td style="text-align: left;">didChangeChannelStatus</td>
<td style="text-align: left;">指定通道的连线状态回调</td>
</tr>
<tr>
<td style="text-align: left;">didReceiveIOCtrlWithType</td>
<td style="text-align: left;">指定通道指令接收回调</td>
</tr>
<tr>
<td style="text-align: left;">didStartTalkSuccess</td>
<td style="text-align: left;">对讲通道建立成功的回调</td>
</tr>
<tr>
<td style="text-align: left;">didStartListenSuccess</td>
<td style="text-align: left;">监听通道建立成功的回调</td>
</tr>
<tr>
<td style="text-align: left;">didReceiveFrameInfoWithChannel</td>
<td style="text-align: left;">指定通道的视频宽高/fps/bps/在线人数/帧数/丢帧数等调试信息回调</td>
</tr>
<tr>
<td style="text-align: left;">onDecodeResultWithFrameNum</td>
<td style="text-align: left;">当前解码结果相关信息回调</td>
</tr>
<tr>
<td style="text-align: left;">outputDecodeVideoYUVData</td>
<td style="text-align: left;">上抛指定通道解码后的yuv数据格式为i420</td>
</tr>
<tr>
<td style="text-align: left;">didReceiveFrameData</td>
<td style="text-align: left;">获取FrameInfo帧信息</td>
</tr>
<tr>
<td style="text-align: left;">didReceiveAudioData</td>
<td style="text-align: left;">指定通道接收的音频帧数据回调</td>
</tr>
<tr>
<td style="text-align: left;">didreportCodecId</td>
<td style="text-align: left;">视频帧编码格式回调</td>
</tr>
<tr>
<td style="text-align: left;">didRecvAudioOutput</td>
<td style="text-align: left;">输出解码后的音频数据</td>
</tr>
<tr>
<td style="text-align: left;">didSendAudioOutput</td>
<td style="text-align: left;">输出Mic采集的音频数据</td>
</tr>
</tbody>
</table>
<h2>1.3 连线处理</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_connect</td>
<td style="text-align: left;">连线Device</td>
</tr>
<tr>
<td style="text-align: left;">TK_LanSearch</td>
<td style="text-align: left;">局域网搜索</td>
</tr>
<tr>
<td style="text-align: left;">TK_disconnect</td>
<td style="text-align: left;">断线Device,同时断开内部所有AV通道</td>
</tr>
<tr>
<td style="text-align: left;">TK_start</td>
<td style="text-align: left;">连线AV通道</td>
</tr>
<tr>
<td style="text-align: left;">TK_stop</td>
<td style="text-align: left;">断线AV通道</td>
</tr>
<tr>
<td style="text-align: left;">TK_getViewAccountOfChannel</td>
<td style="text-align: left;">获取指定通道的用户名</td>
</tr>
<tr>
<td style="text-align: left;">TK_getViewPasswordOfChannel</td>
<td style="text-align: left;">获取指定通道的密码</td>
</tr>
<tr>
<td style="text-align: left;">TK_getServiceTypeOfChannel</td>
<td style="text-align: left;">获取相应通道ServiceTYpe</td>
</tr>
</tbody>
</table>
<h2>1.4 视频处理</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_StartAVFilterWithChannel</td>
<td style="text-align: left;">是否开启解码滤镜</td>
</tr>
<tr>
<td style="text-align: left;">TK_startShow</td>
<td style="text-align: left;">开启视频接收、解码、播放</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopShow</td>
<td style="text-align: left;">停止所有AV通道的视频接收、解码、播放</td>
</tr>
<tr>
<td style="text-align: left;">TK_setDecocdeDelayTime</td>
<td style="text-align: left;">设置最大延迟时间,调整解码每帧时间间隔</td>
</tr>
</tbody>
</table>
<h2>1.5 音频处理</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_startSoundToPhone</td>
<td style="text-align: left;">开始音频接收、解码、播放</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopSoundToPhone</td>
<td style="text-align: left;">停止音频接收、解码、播放</td>
</tr>
<tr>
<td style="text-align: left;">TK_startSoundToDevice</td>
<td style="text-align: left;">开始音频采集、编码、发送</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopSoundToDevice</td>
<td style="text-align: left;">停止音频采集、编码、发送</td>
</tr>
<tr>
<td style="text-align: left;">TK_playAECAudio</td>
<td style="text-align: left;">播放回音消除后的音频数据,一般用于第三方回音消除功能</td>
</tr>
<tr>
<td style="text-align: left;">TK_sendAecAudio</td>
<td style="text-align: left;">发送回音消除后的音频数据,一般用于第三方回音消除功能</td>
</tr>
<tr>
<td style="text-align: left;">TK_startSendAudioChannel</td>
<td style="text-align: left;">开启对讲发送</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopSendAudioChannel</td>
<td style="text-align: left;">关闭对讲发送</td>
</tr>
<tr>
<td style="text-align: left;">TK_setAudioSessionPlayMode</td>
<td style="text-align: left;">设置音频播放模式,默认为Speaker</td>
</tr>
<tr>
<td style="text-align: left;">TK_setSoundToDeviceFormatsChannel(原API:TK_setAudioSpeakFormatsChannel)</td>
<td style="text-align: left;">设置音频对讲格式、采样率等</td>
</tr>
<tr>
<td style="text-align: left;">TK_getSoundToPhoneCodeId(原API:TK_getAudioOutputCodecId)</td>
<td style="text-align: left;">获取音频监听格式</td>
</tr>
<tr>
<td style="text-align: left;">TK_getSoundToDeviceCodeId(原API:TK_getAudioInputCodecId)</td>
<td style="text-align: left;">获取音频对讲格式</td>
</tr>
<tr>
<td style="text-align: left;">TK_isAudioOutputavChannel</td>
<td style="text-align: left;">处理发送音频数据上抛</td>
</tr>
</tbody>
</table>
<h2>1.6 录像与截图</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_initVideoGenerator</td>
<td style="text-align: left;">本地录像功能初始化</td>
</tr>
<tr>
<td style="text-align: left;">TK_startRecordingForChannel</td>
<td style="text-align: left;">开始录像</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopRecording</td>
<td style="text-align: left;">停止录像</td>
</tr>
<tr>
<td style="text-align: left;">TK_getChannel</td>
<td style="text-align: left;">填充制定通道的视频数据</td>
</tr>
<tr>
<td style="text-align: left;">TK_getSnapShotImageWithChannel</td>
<td style="text-align: left;">视频截图</td>
</tr>
</tbody>
</table>
<h2>1.7 指令发送</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_sendIOCtrlToChannel</td>
<td style="text-align: left;">发送命令到Device</td>
</tr>
<tr>
<td style="text-align: left;">TK_sendJsonCtrlToChannel</td>
<td style="text-align: left;">发送json字串命令给设备</td>
</tr>
</tbody>
</table>
<h1>二、指令封装</h1>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_commandCallReq</td>
<td style="text-align: left;">请求接听指令</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetAudioOutFormatWithChannel</td>
<td style="text-align: left;">获取音频格式</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetQVGAWithChannel</td>
<td style="text-align: left;"> 获取当前视频质量指令</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetRecordMode</td>
<td style="text-align: left;">获取当前录像模式指令</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetDeviceInfo</td>
<td style="text-align: left;">获取设备信息指令</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetSupportStreamWithChannel</td>
<td style="text-align: left;"> 获取支持音视频流的通道数</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetChannelNameWithChannel</td>
<td style="text-align: left;"> 获取通道名称</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetGuardWithChannel</td>
<td style="text-align: left;">获取报警布防配置信息</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetMotionDetectWithChannel</td>
<td style="text-align: left;">获取移动侦测配置信息</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetWifiWithChannel</td>
<td style="text-align: left;">获取WiFi配置信息</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetListWifiApWithChannel</td>
<td style="text-align: left;">获取WiFi热点列表</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetListEventWithChannel</td>
<td style="text-align: left;">获取指定时间内的事件列表</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetPlaybackWithChannel</td>
<td style="text-align: left;">获取指定时间的事件回放数据</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetVideoModeWithChannel</td>
<td style="text-align: left;">获取当前的视频翻转模式</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetDeviceSupportOTA</td>
<td style="text-align: left;">获取设备是否支持OTA</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandGetDeviceInfoEx</td>
<td style="text-align: left;"> 获取设备信息指令(扩展)</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandSetQVGAWithLevel</td>
<td style="text-align: left;">设置视频质量等级</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandSetPasswordWithOld</td>
<td style="text-align: left;">修改设备密码</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandSetWifiWithSSID</td>
<td style="text-align: left;">配置设备的WiFi网络</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandSetRecordWithChannel</td>
<td style="text-align: left;">配置设备的录像模式</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandSetMotionDetectWithChannel</td>
<td style="text-align: left;">配置设备的移动侦测功能</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandSetGuardReqWithChannel</td>
<td style="text-align: left;">配置设备的报警布防功能</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandSetRecordProgessWithChannel</td>
<td style="text-align: left;"> 设置设备当前播放的时间录像进度</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandFormatExtStorageWithStorage</td>
<td style="text-align: left;">格式化外置存储器</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandSetVideoModeWithChannel</td>
<td style="text-align: left;">设置设备的视频翻转模式</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandSetPtzWithChannel</td>
<td style="text-align: left;"> 配置设备的PTZ功能</td>
</tr>
<tr>
<td style="text-align: left;">TK_commandOTA</td>
<td style="text-align: left;">OTA升级</td>
</tr>
</tbody>
</table>
<h1>Android接口索引</h1>
<h1>一、IOTCamera</h1>
<h2>1.1 初始化接口</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_initIOTCWithLicenseKey</td>
<td style="text-align: left;">IOTC初始化</td>
</tr>
<tr>
<td style="text-align: left;">TK_unInitIOTC</td>
<td style="text-align: left;">IOTC反初始化</td>
</tr>
<tr>
<td style="text-align: left;">TK_setMasterRegion</td>
<td style="text-align: left;">P2P分区分流</td>
</tr>
<tr>
<td style="text-align: left;">TK_getIOTCameraVersion</td>
<td style="text-align: left;">获取IOTCamera版本号</td>
</tr>
<tr>
<td style="text-align: left;">TK_getIOTCAPIsVerion</td>
<td style="text-align: left;">返回IOTCAPI的版本号</td>
</tr>
<tr>
<td style="text-align: left;">TK_getAVAPIsVersion</td>
<td style="text-align: left;">返回AVAPI的版本号</td>
</tr>
<tr>
<td style="text-align: left;">TK_LanSearch</td>
<td style="text-align: left;">本地搜索设备</td>
</tr>
</tbody>
</table>
<h2>1.2 回调接口</h2>
<h3>1.2.1 P2P回调接口</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_registerIOTCListener</td>
<td style="text-align: left;">注册IOTC回调</td>
</tr>
</tbody>
</table>
<h3>1.2.2 音视频回调接口</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_registerVideoDataListeners</td>
<td style="text-align: left;">注册音视频数据回调</td>
</tr>
</tbody>
</table>
<h2>1.3 连线处理</h2>
<h3>1.3.1 P2P</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_connect</td>
<td style="text-align: left;">连线Device</td>
</tr>
</tbody>
</table>
<h3>1.3.2 共有</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_disconnect</td>
<td style="text-align: left;">断线Device,同时断开内部所有AV通道</td>
</tr>
<tr>
<td style="text-align: left;">TK_start</td>
<td style="text-align: left;">连线AV通道</td>
</tr>
<tr>
<td style="text-align: left;">TK_stop</td>
<td style="text-align: left;">断线AV通道</td>
</tr>
<tr>
<td style="text-align: left;">TK_changeAuthKey</td>
<td style="text-align: left;">修改AuthKey,返回修改后的AuthKey</td>
</tr>
<tr>
<td style="text-align: left;">TK_isSessionConnected</td>
<td style="text-align: left;">Device是否连线</td>
</tr>
<tr>
<td style="text-align: left;">TK_isChannelConnected</td>
<td style="text-align: left;">AV通道是否连线</td>
</tr>
<tr>
<td style="text-align: left;">TK_getAVChannelCount</td>
<td style="text-align: left;">获取已经开启的AV通道数</td>
</tr>
<tr>
<td style="text-align: left;">TK_getServiceTypeOfChannel</td>
<td style="text-align: left;">获取相应通道ServiceTYpe</td>
</tr>
</tbody>
</table>
<h2>1.4 视频处理</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_startShow</td>
<td style="text-align: left;">开启视频接收、解码、播放</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopShow</td>
<td style="text-align: left;">停止所有AV通道的视频接收、解码、播放</td>
</tr>
<tr>
<td style="text-align: left;">TK_getVideoCodecId</td>
<td style="text-align: left;">获取当前视频格式</td>
</tr>
<tr>
<td style="text-align: left;">TK_setAVFilter</td>
<td style="text-align: left;">是否开启解码滤镜</td>
</tr>
</tbody>
</table>
<h2>1.5 音频处理</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_startSoundToDevice</td>
<td style="text-align: left;">开始音频采集、编码、发送</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopSoundToDevice</td>
<td style="text-align: left;">停止音频采集、编码、发送</td>
</tr>
<tr>
<td style="text-align: left;">TK_startSoundToPhone</td>
<td style="text-align: left;">开始音频接收、解码、播放</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopSoundToPhone</td>
<td style="text-align: left;">停止音频接收、解码、播放</td>
</tr>
<tr>
<td style="text-align: left;">TK_startAcousticEchoCanceler</td>
<td style="text-align: left;">开启消回音功能</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopAcousticEchoCanceler</td>
<td style="text-align: left;">停止消回音功能</td>
</tr>
<tr>
<td style="text-align: left;">TK_setAcousticEchoCancelerDelaySize</td>
<td style="text-align: left;">设置消噪,消回音的参数</td>
</tr>
<tr>
<td style="text-align: left;">TK_sendAudioData</td>
<td style="text-align: left;">发送回音消除后的音频数据,一般用于第三方回音消除功能</td>
</tr>
<tr>
<td style="text-align: left;">TK_setAudioSpeakFormats</td>
<td style="text-align: left;">设置音频对讲格式、采样率等</td>
</tr>
<tr>
<td style="text-align: left;">TK_setAudioInputCodecId</td>
<td style="text-align: left;">设置音频对讲格式</td>
</tr>
<tr>
<td style="text-align: left;">TK_getAudioInputCodecId</td>
<td style="text-align: left;">获取音频对讲格式</td>
</tr>
<tr>
<td style="text-align: left;">TK_getAudioOutputCodecId</td>
<td style="text-align: left;">获取音频监听格式</td>
</tr>
</tbody>
</table>
<h2>1.6 录像与截图</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_startRecordingForChannel</td>
<td style="text-align: left;">开始录像</td>
</tr>
<tr>
<td style="text-align: left;">TK_stopRecording</td>
<td style="text-align: left;">停止录像</td>
</tr>
<tr>
<td style="text-align: left;">TK_setSnapshot</td>
<td style="text-align: left;">视频截图</td>
</tr>
</tbody>
</table>
<h2>1.7 指令发送</h2>
<h3>1.7.1 P2P</h3>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_sendIOCtrlToChannel</td>
<td style="text-align: left;">发送命令到Device</td>
</tr>
<tr>
<td style="text-align: left;">TK_sendJsonCtrlToChannel</td>
<td style="text-align: left;">发送json字串命令给设备</td>
</tr>
<tr>
<td style="text-align: left;">TK_removeAllCmd</td>
<td style="text-align: left;">清除command队列</td>
</tr>
</tbody>
</table>
<h1>二、VideoMonitor(播放器)</h1>
<h2>2.1 Method</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_attachCamera</td>
<td style="text-align: left;">为播放器绑定Camera实例</td>
</tr>
<tr>
<td style="text-align: left;">TK_deattachCamera</td>
<td style="text-align: left;">播放器解绑Camera</td>
</tr>
<tr>
<td style="text-align: left;">setScaleType</td>
<td style="text-align: left;">选择控件自动缩放方式,默认为SCALE_ASPECT</td>
</tr>
</tbody>
</table>
<h2>2.2 回调接口</h2>
<table>
<thead>
<tr>
<th style="text-align: left;">API</th>
<th style="text-align: left;">功能说明</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align: left;">TK_setMonitorListener</td>
<td style="text-align: left;">播放器状态监听</td>
</tr>
</tbody>
</table>