第 2 章: RealOne Player のメソッド

この章では、RealOne Player 環境で使用可能なメソッドをアルファベット順に列挙します。 メソッドの概要については、「RealOne Player 環境での JavaScript および ActiveX の使用」を参照してください。

AddToNowPlaying

「Now Playing」リストを開き、 URL を現在のクリップの後のクリップ リストに追加します。 オプションで、追加されたクリップの再生時に指定した高さおよび幅の関連情報ペインに、関連 URL を表示し、メディア ブラウザ ペインに URL のコンテンツを表示します。 このメソッドは JavaScript 拡張および ActiveX コントロールとして使用することができます。

AddToNowPlaying(url, clipinfo, related_info_url, width, height, media_browser_url, target)

url

RealOne Player のクリップ リストへの追加対象 URL を格納した文字列。 このパラメータは必須です。

clipinfo

タイトルや制作者などの、クリップの補助情報文字列。 このパラメータには、パイプ記号で区切られたキーワード名と値のペア文字列 <keyword=value> が格納されます。 このパラメータはオプションです。 clipinfo の有効なキーワードは次のとおりです。

• Album name
• Artist name
• CDNum
• Comments
• Genre
• Language
• Mood
• Preference
• Situation
• Title
• Year

例:

"Title=XXX|Artist name=XXX|Album name=XXX|Genre=XXX;"

注意: 各キーワード/値のペアは、パイプ記号 ( | ) で区切られます。 各エントリが正しく動作するためには、各パイプ記号の前後にスペースを含まないでください。

related_info_url

追加されたクリップの再生時に、関連情報ペインに表示する URL を格納した文字列。 このパラメータはオプションです。

width

関連情報ペインの幅をピクセル単位で指定する整数値。 このパラメータは必須ではありませんが、使用することをお勧めします。 幅が指定されていない場合のデフォルト値は、320 ピクセルとなります。

height

関連情報ペインの高さをピクセル単位で指定する整数値。 このパラメータは必須ではありませんが、使用することをお勧めします。 高さが指定されていない場合、RealOne Player はメディア プレゼンテーションの高さを使用します。

media_browser_url

target パラメータによって指定された URL 内に表示する URL を格納した文字列。 このパラメータはオプションです。

target

media_browser_url パラメータで与えられた URL を開くペインを示すオプションの文字列。 この文字列が _rpbrowser に設定されている場合、URL はメディア ブラウザ ペイン内で開かれます。 これ以外のターゲット名は、URL を補助表示ウィンドウ内で表示します。

ClearNowPlaying

RealOne Player の現在のプレイリストをクリアし、現在再生中のクリップをすべて停止します。 このメソッドは必ず、再生を同期させるその他のメソッドを使用する前にコールする必要があります。 このメソッドは JavaScript 拡張および ActiveX コントロールとして使用することができます。

ClearNowPlaying()

void を返します。

注意: 現在のところ、このメソッドはメソッド名の末尾にカッコ記号を使用しないでください。

ComponentVersion

更新されたコンポーネントのバージョンをパック形式で返します。 このメソッドは JavaScript 拡張および ActiveX コントロールとして使用することができます。

ComponentVersion( name )

name

検査するコンポーネント名。 このパラメータは次の形式で指定する必要があります。

[name]:[major version].[minor version]

次の表は、コンポーネント名の値をまとめたものです。 値は大文字と小文字を区別し、次の表に示す値と全く同じように値を入力する必要があります。

注意: RealOne Player には常にコンポーネントが新しく追加されるため、このリストに含まれていない場合もあります。 リストは適時更新されますが、特に必要であれば RealNetworks までお問い合わせください。

たとえば、次のようにして Flash 6.0 プラグインのバージョンを確認することができます。

