# API

# プレイリストオプション

プレイリストオプションは以下の通りです。想定外の値が指定された場合は無視します。

parentElementId: 文字列

プレイリスト領域のdiv要素のidです。本パラメータが無い場合、プレイリストを表示しません。

mediaElementId: 文字列

コンテンツを再生するvideo／audio要素のidです。本パラメータが無い場合、機能は無効です。

repeatType: 文字列

リピート再生のタイプです。
'none'：リピートしない
'all'：全件リピート
'one'： 1件リピート
デフォルト： 'none'

defaultIndex: 数値

プレイリストの初期化完了時に選択状態にする項目のIndexです。-1以上の整数です。指定のIndexに項目がない場合はデフォルト値になります。
デフォルト： 0（ひとつ目の項目）

enableResumeIndex: 真偽値

レジュームの有効／無効です。
true：有効にします。
false：無効にします。
デフォルト値： false

playerWidth: 数値＜ピクセル＞／文字列

プレイヤーの幅です。値がundefined以外の場合、プレイヤーオプションwidthを本値で上書きします。詳細はプレイヤーの仕様に準拠します。
デフォルト： undefined

playerHeight: 数値＜ピクセル＞／文字列

プレイヤーの高さです。値がundefined以外の場合、プレイヤーオプションheightを本値で上書きします。詳細はプレイヤーの仕様に準拠します。
デフォルト： undefined

playerAspectRatio: 文字列

プレイヤーのアスペクト比です。値がundefined以外の場合、プレイヤーオプションaspectRatioを本値で上書きします。詳細はプレイヤーの仕様に準拠します。
デフォルト： undefined

items: Objectの配列

プレイリストの項目（Object）の配列です。プレイリストには記述した順に表示します。要素数は20以下にしてください。
デフォルト： undefined

thumbUrl: 文字列（URL）: サムネイルのURLです。
デフォルト： undefined
description: 文字列: コンテンツの説明文等のテキストです。HTMLタグを使用できます。
デフォルト： undefined
playerOptions: Object／文字列（URL）: ULIZA Player (HTML5)のプレイヤーオプションです。詳細は、「APIリファレンス」を参照してください。
デフォルト： undefined

# イベント

プレイリストから通知するイベントは以下の通りです。受信するイベントの登録および削除については、addEventListenerおよびremoveEventListenerを参照してください。

# play

コンテンツ切り替えのタイミング、およびdefaultIndexが0以上の状態でプレイリストを初期化したタイミングで送信します。再生状態に切り替えるかは環境により異なります。

イベントを受信する実装の例は以下の通りです。

<script>
  // プレイリストを組み込む部分の詳細は割愛します。
  var playlist = new UlizaPlaylist(playlistOptions);
  playlist.addEventListener('play', function(event) {
    var playerInstance = playlist.player;
  });
</script>

# プロパティ

currentItemIndex: 数値: 現在再生中の項目のIndexです。-1以上の整数です。プレイリストに含まれないコンテンツを再生中の場合は、-1を返します。
アクセス権： Read Only
items: Objectの配列: プレイリストの情報です。詳細は、プレイリストオプションを参照してください。
アクセス権： Read Only
player: Object: プレイヤーのインスタンスです。
アクセス権： Read Only
playerAspectRatio: 文字列: プレイヤーのアスペクト比です。詳細は、プレイリストオプションを参照してください。
アクセス権： Read Write
playerHeight: 数値＜ピクセル＞／文字列: プレイヤーの高さです。詳細は、プレイリストオプションを参照してください。
アクセス権： Read Write
playerWidth: 数値＜ピクセル＞／文字列: プレイヤーの幅です。詳細は、プレイリストオプションを参照してください。
アクセス権： Read Write
repeatType: 文字列: リピート再生のタイプです。詳細は、プレイリストオプションを参照してください。
'none'：リピートしない
'all'：全件リピート
'one'： 1件リピート
アクセス権： Read Write

# メソッド

# UlizaPlaylist（コンストラクタ）

プレイリストのインスタンスを生成します。

【引数】

options: Object: プレイリストオプションです。必須項目です。

【戻り値】

return: Object: プレイリストのインスタンスです。

# addEventListener

受信するイベントを登録します。イベントについては、イベントを参照してください。

【引数】

type: 文字列: 受信するイベントの名前です。必須項目です。
listener: Function: リスナー関数です。必須項目です。

【戻り値】

なし

# appendItem

プレイリストの末尾の項目にコンテンツを追加します。

【引数】

options: Object: プレイリストオプションです。必須項目です。

【戻り値】

なし

# playItem

項目のIndexを指定して再生を開始します。挙動は、項目を選択する場合と同等です。

【引数】

index: 数値: 項目のIndexです。必須項目です。

【戻り値】

return: 真偽値: 再生の成否です。

# playNextItem

再生中のコンテンツの次の項目のコンテンツの再生を開始します。挙動は、連続再生する場合と同等です。

【引数】

なし

【戻り値】

return: 真偽値: 再生の成否です。

# removeEventListener

登録したイベントを解除します。イベントについては、イベントを参照してください。

【引数】

type: 文字列: 受信するイベントの名前です。必須項目です。
listener: Function: リスナー関数です。必須項目です。

【戻り値】

なし

# removeFirstItem

プレイリストの先頭の項目のコンテンツを削除します。プレイリストの先頭の項目のコンテンツを再生中に本メソッドを実行した場合でも再生を継続します。

【引数】

なし

【戻り値】

なし

# removeResumeIndexLocalStorage

ブラウザのローカル記憶領域に保存されたレジュームの情報を削除します。

【引数】

なし

【戻り値】

なし

← 実装方法デザインカスタマイズ →