HelixApp 专业流媒体影音防盗链

Chapter 2: RealOne播放器方法

这个部分提供按字母顺序的RealOne播放器环境下方法介绍。要了解这些方法的概貌参看 "在RealOne播放器环境使用Javascript和ActiveX".

AddToNowPlaying

打开"现在播放"列表并且在当前影片后加入一个URL。通常添加一个影片后它会显示一个关联URL到指定高宽的相关信息面板上，并且可以有一个在媒体浏览面板上显示的URL。可用于Javascript扩展和ActiveX控件。

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

url

字符串内容包含要添加到RealOne播放器播放列表中的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播放器会自动使用媒体播放的影片高度。

media_browser_url

在target指定的显示窗口中要显示内容的URL。这个参数是可选参数。

target

可选的字符串参数用于指定在media_browser_url中指定的URL显示位置。它被设置为 _rpbrowser时，URL显示在媒体浏览面板，其他值会显示在其他的浏览面板显示窗口

ClearNowPlaying

清空当前RealOne播放器的播放列表，并停止当前的播放。你可以在使用其他来同步播放前调用这个方法。它可以有效用于Javascript扩展和ActiveX控件。

ClearNowPlaying()

返回void（表示没有返回）值。

注意： 这个方法在方法名后要接一对没有内容的圆括号。

ComponentVersion

返回一个最新组件包的版本。它在Javascript扩展和ActiveX控件中都是可用的。

ComponentVersion( name )

name

参数是被检查的组件名字，它们必须是如下的格式：

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

接下来的表格是组件的可选名字。这些值是区分大小写的：

组件名字
名字	组件
`audp`	Extra audio plugin（扩展的音频插件）
`DBCMpg1`	MPEG video plugin（MPEG视频插件）
`Flash`	Macromedia Flash plugin（Flash插件）
`GF`	GIF plugin (for backwards compatibility)（向后兼容的GIF插件）
`GFJP`	JPG plugin (for backwards compatibility)（向后兼容的JPG插件）
`imgp`	All image plugin (gif, jpg, png)（所有的图片插件）
`MP3PL`	MP3 Playlist plugin（MP3播放列表插件）
`MPGA`	MP3 Audio plugin（MP3音频插件）
`PNG`	PNG plugin (for backwards compatibility)（向后兼容的PNG插件）
`RA`	RealAudio
`RealTxt`	RealText
`RichFX`	RichFX plugin
`RPix`	RealPix
`RV`	RealVideo
`sdp`	Scalable Multi-cast plugin（可伸缩多播插件）
`vidp`	Extra video plugin（扩展视频插件）

注意： 这个表是不完整的，因为随时有新的组件可以被加入到RealOne播放器中。如果你有需要，可以联系RealNetworks获取最新的列表信息。

下面的例子是检查Flash6.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( )

返回一个表示状态的整数值。它们是：


值	说明
`0`	停止状态。
`1`	链接中。
`2`	缓冲中。
`3`	播放中。
`4`	暂停。
`5`	定位中。
`6`	显示着一个表示线路忙的模态窗口对话框。

HandleAction

执行一个指定的行为。在Javascript扩展和ActiveX控件中有效。

HandleAction( action )

action

描述需要执行的行为。它们可以是如下的行为：


行为	执行的操作
`CD`	在播放器中播放CD页。
`MyDevices`	在播放器中打开设备页。
`MyLibrary`	在播放器中打开我的媒体库页。
`NavigateToURL( url, target )`	在指定的定位上打开指定的URL。可能的定位是 `_rpbrowser`或者`_rpexternal`。
`NowPlaying`	打开"现在播放"列表.
`Radio`	在播放器中打开收音机页。
`ShowArtistInfo ( show )`	显示或者隐藏当前影片的艺术家信息。如果`show`的值是`0`表示隐藏，是`1`则表示显示。
`ShowEqualizer`	打开播放器均衡器。
`ShowPreferences( category, page )`	打开播放器参数选择页。Category和page的描述见后面。
`Web`	在播放器中打开Web页。

ShowPreferences 行为中可以由下面的category和pageaction参数对来完成的工作：


