播放盒开放接口
    播放盒开放接口
    • API接入指南
    • 状态码列表
    • 常见问题
    • 用户相关
      • 登录设备
        POST
      • 登出设备
        DELETE
      • 修改用户信息
        PUT
    • 系统控制相关
      • 设备截图
        GET
      • 设备立即重启
        POST
      • 获取设备定时重启策略
        GET
      • 设置设备定时重启策略
        POST
      • 设置时间
        POST
      • 安装App
        PUT
      • 获取时间
        GET
      • 恢复出厂设置
        PUT
      • 获取终端信息
        GET
      • 获取音量
        GET
      • 设置音量
        POST
      • 设备升级
        PUT
      • 检查本地升级状态
        GET
    • 显示屏控制相关
      • 接收卡相关
        • 获取接收卡的连接信息
        • 获取接收卡的监控信息
        • 获取接收卡基本信息
        • 接收卡点屏(下发.rcfgx文件)
        • 接收卡配屏(下发.scr文件)
        • 接收卡升级
        • 获取接收卡升级进度
      • 发送卡相关
        • 获取发送卡基本信息
      • 获取显示屏亮度
        GET
      • 设置显示屏亮度
        POST
      • 获取显示屏屏幕状态
        GET
      • 设置显示屏屏幕状态
        POST
      • 获取屏幕定时开关策略
        GET
      • 设置屏幕定时开关策略
        POST
      • 设置定时亮度策略
        POST
      • 获取定时亮度策略
        GET
    • 通用能力
      • 上传文件
      • 下载文件
    • 串口控制
      • 启用485串口功能
      • 获取485串口状态
    • 本板继电器
      • 获取本板继电器信息
      • 设置本板继电器信息

    API接入指南

    引言#

    本指南旨在帮助开发者快速、顺利地接入播放盒的 API 服务,本 API 使用 HTTP 协议。通过本 API,您可以将我们的播放盒能力集成到您的应用、系统中,提升业务效率。本文将详细介绍 API 的功能、支持的设备能力范围、接入准备及步骤、以及业务流程示例,以帮助您快速上手。我们希望这份文档能为您提供有价值的参考和帮助。如有任何疑问,欢迎随时与我们沟通交流。

    平台功能#

    播放盒系统控制能力
    LED显示屏的控制能力
    播放盒外设控制能力
    更多接口能力持续更新中...

    支持设备范围#

    播放盒产品:T30/T50/TB30/TB40/TB50/TB60、TB1-4G/TB2-4G、LCB4K、LCB2K、TCC160/TCC70、TB20Plus、TB10Plus、TU40Pro、TU4K/TU4KPro
    更多产品持续更新中...

    接入步骤#

    企业微信截图_17243253167686.png
    1
    搜索设备
    调用我们提供的搜索库接口,来获取到局域网内所有的设备
    说明:搜索主要是为了获取到设备的SN和设备的IP,如果已知SN和IP,可以跳过此步骤;
    我们使用https协议,固定端口号为16674
    搜索到设备后会通过接口回调设备信息,回复数据内容格式如下:
    参数名类型说明
    snstring产品序列号
    productNamestring产品名称
    widthint显示屏宽度, 单位为像素
    heightint显示屏高度, 单位为像素
    rotationint旋转角度:0,90,180,270
    aliasNamestring显示屏别名
    loginedboolean是否有人已经登陆
    - loginedUsernamesstring array已经登陆的用户名列表
    tcpPortinttcp连接端口
    ftpPortintftp连接端口
    syssetFtpPortint系统设置ftp端口
    syssetTcpPortint系统设置tcp端口
    terminalEntrancePortHttpsinthttps请求端口
    terminalEntrancePortWebSocketintwebsocket端口
    keystring终端返回的key
    platformstring系统平台信息
    privacybooleanTrue表示终端支持加密模式
    ipstring设备ip
    回复包Json示例:
    2
    登录设备
    当搜索到设备后,可以通过设备IP和端口号,向设备发起请求,但是在发起业务请求先,需要先进行登录设备,获取到token信息,具体代码可以参考Demo项目。
    3
    业务请求
    当登录设备,获取到设备下发的token之后,我们就可以携带token信息对设备发起请求了,具体代码可以参考Demo项目。
    Android版本说明
    1.首先请将so库放入libs目录下
    image.png
    2.配置build.gradle文件和AndroidManifest文件
    (1)build.gradle文件中配置引入设备搜索so库(该文件gradle语法可能存在差异,请结合对应语法进行修改)
    (2)AndroidManifest文件中配置网络权限
        <uses-permission android:name="android.permission.INTERNET" />
    3.编写JNA接口(以下代码可直接复制)
    4.调用搜索设备接口
    Java版本说明
    1.依赖
    ①首先请将动态库放在对应位置
    Liunx使用so库,放在resources/linux-x86-64/
    Windows使用dll,放在resources/
    企业微信截图_17286471391935.png
    ②将jna-5.6.0.jar包放置在lib目录下
    企业微信截图_17286471994738.png
    2.依赖配置
    (1)在pom.xml引入jna-5.6.0.jar包依赖
       <dependency>
           <groupId>com.sun</groupId>
           <artifactId>jna</artifactId>
           <version>1.0-SNAPSHOT</version>
           <scope>system</scope>
           <systemPath>${project.basedir}/lib/jna-5.6.0.jar</systemPath>
       </dependency>
    注:如果该方法无法引用到jar包,可以执行该命令
    将依赖安装到自己的仓库中,然后用以下方式引用即可
            <dependency>
                <groupId>com.sun</groupId>
                <artifactId>jna</artifactId>
                <version>1.0-SNAPSHOT</version>
            </dependency>
    3.编写JNA接口(以下代码可直接复制)
    4.调用搜索设备接口
    ①异步
    ②同步
    5.系统版本限制
    ①Windows:
    最低 window xp
    ②Linux:
    最低 glibc 版本大于2.19的 发行版本
    最低 Ubuntu 14.04.4 X86_64
    最低 CentOS7 X86_64

    Demo下载#

    Android Demo
    点击下载Android版Demo
    Java Demo
    点击下载PC端Java Demo
    More Demo
    更多Demo持续更新中...
    修改于 2025-04-24 06:08:53
    下一页
    状态码列表
    Built with