VisualPresenter (DoJa 3.5 (APIリファレンス))

概要

パッケージ

クラス

階層ツリー

非推奨 API

索引

ヘルプ

前のクラス 次のクラス

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

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

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

com.nttdocomo.ui
クラス VisualPresenter

Object
  |
  +--com.nttdocomo.ui.Component
        |
        +--com.nttdocomo.ui.VisualPresenter

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

public class VisualPresenter
extends Component
implements MediaPresenter

表示可能なメディアデータの再生オブジェクトを定義します。メディア再生コンポーネントクラスは、スクリーンに表示するメディアデータを再生するための高レベル API のコンポーネントです。リスナを登録することによって、表示の状態の通知を受けることができます。

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

属性の設定は、setAttributeメソッドを使用します。イメージを表示する位置を指定するために IMAGE_XPOS、IMAGE_YPOS 属性を使用することができます。イメージ上のIMAGE_XPOS, IMAGE_YPOS で指定された位置がプレゼンタの左上角に来るように表示されます。アプリケーションプログラムでは、この値を変更することでイメージをスクロール表示することができます。

               IMAGE_XPOS
            +---+--------------+
            |                  |<- Image (MediaImage)
 IMAGE_YPOS +   +------------+ |
            |   | Visual     | |
            |   | Presenter  | |
            |   |            | |
            |   +------------+ |
            |                  |
            +------------------+

setDataメソッドと setImage メソッドは、1つのプレゼンタオブジェクトに対して排他的に使用します。 setDataメソッドでデータを設定してからsetImageメソッドでイメージデータを設定したり、その逆をすることはできません。同じメソッドを複数回呼出した場合は、最後に設定したデータが有効になります。
[DoJa-3.0]
DoJa-3.0では上記の排他使用の制限はありません。いずれかのメソッドにより最後に設定されたデータが有効になります。

ミニマムスペック:

ミニマムスペックでは、setData メソッドを呼び出すと UnsupportedOperationException が発生します。

[DoJa-1.0]
ミニマムスペックでは、リスナの起動はしません。
[DoJa-2.0]
ミニマムスペックでは、VISUAL_COMPLETE、VISUAL_PLAYING、VISUAL_STOPPEDの各イベントタイプのイベントが発生することを保証します。
[DoJa-2.0]
アニメーションの再生中にアプリケーションがサスペンドした場合、再生は一時停止して、アプリケーションがレジュームしたら再生を再開します。

関連項目:: AudioPresenter

フィールドの概要

static int ATTR_AUDIO_OFF
           音声再生の属性値で、音声を再生しないことを表します(=0)。

static int ATTR_AUDIO_ON
           音声再生の属性値で、音声を再生することを表します(=1)。

static int ATTR_FORCE_INLINE_PLAYER
           メディアイメージの再生方法の属性値で、インラインのプレーヤでのみ再生することを表します(=3)。

static int ATTR_FORCE_NATIVE_PLAYER
           メディアイメージの再生方法の属性値で、ネイティブのプレーヤでのみ再生することを表します(=2)。

static int ATTR_PREFER_INLINE_PLAYER
           メディアイメージの再生方法の属性値で、可能であればインラインのプレーヤで再生することを表します(=1)。

static int ATTR_PREFER_NATIVE_PLAYER
           メディアイメージの再生方法の属性値で、可能であればネイティブのプレーヤで再生することを表します(=0)。

static int AUDIO_MODE
           音声付きのメディアイメージの音声を再生するかどうかを属性です(=4)。

static int IMAGE_XPOS
          イメージを表示する位置(X座標)を示す属性です(=1)。

static int IMAGE_YPOS
          イメージを表示する位置(Y座標)を示す属性です(=2)。

protected static int MAX_VENDOR_ATTR
          ベンダ定義属性の種類の最大値(=127)。

protected static int MAX_VENDOR_VISUAL_EVENT
          ベンダ定義のイベントの最大値(=127)。

protected static int MIN_VENDOR_ATTR
          ベンダ定義属性の種類の最少値(=64)。

protected static int MIN_VENDOR_VISUAL_EVENT
          ベンダ定義のイベントの最少値(=64)。

static int PLAYER_MODE
           メディアイメージの再生方法を指定する属性です(=3)。

static int VISUAL_COMPLETE
          再生が終了したことを示すイベントタイプです (=3)。

static int VISUAL_PLAYING
          再生が開始されたことを示すイベントタイプです (=1)。

static int VISUAL_STOPPED
          再生が中断されたことを示すイベントタイプです (=2)。

コンストラクタの概要

VisualPresenter()
          空のプレゼンタオブジェクトを生成します。

メソッドの概要

MediaResource getMediaResource()
          現在セットされているメディアリソースを取得します。

void play()
          メディアデータの再生を開始します。

void setAttribute(int attr, int value)
          再生方法に関する属性を設定します。

void setData(MediaData data)
          メディアデータをセットします。

void setImage(MediaImage image)
          メディアイメージをセットします。

void setMediaListener(MediaListener listener)
          リスナを登録します。

void stop()
          メディアデータの再生を停止します。

