戻る 次へ

第 6 章: 埋め込み型プレーヤーのメソッド

アプリケーションアプレットやコントロールは、この章で説明しているメソッドを使って RealOne Player の埋め込み環境と通信することができます。 以下にコールバック メソッドの一覧をアルファベット順で示します。また、Netscape プラグインや ActiveX コントロールにおけるメソッドの使用方法や、構文と使用法の例、さまざまな API バージョンに対する下位互換性のヒントについても説明します。

詳細情報: メソッドの分類 (プレゼンテーションの再生コントロールに使用されるもの、など) については、「第 5 章」を参照してください。

注意: 次の一覧内のメソッドの多くは、プラグインに対してブール型の値を返します。 このブール型の値は必ず true を返すため、プラグインの開発者は値を無視してもかまいません。 この値は、プラグインで重大なエラーが発生した場合のみ false となります。 このため、スクリプトがうまく動作しない場合はこの戻り値を確認するとよいでしょう。

CanPause

プレーヤーが現在、一時停止可能なクリップを再生中かどうかを示します。

CanPause(void)

プレーヤーが現在クリップを再生中であれば true を返します。 プレーヤーが一時停止中または停止中であれば false を返します。

CanPlay

プレーヤーが現在、クリップを一時停止中または停止中か、再生中かを示します。

CanPlay(void)

プレーヤーが現在一時停止中または停止中で、現在のソース ファイルが有効であれば true を返します。 プレーヤーが現在再生中であれば false を返します。

CanStop

現在のクリップが再生中、一時停止中、または停止中かを示します。 このメソッドは、RealPlayer バージョン 5.0 以降と互換性があります。

CanStop(void)

RealOne Player が現在クリップを再生中または一時停止中であれば true を返します。 クリップがすでに停止中であれば false を返します。

DoGotoURL

コントロールによって指定フレーム ターゲット内の指定 URL へと移動するように試行します。 コンテナは URL 表示をサポートしている必要があります。 このメソッドは RealPlayer 5.0 以上で構築された ActiveX コントロールと下位互換性がありますが、バージョン 5.0 での Netscape プラグインとの互換性はありません。

DoGotoURL(string url, string target)

url

移動先の URL。

target

移動先のフレーム ターゲット。

この関数を使用するにはターゲット パラメータが必要ですが、パラメータ値は無視されます。

void を返します。

DoNextEntry

複数のクリップを収録した RAM (.ram または .rpm) ファイルや SMIL ファイル内の次のクリップへとスキップします。 SMIL ファイルの場合、<par> グループは単一のクリップとして処理されます。

DoNextEntry(void)

プラグインに対してブール型の値を返します。

DoPause

現在のクリップを一時停止させます。 [Pause (一時停止)] ボタンをクリックした場合と同じです。

DoPause(void)

プラグインに対してブール型の値を返します。

DoPlay

現在のクリップを再生します。 [Play (再生)] ボタンをクリックした場合と同じです。

DoPlay(void)

プラグインに対してブール型の値を返します。

DoPrevEntry

複数のクリップを収録した RAM (.ram または .rpm) ファイルや SMIL ファイル内の前のクリップへとスキップします。 SMIL ファイルの場合、<par> グループは単一のクリップとして処理されます。

DoPrevEntry(void)

プラグインに対してブール型の値を返します。

DoStop

クリップを停止させます。 [Stop (停止)] ボタンをクリックした場合と同じです。 このメソッドは、RealPlayer バージョン 5.0 以降と互換性があります。

DoStop(void)

プラグインに対してブール型の値を返します。

GetAuthor

現在のクリップの制作者文字列を示します。

GetAuthor(void)

現在のクリップの制作者名を格納した文字列を返します。

GetAutoGoToURL

AutoGoToURL 設定が有効になっているかどうかを示します。

GetAutoGoToURL(void)

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 メソッド名は、C++ では GetAutoGotoURL ですが、Java では GetAutoGoToURL です。 JavaScript や VBScript で開発している場合、どちらのメソッド名も使用できます。

設定が有効となっていれば true を返します。 設定が無効になっていれば false を返します。

GetAutoStart

再生が自動的に開始されるかどうかを示します。

GetAutoStart(void)

再生が自動的に開始される場合、true を返します。 再生が自動的に開始されない場合は false を返します。

GetBackgroundColor

イメージ ウィンドウの現在の背景色に対する 16 進数値を示します。

GetBackgroundColor(void)

#RRGGBB 形式の RGB 16 進数の色値を持つ文字列を返します。 色値に対する色名称は SetBackgroundColor に説明があります。

GetBandwidthAverage

プレゼンテーションが使用する帯域幅の平均量を示します。

GetBandwidthAverage(void)

