API 参考

本节简述不同 API 模块的接口功能。

Runtime API

许可管理 API。提供许可登录、查看许可、许可加解密等接口。

函数名 描述
dna_init 初始化函数,调用所有Runtime API必须先调用此函数进行初始化
dna_find_license 查找所有许可
dna_get_cloud_token 枚举已登录的用户token
dna_login 登录许可
dna_logout 许可登出
dna_keep_alive 保持登录会话心跳
dna_encrypt 许可加密,相同的许可ID相同的开发者加密结果相同
dna_decrypt 许可解密,相同的许可ID相同的开发者加密结果相同
dna_user_data_getsize 获得许可的数据区大小
dna_user_data_read 读许可数据,可以读取RAW和ROM
dna_user_data_write 写许可的读写数据区
dna_execute_dynamic 许可动态执行代码
dna_mem_alloc 内存托管内存申请
dna_mem_free 释放托管内存
dna_mem_read 内存托管读
dna_mem_write 内存托管内存写入
dna_is_debug 检测是否正在调试
dna_adjust_time_request 获取时间修复数据,用于生成时钟校准请求
dna_get_version 获得runtime库和SS的版本信息.
dna_free 释放API生成的缓冲区
dna_check_module 检查模块区
dna_error_format 通过错误码获得错误信息
dna_cleanup 反初始化函数,与dna_init对应

Control API

提供许可遍历、SS服务遍历查看等接口。

函数名 描述
get_all_server 获取所有服务
get_all_description 获取所有设备描述
get_local_description 获取本地设备数组
get_remote_description 获取本地设备数组
license_id 获取指定设备描述下的所有许可ID
get_pub_size 读取公开区大小
dna_read_pub_data 读取用户公开内容
license_context 获得许可详细信息
dna_kick_session 踢除指定的许可会话
dna_clear_history 清理历史记录
get_device_info 获得设备信息
get_filelist_info 获得所内文件信息
dna_ctrl_verify_device 获取已登录许可的设备证书
dna_client_close 关闭客户端IPC句柄
dna_free 释放API生成的缓冲区
get_service_type 获取服务类型
ss_set_service_type 获取服务类型
dna_ctrl_bind_or_unbind 绑定或解绑请求
dna_ctrl_store_cert 存储证书
get_account_info 获取账号信息
dna_ctrl_refresh_license 刷新许可缓存
get_cloud_token 枚举已登录的用户token

错误码

定义接口返回值的编码及对应错误描述信息。