クラス com.nttdocomo.ui.Component から継承したメソッド

getHeight, getWidth, getX, getY, setBackground, setFont, setForeground, setLocation, setSize, setVisible

クラス Object から継承したメソッド

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

フィールドの詳細

IMAGE_XPOS

public static final int IMAGE_XPOS

イメージを表示する位置(X座標)を示す属性です(=1)。

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

IMAGE_YPOS

public static final int IMAGE_YPOS

イメージを表示する位置(Y座標)を示す属性です(=2)。

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

PLAYER_MODE

public static final int PLAYER_MODE

メディアイメージの再生方法を指定する属性です(=3)。デフォルトではATTR_PREFER_NATIVE_PLAYERに設定されています。

再生中に設定した場合、属性値は設定されますが、再生中の動画には反映されません。

導入されたバージョン:: DoJa-3.5
関連項目:: 定数フィールド値

ATTR_PREFER_NATIVE_PLAYER

public static final int ATTR_PREFER_NATIVE_PLAYER

メディアイメージの再生方法の属性値で、可能であればネイティブのプレーヤで再生することを表します(=0)。設定されたメディアイメージに対して、ネイティブでの再生とインラインでの再生の両方をサポートしている場合は、ネイティブでの再生を行います。どちらか一方しかサポートしていない場合はサポートしている方での再生を行います。

導入されたバージョン:: DoJa-3.5
関連項目:: 定数フィールド値

ATTR_PREFER_INLINE_PLAYER

public static final int ATTR_PREFER_INLINE_PLAYER

メディアイメージの再生方法の属性値で、可能であればインラインのプレーヤで再生することを表します(=1)。設定されたメディアイメージに対して、ネイティブでの再生とインラインでの再生の両方をサポートしている場合は、インラインでの再生を行います。どちらか一方しかサポートしていない場合はサポートしている方での再生を行います。

導入されたバージョン:: DoJa-3.5
関連項目:: 定数フィールド値

ATTR_FORCE_NATIVE_PLAYER

public static final int ATTR_FORCE_NATIVE_PLAYER

メディアイメージの再生方法の属性値で、ネイティブのプレーヤでのみ再生することを表します(=2)。設定されたメディアイメージに対して、ネイティブでの再生をサポートしていない場合は再生を行いません。

導入されたバージョン:: DoJa-3.5
関連項目:: 定数フィールド値

ATTR_FORCE_INLINE_PLAYER

public static final int ATTR_FORCE_INLINE_PLAYER

メディアイメージの再生方法の属性値で、インラインのプレーヤでのみ再生することを表します(=3)。設定されたメディアイメージに対して、インラインでの再生をサポートしていない場合は再生を行いません。

導入されたバージョン:: DoJa-3.5
関連項目:: 定数フィールド値

AUDIO_MODE

public static final int AUDIO_MODE

音声付きのメディアイメージの音声を再生するかどうかを属性です(=4)。インラインのプレーヤで再生する場合のみ有効な属性です。デフォルトではATTR_AUDIO_ONに設定されています。

再生中に設定した場合、属性値は設定されますが、再生中の動画には反映されません。

導入されたバージョン:: DoJa-3.5
関連項目:: 定数フィールド値

ATTR_AUDIO_OFF

public static final int ATTR_AUDIO_OFF

音声再生の属性値で、音声を再生しないことを表します(=0)。

導入されたバージョン:: DoJa-3.5
関連項目:: 定数フィールド値

ATTR_AUDIO_ON

public static final int ATTR_AUDIO_ON

音声再生の属性値で、音声を再生することを表します(=1)。

導入されたバージョン:: DoJa-3.5
関連項目:: 定数フィールド値

MIN_VENDOR_ATTR

protected static final int MIN_VENDOR_ATTR

ベンダ定義属性の種類の最少値(=64)。ベンダ定義の属性を定義する場合は、MIN_VENDOR_ATTRから、 MAX_VENDOR_ATTR までの値を使用しなければなりません。

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

MAX_VENDOR_ATTR

protected static final int MAX_VENDOR_ATTR

ベンダ定義属性の種類の最大値(=127)。ベンダ定義の属性を定義する場合は、MIN_VENDOR_ATTRから、 MAX_VENDOR_ATTR までの値を使用しなければなりません。

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

VISUAL_PLAYING

public static final int VISUAL_PLAYING

再生が開始されたことを示すイベントタイプです (=1)。

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

VISUAL_STOPPED

public static final int VISUAL_STOPPED

再生が中断されたことを示すイベントタイプです (=2)。

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

VISUAL_COMPLETE

public static final int VISUAL_COMPLETE

再生が終了したことを示すイベントタイプです (=3)。ループ型メディアデータの場合は、1回分のループ終了ごとにこのイベントが発生します。

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

MIN_VENDOR_VISUAL_EVENT

protected static final int MIN_VENDOR_VISUAL_EVENT

ベンダ定義のイベントの最少値(=64)。ベンダ定義のイベントを定義する場合は、MIN_VENDOR_VISUAL_EVENT から、 MAX_VENDOR_VISUAL_EVENT までの値を使用しなければなりません。

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