再生開始から現在時刻までのパケット転送の平均帯域幅をビット毎秒の値で格納した int32 を返します。

GetBandwidthCurrent

プレゼンテーションが使用する帯域幅の現在の量を示します。

GetBandwidthCurrent(void)

現在の帯域幅をビット毎秒単位で格納した int32 を返します。

GetBufferingTimeElapsed

現在までに経過したバッファリング時間を示します。

GetBufferingTimeElapsed(void)

経過したバッファリング時間をミリ秒単位で格納した int32 を返します。

GetBufferingTimeRemaining

残りの推定バッファリング時間を示します。

GetBufferingTimeRemaining(void)

残りの推定バッファリング時間をミリ秒の値で格納した int32 を返します。

GetCanSeek

ユーザ インターフェイスからクリップ内をシークできるかどうかを示します。

GetCanSeek(void)

クリップ内でシーク可能であれば true を返します。 クリップ内でシークできない場合は false を返します。 ライブまたは疑似ライブ クリップは常に falseを返します。

GetCenter

ビジュアル データ型がイメージ ウィンドウ内で中央配置されているかどうかを示します。

GetCenter(void)

ビジュアル データ型がイメージ ウィンドウ内で中央配置されている場合は true を返します。 データ型が中央配置されていない場合は false (デフォルト) を返します。

GetClipHeight

プレゼンテーションの高さを示します。

GetClipHeight(void)

クリップ ウィンドウの高さをピクセル単位で格納した int32 を返します。 プレゼンテーションがビジュアルでない場合は、0 の値が返されます。

GetClipWidth

プレゼンテーションの幅を示します。

GetClipWidth(void)

クリップ ウィンドウの幅をピクセル単位で格納した int32 を返します。 プレゼンテーションがビジュアルでない場合は、0 の値が返されます。

GetConnectionBandwidth

RealOne Player の環境設定でユーザが設定した通常の最大帯域幅を示します。

GetConnectionBandwidth(void)

RealOne Player の環境設定ダイアログ ボックスの [Connections (接続)] カテゴリからの最大帯域幅の値をビット毎秒単位で格納した int32 を返します。

GetConsole

複数のコントロール インスタンスをリンクするためのコンソール名を示します。

GetConsole(void)

埋め込まれたコントロールに現在関連付けられている RealOne Player コンソールの名称を格納した文字列を返します。

GetConsoleEvents

コンソール イベントが有効になっているかどうかを示します。

GetConsoleEvents(void)

コンソール イベントが有効となっていれば true を返します。 コンソール イベントが無効になっていれば false を返します。

詳細情報: コンソール イベントの詳細については、「イベント処理」を参照してください。

GetControls

RealOne Player コントロールの可視コンポーネント名を示します。

GetControls(void)

埋め込まれたコントロールの名前または ID に現在関連付けられている RealOne Player コントロールの名称を格納した文字列を返します。

詳細情報: 有効なコントロール名については、「埋め込まれたコントロール」を参照してください。

GetCopyright

現在のクリップの著作権文字列を示します。

GetCopyright(void)

現在のクリップの著作権情報を格納した文字列を返します。

GetCurrentEntry

現在再生中のエントリ番号を示します。

GetCurrentEntry(void)

現在再生中のエントリ番号を格納した int32 を返します。 1 番目のエントリの現在のエントリ番号は 0 となります。

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 を返しますが、Java では int32 を返します。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

GetDRMInfo

ライセンス サーバが特定のユーザに対するコンテンツ ライセンスを生成するために必要なクライアント情報を与えます。 このメソッドは、RealNetworks のデジタル著作権管理システムと組み合わせて使用されます。

GetDRMInfo (string identifier)

identifier

ライセンスが返される 4 文字の文字列識別子。たとえば、文字列 RNBA は Helix DRM に対して使用されます。

次の形式の文字列を返します (読みやすくするために改行を入れてあります)。

ClientPubKey=<ClientPubKey>
&Challenge=<Challenge>
&ExtraInfo=<ExtraInfo>

注意: このメソッドは埋め込み型プレーヤーのビルド 6.0.8.1024 以降のみで使用可能です。

GetDoubleSize

画像が現在 2 倍サイズ モードになっているかどうかを示します。

GetDoubleSize(void)

画像が 2 倍サイズであれば true を返します。 画像が 2 倍サイズでなければ false を返します。

注意: このメソッドは、アプリケーション内で使用されている ActiveX コントロールおよびプラグイン専用であり、Web ページ用ではありません。

GetEntryAbstract

指定されたプレイリスト エントリの概要を示します。

GetEntryAbstract(int32 entry_index)

entry_index

プレイリスト内のクリップの、概要を要求するエントリ番号。 プレイリスト内の 1 番目のクリップのエントリ番号は 0 となります。

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 のパラメータが必要ですが、Java では int32 のパラメータが必要です。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

