musicNotify

来自于：尧一尧

open updateInfo setPlay setPause getOpenNotifyPermissions goOpenNotifySettingPage close

概述

musicNotify是一个类似酷狗音乐播放的通知栏模块，开发者可自定义歌曲，歌手以及LOGO图标的名称，支持监听上一曲，上一曲，暂停，关闭等事件。本模块不提供播放功能，可以配合官方提供的其他音乐播放器模块一起使用。

open

打开

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

params

musicName：

  • 类型：字符串
  • 描述：（可选项）音乐的名称，例如：光辉岁月

singerName：

  • 类型：字符串
  • 描述：（可选项）歌手的名称，例如：BEYOND

file：

wakeUpApp：

  • 类型：布尔（默认值false）
  • 描述：（可选项）是否支持点击通知栏打开APP(app进入后台模式并且不被进程杀死的情况下生效)

fileBorderRadius：

  • 类型：整型
  • 描述：（可选项）图片的圆角弧度值，默认为0

clickPlayOrPauseButtonToChangeStatus:

  • 类型：布尔（默认为false）
  • 描述：（可选项）点击暂停或者播放按钮是否更改到对应的按钮状态，设置true后，点击暂停就会直接切换成播放按钮状态，设置false不更改，由setPlay或者setPause进行设置

callback(ret, err)

ret：

  • 类型：JSON 对象
  • 内部字段：
{
    state:            //数字类型；对应的值有：success，closeClick，pauseOrPlayClick，preClick，nextClick；

}
    success表示打开成功，closeClick为用户点击了关闭按钮，pauseOrPlayClick为用户点击了开始/暂停按钮，preClick为用户点击了上一曲按钮，nextClick为用户点击了下一曲按钮

示例代码

var musicNotify = api.require('musicNotify');
musicNotify.open({
    musicName: "不再犹豫",
    singerName: "BEYOND乐队",
    file:"https://cdn.zxwindow.com/toutiaoforum/202105/08/60962f7e0f8ed.jpg",
    wakeUpApp:true, 
    fileBorderRadius:10, 
    clickPlayOrPauseButtonToChangeStatus:false
}, function(ret, err) {
    if (ret) {
        //alert(JSON.stringify(ret));
        if(ret.state=="success")
        {
            alert("打开成功");
        }
        else if(ret.state=="noPermissions")
        {
            alert("通知栏没有设置打开权限");
        }
        else if(ret.state=="closeClick")
        {
            alert("用户点击了关闭按钮");
        }
        else if(ret.state=="playClick")
        {
            alert("用户点击了播放按钮");
        }
        else if(ret.state=="pauseClick")
        {
            alert("用户点击了暂停按钮");
        }
        else if(ret.state=="preClick")
        {
            alert("用户点击了上一曲按钮");
        }
        else if(ret.state=="nextClick")
        {
            alert("用户点击了下一曲按钮");
        }
        else if(ret.state=="openApp")
        {
            alert("用户点击了推送栏，app将被打开");
        }
    } else {
        alert(JSON.stringify(err));
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

updateInfo

更新通知栏视图中的歌手，歌曲，logo图信息

updateInfo({params})

params

musicName：

  • 类型：字符串
  • 描述：（可选项）音乐的名称，例如：光辉岁月

singerName：

  • 类型：字符串
  • 描述：（可选项）歌手的名称，例如：BEYOND

file：

wakeUpApp：

  • 类型：布尔（默认值false）
  • 描述：（可选项）是否支持点击通知栏打开APP(app进入后台模式并且不被进程杀死的情况下生效)

fileBorderRadius：

  • 类型：整型
  • 描述：（可选项）图片的圆角弧度值，默认为0

clickPlayOrPauseButtonToChangeStatus:

  • 类型：布尔（默认为false）
  • 描述：（可选项）点击暂停或者播放按钮是否更改到对应的按钮状态，设置true后，点击暂停就会直接切换成播放按钮状态，设置false不更改，由setPlay或者setPause进行设置

示例代码

var musicNotify = api.require('musicNotify');
musicNotify.updateInfo({
    musicName: "不再犹豫",
    singerName: "BEYOND乐队",
    file:"https://cdn.zxwindow.com/toutiaoforum/202105/08/60962f7e0f8ed.jpg",
    wakeUpApp:true, 
    fileBorderRadius:10, 
    clickPlayOrPauseButtonToChangeStatus:false
});

可用性

Android系统

可提供的1.0.0及更高版本

setPlay

设置远程视图为播放按钮（隐藏暂停按钮）

setPlay();

示例代码

var musicNotify = api.require('musicNotify');
musicNotify.setPlay();

可用性

Android系统

可提供的1.0.0及更高版本

setPause

设置远程视图为暂停按钮（隐藏播放按钮）

setPause();

示例代码

var musicNotify = api.require('musicNotify');
musicNotify.setPause();

可用性

Android系统

可提供的1.0.0及更高版本

getOpenNotifyPermissions

获取通知栏权限是否开启

getOpenNotifyPermissions()

示例代码

var musicNotify = api.require('musicNotify');
musicNotify.getOpenNotifyPermissions({},function(ret,err){
    if(ret){

        if(ret.state){
            alert("获取到了通知栏权限");
        }else{
            alert("没有获取到通知栏权限");
        }
    }
});

可用性

Android系统

可提供的1.0.0及更高版本

goOpenNotifySettingPage

跳转至打开通知权限界面

goOpenNotifySettingPage()

示例代码

var musicNotify = api.require('musicNotify');
musicNotify.goOpenNotifySettingPage();

可用性

Android系统

可提供的1.0.0及更高版本

close

关闭远程视图

close()

示例代码

var musicNotify = api.require('musicNotify');
musicNotify.close();

可用性

Android系统

可提供的1.0.0及更高版本