第 7 章: 埋め込み型プレーヤーのコールバック
この章では、RealPlayer イベントが発生したことをアプリケーションやスクリプトに通知するための RealPlayer のコールバック メソッドについて説明します。 以下にコールバック メソッドの一覧をアルファベット順で示します。また、Netscape プラグインや ActiveX コントロールにおけるコールバックの使用方法や、構文と使用法の例、さまざまな API バージョンに対する下位互換性のヒントについても説明します。
 |
詳細情報: コールバック メソッドの分類 (プレゼンテーションとユーザとのやり取りの処理に使用されるものなど) については、第 5 章を参照してください。
|
OnAuthorChange
制作者文字列が変更されると送信されます。
OnAuthorChange(string author)
|
author
新しい制作者名の文字列。
void を返します。
OnBuffering
バッファリングが完了した割合を送信します。
OnBuffering(int32 flags, int32 percent_complete)
|
flags
バッファリング フラグ。 以下の値のいずれかになります。
- 0 — バッファリング開始。
- 1 — シークによるバッファリング中。
- 2 — ネットワークの混雑によるバッファリング中。
- 3 — ライブ プレゼンテーションの一時停止後、再開によるバッファリング中。
 |
注意: C++ でプログラミングしている場合、rmacore.h (SDK に同梱) の BUFFERING_REASON Enumerator 内のフラグ値を使用してください。
|
percent_complete
バッファリングが完了した割合のパーセント値。
 |
