|
Foxit PDF SDK
|
演示对象用作媒体对象,指定播放什么、如何播放以及在哪里播放。 (更多详细信息,请参考 <PDF Reference 1.7> P758 Section "9.1.2 Renditions", P762 "Media Renditions")
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
适配样式的枚举。
此枚举的值应单独使用。
适配样式(方式)指定播放器应如何处理与其播放矩形不完全匹配的 视觉媒体类型。
|
strong |
|
strong |
监视器指定类型的枚举。
此枚举的值应单独使用。
监视器指定用于指定在多监视器系统中浮动或 全屏窗口应出现在哪个监视器上。
|
strong |
|
inline |
带参数的构造函数。
| [in] | pdf_doc | 有效的PDF文档对象。 |
| [in] | rendition_dict | 参数 pdf_doc 表示的PDF文档中演示对象的PDF字典。 如果这是 null,意味着在参数 pdf_obj 表示的PDF文档中 构造一个新的演示对象。 默认值:null。 |
|
inline |
使用另一个演示对象的构造函数。
| [in] | other | 另一个演示对象。 |
|
inline |
为指定类型添加媒体播放器对象。
通常,媒体播放器对象应该只添加到具有指定媒体播放器类型的演示对象中。 不建议用户将相同的媒体播放器对象添加到不同的演示或 一个演示的不同媒体播放器类型中;否则可能会发生意外问题(如崩溃)。 如果用户不想构造另一个媒体播放器并设置相同的值,用户可以克隆 原始媒体播放器对象的字典,并使用克隆的字典 直接构造另一个媒体播放器。
| [in] | type | 媒体播放器类型。请参考从 foxit.pdf.Rendition.MediaPlayerType.e_MediaPlayerMustUsed 开始的值, 这应该是这些值中的一个。 |
| [in] | player | 要为指定类型添加的媒体播放器对象。如果媒体播放器已经为 指定类型存在,此函数将返回媒体播放器的索引。 |
|
inline |
设置标志以决定媒体激活时是否应自动播放。
| [in] | is_auto_play | true 表示媒体激活时应自动播放, false 表示媒体激活时应初始暂停 (例如,显示第一帧)。仅与可能暂停的媒体相关。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置控制栏可见性标志。
控制栏可见性标志用于决定播放时是否显示播放器特定的控制器用户界面 (例如,播放/暂停/停止控件)。
| [in] | is_visible | true 表示显示播放器特定的控制器用户界面, false 表示不显示此类用户界面。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置标志以指定浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
| [in] | is_visible | true 表示浮动窗口应包含允许用户 关闭浮动窗口的用户界面元素,false 表示 浮动窗口不需要包含此类用户界面元素。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置标志以指定浮动窗口是否应有标题栏。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
| [in] | is_visible | true 表示浮动窗口应有标题栏,false 表示 浮动窗口不需要有标题栏。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
获取媒体正在播放的矩形的背景颜色。
|
inline |
获取背景不透明度。(对于全屏和隐藏窗口将被忽略)
|
inline |
获取当前对象的PDF字典。
|
inline |
获取内在持续时间。
-2:使用内在持续时间;
-1:无限持续时间;
>= 0:显式持续时间。
|
inline |
获取适配样式。
适配样式(方式)指定播放器应如何处理与其播放矩形不完全匹配的 视觉媒体类型。
|
inline |
获取浮动窗口的高度,以像素为单位。
当窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时,此属性是必需的。
|
inline |
获取事件类型,指定如果浮动窗口完全或部分位于屏幕外 (即在任何物理监视器上都不可见)时应发生什么。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
|
inline |
获取浮动窗口应相对于相关窗口定位的位置。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
窗口相对位置指定浮动窗口应定位到的位置。
|
inline |
获取窗口相对类型。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
相关窗口类型指定浮动窗口应定位到的位置。
|
inline |
获取调整大小类型,指定浮动窗口是否可以由用户调整大小。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
|
inline |
获取多语言文本数组,提供要在浮动窗口标题栏上显示的文本。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
多语言文本数组中的字符串是成对的:每对中的第一个字符串(ASCII字符串) 是语言标识符,第二个字符串是标题。
|
inline |
获取浮动窗口的宽度,以像素为单位。
当窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时,此属性是必需的。
|
inline |
获取基础URL。
基础URL是用于解析媒体数据中找到的任何相对URL的绝对URL。
|
inline |
获取媒体数据的内容类型(MIME类型)。
内容类型指定由文件规范表示的媒体数据的类型。 内容类型字符串应符合Internet RFC 2045中描述的内容类型规范, 多用途Internet邮件扩展(MIME)第一部分:Internet消息主体的格式。
|
inline |
获取实际媒体数据的文件规范。
|
inline |
获取媒体剪辑的名称,用于用户界面。
|
inline |
获取多语言文本数组,在无法播放媒体剪辑数据时 提供替代文本描述。
多语言文本数组中的字符串成对出现:每对中的第一个字符串(ASCII字符串) 是语言标识符,第二个字符串是描述。
|
inline |
根据索引获取指定类型的媒体播放器对象。
| [in] | type | 媒体播放器类型。请参考从 foxit.pdf.Rendition.MediaPlayerType.e_MediaPlayerMustUsed 开始的值, 这应该是这些值中的一个。 |
| [in] | index | 要检索的媒体播放器对象的索引。有效范围:从 0 到 (count-1)。 count 由函数 Rendition.GetMediaPlayerCount 返回。 |
|
inline |
获取指定类型的媒体播放器对象数量。
| [in] | type | 媒体播放器类型。请参考从 foxit.pdf.Rendition.MediaPlayerType.e_MediaPlayerMustUsed 开始的值, 这应该是这些值中的一个。 |
|
inline |
获取监视器指定类型值。
监视器指定用于指定在多监视器系统中浮动或 全屏窗口应出现在哪个监视器上。
|
inline |
获取媒体权限。
媒体权限指示在什么情况下可以接受写入临时文件 来播放媒体剪辑。
|
inline |
获取名称。
此名称可用于JavaScript动作的名称树查找,也可用于用户界面。
|
inline |
获取重复计数,类似于SMIL的repeatCount属性。
|
inline |
获取音量,以录制音量级别的百分比指定所需的音量级别。
|
inline |
获取媒体应播放的窗口类型。
|
inline |
检查浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
|
inline |
检查浮动窗口是否应有标题栏。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
|
inline |
检查当前演示对象是否包含媒体剪辑。
|
inline |
检查媒体激活时是否应自动播放。
|
inline |
检查播放时是否显示播放器特定的控制器用户界面 (例如,播放/暂停/停止控件)。
|
inline |
检查当前对象是否为空。
当前对象为空时,意味着当前对象无用。
|
inline |
删除指定类型的媒体播放器对象。
| [in] | type | 媒体播放器类型。请参考从 foxit.pdf.Rendition.MediaPlayerType.e_MediaPlayerMustUsed 开始的值, 这应该是这些值中的一个。 |
| [in] | player | 要删除的媒体播放器对象。 |
|
inline |
设置媒体正在播放的矩形的背景颜色。
| [in] | color | 要设置的背景颜色。格式:0xRRGGBB。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置背景不透明度。(对于全屏和隐藏窗口将被忽略)
| [in] | opacity | 背景不透明度。有效范围:0.0 到 1.0。 0.0 表示完全透明,1.0 表示完全不透明。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置内在持续时间。
| [in] | duration | 要设置的内在持续时间值。应该是:
|
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置适配样式。
适配样式(方式)指定播放器应如何处理与其播放矩形不完全匹配的 视觉媒体类型。
| [in] | fit_style | 适配样式值。请参考从 foxit.pdf.Rendition.MediaPlayerFitStyle.e_MediaPlayerFitStyleMeet 开始的值,这应该是这些值中的一个。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置事件类型,指定如果浮动窗口完全或部分位于屏幕外 (即在任何物理监视器上都不可见)时应发生什么。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
| [in] | offscreen_event | 浮动窗口屏幕外情况的事件类型。请参考从 foxit.pdf.Rendition.FloatingWindowOffscreenEvent.e_FloatingWindowOffscreenEventNone 开始的值, 这应该是这些值中的一个。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置浮动窗口应相对于相关窗口定位的位置。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
窗口相对位置指定浮动窗口应定位到的位置。
| [in] | position | 窗口相对类型。请参考从 foxit.pdf.Rendition.FloatingWindowRelatedWindowType.e_FloatingWindowRelatedWindowDocument 开始的值, 这应该是这些值中的一个。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置窗口相对类型。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
相关窗口类型指定浮动窗口应定位到的位置。
| [in] | window_type | 相关窗口类型。请参考从 foxit.pdf.Rendition.FloatingWindowRelatedWindowType.e_FloatingWindowRelatedWindowDocument 开始的值, 这应该是这些值中的一个。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置调整大小类型,指定浮动窗口是否可以由用户调整大小。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
| [in] | resize_type | 调整大小类型。请参考从 foxit.pdf.Rendition.FloatingWindowResizeType.e_FloatingWindowResizeTypeNo 开始的值, 这应该是这些值中的一个。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置浮动窗口的大小,以像素为单位。
当窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时,此属性是必需的。
| [in] | width | 浮动窗口的宽度,以像素为单位。此值应大于0。 |
| [in] | height | 浮动窗口的高度,以像素为单位。此值应大于0。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置多语言文本数组,提供要在浮动窗口标题栏上显示的文本。
此属性仅在窗口类型为 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 时有用。
多语言文本数组中的字符串是成对的:每对中的第一个字符串(ASCII字符串) 是语言标识符,第二个字符串是标题。
| [in] | titles | 表示多语言文本数组的字符串数组。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置基础URL。
基础URL是用于解析媒体数据中找到的任何相对URL的绝对URL。
| [in] | base_url | 要设置的基础URL。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置媒体数据的内容类型(MIME类型)。
内容类型指定由文件规范表示的媒体数据的类型。 内容类型字符串应符合Internet RFC 2045中描述的内容类型规范, 多用途Internet邮件扩展(MIME)第一部分:Internet消息主体的格式。
建议用户在通过函数 Rendition.SetMediaClipFile 设置新文件规范时 设置内容类型。
| [in] | content_type | 内容类型(MIME类型)。 |
|
inline |
设置实际媒体数据的文件规范。
此属性对演示对象是必需的。建议用户在设置新文件规范后 通过函数 Rendition.SetMediaClipContentType 设置内容类型。
| [in] | file_specification | A file specification object. |
|
inline |
设置媒体剪辑的名称,用于用户界面。
| [in] | name | 要为媒体剪辑设置的名称字符串。 |
|
inline |
设置多语言文本数组,在无法播放媒体剪辑数据时 提供替代文本描述。
多语言文本数组中的字符串成对出现:每对中的第一个字符串(ASCII字符串) 是语言标识符,第二个字符串是描述。
| [in] | description_array | 用于描述的多语言文本数组。 |
|
inline |
设置监视器指定类型值。
监视器指定用于指定在多监视器系统中浮动或 全屏窗口应出现在哪个监视器上。
| [in] | monitor_specifier | 监视器指定类型值。请参考从 foxit.pdf.Rendition.MonitorSpecifier.e_MonitorSpecifierLargest 开始的值,这应该是这些值中的一个。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置媒体权限。
媒体权限指示在什么情况下可以接受写入临时文件 来播放媒体剪辑。
| [in] | permission | 媒体权限值。请参考从 foxit.pdf.Rendition.MediaPermission.e_MediaPermTempNever 开始的值,这应该是这些值中的一个。 |
|
inline |
设置名称。
此名称可用于JavaScript动作的名称树查找,也可用于用户界面。
| [in] | name | 当前演示对象的名称。 |
|
inline |
设置重复计数,类似于SMIL的repeatCount属性。
| [in] | count | 要设置的重复计数。0 表示永远重复。此值不应为负值。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置音量,以录制音量级别的百分比指定所需的音量级别。
| [in] | volume | 要设置的音量值。0 表示静音。此值不应为负数。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |
|
inline |
设置媒体应播放的窗口类型。
| [in] | window_type | 窗口类型值。请参考从 foxit.pdf.Rendition.WindowType.e_WindowTypeFloating 开始的值,这应该是这些值中的一个。 |
| [in] | opt_type | 媒体选项类型。请参考从 foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored 开始的值,这应该是这些值中的一个。 默认值:foxit.pdf.Rendition.MediaOptionType.e_MediaOptionBestEffort 。 |