Player (Star-1.5 (APIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

com.docomostar.ui.avplayer
クラス Player

Object
  com.docomostar.ui.avplayer.Player

public final class Player
extends Object
extends Object

[iアプリオプションAPI]

音楽プレイヤー機能を定義します。
音楽プレイヤーは音楽再生ソフトウェアを制御する機能を提供します。具体的には、音楽再生ソフトウェアの起動/終了、属性の取得/設定、コンテンツの再生制御を行うことができます。

音楽再生ソフトウェアには以下の状態が存在します。

起動状態	説明
利用不可能状態	音楽再生ソフトウェアが起動していない状態
停止状態	コンテンツの再生を停止している状態
一時停止状態	コンテンツの再生を一時停止している状態
再生状態	コンテンツを再生している状態
早送り状態	コンテンツを早送りしている状態
巻き戻し状態	コンテンツを巻き戻ししている状態

音楽再生ソフトウェアを起動/終了するには powerOn()、及び powerOff() メソッドを使用してください。音楽再生ソフトウェアを起動すると、音楽再生ソフトウェアは停止状態、または一時停止状態となります。音楽再生ソフトウェア（または Star アプリ)を終了すると、音楽再生ソフトウェアは利用不可能状態となります。
音楽再生ソフトウェアを起動中に suspend() メソッドの実行によって Star アプリがサスペンドした場合、音楽再生ソフトウェアの状態は Suspended 状態に遷移する前の状態を維持します。

音楽再生ソフトウェアに対して属性を取得/設定するには getAttribute(int)、及び setAttribute(int, int) メソッドを使用してください。

レジューム情報

音楽プレイヤーの再生情報(プレイリスト・コンテンツインデックス・再生位置・音量・再生モードなど)はレジューム情報として扱われます。このレジューム情報は Star アプリにおける音楽プレイヤーとネイティブのミュージックプレイヤーで共有されます。

レジューム情報は、音楽再生ソフトウェアが終了する契機で保存されます。保存されたレジューム情報は、powerOn() により音楽再生ソフトウェアが起動された時点で読み込まれ、 play() を呼び出すことで前回の続きから再生を再開できます。

Star アプリで音楽再生ソフトウェア起動中に、マルチタスク機能や連携機能によって他機能が後発で起動された場合、及び他のメソッドの実行によってサウンドリソース競合が発生した場合、後発で起動された機能の種類に応じて以下のいずれかの振る舞いをします。

音楽再生ソフトウェアの状態を維持します。
音楽再生ソフトウェアを一時停止します。一時停止する前の音楽再生ソフトウェアの状態が再生状態であった場合、後発起動された機能が終了すると、音楽再生ソフトウェアは自動的に再生を再開します。
音楽再生ソフトウェアを停止、一時停止、もしくは利用不可能にします。後発起動された機能が終了しても、音楽再生ソフトウェアは再生を再開しません。

以下の条件を同時に満たした場合、音楽再生ソフトウェアの状態が利用不可能状態に遷移することがあります。

音楽プレイヤーの音声出力先として Bluetooth 機器を使用している
メイン画面を見て端末を操作できない状態の時に Bluetooth リンクが切断される

導入されたバージョン:: Star-1.5

フィールドの概要
`static int`	`ATTR_PLAY_MODE_ALL_REPEAT` 再生モードの属性で、オールリピートモードを表します(=2)。
`static int`	`ATTR_PLAY_MODE_NORMAL` 再生モードの属性で、通常再生モードを表します(=0)。
`static int`	`ATTR_PLAY_MODE_SHUFFLE` 再生モードの属性で、シャッフルモードを表します(=3)。
`static int`	`ATTR_PLAY_MODE_SHUFFLE_REPEAT` 再生モードの属性で、シャッフルリピートモードを表します(=4)。
`static int`	`ATTR_PLAY_MODE_SINGLE` 再生モードの属性で、 1 曲終了モードを表します(=5)。
`static int`	`ATTR_PLAY_MODE_SINGLE_REPEAT` 再生モードの属性で、シングルリピートモードを表します(=1)。
`static int`	`DEV_PLAY_MODE` 音楽再生ソフトウェアの属性の 1 つで、再生モードを表します(=1)。
`static int`	`DEV_VOLUME` 音楽再生ソフトウェアの属性の 1 つでボリュームを表します(=0)。
`static int`	`STATUS_FAST_FORWARDING` 音楽再生ソフトウェアにおける状態の 1 つで、コンテンツを早送りしている状態を表します(=3)。
`static int`	`STATUS_FAST_REWINDING` 音楽再生ソフトウェアにおける状態の 1 つで、コンテンツを巻き戻ししている状態を表します(=4)。
`static int`	`STATUS_NOT_AVAILABLE` 音楽再生ソフトウェアにおける状態の 1 つで、音楽再生ソフトウェアが起動していない状態を表します(=-1)。
`static int`	`STATUS_PAUSED` 音楽再生ソフトウェアにおける状態の 1 つで、コンテンツの再生を一時停止している状態を表します(=2)。
`static int`	`STATUS_PLAYING` 音楽再生ソフトウェアにおける状態の 1 つで、コンテンツを再生している状態を表します(=1)。
`static int`	`STATUS_STOPPED` 音楽再生ソフトウェアにおける状態の 1 つで、コンテンツの再生を停止している状態を表します(=0)。

メソッドの概要
`void`	`fastForward()` コンテンツを早送りします。
`void`	`fastRewind()` コンテンツを巻き戻しします。
`int`	`getAttribute(int attr)` 音楽再生ソフトウェアから属性を取得します。
`int`	`getContentIndex()` カレントコンテンツのコンテンツインデックスを取得します。
`Content`	`getCurrentContent()` カレントコンテンツを取得します。
`Playlist`	`getCurrentPlaylist()` カレントプレイリストを取得します。
`static Player`	`getInstance()` 音楽プレイヤーオブジェクトを取得します。
`int`	`getPosition()` コンテンツの現在の再生位置を取得します。
`int`	`getStatus()` 音楽再生ソフトウェアの状態を取得します。
`void`	`pause()` コンテンツの再生を一時停止します。
`void`	`play()` カレントコンテンツを再生します。
`void`	`powerOff()` 音楽再生ソフトウェアを終了します。
`void`	`powerOn()` 音楽再生ソフトウェアを起動します。
`void`	`setAttribute(int attr, int value)` 音楽再生ソフトウェアに属性を設定します。
`void`	`setContentIndex(int contentIndex)` 指定されたコンテンツインデックスのコンテンツをカレントコンテンツに変更します。
`void`	`setPlaylist(Playlist playlist)` プレイリストを設定します。
`void`	`setPosition(int position)` コンテンツの再生位置を設定します。
`void`	`skipBackward()` コンテンツ戻しをします。
`void`	`skipForward()` コンテンツ送りをします。
`void`	`stop()` コンテンツの再生を停止します。

クラス Object から継承されたメソッド
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

フィールドの詳細

STATUS_NOT_AVAILABLE

public static final int STATUS_NOT_AVAILABLE

音楽再生ソフトウェアにおける状態の 1 つで、音楽再生ソフトウェアが起動していない状態を表します(=-1)。

関連項目:: getStatus(), 定数フィールド値

STATUS_STOPPED

public static final int STATUS_STOPPED

音楽再生ソフトウェアにおける状態の 1 つで、コンテンツの再生を停止している状態を表します(=0)。

関連項目:: getStatus(), 定数フィールド値

STATUS_PLAYING

public static final int STATUS_PLAYING

音楽再生ソフトウェアにおける状態の 1 つで、コンテンツを再生している状態を表します(=1)。

関連項目:: getStatus(), 定数フィールド値

STATUS_PAUSED

public static final int STATUS_PAUSED

音楽再生ソフトウェアにおける状態の 1 つで、コンテンツの再生を一時停止している状態を表します(=2)。

関連項目:: getStatus(), 定数フィールド値

STATUS_FAST_FORWARDING

public static final int STATUS_FAST_FORWARDING

音楽再生ソフトウェアにおける状態の 1 つで、コンテンツを早送りしている状態を表します(=3)。

関連項目:: getStatus(), 定数フィールド値

STATUS_FAST_REWINDING

public static final int STATUS_FAST_REWINDING

音楽再生ソフトウェアにおける状態の 1 つで、コンテンツを巻き戻ししている状態を表します(=4)。

関連項目:: getStatus(), 定数フィールド値

DEV_VOLUME

public static final int DEV_VOLUME

音楽再生ソフトウェアの属性の 1 つでボリュームを表します(=0)。

コンテンツ本来の音量に対する比率(0 ～ 100)を指定します。この値は、音楽再生ソフトウェアの最大音量に対する相対値として扱われます。

ボリュームはレジューム情報の保存・読込みの対象となり、音楽プレイヤー起動時のボリュームの初期値は、レジューム情報から読み込んだ値となります。音楽プレイヤーがレジューム情報を保持していない場合、ボリュームの初期値は機種依存です。

このボリュームの設定は、音楽再生ソフトウェアに対してのみ影響を及ぼします。 AudioPresenter.SET_VOLUME で設定するボリュームとは独立しており、互いに影響を与えることはありません。

関連項目:: 定数フィールド値

DEV_PLAY_MODE

public static final int DEV_PLAY_MODE

音楽再生ソフトウェアの属性の 1 つで、再生モードを表します(=1)。

再生モードはレジューム情報の保存・読込みの対象となり、音楽プレイヤー起動時の再生モードの初期値は、レジューム情報から読み込んだ値となります。音楽プレイヤーがレジューム情報を保持していない場合、再生モードの初期値は通常再生モードです。

関連項目:: ATTR_PLAY_MODE_NORMAL, ATTR_PLAY_MODE_SINGLE_REPEAT, ATTR_PLAY_MODE_ALL_REPEAT, ATTR_PLAY_MODE_SHUFFLE, ATTR_PLAY_MODE_SHUFFLE_REPEAT, ATTR_PLAY_MODE_SINGLE, 定数フィールド値

ATTR_PLAY_MODE_NORMAL

public static final int ATTR_PLAY_MODE_NORMAL

再生モードの属性で、通常再生モードを表します(=0)。

カレントコンテンツからコンテンツインデックスの昇順に、プレイリストの末尾のコンテンツまで再生を行います。

プレイリストの末尾のコンテンツの再生・早送りが完了した場合や、先頭コンテンツの巻き戻しが完了した場合には、プレイリストの先頭コンテンツをカレントコンテンツとし、停止状態に遷移します。

関連項目:: 定数フィールド値

ATTR_PLAY_MODE_SINGLE_REPEAT

public static final int ATTR_PLAY_MODE_SINGLE_REPEAT

再生モードの属性で、シングルリピートモードを表します(=1)。

カレントコンテンツの再生を繰り返します。

カレントコンテンツの再生が完了した場合、カレントコンテンツは変更せずに、コンテンツの曲頭から再生を継続します。カレントコンテンツの早送り・巻き戻しが完了した場合、カレントコンテンツは変更せずに、停止状態に遷移します。

関連項目:: 定数フィールド値

ATTR_PLAY_MODE_ALL_REPEAT

public static final int ATTR_PLAY_MODE_ALL_REPEAT

再生モードの属性で、オールリピートモードを表します(=2)。

カレントコンテンツからコンテンツインデックスの昇順に、プレイリストの末尾のコンテンツまで再生を行います。末尾のコンテンツの再生が完了すると、先頭コンテンツから再生を繰り返します。

プレイリストの末尾のコンテンツの再生・早送りが完了した場合、カレントコンテンツをプレイリストの先頭コンテンツに変更し、コンテンツの曲頭から再生、または早送りを継続します。
プレイリストの先頭コンテンツの巻き戻しが完了した場合、カレントコンテンツをプレイリストの末尾のコンテンツに変更し、コンテンツの曲末尾から巻き戻しを継続します。

関連項目:: 定数フィールド値

ATTR_PLAY_MODE_SHUFFLE

public static final int ATTR_PLAY_MODE_SHUFFLE

再生モードの属性で、シャッフルモードを表します(=3)。

プレイリストのコンテンツインデックスに関係なく、再生順をランダムに入れ替えて再生を行います。

プレイリスト内の全てのコンテンツの再生・早送り・ 巻き戻しが完了した場合、カレントコンテンツをプレイリスト中のいずれかのコンテンツに変更し、停止状態に遷移します。

関連項目:: 定数フィールド値

ATTR_PLAY_MODE_SHUFFLE_REPEAT

public static final int ATTR_PLAY_MODE_SHUFFLE_REPEAT

再生モードの属性で、シャッフルリピートモードを表します(=4)。

プレイリストのコンテンツインデックスに関係なく、再生順をランダムに入れ替えて再生を行います。プレイリスト内の全てのコンテンツの再生が完了すると、カレントコンテンツをプレイリスト中のいずれかのコンテンツに変更してから再生を繰り返します。

プレイリスト内の全てのコンテンツの再生・早送りが完了した場合、カレントコンテンツをプレイリスト中のいずれかのコンテンツに変更し、コンテンツの曲頭から再生、または早送りを継続します。プレイリスト内の全てのコンテンツの巻き戻しが完了した場合、カレントコンテンツをプレイリスト中のいずれかのコンテンツに変更し、コンテンツの曲末尾から巻き戻しを継続します。

関連項目:: 定数フィールド値

ATTR_PLAY_MODE_SINGLE

public static final int ATTR_PLAY_MODE_SINGLE

再生モードの属性で、 1 曲終了モードを表します(=5)。

カレントコンテンツの再生が完了すると再生を停止します。

カレントコンテンツの再生・早送り・巻き戻しが完了した場合、カレントコンテンツは変更せずに、停止状態に遷移します。

端末が 1 曲終了モードをサポートしている場合のみ意味を持ちます。 1 曲終了モードをサポートしない端末において、setAttribute(int, int)に本属性を指定した場合、何も行わずに無視されます。

関連項目:: 定数フィールド値

メソッドの詳細

getInstance

public static Player getInstance()

音楽プレイヤーオブジェクトを取得します。

このメソッドが初めて呼ばれた場合はオブジェクトを生成して返します。以後、常に同じオブジェクトへの参照を返します。

戻り値:: 音楽プレイヤーオブジェクトを返します。
例外:: UnsupportedOperationException -
音楽プレイヤー機能をサポートしていない場合に発生します。

powerOn

public void powerOn()

音楽再生ソフトウェアを起動します。

このメソッドを実行すると、音楽再生ソフトウェアを起動します。音楽再生ソフトウェアの起動処理にはデータベースの更新が含まれるため、起動には時間がかかりますが、処理が完了するまでこのメソッドはブロックされます。

音楽再生ソフトウェア起動時にレジューム情報が残っていた場合は、レジューム情報を読み込みます。レジューム情報については、本クラスのクラス説明を参照してください。

音楽再生ソフトウェアが起動すると、音楽再生ソフトウェアの状態は停止状態に遷移します。ただし、レジューム情報の読み込みによりカレントコンテンツが設定された場合は一時停止状態に遷移します。

音楽再生ソフトウェアの状態が利用不可能状態以外でこのメソッドを呼び出した場合、何も行いません。

関連項目:: STATUS_NOT_AVAILABLE, STATUS_STOPPED
例外:: SecurityException -
ロック機能などのネイティブ独自のセキュリティ設定により、音楽再生ソフトウェアを起動できない場合に発生します。; UIException -
(NO_RESOURCES)
リソース不足により音楽再生ソフトウェアの起動に失敗した場合に発生します。; UIException -
(BUSY_RESOURCE)
競合により音楽再生ソフトウェアの起動に失敗した場合に発生します。; UIException -
(UNDEFINED)
何らかの理由により音楽再生ソフトウェアの起動に失敗した場合に発生します。

powerOff

public void powerOff()

音楽再生ソフトウェアを終了します。

このメソッドを実行すると、コンテンツの再生を停止し、音楽再生ソフトウェアを終了します。音楽再生ソフトウェアを完全に終了させるまでの間、このメソッドはブロックされます。

音楽再生ソフトウェアが終了された時にリスナが登録されていた場合、イベントタイプ PLAYER_NOT_AVAILABLE でイベントが通知されます。

powerOn() を呼び出す前や、既に powerOff() を呼び出した後など、音楽再生ソフトウェアを起動していない状態でこのメソッドを呼び出した場合は、何も行いません。

関連項目:: STATUS_NOT_AVAILABLE
例外:: UIException -
(UNDEFINED)
何らかの理由により音楽再生ソフトウェアの終了に失敗した場合に発生します。

play

public void play()

カレントコンテンツを再生します。

このメソッドを実行するとコンテンツの再生を開始します。コンテンツの再生中は、音楽再生ソフトウェアの状態は再生状態となります。

コンテンツの再生が開始された時にリスナが登録されていた場合、イベントタイプ PLAYER_PLAYING でイベントが通知されます。

再生を試みるコンテンツが再生不可能な場合、次に再生可能なコンテンツまで自動的にスキップされます。リスナが登録されている状態で後続の全てのコンテンツの再生がスキップされた場合、イベントタイプ PlayerEvent.ERROR_CANNOT_PLAY でイベントが通知されます。ただし、明示的に setContentIndex(int) によって設定されたカレントコンテンツが再生不可能なコンテンツであった場合、本メソッドを実行時に例外が発生します。

このメソッドを呼び出してコンテンツを再生すると、再生したコンテンツの情報がネイティブのミュージックプレイヤーの利用履歴に登録されます。利用履歴に登録されるタイミングは、ネイティブのミュージックプレイヤーと同様のタイミングとなります。

音楽再生ソフトウェアの状態が再生状態でこのメソッドが呼ばれた場合は、呼び出しが無視されます。

関連項目:: STATUS_PLAYING, STATUS_STOPPED
例外:: UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。; UIException -
(ILLEGAL_STATE)
再生不可能なコンテンツを再生しようとした場合に発生します。; UIException -
(NO_RESOURCES)
再生のためのリソースが確保できない場合に発生します。; UIException -
(BUSY_RESOURCE)
競合によりカレントコンテンツの再生に失敗した場合に発生します。; UIException -
(BUSY_RESOURCE)
音声・テレビ電話通話中に呼び出された場合に発生します。; UIException -
(UNDEFINED)
何らかの理由により再生開始に失敗した場合に発生します。

stop

public void stop()

コンテンツの再生を停止します。

このメソッドを実行すると現在再生しているコンテンツの再生を停止します。再生が停止されると、コンテンツの再生位置は曲頭に戻ります。コンテンツの停止中は、音楽再生ソフトウェアの状態は停止状態となります。

再生が停止された時にリスナが登録されていた場合、イベントタイプ PLAYER_STOPPED でイベントが通知されます。

音楽再生ソフトウェアの状態が停止状態でこのメソッドが呼ばれた場合は、呼び出しが無視されます。

関連項目:: STATUS_STOPPED
例外:: UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(UNDEFINED)
何らかの理由により再生停止に失敗した場合に発生します。

pause

public void pause()

コンテンツの再生を一時停止します。

このメソッドを実行すると現在再生しているコンテンツの再生を一時停止します。一時停止では、再生位置は変更されません。コンテンツの一時停止中は、音楽再生ソフトウェアの状態は一時停止状態となります。

再生が一時停止された時にリスナが登録されていた場合、イベントタイプ PLAYER_PAUSED でイベントが通知されます。

音楽再生ソフトウェアの状態が停止状態、一時停止状態でこのメソッドが呼ばれた場合は、呼び出しが無視されます。

関連項目:: STATUS_PAUSED
例外:: UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(UNDEFINED)
何らかの理由により一時停止に失敗した場合に発生します。

fastForward

public void fastForward()

コンテンツを早送りします。

このメソッドを実行するとコンテンツの早送りを開始します。コンテンツの早送り中は、音楽再生ソフトウェアの状態は早送り状態となります。

コンテンツを早送りした時にリスナが登録されていた場合、イベントタイプ PLAYER_FAST_FORWARDING でイベントが通知されます。

早送りを試みるコンテンツが再生不可能な場合、次に再生可能なコンテンツまで自動的にスキップされます。リスナが登録されている状態で後続の全てのコンテンツの早送りがスキップされた場合、イベントタイプ PlayerEvent.ERROR_CANNOT_PLAY でイベントが通知されます。ただし、明示的に setContentIndex(int) によって設定されたカレントコンテンツが再生不可能なコンテンツであった場合、本メソッドを実行時に例外が発生します。

なお、音楽再生ソフトウェアが早送り状態の時における以下の項目は機種依存です。

コンテンツが早送りされる速度
音声が鳴るかどうか

音楽再生ソフトウェアの状態が早送り状態でこのメソッドが呼ばれた場合は、呼び出しが無視されます。

例外:

UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアの状態が次のいずれかの場合に発生します。

巻き戻し状態の場合
利用不可能状態の場合

UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。

UIException -
(ILLEGAL_STATE)
再生不可能なコンテンツを早送りしようとした場合に発生します。

UIException -
(ILLEGAL_STATE)
シーク不可能なコンテンツを早送りしようとした場合に発生します。

UIException -
(NO_RESOURCES)
早送りのためのリソースが確保できない場合に発生します。

UIException -
(BUSY_RESOURCE)
競合によりカレントコンテンツの早送りに失敗した場合に発生します。

UIException -
(BUSY_RESOURCE)
音声・テレビ電話通話中に呼び出された場合に発生します。

UIException -
(UNDEFINED)
何らかの理由により早送りに失敗した場合に発生します。

fastRewind

public void fastRewind()

コンテンツを巻き戻しします。

このメソッドを実行するとコンテンツの巻き戻しを開始します。コンテンツの巻き戻し中は、音楽再生ソフトウェアの状態は巻き戻し状態となります。

コンテンツを巻き戻しした時にリスナが登録されていた場合、イベントタイプ PLAYER_FAST_REWINDING でイベントが通知されます。

巻き戻しを試みるコンテンツが再生不可能な場合、次に再生可能なコンテンツまで自動的にスキップされます。リスナが登録されている状態で後続の全てのコンテンツの巻き戻しがスキップされた場合、イベントタイプ PlayerEvent.ERROR_CANNOT_PLAY でイベントが通知されます。ただし、明示的に setContentIndex(int) によって設定されたカレントコンテンツが再生不可能なコンテンツであった場合、本メソッドを実行時に例外が発生します。

なお、音楽再生ソフトウェアが巻き戻し状態の時における以下の項目は機種依存です。

コンテンツが巻き戻しされる速度
音声が鳴るかどうか

音楽再生ソフトウェアの状態が巻き戻し状態でこのメソッドが呼ばれた場合は、呼び出しが無視されます。

例外:

UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアの状態が次のいずれかの場合に発生します。

早送り状態の場合
利用不可能状態の場合

UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。

UIException -
(ILLEGAL_STATE)
再生不可能なコンテンツを巻き戻ししようとした場合に発生します。

UIException -
(ILLEGAL_STATE)
シーク不可能なコンテンツを巻き戻ししようとした場合に発生します。

UIException -
(NO_RESOURCES)
巻き戻しのためのリソースが確保できない場合に発生します。

UIException -
(BUSY_RESOURCE)
競合によりカレントコンテンツの巻き戻しに失敗した場合に発生します。

UIException -
(BUSY_RESOURCE)
音声・テレビ電話通話中に呼び出された場合に発生します。

UIException -
(UNDEFINED)
何らかの理由により巻き戻しに失敗した場合に発生します。

setPosition

public void setPosition(int position)

コンテンツの再生位置を設定します。

カレントコンテンツの総再生時間を超える値が指定された場合の挙動は機種依存です。

指定する位置(時間)は、コンテンツを一時停止せず曲頭から等倍再生した場合にかかる経過時間として解釈されます。

カレントコンテンツがシーク不可能なコンテンツであった場合、本メソッドを実行時に例外が発生します。

音楽再生ソフトウェアの状態が停止状態でこのメソッドが呼ばれた場合は、コンテンツの再生位置を変更した上で、一時停止状態に遷移します。

パラメータ:

position - 設定する再生位置をミリ秒単位で指定します。

例外:

IllegalArgumentException -
引数 position に 0 未満の値が指定された場合に発生します。

UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアの状態が次のいずれかの場合に発生します。

早送り状態の場合
巻き戻し状態の場合
利用不可能状態の場合

UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。

UIException -
(ILLEGAL_STATE)
シーク不可能なコンテンツの再生位置を設定しようとした場合に発生します。

UIException -
(UNDEFINED)
何らかの理由により再生位置設定に失敗した場合に発生します。

getPosition

public int getPosition()

コンテンツの現在の再生位置を取得します。

コンテンツを一時停止せず等倍再生した場合に曲頭からそのポイントに到達するまでにかかる経過時間を返します。

戻り値:: 現在の再生位置をミリ秒単位で返します。
例外:: UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。; UIException -
(UNDEFINED)
何らかの理由により再生位置取得に失敗した場合に発生します。

setContentIndex

public void setContentIndex(int contentIndex)

指定されたコンテンツインデックスのコンテンツをカレントコンテンツに変更します。

コンテンツインデックスとは、あるコンテンツがプレイリストの最初から何番目の位置にあるか示す、 0 を先頭とする通し番号です。 再生モードの変更によりコンテンツの再生順が変化しても、コンテンツインデックスは変化しません。

このメソッドを実行すると、指定されたインデックスのコンテンツがカレントコンテンツになり、再生位置が曲頭に設定されます(setPosition(0) が暗黙的に呼び出されます)。現在のインデックスと同じ値が指定された場合は何も行いません。

指定されたインデックスのコンテンツが再生不可能な場合、メソッド呼び出し時の音楽再生ソフトウェアの状態に応じて以下のように振舞います。

再生状態の場合: 例外が発生します。
停止状態、一時停止状態の場合: 再生不可能なコンテンツがカレントコンテンツに設定されます。再生不可能なコンテンツの再生時の振舞いは play() を参照してください。

音楽再生ソフトウェアの状態が一時停止状態でこのメソッドが呼ばれた場合は、カレントコンテンツを変更した上で、停止状態に遷移します。

パラメータ:

contentIndex - コンテンツインデックスを指定します。

関連項目:

play()

例外:

IllegalArgumentException -
引数 contentIndex に 0 未満の値、またはカレントプレイリストの総コンテンツ数以上の値が指定された場合に発生します。

UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアの状態が次のいずれかの場合に発生します。

早送り状態の場合
巻き戻し状態の場合
利用不可能状態の場合

UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。

UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが再生状態の時に、再生不可能なコンテンツを指定した場合に発生します。

UIException -
(UNDEFINED)
何らかの理由によりカレントコンテンツの変更に失敗した場合に発生します。

getContentIndex

public int getContentIndex()

カレントコンテンツのコンテンツインデックスを取得します。

戻り値:: カレントコンテンツのコンテンツインデックスを返します。
例外:: UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。; UIException -
(UNDEFINED)
何らかの理由によりカレントコンテンツのコンテンツインデックスの取得に失敗した場合に発生します。

skipForward

public void skipForward()

コンテンツ送りをします。

このメソッドが呼ばれると、プレイリストで再生可能なコンテンツのうち、最も直後のものをカレントコンテンツにした上で、再生位置を曲頭に設定します。

このとき、再生モードがプレイリストを繰り返し再生するモード (オールリピートモード、シャッフルリピートモード)の場合は、プレイリスト末尾のコンテンツの直後に先頭のコンテンツが存在しているものとみなします。また、プレイリスト中の再生不可能コンテンツの存在は無視されます。

コンテンツの送り先が存在しない場合、このメソッドを呼んでも無視されます(カレントコンテンツは変更されません)。

コンテンツ送り時にリスナが登録されていた場合、イベントタイプ PLAYER_CHANGED でイベントが通知されます。

音楽再生ソフトウェアの状態が再生状態でこのメソッドが呼ばれた場合は、コンテンツ送り後も再生状態が継続されます。音楽再生ソフトウェアの状態が停止状態、一時停止状態でこのメソッドが呼ばれた場合、コンテンツ送り後に停止状態となります。

例外:

UnsupportedOperationException -
コンテンツ送りがサポートされていない場合に発生します。

UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアの状態が次のいずれかの場合に発生します。

早送り状態の場合
巻き戻し状態の場合
利用不可能状態の場合

UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。

UIException -
(UNDEFINED)
何らかの理由によりコンテンツ送りに失敗した場合に発生します。

skipBackward

public void skipBackward()

コンテンツ戻しをします。

このメソッドが呼ばれると、カレントコンテンツの再生位置によって以下のいずれかの振る舞いとなります。

カレントコンテンツの再生位置を曲頭に変更します。
プレイリスト上の再生可能なコンテンツのうち、直前のものをカレントコンテンツにした上で、再生位置を曲頭に変更します。

このとき、再生モードがプレイリストを繰り返し再生するモード (オールリピートモード、シャッフルリピートモード) の場合は、プレイリスト先頭のコンテンツの直前に末尾のコンテンツが存在しているものとみなします。また、プレイリスト中の再生不可能コンテンツの存在は無視されます。コンテンツの戻し先が存在しない場合は、カレントコンテンツは変更されず、再生位置を曲頭に変更します。

なお、どちらの振る舞いになるかは再生位置によって異なり、その閾値は機種依存です。プレイリスト内の全てのコンテンツが再生不可能な場合は、このメソッドを実行しても無視されます(カレントコンテンツは変更されません)。

コンテンツ戻し時にリスナが登録されていた場合、イベントタイプ PLAYER_CHANGED でイベントが通知されます。

音楽再生ソフトウェアの状態が再生状態でこのメソッドが呼ばれた場合は、コンテンツ戻し後も再生状態が継続されます。音楽再生ソフトウェアの状態が停止状態、一時停止状態でこのメソッドが呼ばれた場合、コンテンツ戻し後に停止状態となります。

例外:

UnsupportedOperationException -
コンテンツ戻しがサポートされていない場合に発生します。

UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアの状態が次のいずれかの場合に発生します。

早送り状態の場合
巻き戻し状態の場合
利用不可能状態の場合

UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。

UIException -
(UNDEFINED)
何らかの理由によりコンテンツ戻しに失敗した場合に発生します。

getStatus

public int getStatus()

音楽再生ソフトウェアの状態を取得します。

戻り値:: 音楽再生ソフトウェアの状態を取得します。
関連項目:: STATUS_NOT_AVAILABLE, STATUS_STOPPED, STATUS_PLAYING, STATUS_PAUSED, STATUS_FAST_FORWARDING, STATUS_FAST_REWINDING

setPlaylist

public void setPlaylist(Playlist playlist)

プレイリストを設定します。

このメソッドを実行すると、新しいプレイリストの先頭のコンテンツがカレントコンテンツになります(setContentIndex(0) が暗黙に呼び出されます)。カレントプレイリストと同じプレイリストが指定された場合は何も行わず、カレントコンテンツも変更されません。

引数 playlist に null が指定された場合は、音楽再生ソフトウェアは停止状態に遷移し、プレイリスト未設定の状態になります。

音楽再生ソフトウェアの状態が再生状態、一時停止状態、早送り状態、巻き戻し状態の時にプレイリストが設定された場合、音楽再生ソフトウェアは停止状態に遷移します。

パラメータ:: playlist - プレイリストを指定します。
例外:: IllegalArgumentException -
引数 playlist で指定されたプレイリストが無効化されたプレイリストの場合に発生します。; UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(UNDEFINED)
何らかの理由によりプレイリスト設定に失敗した場合に発生します。

getCurrentPlaylist

public Playlist getCurrentPlaylist()

カレントプレイリストを取得します。

このメソッドを実行するには、 ADF に AccessUserInfo キーが指定されている必要があります。

戻り値:: カレントプレイリストを返します。
例外:: SecurityException -
ADF に AccessUserInfo キーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。; UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。; UIException -
(UNDEFINED)
何らかの理由によりプレイリスト取得に失敗した場合に発生します。

getCurrentContent

public Content getCurrentContent()

カレントコンテンツを取得します。

再生予定だったコンテンツが再生制限などの理由でスキップされる可能性があるため、 PLAYER_PLAYING や PLAYER_CHANGED の通知を受けた場合はこのメソッドでカレントコンテンツを取得して情報を表示するようにしてください。

このメソッドを実行するには、 ADF に AccessUserInfo キーが指定されている必要があります。

戻り値:: カレントコンテンツを返します。
例外:: SecurityException -
ADF に AccessUserInfo キーの指定がないアプリケーションがこのメソッドを呼び出した場合に発生します。; UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(ILLEGAL_STATE)
プレイリストが設定されていない場合に発生します。; UIException -
(UNDEFINED)
何らかの理由によりカレントコンテンツ取得に失敗した場合に発生します。

setAttribute

public void setAttribute(int attr,
                         int value)

音楽再生ソフトウェアに属性を設定します。

制御可能でない属性、存在しない属性が指定された場合は何も行わずに無視されます。

パラメータ:: attr - 設定する属性を指定します。; value - 設定する属性の値を指定します。
関連項目:: DEV_VOLUME, DEV_PLAY_MODE
例外:: IllegalArgumentException -
引数 attr で指定された有効な属性に対して、引数 value に不正な値が指定された場合に発生します。; UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(UNDEFINED)
何らかの理由により属性設定に失敗した場合に発生します。

getAttribute

public int getAttribute(int attr)

音楽再生ソフトウェアから属性を取得します。

存在しない属性が指定された場合は -1 が返されます。

パラメータ:: attr - 取得する属性を指定します。
戻り値:: 指定した属性の値を返します。
関連項目:: DEV_VOLUME, DEV_PLAY_MODE
例外:: UIException -
(ILLEGAL_STATE)
音楽再生ソフトウェアが利用不可能状態の場合に発生します。; UIException -
(UNDEFINED)
何らかの理由により属性取得に失敗した場合に発生します。

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

フレームあり フレームなし

概要: 入れ子 | フィールド | コンストラクタ | メソッド

詳細: フィールド | コンストラクタ | メソッド

NTT DOCOMO,INC.

本製品または文書は著作権法により保護されており、その使用、複製、再頒布および逆コンパイルを制限するライセンスのもとにおいて頒布されます。NTTドコモ（その他に許諾者がある場合は当該許諾者も含めて）の書面による事前の許可なく、本製品および関連する文書のいかなる部分も、いかなる方法によっても複製することが禁じられます。フォントを含む第三者のソフトウェアは、著作権法により保護されており、その提供者からライセンスを受けているものです。

Sun、Sun Microsystems、Java、J2MEおよびJ2SEは、米国およびその他の国における米国 Sun Microsystems,Inc.の商標または登録商標です。サンのロゴマークは、米国 Sun Microsystems, Inc.の登録商標です。

FeliCaは、ソニー株式会社が開発した非接触ICカードの技術方式です。FeliCaは、ソニー株式会社の登録商標です。

「ｉモード」、「ｉアプリ／アイアプリ」、「ｉ-αppli」ロゴ、「DoJa」はNTTドコモの商標または登録商標です。

その他記載された会社名、製品名などは該当する各社の商標または登録商標です。

com.docomostar.ui.avplayer クラス Player

STATUS_NOT_AVAILABLE

STATUS_STOPPED

STATUS_PLAYING

STATUS_PAUSED

STATUS_FAST_FORWARDING

STATUS_FAST_REWINDING

DEV_VOLUME

DEV_PLAY_MODE

ATTR_PLAY_MODE_NORMAL

ATTR_PLAY_MODE_SINGLE_REPEAT

ATTR_PLAY_MODE_ALL_REPEAT

ATTR_PLAY_MODE_SHUFFLE

ATTR_PLAY_MODE_SHUFFLE_REPEAT

ATTR_PLAY_MODE_SINGLE

getInstance

powerOn

powerOff

play

stop

pause

fastForward

fastRewind

setPosition

getPosition

setContentIndex

getContentIndex

skipForward

skipBackward

getStatus

setPlaylist

getCurrentPlaylist

getCurrentContent

setAttribute

getAttribute

com.docomostar.ui.avplayer
クラス Player