com.docomostar.ui.flashplayer
クラス FlashPlayerPane

Object
  拡張com.docomostar.ui.Frame
      拡張com.docomostar.ui.flashplayer.FlashPlayerPane

public class FlashPlayerPane
extends Frame
 [iアプリオプションAPI]

Flash® コンテンツを Star アプリ上で再生するための表示面を定義します。

Flash® プレイヤを Star アプリ上で操作することが可能です。 プレイヤの再生領域は表示面の全面になります。

このクラスでは『フレーム』は Flash® のフレームを表します。 このため、他のクラスで用いている『フレーム』を示す用語として『表示面』を用いています。

コンテンツ表示面ごとにプレイヤへの操作は独立しています。 このクラスによるコンテンツの再生手順は次のようになります。 このインスタンスを生成後、再生するコンテンツをプレイヤに設定するため、 set(byte[])/set(byte[], int) を呼び出します。 コンテンツの再生開始は play() を呼び出します。 再生中に一時停止をする場合には pause() を呼び出します。 一時停止から再生を再開するには restart() を呼び出します。 再生を停止する場合には、stop()を呼び出します。 なお、再度、play() を呼び出す前には必ず set(byte[])/set(byte[], int) を呼び出さなければなりません。

プレイヤと Star アプリ間のインタラクションを持ちます。 Star アプリ上で操作するプレイヤは一部機能が制限されているため、 プレイヤの処理要求を Star アプリで受けることを可能にしています。 プレイヤの処理要求はaddFlashEventListener(int, FlashEventListener) でリスナを登録することで FlashEventListener.notificationReceived(FlashEventObject) によって以下のイベントで通知されます。

Star アプリへのプレイヤのエラー通知は次のように行われます。 Star アプリからプレイヤに対する操作のタイミングで発現するプレイヤのエラーは、 例外として Star アプリに通知されます。 また、プレイヤの処理中に発現するプレイヤのエラーは、 エラーイベントとして Star アプリに通知されます。

コンテンツの再生中に Star アプリがサスペンドした場合、 コンテンツは一時停止します。 なお、Star アプリのレジューム後もコンテンツの一時停止が継続されます。 restart() を呼び出すことにより、 一時停止時のコンテンツのフレームから再生を再開できます。

コンテンツの再生中に、 コンテンツ表示面がカレントから非カレント(ダイアログ表示を除く)に遷移した場合、 コンテンツの再生を停止します。 なお、コンテンツ表示面を非カレント(ダイアログ表示を除く)からカレントに戻してもコンテンツの再生は再開されません。 コンテンツを再生するには、 再度、set(byte[])/set(byte[], int) でコンテンツを設定し、 play() を呼び出さなければなりません。

コンテンツの再生中に、 コンテンツ表示面がカレントから非カレント(ネイティブまたは Star アプリのダイアログ表示)に遷移した場合、 コンテンツの再生を一時停止します。 なお、コンテンツ表示面を非カレント(ネイティブまたは Star アプリのダイアログ表示)からカレントに戻してもコンテンツの一時停止は継続されます。 restart() を呼び出すことにより、一時停止時のコンテンツのフレームから再生を再開できます。

Star アプリにおけるコンテンツ表示面のカレントと非カレントのフレーム切り替えタイミングは、 FlashStateChangedEvent によって知ることができます。 そのためには addFlashEventListener(int, FlashEventListener) にリスナを登録してください。 登録することにより、フレーム切り替え時に FlashEventListener.notificationReceived(FlashEventObject) によるコールバックが行われます。

プレイヤの状態を以下に定義します。
状態説明
LOADED プレイヤにコンテンツが設定された状態です。
この状態への遷移
コンテンツ表示
この状態においては、表示面にコンテンツは表示されません。
PLAYING コンテンツ再生中の状態です。
この状態への遷移
コンテンツ表示
この状態においては、表示面に再生中のフレームが表示されます。
STOPPED コンテンツの再生を停止している状態です。
この状態への遷移
  • PLAYING状態で stop() を呼び出した場合に遷移します。
  • PAUSED状態で stop() を呼び出した場合に遷移します。
  • コンテンツの再生を継続することが不可能なエラーがプレイヤで発生した場合に遷移します。
  • PLAYING状態でこのコンテンツ表示面がカレントから非カレント(ダイアログ表示を除く)に変更された場合に遷移します。
  • PAUSED状態でこのコンテンツ表示面がカレントから非カレント(ダイアログ表示を除く)に変更された場合に遷移します。
