设备API版本V1

说明

使用前请阅读快速上手
以下使用示例中的ajax方法请查看使用示例

排期

排期重新开始

方法编码：app.schedule.restart
APP起始版本：4.3.4.5
说明：调用该方法，则app端会重新开始播放

入参

业务数据：无
入参示例

{
    methodCode:'app.schedule.restart',
    needNotify:false
}

出参

无

使用示例

ajax({methodCode:'app.schedule.restart'},function(){
})

节目

查询节目列表

方法编码：app.program.search
APP起始版本：5.1.1.1
说明：调用该方法，可以获取到APP端所有有效节目数据

入参

业务数据：无
入参示例

{
    methodCode:'app.program.search',
    needNotify:true
}

出参

业务数据

名称	字段	类型	可选	说明
节目编码	code	string	N
发布ID	notifyId	string	N
数据	data	JSON	N	参考下面数据

数据

名称	字段	类型	可选	说明
节目列表数据	data	Array	N	参考下面节目列表数据

节目列表数据

名称	字段	类型	可选	说明
节目数据	data	json string	N	参考下面节目数据

节目数据

名称	字段	类型	可选
节目id	id	string	N
节目名称	name	string	N
节目宽度	canvasWidth	string	N
节目高度	canvasHeight	string	N
节目时长	playDuration	string	N
节目简介	remark	string	N

使用示例

ajax({methodCode:'app.program.search',needNotify:true},function(res){
    // res 的结构
    { 
        code:0,
        data:{
            data:[
               // ... 节目列表数据
                {
                    code:'',
                    notifyId:'',
                    data:'{name:""}'
                }
            ]
        }
    }
})

资源

查询资源

方法编码：app.resource.search
APP起始版本：5.1.1.1
说明：调用该方法，可以获取到APP端所有有效的图片或视频资源

入参

业务数据：

名称	字段	类型	可选	说明
节目ID	programId	string	Y	查询节目中返回的节目id

入参示例

{
    methodCode:'app.resource.search',
    needNotify:true,
    data:{
        programId: 节目id
    }
}

出参

业务数据

名称	字段	类型	可选	说明
数据	data	JSON	N	参考下面数据

数据

名称	字段	类型	可选	说明
资源列表数据	data	Array	N	参考下面资源列表数据

资源列表数据

名称	字段	类型	可选	说明
类型	type	string	N	视频 video 图片 image
本地路径	localPath	string	N	访问 http://{ip}:38251/storage/get?path={localPath}
大小	size	string	N	单位是b

使用示例

ajax({
    methodCode:'app.resource.search',
    needNotify:true,
    data:{
            programId: 节目id
    }},function(res){})

视频

视频播放暂停

方法编码：app.video.pause
APP起始版本：4.3.4.5
说明：APP端正在播放视频时，调用该方法，可以暂停播放

入参

业务数据：无
入参示例

{
    methodCode:'app.video.pause',
    needNotify:false
}

出参

无

使用示例

ajax({methodCode:'app.video.pause'},function(){
})

视频播放恢复

方法编码：app.video.resume
APP起始版本：4.3.4.5
说明：APP端视频被暂停播放时，调用该方法，可以恢复播放

入参

业务数据:无
入参示例

{
    methodCode:'app.video.resume',
    needNotify:false
}

出参

无

使用示例

ajax({methodCode:'app.video.resume'},function(){
})

获取视频播放状态

方法编码：app.video.getStatus
APP起始版本：4.3.4.5
说明：调用该方法获取视频的当前播放状态

入参

业务数据:无
入参示例

{
    methodCode:'app.video.getStatus',
    needNotify:true
}

出参

业务数据

名称	字段	类型	可选	说明
视频播放状态	status	number	N	在播放：1，未播放：2

使用示例

ajax({methodCode:'app.video.getStatus',needNotify:true},function(res){
    let status = res.data.status;
    if(status == 1){
        // todo 处理正在播放的业务
    }else{
        // todo 处理未在播放的业务
    }
})

设置视频播放进度

方法编码：app.video.setProgress
APP起始版本：4.3.4.5
说明：调用该方法设置视频的播放进度，在视频当前播放进度下，快进或快退。快进时，当设置的进度时长超过视频时长，则播放下一个视频，若没有下一个视频，则重新播放当前视频。快退时，当设置的进度时长超过视频时长，则重新播放当前视频。

入参

业务数据

名称	字段	类型	可选	说明
进度时长	time	number	N	单位是毫秒，正数是快进，负数是快退

入参示例

{
    methodCode:'app.video.setProgress',
    data:{
        time:10000  // 快进10秒。  值是-10000 时代表快退10秒。
    }
}

