uimusic

论坛示例

为帮助用户更好更快的使用插件,论坛维护了一个示例,示例中包含示例代码供您参考。

概述

uimusic 封装了带音乐界面的音乐播放功能。

固件要求

Android:4.0及以上 iOS:8.0及以上

插件接口

playMusic

播放本地视频、网络音乐

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

params

musics:

  • 类型: 数组对象
  • 描述:(必填项)插件的位置及尺寸
  • 内部字段:
[{
    name: 0,   //(必填项)字符串;音乐名称
    filename: 0,   //(必填项)字符串;音乐播放地址,支持http:// fs:// widget://
    singer: 320, //(必填项)字符串;演唱者
    icon: 250  //(必填项)字符串;音乐图片 图片像素300*300为最佳,支持http:// fs:// widget://,
    background : "#800080", //背景颜色代码
    other : 2, //自定义属性值,可以是你自己的主键id
    fenxiangSum : 55,//分享数量
    downmusicSum : 66,//下载数量
    pinglunSum : 233,//评论数量
},
{
    name: 0,   //(必填项)字符串;音乐名称
    filename: 0,   //(必填项)字符串;音乐播放地址,支持http:// fs:// widget://
    singer: 320, //(必填项)字符串;演唱者
    icon: 250,  //(必填项)字符串;音乐图片 图片像素300*300为最佳,支持http:// fs:// widget://
    background : "#800080", //背景颜色代码
    other : 2, //自定义属性值,可以是你自己的主键id
    fenxiangSum : 55,//分享数量
    downmusicSum : 66,//下载数量
    pinglunSum : 233,//评论数量
}]