コンテンツ表示
この状態においては、表示面に停止時のフレームが表示されます。
PAUSED コンテンツの再生を一時停止している状態です。
この状態への遷移
  • PLAYING状態で pause()を呼び出した場合に遷移します。
  • PLAYING状態でこのアプリがサスペンドした場合に遷移します。
  • PLAYING状態でこのコンテンツ表示面がカレントから非カレント(ネイティブまたは Star アプリのダイアログ表示)に変更された場合に遷移します。
コンテンツ表示
この状態においては、表示面に一時停止時のフレームが表示されます。

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

フィールドの概要
static int QUALITY_HIGH
          レンダリング品質の種別で、再生する品質が高いことを表します(=2)。
static int QUALITY_LOW
          レンダリング品質の種別で、再生する品質が低いことを表します(=0)。
static int QUALITY_MEDIUM
          レンダリング品質の種別で、再生する品質が普通であることを表します(=1)。
 
クラス com.docomostar.ui.Frame から継承したフィールド
ARROW_DOWN, ARROW_LEFT, ARROW_RIGHT, ARROW_UP, SELECT_KEY, SOFT_KEY_1, SOFT_KEY_2, SOFT_KEY_3, SOFT_KEY_4
 
コンストラクタの概要
FlashPlayerPane()
          コンテンツ再生のための表示面を生成します。
FlashPlayerPane(int size)
          プレイヤ用ワークメモリサイズ(Kbyte) を指定して、 コンテンツ再生のための表示面を生成します。
 
メソッドの概要
 void addFlashEventListener(int event, FlashEventListener eventListener)
          イベントリスナを登録します。
 long getFrameInterval()
          コンテンツに設定されているフレーム間隔の時間を取得します。
 int getFrameNumber()
          コンテンツで表示しているフレーム番号を取得します。
 boolean getLoop()
          コンテンツ再生の繰り返し設定状態を取得します。
 int getNumberOfFrames()
          コンテンツの総フレーム数を取得します。
 String getPlayerVersion()
          プレイヤのバージョンを取得します。
 int getQuality()
          コンテンツを再生する際のレンダリング品質を取得します。
 boolean isPlaying()
          コンテンツが再生中であるかプレイヤに問い合わせます。
 void pause()
          コンテンツの再生を一時停止します。
 void play()
          コンテンツの再生を開始します。
 void restart()
          コンテンツの再生を再開します。
 void set(byte[] data)
          コンテンツをプレイヤに設定します。
 void set(byte[] data, int rgb)
          プレイヤの背景色とコンテンツをプレイヤに設定します。
 void setLoop(boolean loop)
          コンテンツ再生の繰り返しを設定します。
 void setQuality(int value)
          コンテンツを再生する際のレンダリング品質を設定します。
 void setSoftArrowLabel(int key)
          上下左右キーの上下左右矢印の表示を設定します。
 void setSoftKeyListener(SoftKeyListener listener)
          ファンクションキーリスナを登録します。
 void setSoftLabel(int key, String label)
          ファンクションキーのラベル文字列を設定します。
 void stop()
          コンテンツの再生を停止します。
 
クラス com.docomostar.ui.Frame から継承したメソッド
getHeight, getWidth, setBackground, setSoftLabelVisible
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

QUALITY_LOW

public static final int QUALITY_LOW
レンダリング品質の種別で、再生する品質が低いことを表します(=0)。

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

QUALITY_MEDIUM

public static final int QUALITY_MEDIUM
レンダリング品質の種別で、再生する品質が普通であることを表します(=1)。

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

QUALITY_HIGH

public static final int QUALITY_HIGH
レンダリング品質の種別で、再生する品質が高いことを表します(=2)。

関連項目:
定数フィールド値
コンストラクタの詳細