window.parent.external.ComponentVersion(`Flash:6.0')

コンポーネントのバージョンをパック形式で格納した文字列を返します。 その後この情報を使って、リクエストされたプレゼンテーションの再生に必要な最低限の条件をプラグインが満たしているかどうかを判定することができます。 満足していない場合、更新要求を初期化することができます。

この値をわかりやすい形式に展開するには、次のように UnpackVersionNumber 関数を使用します。この関数については「バージョン情報の展開」で説明しています。

UnpackVersionNumber(window.parent.external.ComponentVersion('RA:6.0'))

GetClipInfo

メディア制作者によって与えられたクリップ情報から、指定された値を文字列形式で取得します。 このメソッドは、関連情報ペイン内の HTML から起動されたクリップに対してのみ動作します。 JavaScript 拡張として使用可能です。

GetClipInfo( property )

property

要求された情報を指定します。 以下の値のいずれかになります。

• Album name
• Artist name
• CDNum
• Comments
• Genre
• Language
• Mood
• Preference
• Situation
• Title
• Year

関連情報ペイン内の HTML の一部として挿入するのに適した文字列を返します。

GetPlayerState

プレーヤーの現在の状態を取得します。 JavaScript 拡張として使用可能です。

GetPlayerState( )

プレーヤーの現在の状態を示す整数値を返します。 以下の値のいずれかになります。

HandleAction

指定されたアクションを実行します。 このメソッドは JavaScript 拡張および ActiveX コントロールとして使用することができます。

HandleAction( action )

action

実行する特定のアクション。 以下の値のいずれかになります。

ShowPreferences アクションは、次のカテゴリとページのペアのどれかを取ります。

注意: 各カテゴリおよびページのペアは、先に示したとおり頭文字を大文字にする必要があります。 また、カテゴリとコンマ、およびコンマとページの間には、スペースを入れることはできません。

InstalledComponents

RealOne Player によってインストールされた DLL および関連バージョン番号のリストを返します。 このメソッドは JavaScript 拡張および ActiveX コントロールとして使用することができます。

InstalledComponents()

注意: 現在のところ、このメソッドはメソッド名の末尾にカッコ記号を使用しないでください。

RealOne Player によってインストールされた DLL および関連バージョン番号すべてを格納した文字列を返します。 コンポーネント種別およびバージョン番号は、コロン ( : ) で区切られます。 各 DLL はパイプ記号 ( | ) で区切られます。 次の例は可能な戻り値を示します。

athdb:7.0.0.231|Update:7.0.0.960|ath:7.0.0.231|RNAdmin:0.1.0.548|MSG:7.0.0.552|PNCRT:6.0.0.0|RMACore:6.0.9.138|vsrc:6.0.7.2119|DRMLite:6.0.8.1860|Player:6.0.10.319|Free:6.0.10.319|RA:6.0.9.145|RV:6.0.9.145|Flash:6.0.8.2144|Embed:6.0.8.1413|RealTxt:6.0.7.2232|imgp:6.0.7.2225|PNG:6.0.7.2061|GF:6.0.7.2236|RPix:6.0.7.2217|GFJP:6.0.7.2236

OpenURLInPlayerBrowser

メディア ブラウザ ペインに指定 URL を開きます。 このメソッドは JavaScript 拡張および ActiveX コントロールとして使用することができます。

OpenURLInPlayerBrowser( url )

url

メディア ブラウザ ペイン内で開く URL を指定します。

PlayClip

メディア再生ペイン内で、指定 URL からのクリップを再生します。 オプションで、指定の高さおよび幅の関連情報ペインに URL を送信します。 また、メディア ブラウザ ペインまたは補助ウィンドウ内に URL を表示することもできます。 このメソッドは JavaScript 拡張および ActiveX コントロールとして使用することができます。

PlayClip(url, clipinfo, related_info_url, width, height, media_browser_url, target, bnow_playing)

url

メディア再生ペイン内で再生する URL を格納した文字列。 このパラメータは必須です。

clipinfo

タイトルや制作者などの、クリップの補助情報文字列。 このパラメータは、パイプ記号で区切られたキーワード名と値のペア文字列　<keyword, value> として入力します。 このパラメータはオプションです。 このパラメータの有効なキーワードは次のとおりです。

• Album name
• Artist name
• CDNum
• Comments
• Genre
• Language
• Mood
• Preference
• Situation
• Title
• Year

次の例は、clipinfo パラメータに入力可能な値を示します。

"Title=XXX|Artist name=XXX|Album name=XXX|Genre=XXX;" 

注意: 各キーワード/値のペアは、パイプ記号 ( | ) で区切られます。 各エントリが正しく動作するためには、各パイプ記号の前後にスペースが含まれないようにすることが必要です。

related_info_url

関連情報ペイン内に表示する URL を格納した文字列。 予約値 _keep を使うと、関連情報ペインに読み込まれた最後の Web ページが保持されます。 このパラメータはオプションです。

注意: RealOne Player は、プレゼンテーションに関連付けられた関連情報ペインの URL をキャッシュします。 このキャッシュは、新しいプレゼンテーションが開始されるとクリアされます。

width

関連情報ペインの幅をピクセル単位で指定する整数値。 このパラメータは必須ではありませんが、使用することをお勧めします。 幅が指定されていない場合、デフォルト値は 320 ピクセルとなります。

height

関連情報ペインの高さをピクセル単位で指定する整数値。 このパラメータは必須ではありませんが、使用することをお勧めします。 高さが指定されていない場合、RealOne Player はメディア プレゼンテーションの高さを使用します。

media_browser_url

target パラメータによって指定された URL 内に表示する URL を格納した文字列。

target

media_browser_url パラメータで与えられた URL を開くペインを示す文字列。 この文字列が _rpbrowser に設定されている場合、URL はメディア ブラウザ ペイン内で開かれます。 これ以外のターゲット名は、URL を補助表示ウィンドウ内で表示します。

bnow_playing

クリップを「Now Playing」リストに追加するかどうかを指定するブール値。 true (デフォルト) に設定すると、「Now Playing」リストにクリップが追加されます。 false に設定すると、クリップは追加されません。

HTML 内で <A HREF> タグを使って .RAM ファイルにリンクすることは可能ですが、このタグではなく PlayClip メソッドを使用してください。 <A HREF> を使用すると、まずブラウザが起動され、次にブラウザによって RealOne Player が起動されます。 PlayClip メソッドを使用すると、RealOne Player が直接起動され、中間のダイアログ ボックスの表示を省略することができます。

PlayerProperty

指定プロパティの値を取得します。 このメソッドは JavaScript 拡張および ActiveX コントロールとして使用することができます。

PlayerPropery( property ) 

property

適切なプレーヤー プロパティを指定する文字列。 以下の値のいずれかになります。

指定プロパティの値を、文字列または int32 (必要に応じて) として返します。

PreloadURL

再生中に使用する URL をあらかじめキャッシュします。 URL をキャッシュすると、ストリーミング中の帯域幅を低減させることなく、メディア再生中の表示時間を短縮することができます。 JavaScript 拡張として使用可能です。

PreloadURL( url )

url

キャッシュ対象の URL を指定します。

次の例は、再生前に異なる 2 種類の URL (www.example1.com および www.example2.com) をキャッシュする方法を示します。 これらの URL は、PROnPositionChange などのイベントを使って後から参照することができます。

<head>
<script language=JavaScript>
    function RPOnPreload(){
        PreloadURL(http://www.example1.com)
        PreloadURL(http://www.example2.com)
        }
</script>
...

RealPlayerVersion

インストールされている RealOne Player のバージョン番号をパック形式で取得します。 この値は、RealOne Player のバージョンの主番号および副番号を示します。 このメソッドは JavaScript 拡張および ActiveX コントロールとして使用することができます。

RealPlayerVersion()

注意: 現在のところ、このメソッドはメソッド名の末尾にカッコ記号を使用しないでください。

RealOne Player のバージョン情報をパック形式で格納した整数値を返します。 次にこの情報を使って、プレゼンテーションの表示に必要な最小バージョン番号と比較することができます。

「バージョン情報の展開」で説明している UnpackVersionNumber 関数を使用すると、バージョン番号を文字列として表示することができます。 UnpackVersionNumber によって返される文字列は、[Help (ヘルプ)] > [About RealOne Player (RealOne Player のバージョン情報)] ダイアログ ボックス内に表示される値と同じです。

SetVideoBackgroundColor

ビデオの背景色を指定値に設定します。 JavaScript 拡張として使用可能です。

SetVideoBackgroundColor( color )

color

RGB(r,g,b) のような RGB 形式か、#FFFFFF のような 16 進数値 #RRGGBB で指定される色値。

void を返します。

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