Category, Page	执行的工作
`General,General`	在参数对话框中打开常规选项页。
`Connection,Connection`	在参数对话框中打开主要连接页。
`Connection,Playback Settings`	在参数对话框中打开连接设置页下的播放设置。
`Connection,Internet Settings`	在参数对话框中打开连接设置下的Internet设置页。
`Connection,Proxy`	在参数对话框中打开连接设置下代理设置。
`Connection,Network Transports`	在参数对话框中打开连接设置下的网络传输设置。
`My Library,My Library`	在参数对话框中打开我的媒体库设置页。
`My Library,Advanced My Library`	在参数对话框中打开我的媒体库设置下的高级设置。
`CD,CD`	在参数对话框中打开CD页。
`CD,Advanced CD`	在参数对话框中打开CD页下的高级设置。
`Devices,Devices`	在参数对话框中打开设备页。
`Accessories,Accessories`	在参数对话框中打开附件页。
`Media Types,Media Types`	在参数对话框中打开媒体类型页。
`Content,Content`	在参数对话框中打开内容页。
`Hardware,Hardware`	在参数对话框中打开硬件页。
`AutoUpdate,AutoUpdate`	在参数对话框中打开自动设置页。

注意： 每个类别页对参数必须是严格按照上面提供的样式，而且在其之间不能有多余的空格，在逗号两边也不能有空格。

InstalledComponents

返回一个RealOne播放器已经安装了的插件信息列表。在Javascript扩展和ActiveX控件中都有效。

InstalledComponents()

注意： 在方法名后面必须跟一对空圆括号。

返回的值包含所有已经安装在RealOne播放器中的插件信息，这包括了插件的名称和对应的版本号。每组信息中插件名字和对应版本号由冒号(:)分割，而组之间由管道号(|)分割。下面的例子是返回值的一个例子：

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播放器为每个作品缓冲相关信息面板中的URL内容。当开始一个新的作品播放时，缓冲被刷新。

width

指定相关信息面板的宽度象素值。这个值不是必须的，但被推荐使用。默认值时320。

height

指定相关信息面板的高度象素值。这个值不是必须的，但被推荐使用。默认是自动适应作品高度。

media_browser_url

在target参数指定的位置打开的URL地址。

target

指定打开media_browser_url参数指定URL内容的位置。如果设置为_rpbrowser表示在媒体浏览面板中打开，否则表示在其他浏览窗口中打开。

bnow_playing

布尔值指定是否把这个影片加入到现在播放列表中。默认是设置为true表示要加入，如果设置为false则表示不加入。

通PlayClip方法，你可以替代在你的HTML页面中使用<A HREF>来连接到.ram文件。因为在使用 <A HREF>时，会首先在浏览器中调用，再切换到调用RealOne播放器播放。而使用PlayClip方法可以直接调用RealOne播放器从而避免播放前多余的对话框。

PlayerProperty

返回指定属性的值。在Javascript扩展和ActiveX插件中均有效。

PlayerPropery( property )

property

要获取信息的播放器属性名称。它可以是如下的一些值：


属性	执行结果
`APIVERSION`	获得播放器的Javascript扩展版本。
`BANDWIDTH`	获得用户带宽设置。
`COUNTRYID`	获得国家名字信息。
`DISTRIBUTION CODE`	获得OEM发行代码信息。
`INSTALLPATH`	获得播放器安装的完整路径。
`LANGUAGEID`	获得播放器安装系统的语言设置。
`LANGUAGEPREFERENCE`	获得用户首先语言。
`OSNAME`	获得操作系统信息，例如Win98。
`PRODUCTNAME`	获得已经安装的播放器名字，例如RealOne Player。
`PRODUCTVERSION`	获得安装播放器的版本，例如 6.0.10.448 。
`REGIONDATE`	获得邮编号。

返回的值是字符串或者是32位整数值。

PreloadURL

为后面的播放缓冲一个URL指定的内容。缓冲的内容可以在后面媒体播放中不再下载和持续占用带宽而很快的显示。在Javascript扩展中有效。

PreloadURL( url )

url

描述需要缓冲的URL。

下面的例子显示在播放前如果缓冲两个不同的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播放器版本号。这个数字包括了主版本号和附版本号。在Javascript扩展和ActiveX插件中都有效。

RealPlayerVersion()

注意： 在方法名后必须有一对空圆括号。

返回的值是打包的整数格式版本信息，这个信息可以用于比较十分符合你作品的最小版本要求。

使用 "解包版本信息"中介绍的 UnpackVersionNumber函数可以解包为用于显示的字符串信息。 UnpackVersionNumber产生的字符串和显示在 Help>About RealOne Player对话框中的相同。

SetVideoBackgroundColor

设置视频背景颜色为指定的值。在Javascript扩展中有效。

SetVideoBackgroundColor( color )

color

颜色值为RGB格式，例如 "RGB(r,g,b)"或者直接的十六进制数格式"#RRGGBB" 如"#FFFFFF"。

返回为void。