出参

业务数据:无

音量

音量开关[暂不开放]

方法编码：device.volume.switch
APP起始版本：4.3.4.5
说明：调用该方法，可以控制设备声音开启和关闭

入参

业务数据

名称	字段	类型	可选	说明
音量开关状态	status	number	N	打开：1，关闭：2

入参示例

{
    methodCode:'device.volume.switch',
    needNotify:false,
    data:{
        status:1
    }
}

出参

无

使用示例

ajax({methodCode:'device.volume.switch',data:{status:1}},function(){
})

音量调整

方法编码：device.volume.set
APP起始版本：4.3.4.5
说明：调用该方法，可以控制设备音量大小

入参

业务数据

名称	字段	类型	可选	说明
音量大小	volume	number	N	0-100，数字越大声音越大，数字越小声音有效

入参示例

{
    methodCode:'device.volume.set',
    needNotify:false,
    data:{
        volume:50
    }
}

出参

无

使用示例

ajax({methodCode:'device.volume.set',data:{volume:50}},function(){
})

屏幕截图

方法编码：device.screenshot
APP起始版本：4.3.4.5
说明：调用该方法，可以实时截取屏幕画面

入参

业务数据:无
入参示例

{
    methodCode:'device.screenshot',
    needNotify:true
}

出参

业务数据

名称	字段	类型	可选	说明
截图链接	url	string	N

使用示例

ajax({methodCode:'device.screenshot',needNotify:true},function(res){
    let url = res.data.url;
    // todo 屏幕截图的图片地址 url
})

播放模式

模式	说明
自动播放模式	按照发布的排期播放
手控播放模式	需要手动选择图片或视频播放

获取播放模式

方法编码：app.playModel.get
APP起始版本：5.1.1.1
说明：调用该方法，可以获取当前播放模式。

入参

业务数据无
入参示例

{
    methodCode:'app.playModel.get',
    needNotify:true
}

出参

|名称|字段|类型|可选|说明|
|--|--|--|--|--|
|播放模式|model|number|N| 自动播放 1 手控播放2  |

使用示例

ajax({methodCode:'app.playModel.get',needNotify:true},function(res){

})

设置播放模式

方法编码：app.playModel.set
APP起始版本：5.1.1.1
说明：调用该方法，可以切换播放模式。

入参

业务数据

名称	字段	类型	可选	说明
播放模式	model	number	N	自动播放 1 手控播放2

入参示例

{
    methodCode:'app.playModel.set',
    needNotify:false,
    data:{
        model:1
    }
}

出参

无

使用示例

ajax({methodCode:'app.playModel.set',data:{model:1}},function(){
})

播放资源

方法编码：app.media.play
APP起始版本：5.1.1.1
说明：调用该方法，手控播放模式时，可以选择图片或视频播放。

入参

业务数据

名称	字段	类型	可选	说明
资源类型	type	string	N	图片 image 视频 video
本地路径	localPath	string	N

入参示例

{
    methodCode:'app.media.play',
    needNotify:false,
    data:{
        type:'image',
        localPath:'本地图片路径'
    }
}

出参

无

使用示例

ajax({methodCode:'app.media.play',needNotify:false,data:{type:'image',localPath:'本地图片路径'}},function(){
})

说明​

排期​

排期重新开始​

入参​

出参​

使用示例​

节目​

查询节目列表​

入参​

出参​

使用示例​

资源​

查询资源​

入参​

出参​

使用示例​

视频​

视频播放暂停​

入参​

出参​

使用示例​

视频播放恢复​

入参​

出参​

使用示例​

获取视频播放状态​

入参​

出参​

使用示例​

设置视频播放进度​

入参​

出参​

音量​

音量开关[暂不开放]​

入参​

出参​

使用示例​

音量调整​

入参​

出参​

使用示例​

屏幕截图​

入参​

出参​

使用示例​

播放模式​

获取播放模式​

入参​

出参​

使用示例​

设置播放模式​

入参​

出参​

使用示例​

播放资源​

入参​

出参​

使用示例​

说明

排期

排期重新开始

入参

出参

使用示例

节目

查询节目列表

入参

出参

使用示例

资源

查询资源

入参

出参

使用示例

视频

视频播放暂停

入参

出参

使用示例

视频播放恢复

入参

出参

使用示例

获取视频播放状态

入参

出参

使用示例

设置视频播放进度

入参

出参

音量

音量开关[暂不开放]

入参

出参

使用示例

音量调整

入参

出参

使用示例

屏幕截图

入参

出参

使用示例

播放模式

获取播放模式

入参

出参

使用示例

设置播放模式

入参

出参

使用示例

播放资源

入参

出参

使用示例