指定されたプレイリスト エントリの概要を格納した文字列を返します。

GetEntryAuthor

指定されたプレイリスト エントリの制作者を示します。

GetEntryAuthor(int32 entry_index)

entry_index

プレイリスト内のクリップの、制作者名を要求するエントリ番号。 プレイリスト内の 1 番目のクリップのエントリ番号は 0 となります。

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 のパラメータが必要ですが、Java では int32 のパラメータが必要です。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

指定されたプレイリスト エントリの制作者名を格納した文字列を返します。

GetEntryCopyright

指定されたプレイリスト エントリの著作権を示します。

GetEntryCopyright(int32 entry_index)

entry_index

プレイリスト内のクリップの、著作権情報を要求するエントリ番号。 プレイリスト内の 1 番目のクリップのエントリ番号は 0 となります。

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 のパラメータが必要ですが、Java では int32 のパラメータが必要です。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

指定されたプレイリスト エントリの著作権情報を格納した文字列を返します。

GetEntryTitle

指定されたプレイリスト エントリのタイトルを示します。

GetEntryTitle(int32 entry_index)

entry_index

プレイリスト内のクリップの、タイトルを要求するエントリ番号。 プレイリスト内の 1 番目のクリップのエントリ番号は 0 となります。

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 のパラメータが必要ですが、Java では int32 のパラメータが必要です。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

指定されたプレイリスト エントリのタイトルを格納した文字列を返します。

GetFullScreen

画像が現在全画面モードになっているかどうかを示します。

GetFullScreen(void)

画像が全画面モードであれば true を返します。 画像が全画面モードでなければ false を返します。

GetImageStatus

イメージ ウィンドウにステータス テキストが書き込まれているかどうかを示します。

GetImageStatus(void)

イメージ ウィンドウにステータス テキストが書き込まれていれば true を返します。 ステータス テキストが送信されていなければ false を返します。

GetLastErrorMoreInfoURL

最後のエラーからの詳細情報 URL を示します。

GetLastErrorMoreInfoURL(void)

詳細情報 URL を格納した文字列を返します。 戻り値の値がない場合もあります (詳細情報 URL がない場合など)。

GetLastErrorRMACode

通常の操作では、Helix Server によって返される可能性のある次の基本コードを、全コンポーネントが処理可能であることが必要です。

GetLastErrorRMACode(void)

エラー コード値を格納した int32 を返します。

GetLastErrorSeverity

最後のエラーに対するエラーの重大度を示します。

GetLastErrorSeverity(void)

エラー レベルを格納した int32 を返します。

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 を返しますが、Java では int32 を返します。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

エラー レベルは次のとおりです。

エラー レベル
レベル 条件 使用法
0 パニック システム障害となる可能性のあるエラー。 RealOne Player は問題解決に必要なアクションを実行します。 プレゼンテーションをシャット ダウンする場合もあります。
1 非常に重大 ただちにユーザが介入して問題を解決する必要のあるエラー。 RealOne Player は必要に応じてプレゼンテーションをシャット ダウンします。
2 重大 場合によってはユーザが介入して問題を解決する必要のあるエラー。 RealOne Player は必要に応じてプレゼンテーションをシャット ダウンします。
3 一般 通常のシステム動作では重大な問題の発生しないエラー。
4 警告 通常のシステム動作では重大な問題は発生しないが、注意する必要のあるエラー。
5 通知 通常のシステム動作では重大な問題は発生しないが、注意する必要のある状態についての通知。
6 情報 情報メッセージのみ。
7 デバッグ デバッグ専用の情報。

GetLastErrorUserCode

最後のエラーからのユーザ エラー コードを示します。

GetLastErrorUserCode(void)

ユーザ エラー コードを格納した int32 を返します。 このメソッドは常に 0 を返します。ただし、エラー イベントに対して独自のユーザ定義エラー コードを出力するカスタム プラグインを使用している場合を除きます。

GetLastErrorUserString

最後のエラー ダイアログからのエラー文字列を取得します。

GetLastErrorUserString(void)

最後のエラー メッセージを格納した文字列を返します。 エラー イベントに対して独自のユーザ定義エラー文字列を出力するカスタム プラグインを使用していない場合、このメソッドは値を返しません。

GetLastMessage

OnShowStatus コールバック メソッドから返された最後のステータス メッセージのテキストを取得します。

注意: このメソッドは ActiveX コントロール専用です。 Netscape プラグインをコーディングしている場合、代わりに GetLastStatus メソッドを使用してください。

GetLastMessage(void)

最後のステータス メッセージを格納した文字列を返します。

GetLastStatus

OnShowStatus コールバック メソッドから返された最後のステータス メッセージのテキストを取得します。

