leCast

概述

乐播简介

乐播投屏,是一款移动设备（手机/平板等）连接大屏终端（电视、盒子、投影、VR等智能设备）的多屏互动工具，可以实现将移动设备的内容无线投送（可镜像）到大屏终端，达到手机操控电视玩游戏（不改变游戏操作体验）、看电影、听音乐、分享照片等，适合玩大屏游戏、开会办公、视频推送、影音共享、亲子互动等场景 leCast 插件概述

本插件封装了乐播开放平台的原生 SDK，集成了跨屏游戏高清、实时地将手游投到电视上，体验大屏手游的快感和刺激感。会议演示一部手机随时召集会议，让会议操作流程简化，效率更高。视频点播将手机上的任意影像投在电视屏上，与家人一起互动。音乐共享不需要华丽音响，就可以把无线音乐响彻整个house。图片分享朋友聚会聊天，将手机中的照片投到大屏，和朋友们分享照片故事。车载导航将手机中的信息传达到导航屏上，方便操控，安全驾驶。电脑投屏将电脑屏幕，电脑文档投屏至会议室大屏幕中，投屏开会或演示。

插件使用攻略

使用之前须从乐播开放平台申请开发者账号并创建应用，获取 Key 和 secret。leCast 插件优化了乐播插件的投屏、镜像功能。**

乐播平台接入流程参考[乐播平台接入文档]

使用此插件之前建议先配置 config.xml 文件，配置完毕，需通过云端编译生效，配置方法如下：

名称：leCast
参数：lecastKey、lecastSecret、ios_lecastKey、ios_lecastSecret
配置示例:

  <feature name="leCast">
        <param name="lecastKey" value="10723" />
        <param name="lecastSecret" value="365538c26afc0c8ecfceb94d10171a9a" />
        
       <param name="ios_lecastKey" value="11508" />
       <param name="ios_lecastSecret" value="9953428d6a3ca4a842c641814c28c7b3" />
    </feature>

字段描述:

lecastKey：（必须配置）从乐播开放平台获取的 key。key 申请方法参考乐播开放平台接入文档。

lecastSecret：（必须配置）从乐播开放平台获取的 secret。secret 申请方法参考乐播开放平台接入文档。

ios_lecastKey：（必须配置）从乐播开放平台获取的 key。key 申请方法参考乐播开放平台接入文档。

ios_lecastSecret：（必须配置）从乐播开放平台获取的 secret。secret 申请方法参考乐播开放平台接入文档。

Android 系统平台上需注意事项请参考乐播集成注意事项

插件接口

initLeCast

initLeCast(); //插件初始化方法，必须在所有方法调用前调用

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.initLeCast();

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

browse

搜索附近的接收端设备

browse({params}, callback(ret, err))

params

var param = {browseType:0};

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    status: true   //布尔型；true||false
}

err：

类型：JSON 对象
内部字段：

{
    deviceList：设备列表数组
        name:接收端设备名称
        ip：接收端ip,以下大部分接口用ip代表一个接收端设备
        isOnLine：代表设备是否在线（指设备是否能连接到）; 1为在线，0为不在线
        isConnect：代表该设备是否已经连接。 1为已连接，0为没连接。
        uid：设备的id，
        type：设备类型
}

示例代码

