ximalayaPlus

模块使用攻略

1、config.xml：

<feature name="ximalayaPlus">
    <param name="AppKey_Android" value=""/>
    <param name="AppSecret_Android" value=""/>
    <param name="AppKey_iOS" value=""/>
    <param name="AppSecret_iOS" value=""/>
</feature>

模块接口

getCategories

获取分类

getCategories(callback(ret,err))

callback(ret,err)

ret：

类型：JSON对象
内部字段：

{
    status : true,   //布尔型；true||false
    result: []
}

err：

类型：JSON对象
内部字段：

{
    errMsg : ''
}

示例代码

var obj = api.require('ximalayaPlus');
obj.getCategories(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getAlbumsBrowse

获取专辑ID下的音频列表

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

params

albumId：

类型：字符串型
描述：（必填项）专辑ID。

startIndex：

类型：数字型
描述：（可选项）当前第几页。
默认值：1

pageSize：

类型：数字型
描述：（可选项）每页多少条，最多不超过200。
默认值：20

sort：

类型：字符串型
描述：（可选项）"asc"表示喜马拉雅正序，"desc"表示喜马拉雅倒序，"time_asc"表示时间升序，"time_desc"表示时间降序，默认为"asc"。
默认值：asc

callback(ret,err)

ret：

类型：JSON对象
内部字段：

{
    status : true,   //布尔型；true||false
    result : {
       album_id : '',
       album_intro : '',
       album_title : '',
       can_download : '',
       category_id : '',
       channel_play_count : '',
       cover_url : '',
       cover_url_large : '',
       cover_url_middle : '',
       cover_url_small : '',
       current_page : '',
       recommend_reason : '',
       selling_point : '',
       short_rich_intro : '',
       total_count : '',
       total_page : '',
       tracks : [{
           announcer : '',
           can_download : '',
           category_id : '',
           comment_count : '',
           contain_video : '',
           cover_url_large : '',
           cover_url_middle : '',
           cover_url_small : '',
           created_at : '',
           download_count : '',
           download_size : '',
           download_url : '',
           duration : '',
           favorite_count : '',
           id : '',
           kind : '',
           order_num : '',
           play_count : '',
           play_size_24_m4a : '',
           play_size_32 : '',
           play_size_64 : '',
           play_size_64_m4a : '',
           play_size_amr : '',
           play_url_24_m4a : '',
           play_url_32 : '',
           play_url_64 : '',
           play_url_64_m4a : '',
           play_url_amr : '',
           source : '',
           subordinated_album : '',
           track_intro : '',
           track_tags : '',
           updated_at : '',
           vip_first_status : '',
       }]
    }
}

err：

类型：JSON对象
内部字段：

{
    errMsg : ''
}

示例代码

var obj = api.require('ximalayaPlus');
obj.getAlbumsBrowse({
    albumId : 4519297,
},function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

addEventListener

添加播放器事件监听

addEventListener({params},callback(ret))

params

isContinueNextWhenFailed：

类型：布尔型
描述：（可选项）播放失败时是否继续播放下一首(iOS有效)。
默认值：false

useXmPlayNotification：

类型：布尔型
描述：（可选项）用播放器通知栏(Android有效)。
默认值：false

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status : true,   //布尔型；true
    evenType : '',
    //播放时被调用，频率为1s，告知当前播放进度和播放时间 onProcess
    //播放时被调用，告知当前播放器的缓冲进度 onCacheProcess
    //播放列表结束时被调用 onPlaylistEnd
    //开始播放时调用 onDidStart
    //已经播放时被调用 onDidPlaying
    //暂停时调用 onDidPaused
    //停止时调用 onDidStopped
    //结束播放时调用 onDidEnd
    //切换声音时调用 onDidChange
    //播放失败时调用 onDidFailed 
    //成功替换播放列表时调用 onDidReplace
    //没有网络情况下播放器因缓冲已播完而停止播放时触发 onDidPausePlayForBadNetwork
    percent : '',
    currentSecond : '',
    track : {},
    errCode : '',
    errMsg : '',
}

示例代码

var obj = api.require('ximalayaPlus');
obj.addEventListener(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS、Android系统

可提供的1.0.0及更高版本

removeEventListener

移除播放器事件监听

removeEventListener(callback(ret))

callback(ret)

ret：

类型：JSON对象
内部字段：

{
    status : true,   //布尔型；true
}

示例代码

var obj = api.require('ximalayaPlus');
obj.removeEventListener(function(ret, err) {
    alert(JSON.stringify(ret));
});

可用性

iOS系统

可提供的1.0.0及更高版本

playSong

播放列表中指定的序号音频

playSong({params})

params

tracks：

类型：数组型
描述：（必填项）需要播放的音频列表(getAlbumsBrowse接口里面的tracks数组)。

index：

类型：数字型
描述：（必填项）指定音频列表中的第几个开始播放。
默认值：0

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.playSong({
    tracks : {...},
    index : 0,
});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

playSongByUrl

通过url进行播放

playSongByUrl({params})

params

url：

类型：字符串型
描述：（必填项）设置需要播放的URL地址。

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.playSongByUrl({..});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

playSongByTrack

播放局域网内Track

playSongByTrack({params})

params

track：

类型：JSON型
描述：（必填项）需要播放的音频track数据(getAlbumsBrowse接口里面的tracks数组里面的单条json数据)。

{
   announcer : '',
   can_download : '',
   category_id : '',
   comment_count : '',
   contain_video : '',
   cover_url_large : '',
   cover_url_middle : '',
   cover_url_small : '',
   created_at : '',
   download_count : '',
   download_size : '',
   download_url : '',
   duration : '',
   favorite_count : '',
   id : '',
   kind : '',
   order_num : '',
   play_count : '',
   play_size_24_m4a : '',
   play_size_32 : '',
   play_size_64 : '',
   play_size_64_m4a : '',
   play_size_amr : '',
   play_url_24_m4a : '',
   play_url_32 : '',
   play_url_64 : '',
   play_url_64_m4a : '',
   play_url_amr : '',
   source : '',
   subordinated_album : '',
   track_intro : '',
   track_tags : '',
   updated_at : '',
   vip_first_status : '',
}

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.playSongByTrack({
    track : {...}
});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setAutoNext

设置播放器自动播放下一首

setAutoNext({params})

params

autoNext：

类型：布尔型
描述：（可选项）是否播放器自动播放下一首。
默认值：false

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.setAutoNext();
alert(JSON.stringify(ret));

可用性

iOS系统

可提供的1.0.0及更高版本

setPlayMode

设置播放器播放模式

setPlayMode({params})

params

mode：

类型：数字型
描述：（可选项）播放模式：0:专辑播放、1:电台播放。
默认值：0

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.setPlayMode({});
alert(JSON.stringify(ret));

可用性

iOS系统

可提供的1.0.0及更高版本

setTrackPlayMode

设置当前播放器的下一首选择模式

setTrackPlayMode({params})

params

mode：

类型：数字型
描述：（可选项）选择模式：0:列表播放、1:单曲循环、2:随机、3:列表循环。
默认值：0

callback(ret, err)

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.setTrackPlayMode({});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getTrackPlayMode

获取当前播放器的下一首选择模式

getTrackPlayMode()

ret：

类型：JSON对象
内部字段：

{
    status : true,   //布尔型；true||false
    mode : 0, //0:列表播放、1:单曲循环、2:随机、3:列表循环
}

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.getTrackPlayMode();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

pause

暂停当前播放

pause()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.pause();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

play

恢复当前播放

play()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.play();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

isPlaying

获取是否播放中

isPlaying()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.isPlaying();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

playNext

播放下一首

playNext()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.playNext();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

playPrev

播放上一首

playPrev()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.playPrev();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setVolume

设置播放器的音量

setVolume({params})

params

volume：

类型：浮点型
描述：（必填项）音量,范围：0～1。
默认值：1

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.setVolume({...});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

setPlayRate

播放速率

setPlayRate({params})

params

rate：

类型：浮点型
描述：（必填项）播放速率(范围：0.5~2.0)。
默认值：1.0

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.setPlayRate({...});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

seekToTime

设置播放器从特定的时间播放

seekToTime({params})

params

seek：

类型：数字型
描述：（必填项）特定的时间播放。
默认值：0

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.seekToTime({...});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

stop

停止当前播放

stop()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.stop();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

clearPlayCache

清空缓存

clearPlayCache()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.clearPlayCache();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

resetPlayList

更新当前播放列表

resetPlayList({params})

params

tracks：

类型：数组型
描述：（必填项）需要播放的音频列表(getAlbumsBrowse接口里面的tracks数组)。

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.resetPlayList({...});
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getPlayList

获取当前播放列表

getPlayList()

ret：

类型：JSON对象
内部字段：

{
    status : true,   //布尔型；true||false
    result : [{...}],
}

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.getPlayList();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getCurrentTrack

获取当前播放的声音

getCurrentTrack()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.getCurrentTrack();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getNextTrack

获取下一首

getNextTrack()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.getNextTrack();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getPrevTrack

获取上一首

getPrevTrack()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.getPrevTrack();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

getDuration

获取音频总时长

getDuration()

ret：

类型：JSON对象
内部字段：

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

示例代码

var obj = api.require('ximalayaPlus');
var ret = obj.getDuration();
alert(JSON.stringify(ret));

可用性

iOS、Android系统

可提供的1.0.0及更高版本

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

最后更新于 2024/04/24