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)。

関連項目:
定数フィールド値
繧ッ繝ゥ繧ケ com.docomostar.ui.