注意: このメソッドは Netscape のプラグイン専用です。 ActiveX コントロールをコーディングしている場合、代わりに GetLastMessage メソッドを使用してください。

GetLastStatus(void)

最後のステータス メッセージを格納した文字列を返します。

GetLength

クリップの合計長を示します。

GetLength(void)

クリップの合計長をミリ秒単位で格納した int32 を返します。 有効な値は >=0 です。

GetLiveState

現在のクリップがライブかどうかを示します。

GetLiveState(void)

現在のクリップがライブならば true を返します。 現在のクリップがライブでなければ false を返します。

GetLoop

クリップがループ再生に設定されているかどうかを示します。

GetLoop(void)

クリップが再生中断までループ再生するように設定されていれば、true を返します。 クリップがループ再生でなければ (デフォルト)、 false を返します。

GetMaintainAspect

ビジュアル データ型のアスペクト比が維持されているかどうかを示します。

GetMaintainAspect(void)

ビジュアル データ型のアスペクト比が維持されていれば true を返します。 イメージ ウィンドウが引き伸ばされてアスペクト比が変更されていれば false (デフォルト) を返します。

GetMute

音量がミュートになっているかどうかを示します。

GetMute(void)

音量がミュートになっていれば true を返します。 音量がミュートになっていなければ false を返します。

GetNumEntries

プレイリスト内のエントリ総数を示します。

GetNumEntries(void)

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 を返しますが、Java では int32 を返します。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

プレイリスト内のエントリ総数を格納した int32 を返します。 単一のエントリのエントリ数は 1 となります。

GetNumLoop

クリップのループ再生回数の設定値を示します。

GetNumLoop(void)

SetNumLoop によって設定されたクリップのループ再生回数の値を、int32 で返します。

GetNumSources

プレゼンテーション内のソース数を示します。

GetNumSources(void)

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 を返しますが、Java では int32 を返します。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

プレゼンテーション内のソース数を格納した int32 を返します。

GetOriginalSize

画像が現在オリジナルのサイズになっているかどうかを示します。

GetOriginalSize(void)

画像がオリジナルのサイズであれば true を返します。 画像がオリジナルのサイズでなければ false を返します。

GetPacketsEarly

再生準備ができる前に Helix Server から受信したパケット総数を返します。

注意: このメソッドは ActiveX コントロール専用です。

GetPacketsEarly(void)

受信の早すぎるパケット総数を格納した int32 を返します。

GetPacketsLate

再生までに受信の遅すぎた Helix Server からのパケット総数を示します。

GetPacketsLate(void)

受信の遅すぎるパケット総数を格納した int32 を返します。

GetPacketsMissing

再生までに受信が間に合わなかった Helix Server からのパケット総数を示します。

GetPacketsMissing(void)

受信の間に合わなかったパケット総数を格納した int32 を返します。

GetPacketsOutOfOrder

順序違いで受信した Helix Server からのパケット総数を示します。

GetPacketsOutOfOrder(void)

順序違いで受信したパケット総数を格納した int32 を返します。

GetPacketsReceived

現在までに Helix Server から受信したパケット総数を示します。

GetPacketsReceived(void)

現在までに受信したパケット総数を格納した int32 を返します。

GetPacketsTotal

プレゼンテーションによって現在までに使用されたパケット総数を示します。 このメソッドによって出力されたパケット総数は、受信パケット総数と消失パケット総数の合計です。 消失パケットがない場合、このメソッドは GetPacketsReceived と同じパケット総数を返します。

GetPacketsTotal(void)

パケット総数を格納した int32 を返します。

GetPlayState

RealOne Player の現在の状態を示します。

GetPlayState(void)

次の意味を持つ int32 の値を返します。

GetPosition

クリップ内の現在位置を示します。

GetPosition(void)

クリップ内の現在位置をミリ秒単位で格納した int32 を返します。 有効な値は >=0 から <=クリップ合計長の範囲です。

GetPreFetch

PREFETCH が有効になっているかどうかを示します。

GetPreFetch(void)

PREFETCH が有効となっていれば true を返します。 PREFETCH が有効になっていなければ false を返します。

GetShowAbout

[About (バージョン情報)] ダイアログ ボックスが表示されているかどうかを示します。

GetShowAbout(void)

[About (バージョン情報)] ダイアログ ボックスが表示されていれば true を返します。 表示されていなければ false を返します。

GetShowPreferences

[Preferences (環境設定)] ダイアログ ボックスが表示されているかどうかを示します。

GetShowPreferences(void)

[Preferences (環境設定)] ダイアログ ボックスが表示されていれば true を返します。 表示されていなければ false を返します。

GetShowStatistics

RealOne Player の [Statistics (統計情報)] ダイアログ ボックスが表示されているかどうかを示します。

