HelixApp 专业流媒体影音防盗链

Chapter 7: 嵌入播放器的回调

本章介绍在程序中或者利用脚本处理RealOne行为的回调以传送信息的知识。回调方法按字母顺序列下，并包括在 Netscpae plug-in 或者 ActiveX 插件中如何使用，语法和调用的例子以及不同版本API向后兼容的情况。

更多信息：了解回调方法的相关内容，以及如何处理用户交互请参考 Chapter 5。

OnAuthorChange

当作者信息被更改时发生。

OnAuthorChange(string author)

author

新的作者字符串。

返回空值。

OnBuffering

发送缓冲完成百分率。

OnBuffering(int32 flags, int32 percent_complete)

flags

缓冲标志，有下面的可能值：

0 — 开始缓冲

1 — 定位缓冲

2 — 网络拥挤缓冲

3 — 直播暂停后的重新开始缓冲

注意： 如果你利用 C++编程，这些标志值可以在定义于 rmacore.h (参考SDK)的 BUFFERING_REASON枚举定义中找到.

percent_complete

以百分比的缓冲情况总完成值。

警告！ 方法在不同的编程语言中有细微的差别，在中参数是 int32类型，而在Java中是int16。而Javascript或 VBScript不区分。

返回空值。

OnClipClosed

当控件没有打开的影片时发生。 RealPlayer版本5以上兼容。

OnClipClosed(void)

警告！ 方法在不同的编程语言中有细微的差别，在C++中名字是 OnClipClosed，在Java和Javascript中是onClipClosed.

返回空值。

OnClipOpened

当控件打开一个影片是发生。方法在RealPlayer5以上版本提供。

OnClipOpened(string short_clip_name, string url)

警告！ 方法在不同的编程语言中有细微的差别，在C++中名字是 OnClipOpened，在Java和Javascript中是onClipOpened.

short_clip_name

打开的影片名字。

url

打开影片的URL地址。

返回空值。

OnContacting

播放器链接到主机是发生。

OnContacting(string host_name)

host_name

链接到的主机名。

返回空值。

OnCopyrightChange

版权信息改变时发生。

OnCopyrightChange(string copyright)

copyright

新版权信息。

返回空值。

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 中。通常要求所有组件能处理下面这些从Helxi Server传来的基本错误编码：

PNR_FAIL —操作失败。

PNR_OK —操作成功。

PNR_UNEXPECTED —调用出意外或者方法是无效的。

user_code

最后的用户错误码，更多信息参考 GetLastErrorUserCode。

user_string

最后的显示在错误对话框中的用户错误信息，更多信息参考 GetLastErrorUserString。

more_info_url

最后错误对应的 "more info"（"更多信息"） URL地址。这个可能没有值 (例如在没有 "more info" URL时)。

error

错误的文字描述。

返回空值。

OnGotoURL

当播放到URL时发生。这个行为仅仅在 AutoGotoURL设置为 FALSE有效 (这包括在 <EMBED>或<OBJECT> 标签定义中利用AUTOGOTOURL 参数设置或利用 SetAutoGoToURL方法的设置)。

方法兼容于PrealPlayer5以上版本。

OnGotoURL(string url, string target)

警告！ 方法在不同的编程语言中有细微的差别，在C++中名字是 OnGotoURL，在Java和Javascript中是onGoToURL。

url

AutoGotoURL设置为TRUE时包含要传送给浏览器的URL。

target

AutoGotoURL设置为TRUE时要打开URL的浏览器中或帧的名字。

返回空值。

OnKeyDown

当有键盘按下时发生。这个回调方法仅当 SetWantKeyboardEvents方法设置为true时有效。

OnKeyDown(int32 flags, int32 key)

警告！ 当在 Java 或 Javascript编程时，标志参数是无效的。这时的语法为：
OnKeyDown(int32 key)。

flags

按键的位标志。微软的Windows平台SDK中把这些值定义在WM_CHAR消息中。

key

按下的键码。

返回空值。

OnKeyPress

按下并释放一个键盘键时发生，这个回调方法仅在 SetWantKeyboardEvents设置为true时有效。

OnKeyPress(int32 flags, int32 key)

警告！ 当在 Java 或 Javascript编程时，标志参数是无效的。这时的语法为：OnKeyPress(int32 key)。

flags

按键的位标志。微软的Windows平台SDK中把这些值定义在WM_CHAR消息中。

key

键入的按键码。

返回空值。

OnKeyUp

释放键盘按键时发生。这个回调方法仅在 SetWantKeyboardEvents设置为true时有效。

OnKeyUp(int32 flags, int32 key)

警告！ 当在 Java 或 Javascript编程时，标志参数是无效的。这时的语法为：OnKeyUp(int32 key)。

flags

按键的位标志。微软的Windows平台SDK中把这些值定义在WM_CHAR消息中。

key

释放的键盘键编码。

返回空值。

OnLButtonDown

在嵌入组件位置上鼠标左键按下时发生，这个回调方法仅在 SetWantMouseEvents 设置true时有效。

OnLButtonDown(int32 button_flags, int32 x_pos, int32 y_pos)

button_flags

鼠标和鼠标键行为的比特标志值。

可以是下面一些可能值：

鼠标键行为可能值
比特标志值	鼠标行为
`MK_LBUTTON`	左键按下
`MK_RBUTTON`	右键按下
`MK_SHIFT`	键盘 Shift键按下
`MK_CONTROL`	键盘 Ctrl 键按下
`MK_MBUTTON`	中键按下