MAX_VENDOR_VISUAL_EVENT

protected static final int MAX_VENDOR_VISUAL_EVENT

ベンダ定義のイベントの最大値(=127)。ベンダ定義のイベントを定義する場合は、MIN_VENDOR_VISUAL_EVENT から、 MAX_VENDOR_VISUAL_EVENT までの値を使用しなければなりません。

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

コンストラクタの詳細

VisualPresenter

public VisualPresenter()

空のプレゼンタオブジェクトを生成します。

メソッドの詳細

setImage

public void setImage(MediaImage image)

メディアイメージをセットします。

パラメータ:: image - メディアイメージを指定します。
例外:: UIException - 再生中にこのメソッドを呼び出そうとした場合に発生します。; NullPointerException - 引数 image に null が指定された場合に発生します。; UIException - 引数の image にシステムが提供している以外のメディアイメージ (MediaImageインタフェースを実装した未知のクラスのオブジェクト) が渡された場合に発生します(UNSUPPORTED_FORMAT)。; UIException - 引数 image に useされていないメディアイメージが指定された場合に発生します(ILLEGAL_STATE)。; UIException - [DoJa-3.5] これ以上の数のVisualPresenterに動画を設定できない時に、引数 image に動画を指定した場合に発生します(BUSY_RESOURCE)。; UIException - 引数 image に端末で再生できないようなメディアイメージが指定された場合に発生します(UNSUPPORTED_FORMAT)。

setData

public void setData(MediaData data)

メディアデータをセットします。
端末によってはサポートされない場合があります。

定義:: インタフェース MediaPresenter 内の setData

パラメータ:: data - メディアデータを指定します。
例外:: UnsupportedOperationException - 端末がこのメソッドをサポートしていない場合に発生します。; UIException - 再生中にこのメソッドを呼び出そうとした場合に発生します(ILLEGAL_STATE)。; NullPointerException - 引数 data に null が指定された場合に発生します。; UIException - 引数の data にシステムが提供している以外のオブジェクト (MediaDataインタフェースを実装した未知のクラスのオブジェクト) が渡された場合に発生します(UNSUPPORTED_FORMAT)。; UIException - 引数 data に useされていないメディアデータが指定された場合に発生します(ILLEGAL_STATE)。

getMediaResource

public MediaResource getMediaResource()

現在セットされているメディアリソースを取得します。

定義:: インタフェース MediaPresenter 内の getMediaResource

戻り値:: メディアリソースを返します。

play

public void play()

メディアデータの再生を開始します。データを最後まで再生したら自動的に停止します。プレゼンタが実際に表示される前にplayメソッドが呼び出された場合、実際にプレゼンタが表示されてからメディアデータの再生が開始されます。再生中に play メソッドが呼ばれた場合は、再生を停止して再び先頭から再生を開始します。

定義:: インタフェース MediaPresenter 内の play

例外:: UIException - メディアデータがセットされていない場合に発生します(ILLEGAL_STATE)。; UIException - メディアデータがuse()されていない場合に発生します(ILLEGAL_STATE)。; UIException - [DoJa-3.5] これ以上の数のVisualPresenterで動画再生できない時に、動画を再生しようとした場合に発生します(BUSY_RESOURCE)。; UIException - [DoJa-3.5] 動画全体を画面に表示できなくなる可能性がある場合や、同一パネルにアニメGIFを再生しているプレゼンタが存在している場合など、端末の制限により動画が再生できない状況の場合に発生します(ILLEGAL_STATE)。; UIException - ネイティブ側で再生開始に失敗した場合に発生します(ILLEGAL_STATE)。; UIException - [DoJa-2.1] 通話中に呼び出された場合に発生します(BUSY_RESOURCE)。; UIException - [DoJa-3.5] マルチタスク機能によってバックグラウンドで動作しているネイティブ機能が未保存のデータを保持している場合に、ユーザ確認においてユーザが当該データの破棄を拒否すると発生します(BUSY_RESOURCE)。

stop

public void stop()

メディアデータの再生を停止します。停止しているときにstopメソッドが呼ばれた場合、なにもしません。

定義:: インタフェース MediaPresenter 内の stop

例外:: UIException - メディアデータがセットされていない場合に発生します(ILLEGAL_STATE)。; UIException - メディアデータがuse()されていない場合に発生します(ILLEGAL_STATE)。

setAttribute

public void setAttribute(int attr,
                         int value)

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

定義:: インタフェース MediaPresenter 内の setAttribute

パラメータ:: attr - 設定する属性の種類を指定します。; value - 設定する属性の値を指定します。
例外:: IllegalArgumentException - [DoJa-2.0] 引数 attr で指定された有効な属性に対して、引数 value に不正な値が指定された場合に発生します。

setMediaListener

public void setMediaListener(MediaListener listener)

リスナを登録します。プレゼンタに登録できるリスナは1つだけです。このメソッドを複数回呼出した場合、最後に登録したリスナだけが有効です。リスナオブジェクトとして null を指定すると、リスナの登録を削除します。

定義:: インタフェース MediaPresenter 内の setMediaListener

パラメータ:: listener - 登録するリスナを指定します。

概要