var uid1=""；
var leCastDemo = api.require('leCast');
leCastDemo.browse(param, function(ret, err){
    console.log(JSON.stringify(ret));
  uid1=(ret.deviceList)[0]["ip"];
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

stopBrowse

停止搜索附近的接收端设备因为browse方法会不停的搜索，所以要在适当的时候调用stopBrowse方法

stopBrowse(callback(ret, err))

ret：

类型：JSON 对象
内部字段：

{
    result: 1   //数字型；1||0
}

err：

类型：JSON 对象
内部字段：

{
    result: 0     //数字类型；
                //0（未知错误）
                //1（成功）
}

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.stopBrowse( function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

connect

通过ip连接接收端设备

connect({params}, callback(ret, err))

params

serviceInfoIp：

类型：字符串
描述：传入ip。 var param = {serviceInfoIp:uid1};//传入Ip

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    status: true   //布尔型；true||false
}

err：

类型：JSON 对象
内部字段：

返回字段说明：
  {result:1
  isPin：是否是pin码连接
  deviceName：设备名称
  type：设备类型
  deviceUid：设备uid
  deviceIp:设备ip
  canPlayLocalVideo：是否能播放本地视频
  canPlayLocalPhoto：是否能播放本地图片
  canPlayLocalAudio：是否能播放本地音乐
  canPlayOnlieVideo：是否能播放网络视频
  canPlayOnliePhoto：是否能播放网络图片
  canPlayOnlieAudio：是否能播放网络音乐
   msg：错误信息(result为0时有)，分别是以下其中之一：连接失败，等待确认，连接拒绝，连接超时，连接黑名单
  }

示例代码

var leCastDemo = api.require('leCast');
var param = {serviceInfoIp:uid1};//传入Ip
leCastDemo.connect(param, function(ret, err){
    alert(JSON.stringify(ret));
});

补充说明

通过ip连接接收端设备，必须先调用browse方法获取ip，该方法为耗时方法(需要一定时间才能回调)

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

QRconnect

通过二维码连接接收端设备

QRconnect({params}, callback(ret, err))

params

qrCode：

类型：字符串
描述：（必填项）从二维码扫描出来的字符串，开发者可用apicloud上任意一个扫描二维码的插件扫描二维码，将扫描结果传入该字段。

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    status: true   //布尔型；true||false
}

err：

类型：JSON 对象
内部字段：

  返回字段说明：
  {result:1
  isPin：是否是pin码连接
  deviceName：设备名称
  type：设备类型
  deviceUid：设备uid
  deviceIp:设备ip
  canPlayLocalVideo：是否能播放本地视频
  canPlayLocalPhoto：是否能播放本地图片
  canPlayLocalAudio：是否能播放本地音乐
  canPlayOnlieVideo：是否能播放网络视频
  canPlayOnliePhoto：是否能播放网络图片
  canPlayOnlieAudio：是否能播放网络音乐
   msg：错误信息(result为0时有)，分别是以下其中之一：连接失败，等待确认，连接拒绝，连接超时，连接黑名单
  }

示例代码

var leCastDemo = api.require('leCast');
var param = {qrCode:"http://sl.hpplay.cn/c75bG"};//传入二维码扫描结果  http://sl.hpplay.cn/c75bG
leCastDemo.QRconnect(param,function(ret, err){//连接回调
    alert(JSON.stringify(ret));
    uid1=ret.deviceIp;//保存已连接的ip，断开时用到
});

补充说明

通过二维码连接接收端设备，该方法为耗时方法(需要一定时间才能回调)

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

pinConnect

通过pin码连接

pinConnect({params}, callback(ret, err))

params

pinCode：

类型：字符串
描述：必填项，pin码是乐播的概念，为9位字符串。

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    status: true   //布尔型；true||false
}

err：

类型：JSON 对象
内部字段：

返回字段说明：
  {result:1
  isPin：是否是pin码连接
  deviceName：设备名称
  type：设备类型
  deviceUid：设备uid
  canPlayLocalVideo：是否能播放本地视频
  canPlayLocalPhoto：是否能播放本地图片
  canPlayLocalAudio：是否能播放本地音乐
  canPlayOnlieVideo：是否能播放网络视频
  canPlayOnliePhoto：是否能播放网络图片
  canPlayOnlieAudio：是否能播放网络音乐
   msg：错误信息(result为0时有)，分别是以下其中之一：连接失败，等待确认，连接拒绝，连接超时，连接黑名单
  }

示例代码