ttf:

  • 类型:字符串
  • 描述:(可选项)字体文件(仅支持widget://路径)。

downmusicBtn:

  • 类型:布尔型
  • 描述:(可选项)是否显示下载按钮。
  • 默认值: true

fenxiangBtn:

  • 类型:布尔型
  • 描述:(可选项)是否显示分享按钮。
  • 默认值: true

pinglunBtn:

  • 类型:布尔型
  • 描述:(可选项)是否显示评论按钮。
  • 默认值: true

nameTextSize:

  • 类型:数值型
  • 描述:(可选项)歌曲名称字体大小。
  • 默认值: 20

singerTextSize:

  • 类型:数值型
  • 描述:(可选项)歌曲演唱者字体大小。
  • 默认值: 10

isShowUi:

  • 类型:布尔型
  • 描述:(可选项)是否默认打开UI界面。
  • 默认值: true

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var demo = api.require('uimusic');
demo.playMusic({
    musics: [{
        name: "小苹果1(在线)",
        filename: "http://7xwc0t.com1.z0.glb.clouddn.com/apicloud/619a3762a2be7650c4345c1d7c23575e.mp3",
        singer: "筷子兄弟",
        icon: "http://7xwc0t.com1.z0.glb.clouddn.com/apicloud/3a3d926564ab4c5b2292744d5ffb0ec6.jpg",
        other : 1,
         fenxiangSum : 55,
         downmusicSum : 66,
         pinglunSum : 233,
         background : "#800080"
    },
    {
        name: "小苹果2(在线)",
        filename: "http://7xwc0t.com1.z0.glb.clouddn.com/apicloud/28643b3e661abe4dfb3da33f2d1e2b59.mp3",
        singer: "筷子兄弟",
        icon: "http://7xwc0t.com1.z0.glb.clouddn.com/apicloud/7c23cd15fc8fe841ab20f6c87d47ae59.jpg",
        other : 2,
         fenxiangSum : 55,
         downmusicSum : 66,
         pinglunSum : 233,
         background : "#800080"
    },
    {
        name: "小苹果3(本地)",
        filename: "widget://res/MP3s/120125029.mp3",
        singer: "筷子兄弟",
        icon: "widget://res/Images/1.jpg",
        other : 3,
         fenxiangSum : 55,
         downmusicSum : 66,
         pinglunSum : 233,
         background : "#800080"
    },
    {
        name: "传奇4(本地)",
        filename: "widget://res/MP3s/10405520.mp3",
        singer: "王菲",
        icon: "widget://res/Images/nanquan.jpg",
        other : 4,
         fenxiangSum : 55,
         downmusicSum : 66,
         pinglunSum : 233,
         background : "#800080"
    }],
    ttf : "widget://res/UKIJTor.ttf",
    downmusicBtn : true,
    fenxiangBtn : false,
    pinglunBtn : true,
    nameTextSize : 20,
    singerTextSize : 10
},
function(ret, err) {
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

showUI

显示播放界面

showUI(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var obj = api.require('uimusic');
obj.showUI(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

closeUI

隐藏播放界面

closeUI(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var obj = api.require('uimusic');
obj.closeUI(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addEventListener

音乐界面按钮监听

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

params

name:

  • 类型:字符串
  • 描述:(必填项)监听事件类型>>隐藏播放器界面:closeui 评论按钮:pinglun 分享按钮:fenxiang 下载按钮:downmusic

## callback(ret, err)

ret:

- 类型:JSON对象
- 内部字段:

```js
{
    status: true,   //布尔型;true||false
    index : 0,     //当前播放音乐数组索引序号 (仅评论,分享,下载才返回)
    title : '',   //当前音乐标题
    url : '',     //当前音乐播放路径
    pic : '',    //当前音乐图片
    other : ''   //当前音乐自定义属性值(可以是自己的主键id)
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var demo = api.require('uimusic');
demo.addEventListener({
    name: "closeui"
},
function(ret, err) {
    demo.closeUI();
    alert("closeui>>addEventListener|" + JSON.stringify(ret));
});
demo.addEventListener({
    name: "pinglun"
},
function(ret, err) {
    demo.closeUI();
    alert("pinglun>>addEventListener|" + JSON.stringify(ret));
});
demo.addEventListener({
    name: "fenxiang"
},
function(ret, err) {
    demo.closeUI();
    alert("fenxiang>>addEventListener|" + JSON.stringify(ret));
});
demo.addEventListener({
    name: "downmusic"
},
function(ret, err) {
    demo.closeUI();
    alert("downmusic>>addEventListener|" + JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addMusic

添加播放音乐

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

params

data:

  • 类型:json对象
  • 描述:(必填项)待播放音乐信息
{
    name: 0,   //(必填项)字符串;音乐名称
    filename: 0,   //(必填项)字符串;音乐播放地址,支持http:// fs:// widget://
    singer: 320, //(必填项)字符串;演唱者
    icon: 250,  //(必填项)字符串;音乐图片 图片像素300*300为最佳,支持http:// fs:// widget://
    background : "#800080", //背景颜色代码
    other : 2, //自定义属性值,可以是你自己的主键id
    fenxiangSum : 55,//分享数量
    downmusicSum : 66,//下载数量
    pinglunSum : 233,//评论数量
}

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    index : 0,     //当前播放音乐数组索引序号 (仅评论,分享,下载才返回)
    title : '',   //当前音乐标题
    url : '',     //当前音乐播放路径
    pic : '',    //当前音乐图片
    other : ''   //当前音乐自定义属性值(可以是自己的主键id)
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var demo = api.require('uimusic');
demo.addMusic({
    data : {
        name : "小苹果3666(widget://)",
        filename : "widget://res/MP3s/cemo111.mp3",
        singer : "666666",
        icon : "widget://res/Images/1.jpg",
        other : 5,
        fenxiangSum : 3,
        downmusicSum : 33,
        pinglunSum : 44,
        background : "#DDA0DD"
    }
}, function(ret, err) {
    alert("addMusic|" + JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

selectMusic

通过数组序号播放音乐

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

params

index:

  • 类型:数字型
  • 描述:(必填项)待播放音乐信息的序号(备注:other传值时为非必填项)

other:

  • 类型:字符型
  • 描述:(必填项)自定义属性值,可以是自己的主键id(备注:index传值时为非必填项)

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    index : 0,     //当前播放音乐数组索引序号 (仅评论,分享,下载才返回)
    title : '',   //当前音乐标题
    url : '',     //当前音乐播放路径
    pic : '',    //当前音乐图片
    other : ''   //当前音乐自定义属性值(可以是自己的主键id)
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var demo = api.require('uimusic');
demo.selectMusic({
    index : 3
}, function(ret, err) {
    alert("selectMusic|" + JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getCurrentPlayer

获取当前正在播放的音乐

getCurrentPlayer(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true,   //布尔型;true||false
    index : 0,     //当前播放音乐数组索引序号 (仅评论,分享,下载才返回)
    title : '',   //当前音乐标题
    url : '',     //当前音乐播放路径
    pic : '',    //当前音乐图片
    other : '',   //当前音乐自定义属性值(可以是自己的主键id)
    duration : 11,  //当前音乐时长
    currentTime : 0 //当前音乐已经播放时间
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var demo = api.require('uimusic');
demo.getCurrentPlayer(function(ret, err) {
    alert("getCurrentPlayer|" + JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stopMusic

停止正在播放的音乐,重新播放需要重新初始化播放器,执行退出应用前请执行该接口

stopMusic(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var demo = api.require('uimusic');
demo.stopMusic(function(ret, err) {
    alert("stopMusic|" + JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

musicPlayPause

暂停或者继续播放音乐

musicPlayPause(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var obj = api.require('uimusic');
obj.musicPlayPause(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

musicPrevious

切换上一曲播放

musicPrevious(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var obj = api.require('uimusic');
obj.musicPrevious(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

musicNext

切换下一曲播放

musicNext(callback(ret, err))

callback(ret, err)

ret:

  • 类型:JSON对象
  • 内部字段:
{
    status: true   //布尔型;true||false
}

err:

  • 类型:JSON对象
  • 内部字段:
{
    msg: ""
}

示例代码

var obj = api.require('uimusic');
obj.musicNext(function(ret, err) {
    api.alert({msg: JSON.stringify(ret)});
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

是否仍需要帮助? 请保持联络!
最后更新于 2024/04/8