FlashPlayerPane

public FlashPlayerPane()
コンテンツ再生のための表示面を生成します。

このインスタンス生成時に、 プレイヤの初期化と 256Kbytes のプレイヤ用ワークメモリの確保を行います。 ただし、メモリ状態によっては、プレイヤ用ワークメモリが確保できない場合があります。 その場合には、例外が発生します。

端末によっては、Flash® プレイヤ連携機能をサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。

例外:
UnsupportedOperationException -
この端末が Flash® プレイヤ連携機能をサポートしていない場合に発生します。
UIException -
(NO_RESOURCES)
プレイヤ用ワークメモリが確保できない場合に発生します。

FlashPlayerPane

public FlashPlayerPane(int size)
プレイヤ用ワークメモリサイズ(Kbyte) を指定して、 コンテンツ再生のための表示面を生成します。

引数 size に 256Kbytes 以上のプレイヤ用ワークメモリのサイズを指定できます。 このインスタンス生成時に、 プレイヤの初期化と指定したサイズのプレイヤ用ワークメモリの確保を行います。 ただし、メモリ状態によっては、プレイヤ用ワークメモリが確保できない場合があります。 その場合には、例外が発生します。

端末によっては、Flash® プレイヤ連携機能をサポートしていない場合があります。 その場合には、例外 UnsupportedOperationException が発生します。

パラメータ:
size - プレイヤ用ワークメモリをキロバイト単位で指定します。
例外:
UnsupportedOperationException -
この端末が Flash® プレイヤ連携機能をサポートしていない場合に発生します。
IllegalArgumentException -
引数 size に 256Kbytes 未満の値を指定した場合に発生します。
UIException -
(NO_RESOURCES)
プレイヤ用ワークメモリが確保できない場合に発生します。
メソッドの詳細

setLoop

public void setLoop(boolean loop)
コンテンツ再生の繰り返しを設定します。

デフォルトでは、true が設定されます。

PLAYING状態でも、 このメソッドの実行により繰り返し設定は変更可能です。

パラメータ:
loop - 再生を繰り返す場合にはtrueを、繰り返さない場合にはfalseを設定します。

getLoop

public boolean getLoop()
コンテンツ再生の繰り返し設定状態を取得します。

戻り値:
繰り返しが設定されている場合にはtrue、 繰り返しが設定されていない場合にはfalseを返します。

setQuality

public void setQuality(int value)
コンテンツを再生する際のレンダリング品質を設定します。

品質の設定値は以下のいずれかです。

なお、デフォルトでは、QUALITY_MEDIUM が設定されます。

パラメータ:
value - 品質を指定します。
関連項目:
getQuality()
例外:
IllegalArgumentException -
引数valueで指定された値が不正な値の場合に発生します。

getQuality

public int getQuality()
コンテンツを再生する際のレンダリング品質を取得します。

戻り値:
コンテンツの再生品質を表す値を返します。
関連項目:
setQuality(int)

getPlayerVersion

public String getPlayerVersion()
プレイヤのバージョンを取得します。

戻り値:
プレイヤのバージョンを返します。

addFlashEventListener

public void addFlashEventListener(int event,
                                  FlashEventListener eventListener)
イベントリスナを登録します。

このメソッドを用いてイベントリスナを登録すると、 登録したイベントが発生した場合にイベントが通知されるようになります。

既に登録したリスナを解除するには、引数 eventListener に null を指定してください。

パラメータ:
event - 登録したいイベントの種類を指定します。 FlashEventObject クラスで定義されている定数を指定します。
eventListener - 引数 event で指定したイベントが発生した時に、 FlashEventListener.notificationReceived(FlashEventObject) を呼び出して欲しいリスナを指定します。 既に登録されているリスナを解除する時には null を指定します。
例外:
IllegalArgumentException -
引数 event に不正な値が指定された場合に発生します。
IllegalArgumentException -
既に、引数 event で指定したイベントに対応するリスナが登録されているにもかかわらず、 引数 eventListener に null で無い値を指定した場合に発生します。

setSoftKeyListener

public void setSoftKeyListener(SoftKeyListener listener)
ファンクションキーリスナを登録します。