GetShowStatistics(void)

RealOne Player の [Statistics (統計情報)] ダイアログ ボックスが表示されていれば true を返します。 表示されていなければ false (デフォルト) を返します。

GetShuffle

シャッフル再生が有効になっているかどうかを示します。

GetShuffle(void)

シャッフル再生が有効となっていれば true を返します。 シャッフル再生が無効になっていれば false を返します。

GetSource

再生中のクリップの URL を示します。

GetSource(void)

再生中のクリップの URL を格納した文字列を返します。

GetSourceTransport

再生用のソース プロトコルを格納した文字列を返します。

GetSourceTransport(int32 source_number)

source_number

プロトコルの指定対象のソース番号。 この番号は 1 から n までの値となります。ここで、nGetNumSources によって返されたソース数です。

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 のパラメータが必要ですが、Java では int32 のパラメータが必要です。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

再生用のソース プロトコル (localudp、または tcp) を特定する文字列を返します。

GetStereoState

現在のクリップがステレオかどうかを示します。

GetStereoState(void)

現在のクリップがステレオならば true を、モノラルならば false を返します。 この関数は、Netscape プラグインに対してブール型の値を返します。

GetTitle

現在のクリップのタイトル文字列を示します。

GetTitle(void)

現在のクリップのタイトルを格納した文字列を返します。

GetVersionInfo

埋め込み型 RealOne Player (親プレーヤーの RealOne Player ではなく) のバージョンの主番号および副番号を示します。

GetVersionInfo(void)

6.0.0.128 などのバージョン情報を格納した文字列を返します。

GetVolume

現在の音量レベルを示します。

GetVolume(void)

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 を返しますが、Java では int32 を返します。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

現在の音量レベルを格納した int32 を返します。 戻り値は 0 から 100 までの範囲内です。

GetWantErrors

エラー ダイアログが表示されるかどうかを示します。

GetWantErrors(void)

エラー ダイアログがトラップされ表示されなければ true を返します。 エラー ダイアログが表示される場合、false を返します。

GetWantKeyboardEvents

キーボード イベントが送信されるかどうかを示します (つまり、OnKeyDownOnKeyPress、および OnKeyUp コールバックが送信されるかどうかを示します)。

GetWantKeyboardEvents(void)

キーボード イベントが送信される場合は true を返します。 キーボード イベントが送信されない場合は false (デフォルト) を返します。

GetWantMouseEvents

マウス イベントが送信されるかどうかを示します (つまり、OnLButtonDownOnLButtonUpOnMouseMoveOnRButtonDown、および OnRButtonUp コールバックが送信されるかどうかを示します)。

GetWantMouseEvents(void)

マウス イベントが送信される場合は true を返します。 マウス イベントが送信されない場合は false (デフォルト) を返します。

HasNextEntry

次クリップ機能が使用可能かどうかを調べます。 接続されたソースが複数のクリップを収録した RAM (.ram.rpm) または SMIL ファイルであり、現在のクリップが RAM または SMIL ファイル内の最後のクリップでない場合、次クリップ機能が使用可能です。 SMIL ファイルの場合、<par> グループは単一のクリップとして処理されます。

HasNextEntry(void)

次クリップ機能が使用可能であれば true を返します。 現在のクリップの後に使用可能なクリップがなければ、false を返します。

HasPrevEntry

前クリップ機能が使用可能かどうかを調べます。 接続されたソースが複数のクリップを収録した RAM (.ram.rpm) または SMIL ファイルであり、現在のクリップが RAM ファイル内の最初のクリップでない場合、前クリップ機能が使用可能です。 SMIL ファイルの場合、<par> グループは単一のクリップとして処理されます。

HasPrevEntry(void)

前クリップ機能が使用可能であれば true を返します。 現在のクリップが最初のクリップならば false を返します。

SetAuthor

現在のクリップの制作者文字列を、既存の制作者情報に上書きして設定します。 その後の GetAuthor はこの新しい値を返します。

SetAuthor(string new_author)

new_author

設定する制作者名の文字列。 この制作者文字列は、マルチクリップ プレゼンテーション内の以後の制作者情報に上書きされます。

プラグインに対してブール型の値を返します。

SetAutoGoToURL

URL の処理方法を指定します。 このメソッドは、RealPlayer バージョン 5.0 以降と互換性があります。

SetAutoGoToURL(boolean enable_start)

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 メソッド名は、C++ では SetAutoGotoURL ですが、Java では SetAutoGoToURL です。 JavaScript や VBScript で開発している場合、どちらのメソッド名も使用できます。

enable_start

true に設定した場合、RealPlayer のプラグインは自動的に URL イベントをブラウザに渡します。 false に設定した場合、onGoToURL イベントは代わりに Java アプレットまたは VBScript によって処理されます。