警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 C++ におけるこのパラメータのデータ型は int32 ですが、Java でのデータ型は int16 です。 JavaScript や VBScript で開発している場合、どちらのデータ型も使用できます。
|
void を返します。
OnClipClosed
コントロールによってクリップが 1 つも開かれていないことを示すために送信されます。 このメソッドは、RealPlayer バージョン 5.0 以降と互換性があります。
|
警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 メソッド名は、C++ では OnClipClosed ですが、Java および JavaScript では onClipClosed です。
|
void を返します。
OnClipOpened
コントロールによってクリップが開かれた場合に送信されます。 このメソッドは、RealPlayer バージョン 5.0 以降と互換性があります。
OnClipOpened(string short_clip_name, string url)
|
|
警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 メソッド名は、C++ では OnClipOpened ですが、Java および JavaScript では onClipOpened です。
|
short_clip_name
開かれたクリップの名前。
url
開かれたクリップの URL。
void を返します。
OnContacting
RealPlayer がホストに接続すると送信されます。
OnContacting(string host_name)
|
host_name
ホスト名の文字列。
void を返します。
OnCopyrightChange
著作権文字列が変更されると送信されます。
OnCopyrightChange(string copyright)
|
copyright
新しい著作権情報の文字列。
void を返します。
OnErrorMessage
エラー発生時に送信されます。
OnErrorMessage(
int16 severity,
int32 rma_code,
int32 user_code,
string user_string,
string more_info_url,
string error
)
|
severity
最後のエラーに対するエラーの重大度。 重大度のレベルの詳細については、GetLastErrorSeverity を参照してください。
rma_code
最後のエラーからの RMA エラー コード。 RMA エラー コードについては、SDK に同梱されているヘッダー ファイル pnresult.h 内で説明しています。 通常の操作では、Helix Server によって返される可能性のある次の基本コードを全コンポーネントが処理可能であることが必要です。
- PNR_FAIL — 操作は失敗。
- PNR_OK — 操作は成功。
- PNR_UNEXPECTED — コールは想定外、またはメソッドが実装されていない。
user_code
最後のエラーからのユーザ エラー コード。 詳細については、GetLastErrorUserCode を参照してください。
user_string
最後のエラー ダイアログからのエラー文字列。 詳細については、GetLastErrorUserString を参照してください。
more_info_url
最後のエラーからの詳細情報 URL。 値がない場合もあります (詳細情報 URL がない場合など)。
error
エラーの説明。
void を返します。
OnGotoURL
現在再生中の RealPlayer のクリップに対応する URL イベントが発生した場合に送信されます。 このイベントは、AutoGotoURL 設定が FALSE の場合のみ発生します (この設定は、<EMBED> または <OBJECT> タグで AUTOGOTOURL パラメータを使用するか、または SetAutoGoToURL メソッドを使用して変更します)。
このメソッドは RealPlayer バージョン 5.0 以降と互換性があります。
OnGotoURL(string url, string target)
|
|
警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 メソッド名は、C++ では OnGotoURL ですが、Java および JavaScript では onGoToURL です。
|
url
AutoGotoURL が TRUE の場合にブラウザに送信されることになっている URL を記述します。
target
AutoGotoURL が TRUE の場合に URL を開くことになっているブラウザまたはフレームの名前。
void を返します。
OnKeyDown
ユーザがキーボードのキーを押し下げると送信されます。 このコールバック メソッドは、SetWantKeyboardEvents メソッドの set パラメータが true に設定されている場合のみ送信されます。
OnKeyDown(int32 flags, int32 key)
|
|
警告 ! Java または JavaScript でプログラミングしている場合、flags パラメータを使用することができません。 正しい構文は OnKeyDown(int32 key) です。
|
flags
キー押下に対するビット フラグ。 Windows はこのパラメータの値を Microsoft の Windows Platform SDK の WM_CHAR メッセージの下で定義します。
key
押下されたキーに対するキー コード。
void を返します。
OnKeyPress
ユーザがキーボードのキーを押してから離すと送信されます。 このコールバック メソッドは、SetWantKeyboardEvents メソッドの set パラメータが true に設定されている場合のみ送信されます。
OnKeyPress(int32 flags, int32 key)
|
|
警告 ! Java または JavaScript でプログラミングしている場合、flags パラメータを使用することができません。 正しい構文は OnKeyPress(int32 key) です。
|
flags
キー押下に対するビット フラグ。 Windows はこのパラメータの値を Microsoft の Windows Platform SDK の WM_CHAR メッセージの下で定義します。
key
押下されてから離されたキーに対するキー コード。
void を返します。
OnKeyUp
ユーザがキーボードのキーを離すと送信されます。 このコールバック メソッドは、SetWantKeyboardEvents メソッドの set パラメータが true に設定されている場合のみ送信されます。
OnKeyUp(int32 flags, int32 key)
|
|
警告 ! Java または JavaScript でプログラミングしている場合、flags パラメータを使用することができません。 正しい構文は OnKeyUp(int32 key) です。
|
flags
キー押下に対するビット フラグ。 Windows はこのパラメータの値を Microsoft の Windows Platform SDK の WM_CHAR メッセージの下で定義します。
key
離されたキーに対するキー コード。
void を返します。
OnLButtonDown
カーソルが埋め込み式コンポーネント上に置かれている時に、ユーザが左マウス ボタンを押し下げると送信されます。 このコールバック メソッドは、SetWantMouseEvents メソッドの set パラメータが true に設定されている場合のみ送信されます。
OnLButtonDown(int32 button_flags, int32 x_pos, int32 y_pos)
|
button_flags
マウスおよびマウス ボタンに対するビット フラグ。
次の表は、button_flags パラメータの値をまとめたものです。
マウス ボタン イベントに対するパラメータ値
| ビット値 |
マウス ボタン イベント |
MK_LBUTTON |
左マウス ボタンが押下されている。 |
MK_RBUTTON |
右マウス ボタンが押下されている。 |
MK_SHIFT |
キーボードの Shift キーが押下されている。 |
MK_CONTROL |
キーボードの Ctrl キーが押下されている。 |
MK_MBUTTON |
中央マウス ボタンが押下されている。 |
x_pos
左マウス ボタンが押下された時のマウスの x 座標。
y_pos
左マウス ボタンが押下された時のマウスの y 座標。
void を返します。
OnLButtonUp
カーソルが埋め込み式コンポーネント上に置かれている時に、ユーザが左マウス ボタンを離すと送信されます。 このコールバック メソッドは、SetWantMouseEvents メソッドの set パラメータが true に設定されている場合のみ送信されます。
OnLButtonUp(int32 button_flags, int32 x_pos, int32 y_pos)
|
button_flags
マウスおよびマウス ボタンに対するビット フラグ。 このパラメータの値については、マウス ボタン イベントに対するパラメータ値の表を参照してください。
x_pos
左マウス ボタンが離された時のマウスの x 座標。
y_pos
左マウス ボタンが離された時のマウスの y 座標。
void を返します。
OnMouseMove
カーソルが埋め込み式コンポーネント上に置かれている時に、ユーザがマウスを動かすと送信されます。 このコールバック メソッドは、SetWantMouseEvents メソッドの set パラメータが true に設定されている場合のみ送信されます。
|
注意: このコールバックは、マウスが動かされたことをオペレーティング システムがプラグインや ActiveX コントロールに対して通知する場合に送信されます。
|
OnMouseMove(int32 button_flags, int32 x_pos, int32 y_pos)
|
button_flags
マウスおよびマウス ボタンに対するビット フラグ。 このパラメータの値については、マウス ボタン イベントに対するパラメータ値の表を参照してください。
x_pos
マウスの x 座標。
y_pos
マウスの y 座標。
void を返します。
OnMuteChange
音量ミュートの設定時または設定解除時に送信されます。
OnMuteChange(boolean mute)
|
mute
true の場合、音量はミュートとなります。 false の場合、音量が元に戻ります。
void を返します。
OnPlayStateChange
RealPlayer 内のプレゼンテーションの再生状態が変化すると送信されます。
OnPlayStateChange(int32 old_state, int32 new_state)
|
|
警告 ! ActiveX コントロールでプログラミングしている場合、old_state パラメータは使用できません。 正しい構文は OnPlayStateChange(int32 new_state) です。 ActiveX アプリケーションに old_state パラメータおよび new_state パラメータの両方が必要な場合、代わりに OnStateChange コールバックを使用してください。
|
old_state
前の再生状態。
new_state
現在の再生状態。
次の表は、old_state パラメータおよび new_state パラメータの値をまとめたものです。
再生状態に対するパラメータ値
| パラメータ値 |
再生状態 |
0 |
停止中 |
1 |
接続中 |
2 |
バッファリング中 |
3 |
再生中 |
4 |
シーク中 |
void を返します。
OnPosLength
クリップ内の位置が変更されると送信されます。
OnPosLength(int32 pos, int32 len)
|
|
注意: このコールバックは Netscape のプラグイン専用です。 ActiveX コントロールをコーディングしている場合、代わりに OnPositionChange コールバックを使用してください。
|
pos
クリップの現在位置。単位はミリ秒。
len
クリップの長さ。単位はミリ秒。
void を返します。
OnPositionChange
クリップ内の位置が変更されると送信されます。
OnPositionChange(int32 pos, int32 len)
|
|
注意: このコールバックは ActiveX コントロール専用です。 Netscape プラグインをコーディングしている場合、代わりに OnPosLength コールバックを使用してください。
|
pos
クリップの現在位置。単位はミリ秒。
len
クリップの長さ。単位はミリ秒。
void を返します。
OnPostSeek
シーク終了時に送信されます。
OnPostSeek(int32 old_time, int32 new_time)
|
old_time
シーク開始前のプレゼンテーションの時刻。単位はミリ秒。
new_time
シーク後のプレゼンテーションの時刻。単位はミリ秒。
void を返します。
OnPreFetchComplete
コンポーネントがストリームのヘッダー情報を取得すると送信されます。 <EMBED> または <OBJECT> タグ内で PREFETCH が true に設定されている場合、または SetPreFetch メソッドの設定パラメータが true に設定されている場合にコールされます。
void を返します。
OnPreSeek
プレゼンテーションの位置スライダを移動してシークを実行すると送信されます。
OnPreSeek(int32 old_time, int32 new_time)
|
old_time
シーク開始時のプレゼンテーションの時刻。単位はミリ秒。
new_time
プレゼンテーションのシーク対象時刻。単位はミリ秒。
void を返します。
OnPresentationClosed
プレゼンテーション停止時に送信されます。
OnPresentationClosed(void)
|
void を返します。
OnPresentationOpened
プレゼンテーション開始時に送信されます。
OnPresentationOpened(void)
|
void を返します。
OnRButtonDown
カーソルが埋め込み式コンポーネント上に置かれている時に、ユーザが右マウス ボタンを押し下げると送信されます。 このコールバック メソッドは、SetWantMouseEvents メソッドの set パラメータが true に設定されている場合のみ送信されます。
OnLButtonDown(int32 button_flags, int32 x_pos, int32 y_pos)
|
button_flags
マウスおよびマウス ボタンに対するビット フラグ。 このパラメータの値については、マウス ボタン イベントに対するパラメータ値の表を参照してください。
x_pos
右マウス ボタンが押下された時のマウスの x 座標。
y_pos
右マウス ボタンが押下された時のマウスの y 座標。
void を返します。
OnRButtonUp
カーソルが埋め込み式コンポーネント上に置かれている時に、ユーザが右マウス ボタンを離すと送信されます。 このコールバック メソッドは、SetWantMouseEvents メソッドの set パラメータが true に設定されている場合のみ送信されます。
OnRButtonUp(int32 button_flags, int32 x_pos, int32 y_pos)
|
button_flags
マウスおよびマウス ボタンに対するビット フラグ。 このパラメータの値については、マウス ボタン イベントに対するパラメータ値の表を参照してください。
x_pos
右マウス ボタンが離された時のマウスの x 座標。
y_pos
右マウス ボタンが離された時のマウスの y 座標。
void を返します。
OnShowStatus
ステータス テキストが変化したことを示すために送信されます。 このメソッドは、RealPlayer バージョン 5.0 以降と互換性があります。
OnShowStatus(string status_text)
|
|
警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 メソッド名は、C++ では OnShowStatus ですが、Java および JavaScript では onShowStatus です。
|
status_text
新しいステータス テキスト。
void を返します。
OnStateChange
RealPlayer 内のプレゼンテーションの再生状態が変化すると送信されます。
|
注意: このコールバックは ActiveX コントロール専用です。 Netscape プラグインをコーディングしている場合、代わりに OnPlayStateChange コールバックを使用してください。
|
OnStateChange(int32 old_state, int32 new_state)
|
old_state
前の再生状態。
new_state
現在の再生状態。
old_state パラメータおよび new_state パラメータの値については、再生状態に対するパラメータ値の表を参照してください。
void を返します。
OnTitleChange
タイトル文字列が変更されると送信されます。
OnTitleChange(string title)
|
title
新しいタイトル文字列。
void を返します。
OnVolumeChange
音量レベルが変更されると送信されます。
OnVolumeChange(int32 new_volume)
|
new_volume
新しい音量レベル。 音量の有効範囲は 0 から 100 までで、0 は音量なしを意味します。
|
警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 C++ におけるこのパラメータのデータ型は int16 ですが、Java でのデータ型は int32 です。 JavaScript や VBScript で開発している場合、どちらのデータ型も使用できます。
|
void を返します。
|
©2002 RealNetworks, Inc. All rights reserved.
詳細については、RealNetworks を参照してください。
画面左側に目次フレームが表示されない場合は、ここをクリックしてください。
|