x_pos

鼠标指针位置x座标。

y_pos

鼠标指针位置y座标

返回空值。

OnLButtonUp

在嵌入组件位置上当鼠标左键释放时发生，这个回调方法仅在 SetWantMouseEvents 设置true时有效。

OnLButtonUp(int32 button_flags, int32 x_pos, int32 y_pos)

button_flags

鼠标和鼠标键行为的比特标志值。一个可能参数值，参考 "鼠标键行为可能值"列表.

x_pos

x座标位置

y_pos

y座标位置

返回空值。

OnMouseMove

在嵌入组件上移动鼠标时发生，这个回调方法仅在 SetWantMouseEvents 设置true时有效。

注意： 这个回调方法仅当操作系统通知plug-in 或者 ActiveX控件鼠标有移动时发生。

OnMouseMove(int32 button_flags, int32 x_pos, int32 y_pos)

button_flags

鼠标和鼠标键行为的比特标志值。一个可能参数值，参考 "鼠标键行为可能值"列表.

x_pos

鼠标指针x座标。

y_pos

y座标。

返回空值。

OnMuteChange

当禁音状态改变时发生。

OnMuteChange(boolean mute)

mute

true表示禁音，而false表示没有禁音。

返回空值。

OnPlayStateChange

播放状态改变时发生。

OnPlayStateChange(int32 old_state, int32 new_state)

警告！ 在对于 ActiveX控件编程中 old_state 参数是无效的，这时语法为：OnPlayStateChange(int32 new_state)。如果在 ActiveX 程序中需要两个参数 old_state和new_state则使用 OnStateChange回调。

old_state

前面的播放状态。

new_state

新的播放状态

下面是可能的播放状态列表：

播放状态的可能值
参数值	播放状态
`0`	停止的
`1`	链接中
`2`	缓冲中
`3`	播放中
`4`	定位中

返回空值。

OnPosLength

当在影片中定位改变时发生。

OnPosLength(int32 pos, int32 len)

注意： 回调只用于Netscape plug-in，如果想在ActiveX 控件中获得相似效果请用 OnPositionChange回调。

pos

微秒单位的当前定位。

len

微秒单位的影片长度。

返回空值。

OnPositionChange

当在影片中定位改变时发生。

OnPositionChange(int32 pos, int32 len)

注意： 仅用于 ActiveX 插件，在 Netscape plug-in中用 OnPosLength 回调。

pos

微秒单位的当前定位。

len

微秒单位的影片长度。

返回空值。

OnPostSeek

定位完成时发生。

OnPostSeek(int32 old_time, int32 new_time)

old_time

微秒为单位的定位前位置时间。

new_time

微秒单位的定位后位置时间。

返回空值。

OnPreFetchComplete

在完成取得流头信息时发生。在 <EMBED>或 <OBJECT>标签中以PREFETCH进行了设置或在 SetPreFetch 方法中设置了true时调用。

OnPreFetchComplete(void)

返回空值。

OnPreSeek

当移动作品定位拖动条进行定位操作时发生。

OnPreSeek(int32 old_time, int32 new_time)

old_time

微秒为单位的原位置时间。

new_time

微秒为单位的要定位的时间。

返回空值。

OnPresentationClosed

在作品停止播放时发生。

OnPresentationClosed(void)

返回空值。

OnPresentationOpened

当开始播放作品时发生。

OnPresentationOpened(void)

返回空值。

OnRButtonDown

在嵌入组件上按下鼠标右键时发生，这个回调方法仅在 SetWantMouseEvents 设置true时有效。

OnLButtonDown(int32 button_flags, int32 x_pos, int32 y_pos)

button_flags

鼠标和鼠标键行为的比特标志值。一个可能参数值，参考 "鼠标键行为可能值"列表.

x_pos

x座标。

y_pos

y座标。

返回空值。

OnRButtonUp

在嵌入组件上释放鼠标右键时发生，这个回调方法仅在 SetWantMouseEvents 设置true时有效。

OnRButtonUp(int32 button_flags, int32 x_pos, int32 y_pos)

button_flags

鼠标和鼠标键行为的比特标志值。一个可能参数值，参考 "鼠标键行为可能值"列表.

x_pos

x座标值。

y_pos

y座标值。

返回空值。

OnShowStatus

在状态文本改变时发生。方法在RealPlayer5以上版本提供。

OnShowStatus(string status_text)

警告！ 方法在不同的编程语言中有细微的差别，在C++中名字是OnShowStatus, 在Java和Javascript中是onShowStatus.

status_text

新的状态值文本。

返回空值。

OnStateChange

在播放器状态改变时发生。

注意： 仅用于 ActiveX插件，在 Netscape plug-in中使用OnPlayStateChange回调。

OnStateChange(int32 old_state, int32 new_state)

old_state

原有状态。

new_state

新状态。

old_state和 new_state参数值参考"播放状态可能值"表。

返回空值。

OnTitleChange

标题文本改变时发生。

OnTitleChange(string title)

title

新的标题值。

返回空值。

OnVolumeChange

音量改变时发生。

OnVolumeChange(int32 new_volume)

new_volume

百分比的新的音量值，0表示无声。

警告！ 方法在不同的编程语言中存在差别，在C++中，参数类型是int16，在 Java中是int32，而在 Javascript 或 VBScript中不区别。

返回空值。