このインスタンスに登録できるリスナは一つだけです。 このメソッドを複数回呼び出した場合は最後に登録したリスナだけが有効です。

リスナオブジェクトとして null を指定するとリスナの登録を解除します。

パラメータ:
listener - 登録するリスナオブジェクトを指定します。

set

public void set(byte[] data)
コンテンツをプレイヤに設定します。

このメソッドの呼び出しにより、 この表示面のプレイヤの状態はLOADED状態に遷移します。

このコンテンツ表示面が、カレントか非カレントにかかわらずコンテンツの設定が可能です。 ただし、この表示面が非カレントで、 プレイヤの状態がSTOPPED状態およびPAUSED状態の場合には、 このメソッドの呼び出しは無視されます。 この場合、例外は発生しません。

この表示面に既にコンテンツが設定されてる場合は、 この表示面のプレイヤの状態にかかわらず、このメソッドの呼び出した時点で、 引数 data のコンテンツに置き換わります。

コンテンツのステージ色をプレイヤの背景色としてプレイヤに設定します。 コンテンツのステージ色が無色である場合、プレイヤの背景色はプレイヤのデフォルト背景色です。

パラメータ:
data - 入力バイト配列を指定します。
例外:
NullPointerException -
引数dataに null が指定された場合に発生します。
UIException -
(UNSUPPORTED_FORMAT)
引数dataに不正なコンテンツが指定された場合に発生します。
UIException -
(NO_RESOURCES)
システムリソース不足などでコンテンツをプレイヤに設定できない場合に発生します。

set

public void set(byte[] data,
                int rgb)
プレイヤの背景色とコンテンツをプレイヤに設定します。

このメソッドの呼び出しにより、 この表示面のプレイヤの状態はLOADED状態に遷移します。

このコンテンツ表示面が、カレントか非カレントにかかわらずコンテンツの設定が可能です。 ただし、この表示面が非カレントで、 プレイヤの状態がSTOPPED状態およびPAUSED状態の場合には、 このメソッドの呼び出しは無視されます。 この場合、例外は発生しません。

この表示面に既にコンテンツが設定されてる場合は、 この表示面のプレイヤの状態にかかわらず、このメソッドの呼び出した時点で、 引数 data のコンテンツに置き換わります。

引数 rgb に指定した色をプレイヤの背景色としてプレイヤに設定します。 なお、引数 rgb への色の指定は、RGBとする0x00rrggbbの形式で行います。 int 型の先頭 9 ビット目から順次 8 ビットづつ、 赤 (red)、 緑 (green)、 青 (blue) を指定します。 なお、int 型の上位 8 ビットに値を設定した場合には、その値は無視されます。

パラメータ:
data - 入力バイト配列を指定します。
rgb - 0x00rrggbbの形式でプレイヤの背景色を指定します。なお、上位8ビットは無視されます。
例外:
NullPointerException -
引数dataに null が指定された場合に発生します。
UIException -
(UNSUPPORTED_FORMAT)
引数dataに不正なコンテンツが指定された場合に発生します。
UIException -
(NO_RESOURCES)
システムリソース不足などでコンテンツをプレイヤに設定できない場合に発生します。

getFrameInterval

public long getFrameInterval()
コンテンツに設定されているフレーム間隔の時間を取得します。

戻り値:
コンテンツに設定されているフレーム間隔の時間をミリ秒で返します。
例外:
UIException -
(ILLEGAL_STATE)
プレイヤにコンテンツが設定されていない場合に発生します。

play

public void play()
コンテンツの再生を開始します。

LOADED状態でコンテンツ表示面がカレントである場合に、このメソッドを呼び出すと、 コンテンツの最初のフレームから再生を開始します。 このメソッドの呼び出しにより、 この表示面のプレイヤの状態はPLAYING状態に遷移します。 また、LOADED状態でコンテンツ表示面が非カレントである場合に、このメソッドを呼び出すと、 例外 UIException が発生します。

なお、LOADED状態でない場合、このメソッドの呼び出しは無視されます。この場合、例外は発生しません。