詳細情報: RealPlayer G2 以降では、<EMBED> または <OBJECT> タグ内で AUTOGOTOURL パラメータを使って設定することもできます。

プラグインに対してブール型の値を返します。

SetAutoStart

ソース データが使用可能になるとコントロールが自動的に再生を開始するかどうかを設定します。 このメソッドは RealPlayer バージョン 5.0 以降で構築された Netscape プラグインおよび ActiveX コントロールと下位互換性があります。

SetAutoStart(boolean auto_start)

auto_start

true に設定した場合、ソース データが使用可能になると制御が自動的に開始されます。 false に設定すると、コントロールは自動的に再生を開始します。

プラグインに対してブール型の値を返します。

詳細情報: RealPlayer バージョン 5.0 以降の Netscape のプラグインを開発する場合、AUTOSTART パラメータを使ってタグ定義内で自動再生を指定することができます。

SetBackgroundColor

イメージ ウィンドウ コントロールに必要な背景色を指定します。

SetBackgroundColor(string color)

color

イメージ ウィンドウ コントロールの背景色。 有効な色の値は、#RRGGBB 形式の RGB 16 進数値か、次の色名で指定します。色名と対応する 16 進数も以下に示します。

white (#FFFFFF)silver (#C0C0C0)gray (#808080)black (#000000)
yellow (#FFFF00)fuchsia (#FF00FF)red (#FF0000)maroon (#800000)
lime (#00FF00)olive (#808000)green (#008000)purple (#800080)
aqua (#00FFFF)teal (#008080)blue (#0000FF)navy (#000080)

プラグインに対してブール型の値を返します。

詳細情報: BACKGROUNDCOLOR パラメータを使うと、イメージ ウィンドウの背景色をタグ定義内で指定することができます。

SetCanSeek

ユーザ インターフェイスからクリップ内をシークできるようにするかどうかを設定します。

SetCanSeek(boolean can_seek)

can_seek

true (デフォルト) に設定すると、クリップ内でシーク可能となります。 false に設定すると、ユーザはクリップ内でシークできません。 この関数によってライブ クリップや疑似ライブ クリップでシーク機能を実現することはできません。

プラグインに対してブール型の値を返します。

SetCenter

ビジュアル データ型がイメージ ウィンドウ内に通常のサイズで中央配置するかどうかを設定します。

SetCenter(boolean value)

value

true に設定すると、ビジュアル データ型がイメージ ウィンドウ内に通常のサイズで中央配置されます。 false (デフォルト) に設定した場合、ビジュアル データ型の高さおよび幅がイメージ ウィンドウ全体に拡大表示されます。

注意: SetCenter メソッドおよび SetMaintainAspect メソッドの両方を true に設定することはできません。 このため、SetMaintainAspect メソッドの set パラメータを true に設定した場合、SetMaintainAspect メソッドの value パラメータは false に設定する必要があります。

プラグインに対してブール型の値を返します。

詳細情報: CENTER パラメータを使うと、イメージ ウィンドウ内でプレゼンテーションを中央配置するようにタグ定義内で指定することができます。

SetConsole

複数のコントロール インスタンスをリンクするためのコンソール名を設定します。 リンクしたいコントロールの各インスタンスに対して 1 回コールしてください。 同一のコンソール名を持つコントロールはすべて、動作が連携します。 たとえば、同一のページに [Play (再生)] および [Stop (停止)] ボタンが複数ある場合、共有コンソール名によってこれらのボタンが同一のクリップをコントロールできるようになります。 コンソール名 _master は全インスタンスにリンクします。 コンソール名 _unique は、ほかのインスタンスにリンクしません。

SetConsole(string console)

console

設定するコンソール名。 このコンソール名は、リンクしたい埋め込まれたコントロールそれぞれに対する一意の名称または ID と関連付ける必要があります。 次に例を示します。

document.playcontrol.SetConsole("console1") — JavaScript

Document.playcontrol.SetConsole("console1") — VBScript

プラグインに対してブール型の値を返します。

詳細情報: CONSOLE パラメータを使うと、コントロールをリンクさせるかどうかをタグ定義内で指定することができます。

SetConsoleEvents

コンソール イベントを有効にするかどうかを設定します。 このメソッドは、プラグイン内でコールバックを高度にコントロールするために用意されています。

このメソッドは ActiveX コントロールには影響しません。

SetConsoleEvents(boolean value)

value

true に設定した場合、すべてのプラグインからのイベントがアプレットに送信されます。 false に設定した場合、コンソールの接続対象のプラグインだけがイベントを送信します。

プラグインに対してブール型の値を返します。

詳細情報: コンソール イベントの詳細については、「イベント処理」を参照してください。

SetControls

コントロールの可視コンポーネントを設定します。

SetControls(string controls)

controls

設定する RealOne Player コントロール名。 このコントロール名は、埋め込まれたコントロールそれぞれに対する一意の名称または ID と関連付ける必要があります。 次に例を示します。

document.playcontrol.SetControls("PlayOnlyButton") — JavaScript

Document.playcontrol.SetControls("PlayOnlyButton") — VBScript

プラグインに対してブール型の値を返します。

詳細情報: CONTROLS パラメータを使うと、タグ定義でコントロールをお客様の Web ページに追加することができます。

SetCopyright

現在のクリップの著作権文字列を、既存の著作権情報に上書きして設定します。 その後の GetCopyright はこの新しい値を返します。

SetCopyright(string copyright)

copyright

設定する著作権情報の文字列。 この著作権文字列は、マルチクリップ プレゼンテーション内の以後の著作権情報に上書きされます。

プラグインに対してブール型の値を返します。

SetDoubleSize

イメージ ウィンドウをオリジナルの 2 倍のサイズに設定します。

SetDoubleSize(void)

プラグインに対してブール型の値を返します。

注意: このメソッドは、アプリケーション内で使用されている ActiveX コントロールおよびプラグイン専用であり、Web ページ用ではありません。

SetFullScreen

画像を全画面モードに設定します。

SetFullScreen(void)

プラグインに対してブール型の値を返します。

注意: ユーザが Esc キーを押すと、画像はオリジナルのサイズに戻ります。

SetImageStatus

イメージ ウィンドウの最下段に表示されるステータス テキストの有効/無効を切り換えます。

SetImageStatus(boolean enabled)

enabled

true (デフォルト) に設定すると、イメージ ウィンドウにステータス テキストが書き込まれます。 false に設定すると、ステータス テキストはイメージ ウィンドウに送信されません。

プラグインに対してブール型の値を返します。

SetLoop

クリップをループ再生するかどうかを指定します。

SetLoop(boolean set)

set

true に設定すると、クリップは再生中断までループ再生されます。 false に設定すると、クリップはループ再生されません (デフォルト)。

プラグインに対してブール型の値を返します。

詳細情報: タグ定義において、LOOP パラメータを使ってクリップをループ再生させるかどうかを指定することができます。

SetMaintainAspect

イメージ ウィンドウ拡大時にソースの正しいアスペクトをイメージ ウィンドウ内で保持するかどうかを設定します。

SetMaintainAspect(boolean set)

set

true に設定すると、ソースの正しいアスペクト比が保持されます。 false (デフォルト) に設定すると、ソースがイメージ ウィンドウ全体に表示されるようにアスペクト比が変更されます。

注意: SetMaintainAspect メソッドおよび SetCenter メソッドの両方を true に設定することはできません。 このため、SetCenter メソッドの value パラメータを true に設定した場合、SetMaintainAspect メソッドの set パラメータは false に設定する必要があります。

プラグインに対してブール型の値を返します。

詳細情報: MAINTAINASPECT パラメータを使うと、正しいアスペクト比を保持するかどうかを指定することができます。

SetMute

ミュート状態を設定します。

SetMute(boolean mute)

mute

true に設定すると、オーディオはミュートとなります。 false に設定すると、サウンドはミュートになりません。

プラグインに対してブール型の値を返します。

SetNumLoop

クリップのループ再生回数を設定します。

SetNumLoop(int32 number_of_loops)

number_of_loops

クリップのループ再生回数。

プラグインに対してブール型の値を返します。

詳細情報: NUMLOOP パラメータを使うと、プレゼンテーションのループ再生回数をタグ定義内で指定することができます。

SetOriginalSize

イメージ ウィンドウをオリジナルのサイズに設定します。

SetOriginalSize(void)

プラグインに対してブール型の値を返します。

SetPosition

指定された時点までクリップをシークします。

SetPosition(int32 position)

position

シーク対象のクリップの時点。単位はミリ秒。 有効な値は >=0 から <=クリップ合計長の範囲です。 シーク対象の時点を >合計長に設定しようとすると、SetPosition合計長を設定します。

注意: このメソッドによって指定された時点にクリップの位置があることの必要なプログラミングを継続する場合、必ずシークが終了するまで待機してください。

プラグインに対してブール型の値を返します。

SetPreFetch

PREFETCH 再生モードの有効/無効を切り換えます。

SetPreFetch(boolean set)

set

true に設定すると、PREFETCH 再生モードが有効になります。 false (デフォルト) に設定すると、PREFETCH 再生モードが無効になります。

プラグインに対してブール型の値を返します。

詳細情報: PREFETCH パラメータを使うと、プリフェッチ再生モードを有効にするかどうかをタグ定義内で指定することができます。

SetShowAbout

RealOne Player の [About (バージョン情報)] ダイアログ ボックスを表示します。

SetShowAbout(boolean set)

set

true に設定すると、RealOne Player の [About (バージョン情報)] ダイアログ ボックスが表示されます。 ダイアログ ボックスの表示中にこのパラメータを false に設定しても何も起こりません。ダイアログ ボックス内のボタンを使って表示を閉じる必要があります。

プラグインに対してブール型の値を返します。

SetShowPreferences

RealOne Player 環境を開き、RealOne Player の [Preferences (環境設定)] ダイアログ ボックスを表示します。

SetShowPreferences(boolean set)

set

true に設定すると、RealOne Player の [Preferences (環境設定)] ダイアログ ボックスが表示されます。 ダイアログ ボックスの表示中にこのパラメータを false に設定しても何も起こりません。ダイアログ ボックス内のボタンを使って表示を閉じる必要があります。

プラグインに対してブール型の値を返します。

SetShowStatistics

RealOne Player の [Statistics (統計情報)] ダイアログ ボックスの表示を設定します。

SetShowStatistics(boolean set)

set

true に設定すると、RealOne Player の [Statistics (統計情報)] ダイアログ ボックスが表示されます。 false に設定し、RealOne Player の [Statistics (統計情報)] ダイアログ ボックスが表示されている場合、ダイアログ ボックスが閉じます。

プラグインに対してブール型の値を返します。

SetShuffle

すべてのクリップをランダムに再生します。ただし、再生済みのクリップを除きます。 マルチクリップ RAM ファイル (.ram または .rpm) か、クリップのシーケンスだけを収録した SMIL ファイルに対して有効です。

SetShuffle(boolean set)

set

true に設定すると、クリップの再生がランダムとなります。 false に設定すると、クリップはマルチクリップ ファイルまたは SMIL ファイル内の表示順に従って再生されます。

プラグインに対してブール型の値を返します。

詳細情報: SHUFFLE パラメータを使うと、クリップをランダム再生するかどうかをタグ定義内で指定することができます。

SetSource

再生対象のクリップの URL を指定します。 このメソッドは RealPlayer 5.0 以上で構築された Netscape プラグインと下位互換性がありますが、バージョン 5.0 での ActiveX コントロールとの互換性はありません。

SetSource(string source)

source

再生対象のクリップの URL。 ソース URL は rtsp://http://pnm://、または file:// から始まります。

プラグインに対してブール型の値を返します。

詳細情報: SRC パラメータを使うと、プレゼンテーションの URL をタグ定義内で指定することができます。

SetTitle

現在のクリップのタイトル文字列を、既存のタイトル情報に上書きして設定します。 その後の GetTitle はこの新しい値を返します。

SetTitle(string title)

title

設定するタイトル文字列。 このタイトル文字列は、マルチクリップ プレゼンテーション内の以後のタイトル情報に上書きされます。

プラグインに対してブール型の値を返します。

SetVolume

音量レベルを設定します。

SetVolume(int16 volume)

volume

設定する音量レベル。 有効な値は 0 から 100 までです。

警告 ! このメソッドの使用方法は、プログラミング言語によって多少異なります。 この関数は、C++ では int16 のパラメータが必要ですが、Java では int32 のパラメータが必要です。 JavaScript や VBScript で開発している場合、どちらの整数型も使用できます。

void を返します。

SetWantErrors

エラー シンクを設定します。

SetWantErrors(boolean set)

set

true に設定すると、エラーがトラップされてエラー ダイアログがプレーヤーに表示されなくなります。 false に設定すると、エラー ダイアログがプレーヤーに表示されます。

プラグインに対してブール型の値を返します。

SetWantKeyboardEvents

キーボード イベントが送信されるかどうかを設定します (つまり、OnKeyDownOnKeyPress、および OnKeyUp コールバックが送信されるかどうかを設定します)。

SetWantKeyboardEvents(boolean set)

set

true に設定すると、キーボード イベントが送信されます。 false (デフォルト) に設定すると、キーボード イベントは送信されません。

プラグインに対してブール型の値を返します。

SetWantMouseEvents

マウス イベントが送信されるかどうかを設定します (つまり、OnLButtonDownOnLButtonUpOnMouseMoveOnRButtonDown、および OnRButtonUp コールバックが送信されるかどうかを設定します)。

SetWantMouseEvents(boolean set)

set

true に設定すると、マウス イベントが送信されます。 false (デフォルト) に設定すると、マウス イベントは送信されません。

プラグインに対してブール型の値を返します。


RealNetworks, Inc. ©2002 RealNetworks, Inc. All rights reserved.
詳細については、RealNetworks を参照してください。
画面左側に目次フレームが表示されない場合は、ここをクリックしてください。
戻る 次へ