AudioPresenter (Star-2.0 (APIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

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

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

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

com.docomostar.ui
クラス AudioPresenter

Object
  com.docomostar.ui.AudioPresenter

すべての実装されたインタフェース:: MediaPresenter

直系の既知のサブクラス:: AudioTrackPresenter

public class AudioPresenter
extends Object
implements MediaPresenter
extends Object
implements MediaPresenter

音声のメディアデータの、再生オブジェクトを定義します。メディア再生クラスは、音を出すメディアデータを再生するためのプレゼンタです。リスナを登録することによって、演奏の状態の通知を受けることができます。

端末で再生できないようなメディアデータをセットした場合の振舞は機種依存で、 MediaException が発生する場合があります。

属性の設定は setAttribute(int, int) メソッドを使用します。

同じメソッドを複数回呼出した場合は、最後に設定したデータが有効になります。

再生中にアプリケーションがサスペンドした場合、再生は停止します。すなわち、stop() メソッドが呼ばれたのと同じ状態になります。

AudioPresenterの状態管理においては、 一時停止中も再生中と同じ状態であると判断されます。例えば、同時再生数の管理においては、一時停止中のAudioPresenterも再生中として扱われます。また、例えば再生中にサスペンドが発生したり、 stop メソッドが呼ばれた場合には停止しますが、一時停止中でも同じです。

AudioPresenter では再生するポートを指定して、音声を再生できます。ポート指定が行われているAudioPresenterと、ポート指定が行われていないAudioPresenterは同時には再生されず、優先順位に関係なく後から再生を指示されたほうが優先されます。例えば、ポート指定が行われているAudioPresenterを再生中にポート指定が行われていないAudioPresenterの再生を指示すると、再生に成功しなくとも、再生中のAudioPresenterは優先順位に関係なく停止します。
PhoneSystem.playSound(int) が呼び出された場合、ポート指定がなく MAX_PRIORITY が指定された AudioPresenterの再生が指示されたように振舞います。

ポート指定がない場合の動作
同時再生可能な範囲内で複数のAudioPresenterが再生されている場合、すべてのAudioPresenterの音が聞こえます。ただし、同時発音可能な発音数やチャンネル数を超えている場合には、すべての音が聞こえるとは限りません。どの音が聞こえるかは機種依存です。同時再生可能なAudioPresenterの数を超えた場合、高優先順位のAudioPresenterが優先され、同じ優先順位の場合には後から再生を指示された方が優先されます。すなわち、同時再生可能な最大数のAudioPresenterが再生されているときに新たなAudioPresenterの再生が指示されると、その優先順位が再生中の最低優先順位のAudioPresenterの優先順位と同じあるいはそれ以上の場合、再生中の最低優先順位のAudioPresenterは停止(stop)させられ、新しいAudioPresenterが再生されます。再生中の最低優先順位のAudioPresenterが複数あった場合、どのAudioPresenterが停止させられるかは機種依存です。
新しいAudioPresenterが再生中のどのAudioPresenterの優先順位よりも低い場合、 AudioPresenterは再生されません (例外はスローされず、イベントも一切発生しません)。
例えば同時再生可能数が 2 であり、優先順位が 1 と 2のAudioPresenter ap1、ap2が再生中に優先順位 1 のAudioPresenter ap3を再生しようとした場合、 ap1は停止し、ap3が再生されます。
また、同時再生可能数が 2 であり、優先順位が 1 の2つのAudioPresenter ap1、ap2が再生中に優先順位 1 のAudioPresenter ap3を再生しようとした場合、 ap3 が再生されますが、 ap1とap2のどちらが停止するかは機種依存です。
さらに、同時再生可能数が 2 であり、優先順位が 2 の2つのAudioPresenter ap1、ap2が再生中に優先順位 1 のAudioPresenter ap3を再生しようとした場合、 ap3 の再生要求は無視されます。
ポート指定がある場合の動作
ポートは、 1つのAudioPresenterを再生可能な物理的な再生器をイメージさせるものです。 (実際にポートに対応する物理的な再生器が存在するとは限りません。) ポートは、同時再生可能なAudioPresenterと同じ数だけあります。 2つのAudioPresenterが再生可能である場合、ポート番号として0〜1が使用できます。
複数のポートでAudioPresenterが再生されている場合、すべてのAudioPresenterの音が聞こえます。ただし、同時発音可能な発音数やチャンネル数を超えている場合にはすべての音が聞こえるとは限りません。どの音が聞こえるかは機種依存です。
ポート指定がある場合の優先順位は、同じポートのAudioPresenterに対してのみ有効であることを除き、ポート指定がない場合と同様です。

SMF の再生と MFi の再生の両方をサポートしている場合であっても、 SMF と MFi の同時再生が可能かどうかは機種依存です。同時再生が不可能な場合は、後から再生しようとしたものについて play() メソッドが呼ばれた時に「実装がサポートしている以上のリソースを使用する」という理由により UIException(BUSY_RESOURCE) が発生します。

ミニマムスペック:

AUDIO_COMPLETE、AUDIO_PLAYING、AUDIO_STOPPED、 AUDIO_PAUSED、AUDIO_RESTARTED、AUDIO_SYNC、 AUDIO_LOOPED の各イベントタイプのイベントが発生することを保証します。
ミニマムスペックでは、 4 つの AudioPresenter の同時(並列)再生をサポートします。ただし、複数の PhoneSystem.playSound(int) の同時再生はサポートされない場合があります。その場合、既に playSound(int) により標準サウンド A を再生中に、別の標準サウンド B を再生しようとすると、標準サウンド A が停止し、代わりに標準サウンド B が再生されます。

導入されたバージョン:: Star-1.0
関連項目:: MediaSound, MediaListener

フィールドの概要
`static int`	`ATTR_SYNC_OFF` 同期イベントの属性値で、同期イベントを発生させないことを表します(=0)。
`static int`	`ATTR_SYNC_ON` 同期イベントの属性値で、同期イベントを発生させることを表します(=1)。
`static int`	`AUDIO_COMPLETE` 演奏が終了したことを示すイベントタイプです (=3)。
`static int`	`AUDIO_LOOPED` 演奏がループしたことを示すイベントタイプです(=7)。
`static int`	`AUDIO_PAUSED` 演奏が一時停止したことを示すイベントタイプです(=5)。
`static int`	`AUDIO_PLAYING` 演奏が開始されたことを示すイベントタイプです (=1)。
`static int`	`AUDIO_RESTARTED` 演奏が再開したことを示すイベントタイプです(=6)。
`static int`	`AUDIO_STOPPED` 演奏が中断されたことを示すイベントタイプです (=2)。
`static int`	`AUDIO_SYNC` 曲データの同期イベントを示すイベントタイプです(=4)。
`static int`	`CHANGE_TEMPO` メディア再生時のテンポを示す属性です (=5)。
`static int`	`LOOP_COUNT` メディア全体のループ再生回数を示す属性です (=6)。
`static int`	`MAX_OPTION_ATTR` オプションのオーディオ属性の最大値 (=255)。
`static int`	`MAX_PRIORITY` 優先順位の属性値で、最も高い優先順位を表します (=10)。
`protected static int`	`MAX_VENDOR_ATTR` ベンダ定義属性の種類の最大値(=127)。
`protected static int`	`MAX_VENDOR_AUDIO_EVENT` ベンダ定義のイベントの最大値(=127)。
`static int`	`MIN_OPTION_ATTR` オプションのオーディオ属性の最小値 (=128)。
`static int`	`MIN_PRIORITY` 優先順位の属性値で、最も低い優先順位を表します (=1)。
`protected static int`	`MIN_VENDOR_ATTR` ベンダ定義属性の種類の最少値(=64)。
`protected static int`	`MIN_VENDOR_AUDIO_EVENT` ベンダ定義のイベントの最少値(=64)。
`static int`	`NORM_PRIORITY` 優先順位の属性値で、通常の優先順位を表します (=5)。
`static int`	`PRIORITY` メディアデータの再生の優先順位を示す属性です(=1)。
`static int`	`SET_VOLUME` ボリュームを示す属性です(=4)。
`static int`	`SYNC_MODE` メディアデータの再生と同期してイベントを発生させるかどうかを示す属性です(=2)。
`static int`	`TRANSPOSE_KEY` メディア再生時の音程の変化を示す属性です(=3)。

コンストラクタの概要
`protected`	`AudioPresenter()` アプリケーションが直接このクラスのインスタンスを生成することはできません。

メソッドの概要
`Audio3D`	`getAudio3D() [iアプリオプションAPI]` プレゼンタに関連付けて 3D サウンドの制御を行うオブジェクトを取得します。
`static AudioPresenter`	`getAudioPresenter()` オーディオ再生オブジェクトを取得します。
`static AudioPresenter`	`getAudioPresenter(int port)` 再生するポート番号を指定してオーディオ再生オブジェクトを取得します。
`static AudioTrackPresenter`	`getAudioTrackPresenter()` 動画のオーディオトラック再生オブジェクトを取得します。
`int`	`getCurrentTime()` 曲頭からの演奏時間をms単位で返します。
`MediaResource`	`getMediaResource()` 現在セットされているメディアリソースを取得します。
`int`	`getTotalTime()` 曲全体の演奏時間をms単位で返します。
`void`	`pause()` メディアデータの再生を一時停止します。
`void`	`play()` メディアデータの再生を開始します。
`void`	`play(int time)` メディアデータの特定の位置からの再生を開始します。
`void`	`restart()` メディアデータの再生を再開します。
`void`	`setAttribute(int attr, int value)` 再生方法に関する属性値を設定します。
`void`	`setMediaListener(MediaListener listener)` リスナを登録します。
`void`	`setSound(MediaSound sound)` メディアサウンドをセットします。
`void`	`setSyncEvent(int channel, int key)` チャンネルとキーに対応するノートメッセージを同期イベントとして設定します。
`void`	`stop()` メディアデータの再生を停止します。

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

sp; 繝｡繝

com.docomostar.ui クラス AudioPresenter

com.docomostar.ui
クラス AudioPresenter