hfLiveMusicPlayer

概述

hfLiveMusicPlayer简介

hfLiveMusicPlayer HIFIVE音乐版权直播场景解决方案依托百万级海量正版曲库及多年音乐运营内容沉淀为直播行业解决音乐版权、音乐选择和使用问题。助力平台提升用户活跃打造优质平台内容。

hfLiveMusicPlayer使用

hfLiveMusicPlayer使用需要获取appKey和secret,请前往HIFIVE音乐开放平台申请注册HIFIVE账号,登陆到控制台后,可以查看您专属的沙箱环境账号,获取appKey和secret具体参照音乐开放平台/快速入门

联系商务: 13466712640(赵先生)

模块接口

registerApp

注册app,初始化模块

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

params

appKey

  • 类型:字符串
  • 描述:开放平台申请appId
  • 必传:是

secret:

  • 类型:字符串
  • 描述:开放平台申请secret
  • 必传:是

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    success: true  //请求是否成功
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: "参数不完整"  //错误信息
    code: 10502     //数字类型;
                      //错误码:
}

示例代码

var demo = api.require('hfLiveMusicPlayer');
demo.registerApp({
    appKey: 'appKey',
    secretKey: 'secretKey'
},function(ret, err){
   if(!err) {
       //初始化成功
       api.toast({
           msg: "初始化成功",
           location: 'middle'
       })
   } else {
       //初始化失败
       api.toast({
           msg: err.msg,
           location: 'middle'
       })
   }
});

可用性

iOS系统,Android系统

可提供的1.2.0及更高版本

memberLogin

会员登陆

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

params

memberName:

  • 类型:字符串
  • 描述:会员名称
  • 必传:是

memberId:

  • 类型:字符串
  • 描述:会员外部ID
  • 必传:是

sociatyName:

  • 类型:字符串
  • 描述:公会名称
  • 必传:否

sociatyId:

  • 类型:字符串
  • 描述:公会外部ID
  • 必传:否

headerUrl:

  • 类型:字符串
  • 描述:头像URL
  • 必传:否

gender:

  • 类型:字符串
  • 描述:性别,未知:0,男:1,女:2
  • 必传:否

birthday:

  • 类型:字符串
  • 描述:生日
  • 必传:否

location:

  • 类型:字符串
  • 描述:经纬度信息,纬度在前(30.779164,103.94547)
  • 必传:否

favoriteSinger:

  • 类型:字符串
  • 描述:喜欢的歌手名,多个用英文逗号隔开
  • 必传:否

phone:

  • 类型:字符串
  • 描述:手机号
  • 必传:否

callback(ret, err)

ret:

  • 类型:JSON 对象
  • 内部字段:
{
    success: true  //请求是否成功
}

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: "参数不完整"  //错误信息
    code: 10502      //数字类型;
                     //错误码:
}

示例代码

var demo = api.require('hfLiveMusicPlayer');
demo.memberLogin({
    memberName: 'yourName',
    memberId: 'yourId'
},function(ret, err){
   if(!err) {
       //登陆成功
       api.toast({
           msg: "登陆成功",
           location: 'middle'
       })
   } else {
       //登陆失败
       api.toast({
           msg: err.msg,
           location: 'middle'
       })
   }
});

可用性

iOS系统,Android系统

可提供的1.2.0及更高版本

showPlayer

显示HILivePlayer播放器UI

showPlayer({params})

params

topLimit:

  • 类型:字符串
  • 描述:拖拽上限
  • 必传:否

bottomLimit:

  • 类型:字符串
  • 描述:拖拽下限
  • 必传:否

示例代码

var demo = api.require('hfLiveMusicPlayer');
demo.showPlayer({
    topLimit: 350,
    bottomLimit: 600
});

可用性

iOS系统,Android系统

可提供的1.2.0及更高版本

removePlayer

移除HILivePlayer播放器UI

removePlayer( )

示例代码

var demo = api.require('hfLiveMusicPlayer');
demo.removePlayer();

可用性

iOS系统,Android系统

可提供的1.2.0及更高版本

configServerErrorHandler

配置请求错误回调(服务端)

configServerErrorHandler(callback(ret, err))

callback(ret, err)

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: "参数不完整"  //错误信息
   code: 10502       //数字类型;
                    //错误码:
}

示例代码

var demo = api.require('hfLiveMusicPlayer');
demo.configServerErrorHandler(function(ret, err){
    //服务器错误
    api.toast({
        msg: err.msg,
        location: 'middle'
    })
})

可用性

iOS系统,Android系统

可提供的1.2.0及更高版本

configSendRequestErrorHandler

配置请求错误回调(客户端)

configSendRequestErrorHandler(callback(ret, err))

callback(ret, err)

err:

  • 类型:JSON 对象
  • 内部字段:
{
    msg: "参数不完整"  //错误信息
   code: 10502       //数字类型;
                    //错误码:
}

示例代码

var demo = api.require('hfLiveMusicPlayer');
demo.configSendRequestErrorHandler(function(ret, err){
    api.toast({
        msg: err.msg,
        location: 'middle'
    })
})

可用性

iOS系统,Android系统

可提供的1.2.0及更高版本

错误码

iOS

错误码 错误描述 解决方案
10500 未初始化SDK 初始化
10501 未登录 登录
10502 参数不全 必选参数缺失
10503 参数字符格式错误 检查上传参数
10504 响应不数据不是json 反馈官方技术支持
10505 无网络连接 检查网络
10506 请求超时 稍后重试

Android

错误码 错误描述 解决方案
10000 未初始化ADK 初始化SDK
10001 网络错误 请检查网络连接
10002 连接超时 请检查网络连接
10003 http异常 重试
10097 JSON转换失败 重试
10098 JSON格式不匹配 检查Json
10099 未知错误

服务端

错误码 说明
200 成功
400 参数缺失
401 签名错误
402 IP地址不在白名单内
403 AppId不存在或App状态异常
404 找不到请求记录
405 您的服务暂未开通,请检查接口的授权状态
412 请不要重复请求接口
413 签名已过期
422 找不到服务模块,请检查url是否正确
423 已达到今天调用上限
424 用户已存在
425 用户不存在
426 未登录
427 绑定失败
428 accessToken不正确
450 歌单不存在
451 音乐不存在
452 音乐已存在
453 歌单音乐数量不能超过1000首
454 应版权方要求,该音乐已下架
500 系统繁忙,请稍后重试
503 非法参数
504 当前排队人数过多,请稍后再试

后台播放

IOS

需要在config.xml进行如下配置 preference name="backgroundMode" value="audio"