例外:
UIException -
(ILLEGAL_STATE)
プレイヤにコンテンツが設定されていない場合に発生します。
UIException -
(ILLEGAL_STATE)
コンテンツ表示面が非カレントであり、LOADED状態であるときに呼び出した場合に発生します。

stop

public void stop()
コンテンツの再生を停止します。

このメソッドの呼び出しにより、 この表示面のプレイヤの状態はSTOPPED状態に遷移します。

このコンテンツ表示面がカレントで、 PLAYING状態とPAUSED状態でない場合、 このメソッドの呼び出しは無視されます。 また、この表示面が非カレントの場合もこのメソッドの呼び出しは無視されます。 これらの場合、例外は発生しません。


pause

public void pause()
コンテンツの再生を一時停止します。

このメソッドの呼び出しにより、 この表示面のプレイヤの状態はPAUSED状態に遷移します。

このコンテンツ表示面がカレントで PLAYING状態でない場合、 このメソッドの呼び出しは無視されます。 また、この表示面が非カレントの場合もこのメソッドの呼び出しは無視されます。 これらの場合、例外は発生しません。

コンテンツの再生を再開するにはrestart()を呼び出します。


restart

public void restart()
コンテンツの再生を再開します。

このメソッドの呼び出しにより、 この表示面のプレイヤの状態はPLAYING状態に遷移します。

このコンテンツ表示面がカレントでPAUSED状態でない場合、 このメソッドの呼び出しは無視されます。 また、この表示面が非カレントの場合もこのメソッドの呼び出しは無視されます。 これらの場合、例外は発生しません。


isPlaying

public boolean isPlaying()
コンテンツが再生中であるかプレイヤに問い合わせます。

戻り値:
再生中である場合にはtrueを、そうでない場合にはfalseを返します。
例外:
UIException -
(ILLEGAL_STATE)
プレイヤにコンテンツが設定されていない場合に発生します。

getFrameNumber

public int getFrameNumber()
コンテンツで表示しているフレーム番号を取得します。

戻り値:
表示しているフレーム番号を返します。
例外:
UIException -
(ILLEGAL_STATE)
プレイヤにコンテンツが設定されていない場合に発生します。

getNumberOfFrames

public int getNumberOfFrames()
コンテンツの総フレーム数を取得します。

戻り値:
総フレーム数を返します。
例外:
UIException -
(ILLEGAL_STATE)
プレイヤにコンテンツが設定されていない場合に発生します。

setSoftLabel

public void setSoftLabel(int key,
                         String label)
ファンクションキーのラベル文字列を設定します。

設定したラベル文字列は、 この表示面がカレントになったときに、 ファンクションキーのラベル文字列を表示する位置に自動的に設定されます。 なお、この表示面がカレントのとき、 このメソッドによってラベル文字列を変更した場合は、即時に表示が変更されます。

引数 key に Frame.SELECT_KEY が指定された場合、このメソッドの呼び出しは無視されます。 この場合、例外は発生しません。

オーバーライド:
クラス Frame 内の setSoftLabel
パラメータ:
key - ラベル文字列を設定するファンクションキーの番号を指定します。 Frame.SOFT_KEY_1, Frame.SOFT_KEY_2, Frame.SOFT_KEY_3, Frame.SOFT_KEY_4 のいずれかを指定します。
label - ラベル文字列を指定します。 null を指定した場合は、ファンクションキーのラベル文字列を表示しません。 空文字列("")が指定された場合は、空文字列("")のラベルを表示します。
例外:
IllegalArgumentException -
引数 key に不正な値が指定された場合に発生します。

setSoftArrowLabel

public void setSoftArrowLabel(int key)
上下左右キーの上下左右矢印の表示を設定します。

このクラスでは、上下左右矢印の表示を設定できないので、 オーバライドにより機能を止めています。したがって、 このメソッドを呼び出した場合、常に UnsupportedOperationException 例外が発生します。

オーバーライド:
クラス Frame 内の setSoftArrowLabel
パラメータ:
key - 指定に意味を持ちません。
例外:
UnsupportedOperationException -
このメソッドが呼ばれた場合に発生します。


NTT DOCOMO,INC.

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

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

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

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

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