var leCastDemo = api.require('leCast');
var param = {pinCode:"xxxxxxxx"};//传入pin码
leCastDemo.pinConnect(param,function(ret, err){//连接回调
    alert(JSON.stringify(ret));
    uid1=ret.deviceIp;//保存已连接的ip，断开时用到
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

disConnect

断开连接

disConnect({params}, callback(ret, err))

params

serviceInfoIp：

类型：字符串
描述：必填项，连接时用的ip。

callback(ret, err)

ret：

类型：JSON 对象

返回字段说明：
          {result:1
          isPin：是否是pin码连接
          deviceName：设备名称
          deviceUid：设备uid
           msg：错误信息(result为0时有)
          }

示例代码

var leCastDemo = api.require('leCast');
var param = {serviceInfoIp:uid1};//传入Ip
leCastDemo.disConnect(param,function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

getConnectLelinkServiceInfos

获取已经连接的设备

getConnectLelinkServiceInfos(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

返回字段说明：
          {result:1
          deviceList:[{"name":"xxx"}]
          }
            deviceList：设备列表数组
            name:接收端设备名称
            ip：接收端ip
            isOnLine：代表设备是否在线（指设备是否能连接到）; 1为在线，0为不在线
            isConnect：代表该设备是否已经连接。 1为已连接，0为没连接。
            uid：设备的id
            type：设备类型

err：

类型：JSON 对象
内部字段：

{

}

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.getConnectLelinkServiceInfos( function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

startMirror

开始镜像，该方法为耗时方法(需要一定时间才能回调)，调用该方法前必须先连接设备

startMirror({params}, callback(ret, err))

params

connectedTargetIp：必填项,已连接的设备的ip

resolutionLevel：分辨率:选填项，数字型，1高，2中，3自动,默认2

bitrateLevel：比特率：选填项，数字型，4高，5中，6低,默认5

isAudioEnnable：是否开启声音，选填项，数字型，1开启，0关闭,默认0

screenCode：字符串，投屏码，有些设备需要投屏码才能播放，没有则不传，或传""

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  result:1
    msg:错误信息(result为0时有)
}

示例代码

var leCastDemo = api.require('leCast');
var param = {
connectedTargetIp:uid1,//已连接的设备的ip
resolutionLevel:1,//分辨率:数字型，1高，2中，3自动
bitrateLevel:5,//比特率：数字型，4高，5中，6低
isAudioEnnable:1,//数字型，1开启，0关闭
screenCode:"",//如果接收端需要投屏码请加上该字段
};
leCastDemo.startMirror(param,function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

stopMirror

结束镜像

stopMirror(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  result: 1,      //数字型；1||0
}

err：

类型：JSON 对象
内部字段：

{
  result: 0,      //数字型；1||0
}

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.stopMirror(function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

play

播放媒体，该方法为耗时方法(需要一定时间才能回调)

play({params}, callback(ret, err))

params

directPlay:1,//是否直接播放，1无需连接设备直接播放，但需要先搜索设备，0需连接设备(默认) connectedTargetIp:uid1,//直接播放的设备的ip(需要先搜索获取)，directPlay为1时该字段必须要传 screenCode:"",//有些屏幕需要投屏码的就要传，可选项 mediaType:2,//媒体类型：数字型，1音乐,2视频，3图片，必填 localUrl:"",//本地媒体路径，支持widget://,fs://,安卓系统标准文件路径 netUrl:NET_VIDEO_URL,//网络文件路径,http://... //以上这两个url必须要传一个，两个都传时只认localUrl

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
    result:0//为0时为调用方法或逻辑错误，相应的有msg字段信息提示
    以下是播放中(包括镜像相关的状态)各个状态的返回值描述，
    左边已status字段返回，右边以msg返回
    1：正在加载
    2：正在播放
    3：暂停播放
    4：播放完成
    5：播放结束
    6：设置进度完成
    7：文件不存在
    8：IM TV不在线
    9：图片错误
    10：IM不支持的媒体类型
    11：未知
    12：不支持镜像
    13：镜像权限拒绝
    14：设备不支持镜像
    15：请输入投屏码
    16：获取镜像信息出错
    17：获取镜像端口出错
    18：请输入投屏码
    19：播放无响应
    20： 退出播放无响应
    21：暂停无响应
    22：请输入投屏码
    23：恢复无响应
    24：音量变化成功
    25：播放进度已更新
}

err：

类型：JSON 对象
内部字段：

{
    result: 0     //数字类型；
                //错误码：0
}

示例代码

var leCastDemo = api.require('leCast');
var param = {
directPlay:0,//是否直接播放，1无需连接设备直接播放(但需要先搜索)，0需连接设备(默认)
connectedTargetIp:uid1,//直接播放的设备的ip(需要先搜索获取)，directPlay为1时该字段必须要传
screenCode:"237-746-544",//有些屏幕需要投屏码的就要传，可选项
mediaType:2,//媒体类型：数字型，1音乐,2视频，3图片
localUrl:"",//本地媒体路径，支持fs://,安卓系统标准文件路径
netUrl:NET_VIDEO_URL,//网络文件路径,http://...
//这两个url必须要传一个，两个都传时只认localUrl
};
leCastDemo.play(param,function(ret, err){
if(ret.status!=25){//播放进度已更新不弹窗，避免弹窗过多
    alert(JSON.stringify(ret));
}

});

补充说明

该方法为耗时方法(需要一定时间才能回调)

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

pause

暂停播放媒体，返回值参考play方法

pause(callback(ret, err))

callback(ret, err)

ret：# 返回值参考play方法

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.pause(function(ret, err){
        alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

shareMutableImg

恢复播放媒体，返回值参考play方法

resume(callback(ret, err))

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.resume(function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的4.0.0及更高版本

stop

停止播放媒体，返回值参考play方法

stop(callback(ret))

callback

返回值参考play方法

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.stop(function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

Android系统

可提供的1.0.6及更高版本

seekTo

播放进度控制，进度，数字型，单位为秒

startMirror({params}, callback(ret, err))

params

progress:10,//进度，数字型，单位为秒

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  result:1
    msg:错误信息(result为0时有)
}

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.seekTo(param,function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

addVolume

增加音量

addVolume(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  result:1
    msg:错误信息(result为0时有)
}

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.addVolume(function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

subVolume

减少音量

subVolume(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  result:1
    msg:错误信息(result为0时有)
}

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.subVolume(function(ret, err){
    alert(JSON.stringify(ret));
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

isSupportDanmuku

是否支持弹幕

isSupportDanmuku(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  result:1
    msg:错误信息(result为0时有)
}

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.isSupportDanmuku(function(ret, err){
    alert(JSON.stringify(ret));//返回值result数字型，1支持，0不支持
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

setInteractiveAdListener

设置广告监听

setInteractiveAdListener(callback(ret, err))

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  result:1
    msg:错误信息(result为0时有)
}

示例代码

var leCastDemo = api.require('leCast');
leCastDemo.setInteractiveAdListener(function(ret, err){
    alert(JSON.stringify(ret));//返回值result数字型，1支持，0不支持
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

onInteractiveAdShow

广告播放上报

onInteractiveAdShow({params}, callback(ret, err))

params

status:1,//上报状态值，数字型，1成功，0失败

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  result:1
    msg:错误信息(result为0时有)
}

示例代码

var leCastDemo = api.require('leCast');
var param = {
    status:1,//上报状态值，数字型，1成功，0失败
};
leCastDemo.onInteractiveAdShow(param,function(ret, err){
    alert(JSON.stringify(ret));//1上报成功
});

可用性

iOS系统，Android系统可提供的4.0.0及更高版本

onInteractiveAdClosed

广告播放完成上报

onInteractiveAdClosed({params}, callback(ret, err))

params

status:1,//上报状态值，数字型，1成功，0失败 duration:5//广告播放时长,应该是秒为单位

callback(ret, err)

ret：

类型：JSON 对象
内部字段：

{
  result:1
    msg:错误信息(result为0时有)
}

示例代码

var leCastDemo = api.require('leCast');
var param = {
            status:1,//上报状态值，数字型，1成功，0失败
            duration:5//广告播放时长,应该是秒为单位
};
leCastDemo.onInteractiveAdClosed(param,function(ret, err){
    alert(JSON.stringify(ret));//1上报成功
});

可用性

iOS系统，Android系统

可提供的4.0.0及更高版本

是否仍需要帮助？请保持联络！

最后更新于 2024/04/24