VocaPlayer API for VocaPlayer 1.0

/*
    VocaPlayer API for VocaPlayer 1.0
    by catLee
    Chinese ver.
    Sep 1 2012

    目錄
        ┌A.PlayList Object
        ├B.播放控制
        ├C.播放器狀況
        └D.其他
*/

//A.Play List Object
/*
    1.0版的VocaPlayer為了增加對多歌單的支援，使用vcprList物件作為新增歌單的方式
*/
//A-1   新增(宣告)vcprList物件
    list = new vcprList(name)
    /*
        list: 自定義名稱，除了操作之外沒有其他功能。(注意不同歌單名稱不能重複)
        name: 歌單的顯示名稱，需為字串(文字請記得加上"")

        #請在VocaPlayer的程式碼之後宣告，否則宣告無效
        要在VocaPlayer之前宣告請參考最後一章 D.其他 vcprCallback()
    */
    //A-1 範例
    mylist = new vcprList("我的播放清單");

//A-2   新增歌曲
    list.addSong(song) //新增曲目
    list.addSongArray(songArray) //批次新增曲目
    /*
        list: 新增歌單時定義的名稱
        song: 曲目Array
            曲目Array必須是以下格式: ["song","feat","Youtube ID","UPer","NicoNico ID","Cover"]
        songArray: 歌單Array
            只是很純粹的把曲目Array再包成Array，像是[["song","feat","Youtube ID","UPer","NicoNico ID","Cover"],["song","feat","Youtube ID","UPer","NicoNico ID","Cover"]]

        #cover欄位目前還無任何作用，可留「""」當作空白
    */
    //A-2 範例
    mylist.addSong(["No logic", "巡音ルカ", "4KyRXxQ06Fo", "ジミーサムP", "sm13221358","http://i.imgur.com/fyFDo.png"]);

//A-3   播放器歌單同步
    list.update()
    /*
        list: 新增歌單時定義的名稱
        #請在對歌單做任何操作之後執行這個函數，可避免不必要的問題出現
    */


//B.播放控制
vcpr.playSong(id,list)
    //播放指定歌曲
    /*
        id: 曲目被加進歌單的順序，number，從0開始
        list: 歌單被宣告的順序，number，從0開始
    */
vcpr.play()
    //播放或暫停，效果等同播放鍵   (播放器的狀態請參考下一章 C.播放器狀況 vcpr.state)

vcpr.stop()
    //停止，效果等同播放鍵

vcpr.nextSong()
    //換曲，效果等同換曲鍵

vcpr.vol.up()
    //音量上升10%   (音量的量值請參考下一章 C.播放器狀況 vcpr.vol.value)

vcpr.vol.down()
    //音量下降10%

vcpr.vol.muteSwitch()
    //切換靜音  (音量的量值請參考下一章 C.播放器狀況 vcpr.Flash.isMuted)

vcpr.randomSwitch()
    //切換隨機播放    (隨機播放的狀態請參考下一章 C.播放器狀況 vcpr.random)


//C.播放器狀況
vcpr.state
    //播放器的狀態，變數
    //直接修改其值是不會影響播放狀態的
    /*
        -1 (未開始)
        0 (已結束)
        1 (播放中)
        2 (暫停)
        3 (緩衝)
    */

vcpr.vol.value
    //播放器的音量，變數，0~100，預設為70
    //直接修改其值不會直接影響播放狀態

vcpr.Flash.isMuted()
    //檢查是否靜音，函數，回傳值為0(unMute)或1(Mute)

vcpr.random
    //隨機播放狀態，變數，值為0(正常)或1(隨機)
    //修改其值會影響播放狀態

vcpr.nowArray()
    //現在播放歌曲，函數，回傳值為array，格式: ["song","feat","Youtube ID","UPer","NicoNico ID","Cover"]

vcpr.ui.showList()
    //顯示播放清單
vcpr.ui.hideList()
    //隱藏播放清單


//D.其他
vcpr.defaultTitle
    //標題(未播放影片時影片上方的文字，預設為VocaPlayer 1.0)
    //變數，可寫入HTML tag
    //請直接變更程式內的字串會方便得多
vcpr.title(str)
    //控制標題的文字，會強制覆蓋播放中的曲目資訊！
    //可將HTML tag代入

vcprCallback()
    //VocaPlayer在初始化完成後會呼叫的函數，預設未定義
    //當需要在VocaPlayer之前宣告歌單時會用到
//範例
    function vcprCallback(){
        mylist = new vcprList("我的播放清單");
        mylist.addSong(["No logic", "巡音ルカ", "4KyRXxQ06Fo", "ジミーサムP", "sm13221358","http://i.imgur.com/fyFDo.png"]);
    };