Foxit PDF SDK

Public 类型 | Public 成员函数 | 所有成员列表
foxit::pdf::Rendition类 参考
类 foxit::pdf::Rendition 继承关系图:

## Public 类型
enum | FloatingWindowOffscreenEvent { e_FloatingWindowOffscreenEventNone = 0, e_FloatingWindowOffscreenEventMoveResize = 1, e_FloatingWindowOffscreenEventNonViable = 2 }
| 浮动窗口屏幕外事件类型的枚举。 更多...
enum | FloatingWindowRelatedWindowType { e_FloatingWindowRelatedWindowDocument = 0, e_FloatingWindowRelatedWindowApplication = 1, e_FloatingWindowRelatedWindowFullDesktop = 2, e_FloatingWindowRelatedWindowMonitor = 3 }
| 浮动窗口相关窗口类型的枚举。 更多...
enum | FloatingWindowResizeType { e_FloatingWindowResizeTypeNo = 0, e_FloatingWindowResizeTypeAspectRatio = 1, e_FloatingWindowResizeTypeAnyway = 2 }
| 浮动窗口调整大小类型的枚举。 更多...
enum | MediaOptionType { e_MediaOptionMustBeHonored = 0, e_MediaOptionBestEffort = 1 }
| 媒体选项类型的枚举。 更多...
enum | MediaPermission { e_MediaPermTempNever = 0, e_MediaPermTempExtract = 1, e_MediaPermTempAccess = 2, e_MediaPermTempAlways = 3 }
| PDF媒体播放器权限的枚举。 更多...
enum | MediaPlayerFitStyle { e_MediaPlayerFitStyleMeet = 0, e_MediaPlayerFitStyleSlice = 1, e_MediaPlayerFitStyleFill = 2, e_MediaPlayerFitStyleScroll = 3, e_MediaPlayerFitStyleHidden = 4, e_MediaPlayerFitStyleDefault = 5 }
| 适配样式的枚举。 更多...
enum | MediaPlayerType { e_MediaPlayerMustUsed = 0, e_MediaPlayerAvailable = 1, e_MediaPlayerNotUsed = 2 }
| PDF媒体播放器分类类型的枚举。 更多...
enum | MonitorSpecifier { e_MonitorSpecifierLargest = 0, e_MonitorSpecifierSmallest = 1, e_MonitorSpecifierPrimary = 2, e_MonitorSpecifierGreatestColorDepth = 3, e_MonitorSpecifierGreatestArea = 4, e_MonitorSpecifierGreatestHeight = 5, e_MonitorSpecifierGreatestWidth = 6 }
| 监视器指定类型的枚举。 更多...
enum | WindowType { e_WindowTypeFloating = 0, e_WindowTypeFullScreen = 1, e_WindowTypeHidden = 2, e_WindowTypeAnnotRect = 3 }
| 媒体应播放的窗口类型的枚举。 更多...

## Public 成员函数
| Rendition (const PDFDoc &pdf_doc, objects::PDFDictionary *rendition_dict=0)
| 带参数的构造函数。 更多...
| Rendition (const Rendition &other)
| 使用另一个演示对象的构造函数。 更多...
| ~Rendition ()
| 析构函数。
int | AddMediaPlayer (MediaPlayerType type, const MediaPlayer &player)
| 为指定类型添加媒体播放器对象。 更多...
void | EnableAutoPlay (bool is_auto_play, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置标志以决定媒体激活时是否应自动播放。 更多...
void | EnableControlBarVisible (bool is_visible, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置控制栏可见性标志。 更多...
void | EnableFloatingWindowCloseButton (bool is_visible, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置标志以指定浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。 更多...
void | EnableFloatingWindowTitleBar (bool is_visible, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置标志以指定浮动窗口是否应有标题栏。 更多...
RGB | GetBackgroundColor () const
| 获取媒体正在播放的矩形的背景颜色。 更多...
float | GetBackgroundOpacity () const
| 获取背景不透明度。（对于全屏和隐藏窗口将被忽略） 更多...
objects::PDFDictionary * | GetDict () const
| 获取当前对象的PDF字典。 更多...
int | GetDuration () const
| 获取内在持续时间。 更多...
MediaPlayerFitStyle | GetFitStyle () const
| 获取适配样式。 更多...
int | GetFloatingWindowHeight () const
| 获取浮动窗口的高度，以像素为单位。 更多...
FloatingWindowOffscreenEvent | GetFloatingWindowOffscreenEvent () const
| 获取事件类型，指定如果浮动窗口完全或部分位于屏幕外 （即在任何物理监视器上都不可见）时应发生什么。 更多...
common::Position | GetFloatingWindowPosition () const
| 获取浮动窗口应相对于相关窗口定位的位置。 更多...
FloatingWindowRelatedWindowType | GetFloatingWindowRelatedWindowType () const
| 获取窗口相对类型。 更多...
FloatingWindowResizeType | GetFloatingWindowResizeType () const
| 获取调整大小类型，指定浮动窗口是否可以由用户调整大小。 更多...
WStringArray | GetFloatingWindowTitles () const
| 获取多语言文本数组，提供要在浮动窗口标题栏上显示的文本。 更多...
int | GetFloatingWindowWidth () const
| 获取浮动窗口的宽度，以像素为单位。 更多...
String | GetMediaBaseURL () const
| 获取基础URL。 更多...
String | GetMediaClipContentType () const
| 获取媒体数据的内容类型（MIME类型）。 更多...
FileSpec | GetMediaClipFile () const
| 获取实际媒体数据的文件规范。 更多...
WString | GetMediaClipName () const
| 获取媒体剪辑的名称，用于用户界面。 更多...
WStringArray | GetMediaDescriptions () const
| 获取多语言文本数组，在无法播放媒体剪辑数据时 提供替代文本描述。 更多...
MediaPlayer | GetMediaPlayer (MediaPlayerType type, int index) const
| 根据索引获取指定类型的媒体播放器对象。 更多...
int | GetMediaPlayerCount (MediaPlayerType type) const
| 获取指定类型的媒体播放器对象数量。 更多...
MonitorSpecifier | GetMonitorSpecifier () const
| 获取监视器指定类型值。 更多...
MediaPermission | GetPermission () const
| 获取媒体权限。 更多...
WString | GetRenditionName () const
| 获取名称。 更多...
int | GetRepeatCount () const
| 获取重复计数，类似于SMIL的repeatCount属性。 更多...
int | GetVolume () const
| 获取音量，以录制音量级别的百分比指定所需的音量级别。 更多...
WindowType | GetWindowType () const
| 获取媒体应播放的窗口类型。 更多...
bool | HasFloatingWindowCloseButton () const
| 检查浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。 更多...
bool | HasFloatingWindowTitleBar () const
| 检查浮动窗口是否应有标题栏。 更多...
bool | HasMediaClip () const
| 检查当前演示对象是否包含媒体剪辑。 更多...
bool | IsAutoPlay () const
| 检查媒体激活时是否应自动播放。 更多...
bool | IsControlBarVisible () const
| 检查播放时是否显示播放器特定的控制器用户界面 （例如，播放/暂停/停止控件）。 更多...
bool | IsEmpty () const
| 检查当前对象是否为空。 更多...
bool | operator!= (const Rendition &other) const
| 不等于操作符。 更多...
Rendition & | operator= (const Rendition &other)
| 赋值操作符。 更多...
bool | operator== (const Rendition &other) const
| 等于操作符。 更多...
void | RemoveMediaPlayer (MediaPlayerType type, const MediaPlayer &player)
| 删除指定类型的媒体播放器对象。 更多...
void | SetBackgroundColor (RGB color, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置媒体正在播放的矩形的背景颜色。 更多...
void | SetBackgroundOpacity (float opacity, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置背景不透明度。（对于全屏和隐藏窗口将被忽略） 更多...
void | SetDuration (int duration, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置内在持续时间。 更多...
void | SetFitStyle (MediaPlayerFitStyle fit_style, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置适配样式。 更多...
void | SetFloatingWindowOffscreenEvent (FloatingWindowOffscreenEvent offscreen_event, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置事件类型，指定如果浮动窗口完全或部分位于屏幕外 （即在任何物理监视器上都不可见）时应发生什么。 更多...
void | SetFloatingWindowPosition (common::Position position, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置浮动窗口应相对于相关窗口定位的位置。 更多...
void | SetFloatingWindowRelatedWindowType (FloatingWindowRelatedWindowType window_type, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置窗口相对类型。 更多...
void | SetFloatingWindowResizeType (FloatingWindowResizeType resize_type, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置调整大小类型，指定浮动窗口是否可以由用户调整大小。 更多...
void | SetFloatingWindowSize (int width, int height, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置浮动窗口的大小，以像素为单位。 更多...
void | SetFloatingWindowTitles (const WStringArray &titles, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置多语言文本数组，提供要在浮动窗口标题栏上显示的文本。 更多...
void | SetMediaBaseURL (const String &base_url, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置基础URL。 更多...
void | SetMediaClipContentType (const char *content_type)
| 设置媒体数据的内容类型（MIME类型）。 更多...
void | SetMediaClipFile (FileSpec file_specification)
| 设置实际媒体数据的文件规范。 更多...
void | SetMediaClipName (const WString &name)
| 设置媒体剪辑的名称，用于用户界面。 更多...
void | SetMediaDescriptions (const WStringArray &description_array)
| 设置多语言文本数组，在无法播放媒体剪辑数据时 提供替代文本描述。 更多...
void | SetMonitorSpecifier (MonitorSpecifier monitor_specifier, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置监视器指定类型值。 更多...
void | SetPermission (MediaPermission permission)
| 设置媒体权限。 更多...
void | SetRenditionName (const WString &name)
| 设置名称。 更多...
void | SetRepeatCount (int count, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置重复计数，类似于SMIL的repeatCount属性。 更多...
void | SetVolume (int volume, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置音量，以录制音量级别的百分比指定所需的音量级别。 更多...
void | SetWindowType (WindowType window_type, MediaOptionType opt_type=e_MediaOptionBestEffort)
| 设置媒体应播放的窗口类型。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE | Handle () const
| 获取当前对象的句柄。 更多...

## 详细描述

演示对象用作媒体对象，指定播放什么、如何播放以及在哪里播放。 （更多详细信息，请参考 <PDF Reference 1.7> P758 Section "9.1.2 Renditions", P762 "Media Renditions"）

## 成员枚举类型说明

## ◆ FloatingWindowOffscreenEvent

enum foxit::pdf::Rendition::FloatingWindowOffscreenEvent

浮动窗口屏幕外事件类型的枚举。

此枚举的值应单独使用。
屏幕外事件类型用于指定如果浮动窗口 完全或部分位于屏幕外（即在任何物理监视器上都不可见）时应发生什么。

枚举值
e_FloatingWindowOffscreenEventNone | 什么都不做
e_FloatingWindowOffscreenEventMoveResize | 移动或调整大小
e_FloatingWindowOffscreenEventNonViable | 认为对象不可行

## ◆ FloatingWindowRelatedWindowType

enum foxit::pdf::Rendition::FloatingWindowRelatedWindowType

浮动窗口相关窗口类型的枚举。

此枚举的值应单独使用。
相关窗口类型指定浮动窗口应定位到的位置。

枚举值
e_FloatingWindowRelatedWindowDocument | 文档窗口
e_FloatingWindowRelatedWindowApplication | 应用程序窗口
e_FloatingWindowRelatedWindowFullDesktop | 完整的虚拟桌面
e_FloatingWindowRelatedWindowMonitor | 依赖于监视器指定。

## ◆ FloatingWindowResizeType

enum foxit::pdf::Rendition::FloatingWindowResizeType

浮动窗口调整大小类型的枚举。

此枚举的值应单独使用。

枚举值
e_FloatingWindowResizeTypeNo | 不能调整大小
e_FloatingWindowResizeTypeAspectRatio | 只有在保持宽高比的情况下才可以调整大小
e_FloatingWindowResizeTypeAnyway | 可以在不保持宽高比的情况下调整大小

## ◆ MediaOptionType

enum foxit::pdf::Rendition::MediaOptionType

媒体选项类型的枚举。

此枚举的值应单独使用。
请参考 <PDF reference 1.7> P757 Section "9.1.1 Viability" 获取更多详细信息。

枚举值
e_MediaOptionMustBeHonored | 在此类型中定义的选项必须被遵守，演示对象才被认为是可行的。
e_MediaOptionBestEffort | 在此类型中定义的选项只需要在"尽力而为"的意义上被遵守。

## ◆ MediaPermission

enum foxit::pdf::Rendition::MediaPermission

PDF媒体播放器权限的枚举。

此枚举的值应单独使用。
媒体权限指示在什么情况下可以接受写入临时文件 来播放媒体剪辑。

枚举值
e_MediaPermTempNever | 从不允许。
e_MediaPermTempExtract | 只有当文档权限允许内容提取时才允许。
e_MediaPermTempAccess | 只有当文档权限允许内容提取（包括用于辅助功能目的）时才允许。
e_MediaPermTempAlways | 总是允许。

## ◆ MediaPlayerFitStyle

enum foxit::pdf::Rendition::MediaPlayerFitStyle

适配样式的枚举。

此枚举的值应单独使用。
适配样式（方式）指定播放器应如何处理与其播放矩形不完全匹配的 视觉媒体类型。

枚举值
e_MediaPlayerFitStyleMeet | 在保持宽高比的同时缩放媒体的宽度和高度，使得 媒体和播放矩形具有最大可能的交集，同时仍然 显示所有媒体内容。与SMIL的fit属性的"meet"值相同。
e_MediaPlayerFitStyleSlice | 在保持宽高比的同时缩放媒体的宽度和高度，使得 播放矩形完全填满，并且不适合 播放矩形内的媒体内容量最小化。与SMIL的fit属性的"slice"值相同。
e_MediaPlayerFitStyleFill | 媒体的宽度和高度独立缩放，使得媒体和播放矩形相同； 宽高比不一定保持。与SMIL的fit属性的"fill"值相同。
e_MediaPlayerFitStyleScroll | 媒体不缩放。如果媒体矩形比播放矩形更宽或更高， 则提供滚动用户界面。与SMIL的fit属性的"scroll"值相同。
e_MediaPlayerFitStyleHidden | 媒体不缩放。只显示媒体矩形与播放矩形 相交的部分。与SMIL的fit属性的"hidden"值相同。
e_MediaPlayerFitStyleDefault | 使用播放器的默认设置（作者没有偏好）。

## ◆ MediaPlayerType

enum foxit::pdf::Rendition::MediaPlayerType

PDF媒体播放器分类类型的枚举。

此枚举的值应单独使用。

枚举值
e_MediaPlayerMustUsed | 此类型中的播放器之一必须用于播放相关的媒体剪辑。
e_MediaPlayerAvailable | 此类型中的任何播放器都可以用于播放相关的媒体剪辑。
e_MediaPlayerNotUsed | 此类型中的播放器不得用于播放相关的媒体剪辑。

## ◆ MonitorSpecifier

enum foxit::pdf::Rendition::MonitorSpecifier

监视器指定类型的枚举。

此枚举的值应单独使用。
监视器指定用于指定在多监视器系统中浮动或 全屏窗口应出现在哪个监视器上。

枚举值
e_MonitorSpecifierLargest | 包含文档窗口最大部分的监视器
e_MonitorSpecifierSmallest | 包含文档窗口最小部分的监视器
e_MonitorSpecifierPrimary | 主监视器。如果没有监视器被认为是主要的，使用情况0
e_MonitorSpecifierGreatestColorDepth | 具有最大颜色深度的监视器
e_MonitorSpecifierGreatestArea | 具有最大面积的监视器（以像素平方为单位）
e_MonitorSpecifierGreatestHeight | 具有最大高度的监视器（以像素为单位）
e_MonitorSpecifierGreatestWidth | 具有最大宽度的监视器（以像素为单位）

## ◆ WindowType

enum foxit::pdf::Rendition::WindowType

媒体应播放的窗口类型的枚举。

此枚举的值应单独使用。

枚举值
e_WindowTypeFloating | 窗口类型：浮动窗口
e_WindowTypeFullScreen | 窗口类型：遮挡所有其他窗口的全屏窗口
e_WindowTypeHidden | 窗口类型：隐藏窗口
e_WindowTypeAnnotRect | 窗口类型：与演示对象关联的屏幕注释所占据的矩形。

## 构造及析构函数说明

## ◆ Rendition() [1/2]

foxit::pdf::Rendition::Rendition | ( | const PDFDoc & | pdf_doc,
|  | objects::PDFDictionary * | rendition_dict = `0`
| ) |  |

带参数的构造函数。

参数

  [in] | pdf_doc | 有效的PDF文档对象。
  [in] | rendition_dict | 参数 pdf_doc 表示的PDF文档中演示对象的PDF字典。 如果这是 NULL，意味着在参数 pdf_obj 表示的PDF文档中 构造一个新的演示对象。 默认值：NULL。

## ◆ Rendition() [2/2]

foxit::pdf::Rendition::Rendition | ( | const Rendition & | other | ) |

使用另一个演示对象的构造函数。

参数

  [in] | other | 另一个演示对象。

## 成员函数说明

## ◆ AddMediaPlayer()

int foxit::pdf::Rendition::AddMediaPlayer | ( | MediaPlayerType | type,
|  | const MediaPlayer & | player
| ) |  |

为指定类型添加媒体播放器对象。

通常，媒体播放器对象应该只添加到具有指定媒体播放器类型的演示对象中。 不建议用户将相同的媒体播放器对象添加到不同的演示或 一个演示的不同媒体播放器类型中；否则可能会发生意外问题（如崩溃）。 如果用户不想构造另一个媒体播放器并设置相同的值，用户可以克隆 原始媒体播放器对象的字典，并使用克隆的字典 直接构造另一个媒体播放器。

参数

  [in] | type | 媒体播放器类型。请参考从 Rendition::e_MediaPlayerMustUsed 开始的值， 这应该是这些值中的一个。
  [in] | player | 要为指定类型添加的媒体播放器对象。如果媒体播放器已经为 指定类型存在，此函数将返回媒体播放器的索引。

返回
  输入媒体播放器的索引。

## ◆ EnableAutoPlay()

void foxit::pdf::Rendition::EnableAutoPlay | ( | bool | is_auto_play,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置标志以决定媒体激活时是否应自动播放。

参数

  [in] | is_auto_play | true 表示媒体激活时应自动播放， false 表示媒体激活时应初始暂停 （例如，显示第一帧）。仅与可能暂停的媒体相关。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ EnableControlBarVisible()

void foxit::pdf::Rendition::EnableControlBarVisible | ( | bool | is_visible,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置控制栏可见性标志。

控制栏可见性标志用于决定播放时是否显示播放器特定的控制器用户界面 （例如，播放/暂停/停止控件）。

参数

  [in] | is_visible | true 表示显示播放器特定的控制器用户界面， false 表示不显示此类用户界面。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ EnableFloatingWindowCloseButton()

void foxit::pdf::Rendition::EnableFloatingWindowCloseButton | ( | bool | is_visible,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置标志以指定浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。

参数

  [in] | is_visible | true 表示浮动窗口应包含允许用户 关闭浮动窗口的用户界面元素，false 表示 浮动窗口不需要包含此类用户界面元素。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ EnableFloatingWindowTitleBar()

void foxit::pdf::Rendition::EnableFloatingWindowTitleBar | ( | bool | is_visible,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置标志以指定浮动窗口是否应有标题栏。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。

参数

  [in] | is_visible | true 表示浮动窗口应有标题栏，false 表示 浮动窗口不需要有标题栏。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ GetBackgroundColor()

RGB foxit::pdf::Rendition::GetBackgroundColor | ( |  | ) | const

获取媒体正在播放的矩形的背景颜色。

返回
  背景颜色。格式：0xRRGGBB。返回值 0xFFFFFF 也可能意味着演示对象中 未定义此属性的值。

## ◆ GetBackgroundOpacity()

float foxit::pdf::Rendition::GetBackgroundOpacity | ( |  | ) | const

获取背景不透明度。（对于全屏和隐藏窗口将被忽略）

返回
  背景不透明度。有效范围：0.0 到 1.0。 0.0 表示完全透明，1.0 表示完全不透明。 如果演示对象中未定义此属性的值， 默认返回 1.0。

## ◆ GetDict()

objects::PDFDictionary* foxit::pdf::Rendition::GetDict | ( |  | ) | const

获取当前对象的PDF字典。

返回
  PDF字典。如果有任何错误，此函数将返回 NULL。

## ◆ GetDuration()

int foxit::pdf::Rendition::GetDuration | ( |  | ) | const

获取内在持续时间。

返回
  内在持续时间值。可能是：
  - -2：使用内在持续时间；
  - -1：无限持续时间；
  - >= 0：显式持续时间。
  如果演示对象中未定义此属性的值，默认返回 -2。

## ◆ GetFitStyle()

MediaPlayerFitStyle foxit::pdf::Rendition::GetFitStyle | ( |  | ) | const

获取适配样式。

适配样式（方式）指定播放器应如何处理与其播放矩形不完全匹配的 视觉媒体类型。

返回
  适配样式值。请参考从 Rendition::e_MediaPlayerFitStyleMeet 开始的值， 这将是这些值中的一个。如果演示对象中未定义此属性的值， 默认返回 Rendition::e_MediaPlayerFitStyleDefault。

## ◆ GetFloatingWindowHeight()

int foxit::pdf::Rendition::GetFloatingWindowHeight | ( |  | ) | const

获取浮动窗口的高度，以像素为单位。

当窗口类型为 Rendition::e_WindowTypeFloating 时，此属性是必需的。

返回
  浮动窗口的高度，以像素为单位。

## ◆ GetFloatingWindowOffscreenEvent()

FloatingWindowOffscreenEvent foxit::pdf::Rendition::GetFloatingWindowOffscreenEvent | ( |  | ) | const

获取事件类型，指定如果浮动窗口完全或部分位于屏幕外 （即在任何物理监视器上都不可见）时应发生什么。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。

返回
  浮动窗口屏幕外情况的事件类型。请参考从 Rendition::e_FloatingWindowOffscreenEventNone 开始的值，这将是这些值中的一个。 如果演示对象中未定义此属性的值， 默认返回 Rendition::e_FloatingWindowOffscreenEventMoveResize。

## ◆ GetFloatingWindowPosition()

common::Position foxit::pdf::Rendition::GetFloatingWindowPosition | ( |  | ) | const

获取浮动窗口应相对于相关窗口定位的位置。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。
窗口相对位置指定浮动窗口应定位到的位置。

返回
  位置值。请参考从 common::e_PosTopLeft 开始的值， 这将是这些值中的一个。如果演示对象中未定义此属性的值， 默认返回 common::e_PosCenter。

## ◆ GetFloatingWindowRelatedWindowType()

FloatingWindowRelatedWindowType foxit::pdf::Rendition::GetFloatingWindowRelatedWindowType | ( |  | ) | const

获取窗口相对类型。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。
相关窗口类型指定浮动窗口应定位到的位置。

返回
  相关窗口类型。请参考从 Rendition::e_FloatingWindowRelatedWindowDocument 开始的值，这将是这些值中的一个。 如果演示对象中未定义此属性的值， 默认返回 Rendition::e_FloatingWindowRelatedWindowDocument。

## ◆ GetFloatingWindowResizeType()

FloatingWindowResizeType foxit::pdf::Rendition::GetFloatingWindowResizeType | ( |  | ) | const

获取调整大小类型，指定浮动窗口是否可以由用户调整大小。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。

返回
  调整大小类型。请参考从 Rendition::e_FloatingWindowResizeTypeNo 开始的值， 这将是这些值中的一个。如果演示对象中未定义此属性的值， 默认返回 Rendition::e_FloatingWindowResizeTypeNo。

## ◆ GetFloatingWindowTitles()

WStringArray foxit::pdf::Rendition::GetFloatingWindowTitles | ( |  | ) | const

获取多语言文本数组，提供要在浮动窗口标题栏上显示的文本。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。
多语言文本数组中的字符串是成对的：每对中的第一个字符串（ASCII字符串） 是语言标识符，第二个字符串是标题。

返回
  表示多语言文本数组的字符串数组。

## ◆ GetFloatingWindowWidth()

int foxit::pdf::Rendition::GetFloatingWindowWidth | ( |  | ) | const

获取浮动窗口的宽度，以像素为单位。

当窗口类型为 Rendition::e_WindowTypeFloating 时，此属性是必需的。

返回
  浮动窗口的宽度，以像素为单位。

## ◆ GetMediaBaseURL()

String foxit::pdf::Rendition::GetMediaBaseURL | ( |  | ) | const

获取基础URL。

基础URL是用于解析媒体数据中找到的任何相对URL的绝对URL。

返回
  基础URL。

## ◆ GetMediaClipContentType()

String foxit::pdf::Rendition::GetMediaClipContentType | ( |  | ) | const

获取媒体数据的内容类型（MIME类型）。

内容类型指定由文件规范表示的媒体数据的类型。 内容类型字符串应符合Internet RFC 2045中描述的内容类型规范， 多用途Internet邮件扩展（MIME）第一部分：Internet消息主体的格式。

返回
  内容类型（MIME类型）。

## ◆ GetMediaClipFile()

FileSpec foxit::pdf::Rendition::GetMediaClipFile | ( |  | ) | const

获取实际媒体数据的文件规范。

返回
  文件规范对象。

## ◆ GetMediaClipName()

WString foxit::pdf::Rendition::GetMediaClipName | ( |  | ) | const

获取媒体剪辑的名称，用于用户界面。

返回
  媒体剪辑的名称。

## ◆ GetMediaDescriptions()

WStringArray foxit::pdf::Rendition::GetMediaDescriptions | ( |  | ) | const

获取多语言文本数组，在无法播放媒体剪辑数据时 提供替代文本描述。

多语言文本数组中的字符串成对出现：每对中的第一个字符串（ASCII字符串） 是语言标识符，第二个字符串是描述。

返回
  用于描述的多语言文本数组。

## ◆ GetMediaPlayer()

MediaPlayer foxit::pdf::Rendition::GetMediaPlayer | ( | MediaPlayerType | type,
|  | int | index
| ) |  | const

根据索引获取指定类型的媒体播放器对象。

参数

  [in] | type | 媒体播放器类型。请参考从 Rendition::e_MediaPlayerMustUsed 开始的值， 这应该是这些值中的一个。
  [in] | index | 要检索的媒体播放器对象的索引。有效范围：从 0 到 (count-1)。 count 由函数 Rendition::GetMediaPlayerCount 返回。

返回
  媒体播放器对象。

## ◆ GetMediaPlayerCount()

int foxit::pdf::Rendition::GetMediaPlayerCount | ( | MediaPlayerType | type | ) | const

获取指定类型的媒体播放器对象数量。

参数

  [in] | type | 媒体播放器类型。请参考从 Rendition::e_MediaPlayerMustUsed 开始的值， 这应该是这些值中的一个。

返回
  指定类型的媒体播放器对象数量。

## ◆ GetMonitorSpecifier()

MonitorSpecifier foxit::pdf::Rendition::GetMonitorSpecifier | ( |  | ) | const

获取监视器指定类型值。

监视器指定用于指定在多监视器系统中浮动或 全屏窗口应出现在哪个监视器上。

返回
  监视器指定类型值。请参考从 Rendition::e_MonitorSpecifierLargest 开始的值，这将是这些值中的一个。 如果演示对象中未定义此属性的值， 默认返回 Rendition::e_MonitorSpecifierLargest。

## ◆ GetPermission()

MediaPermission foxit::pdf::Rendition::GetPermission | ( |  | ) | const

获取媒体权限。

媒体权限指示在什么情况下可以接受写入临时文件 来播放媒体剪辑。

返回
  媒体权限值。请参考从 Rendition::e_MediaPermTempNever 开始的值， 这将是这些值中的一个。

## ◆ GetRenditionName()

WString foxit::pdf::Rendition::GetRenditionName | ( |  | ) | const

获取名称。

此名称可用于JavaScript动作的名称树查找，也可用于用户界面。

返回
  当前演示对象的名称。

## ◆ GetRepeatCount()

int foxit::pdf::Rendition::GetRepeatCount | ( |  | ) | const

获取重复计数，类似于SMIL的repeatCount属性。

返回
  重复计数。0 表示永远重复。如果演示对象中未定义此属性的值， 默认返回 1。

## ◆ GetVolume()

int foxit::pdf::Rendition::GetVolume | ( |  | ) | const

获取音量，以录制音量级别的百分比指定所需的音量级别。

返回
  音量值。0 表示静音。如果演示对象中未定义此属性的值， 默认返回 100。

## ◆ GetWindowType()

WindowType foxit::pdf::Rendition::GetWindowType | ( |  | ) | const

获取媒体应播放的窗口类型。

返回
  窗口类型值。请参考 Rendition::e_WindowTypeFloating 值，这将是这些值中的一个。如果演示对象中未定义此属性的值， 默认返回 Rendition::e_WindowTypeAnnotRect。

## ◆ HasFloatingWindowCloseButton()

bool foxit::pdf::Rendition::HasFloatingWindowCloseButton | ( |  | ) | const

检查浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。

返回
  true 表示浮动窗口应包含允许用户 关闭浮动窗口的用户界面元素，false 表示浮动窗口不需要 包含此类用户界面元素。如果演示对象中未定义此属性的值， 默认返回 true。

## ◆ HasFloatingWindowTitleBar()

bool foxit::pdf::Rendition::HasFloatingWindowTitleBar | ( |  | ) | const

检查浮动窗口是否应有标题栏。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。

返回
  true 表示浮动窗口应有标题栏，false 表示 浮动窗口不需要有标题栏。如果演示对象中未定义此属性的值， 默认返回 true。

## ◆ HasMediaClip()

bool foxit::pdf::Rendition::HasMediaClip | ( |  | ) | const

检查当前演示对象是否包含媒体剪辑。

返回
  true 表示当前演示对象包含媒体剪辑，false 表示 当前演示对象不包含任何媒体剪辑。

## ◆ IsAutoPlay()

bool foxit::pdf::Rendition::IsAutoPlay | ( |  | ) | const

检查媒体激活时是否应自动播放。

返回
  true 表示媒体激活时应自动播放， false 表示媒体激活时应初始暂停 （例如，显示第一帧）。仅与可能暂停的媒体相关。 如果演示对象中未定义此属性的值，默认返回 true。

## ◆ IsControlBarVisible()

bool foxit::pdf::Rendition::IsControlBarVisible | ( |  | ) | const

检查播放时是否显示播放器特定的控制器用户界面 （例如，播放/暂停/停止控件）。

返回
  true 表示显示播放器特定的控制器用户界面， false 表示不显示此类用户界面。 如果演示对象中未定义此属性的值，默认返回 false。

## ◆ IsEmpty()

bool foxit::pdf::Rendition::IsEmpty | ( |  | ) | const

检查当前对象是否为空。

当前对象为空时，意味着当前对象无用。

返回
  true 表示当前对象为空，false 表示不为空。

## ◆ operator!=()

bool foxit::pdf::Rendition::operator!= | ( | const Rendition & | other | ) | const

不等于操作符。

参数

  [in] | other | 另一个演示对象。此函数将检查当前对象是否不等于这个对象。

返回
  true 表示不相等，false 表示相等。

## ◆ operator=()

Rendition& foxit::pdf::Rendition::operator= | ( | const Rendition & | other | ) |

赋值操作符。

参数

  [in] | other | 另一个演示对象，其值将被赋给当前对象。

返回
  对当前对象自身的引用。

## ◆ operator==()

bool foxit::pdf::Rendition::operator== | ( | const Rendition & | other | ) | const

等于操作符。

参数

  [in] | other | 另一个演示对象。此函数将检查当前对象是否等于这个对象。

返回
  true 表示相等，false 表示不相等。

## ◆ RemoveMediaPlayer()

void foxit::pdf::Rendition::RemoveMediaPlayer | ( | MediaPlayerType | type,
|  | const MediaPlayer & | player
| ) |  |

删除指定类型的媒体播放器对象。

参数

  [in] | type | 媒体播放器类型。请参考从 Rendition::e_MediaPlayerMustUsed 开始的值， 这应该是这些值中的一个。
  [in] | player | 要删除的媒体播放器对象。

返回
  无。

## ◆ SetBackgroundColor()

void foxit::pdf::Rendition::SetBackgroundColor | ( | RGB | color,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置媒体正在播放的矩形的背景颜色。

参数

  [in] | color | 要设置的背景颜色。格式：0xRRGGBB。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetBackgroundOpacity()

void foxit::pdf::Rendition::SetBackgroundOpacity | ( | float | opacity,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置背景不透明度。（对于全屏和隐藏窗口将被忽略）

参数

  [in] | opacity | 背景不透明度。有效范围：0.0 到 1.0。 0.0 表示完全透明，1.0 表示完全不透明。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetDuration()

void foxit::pdf::Rendition::SetDuration | ( | int | duration,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置内在持续时间。

参数

  [in] | duration | 要设置的内在持续时间值。应该是： -2：使用内在持续时间； -1：无限持续时间； >= 0：显式持续时间。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetFitStyle()

void foxit::pdf::Rendition::SetFitStyle | ( | MediaPlayerFitStyle | fit_style,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置适配样式。

适配样式（方式）指定播放器应如何处理与其播放矩形不完全匹配的 视觉媒体类型。

参数

  [in] | fit_style | 适配样式值。请参考从 Rendition::e_MediaPlayerFitStyleMeet 开始的值，这应该是这些值中的一个。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetFloatingWindowOffscreenEvent()

void foxit::pdf::Rendition::SetFloatingWindowOffscreenEvent | ( | FloatingWindowOffscreenEvent | offscreen_event,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置事件类型，指定如果浮动窗口完全或部分位于屏幕外 （即在任何物理监视器上都不可见）时应发生什么。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。

参数

  [in] | offscreen_event | 浮动窗口屏幕外情况的事件类型。请参考从 Rendition::e_FloatingWindowOffscreenEventNone 开始的值， 这应该是这些值中的一个。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetFloatingWindowPosition()

void foxit::pdf::Rendition::SetFloatingWindowPosition | ( | common::Position | position,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置浮动窗口应相对于相关窗口定位的位置。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。
窗口相对位置指定浮动窗口应定位到的位置。

参数

  [in] | position | 窗口相对类型。请参考从 Rendition::e_FloatingWindowRelatedWindowDocument 开始的值， 这应该是这些值中的一个。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetFloatingWindowRelatedWindowType()

void foxit::pdf::Rendition::SetFloatingWindowRelatedWindowType | ( | FloatingWindowRelatedWindowType | window_type,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置窗口相对类型。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。
相关窗口类型指定浮动窗口应定位到的位置。

参数

  [in] | window_type | 相关窗口类型。请参考从 Rendition::e_FloatingWindowRelatedWindowDocument 开始的值， 这应该是这些值中的一个。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetFloatingWindowResizeType()

void foxit::pdf::Rendition::SetFloatingWindowResizeType | ( | FloatingWindowResizeType | resize_type,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置调整大小类型，指定浮动窗口是否可以由用户调整大小。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。

参数

  [in] | resize_type | 调整大小类型。请参考从 Rendition::e_FloatingWindowResizeTypeNo 开始的值， 这应该是这些值中的一个。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetFloatingWindowSize()

void foxit::pdf::Rendition::SetFloatingWindowSize | ( | int | width,
|  | int | height,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置浮动窗口的大小，以像素为单位。

当窗口类型为 Rendition::e_WindowTypeFloating 时，此属性是必需的。

参数

  [in] | width | 浮动窗口的宽度，以像素为单位。此值应大于0。
  [in] | height | 浮动窗口的高度，以像素为单位。此值应大于0。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetFloatingWindowTitles()

void foxit::pdf::Rendition::SetFloatingWindowTitles | ( | const WStringArray & | titles,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置多语言文本数组，提供要在浮动窗口标题栏上显示的文本。

此属性仅在窗口类型为 Rendition::e_WindowTypeFloating 时有用。
多语言文本数组中的字符串是成对的：每对中的第一个字符串（ASCII字符串） 是语言标识符，第二个字符串是标题。

参数

  [in] | titles | 表示多语言文本数组的字符串数组。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetMediaBaseURL()

void foxit::pdf::Rendition::SetMediaBaseURL | ( | const String & | base_url,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置基础URL。

基础URL是用于解析媒体数据中找到的任何相对URL的绝对URL。

参数

  [in] | base_url | 要设置的基础URL。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetMediaClipContentType()

void foxit::pdf::Rendition::SetMediaClipContentType | ( | const char * | content_type | ) |

设置媒体数据的内容类型（MIME类型）。

内容类型指定由文件规范表示的媒体数据的类型。 内容类型字符串应符合Internet RFC 2045中描述的内容类型规范， 多用途Internet邮件扩展（MIME）第一部分：Internet消息主体的格式。
建议用户在通过函数 Rendition::SetMediaClipFile 设置新文件规范时 设置内容类型。

参数

  [in] | content_type | 内容类型（MIME类型）。

返回
  无。

## ◆ SetMediaClipFile()

void foxit::pdf::Rendition::SetMediaClipFile | ( | FileSpec | file_specification | ) |

设置实际媒体数据的文件规范。

此属性对演示对象是必需的。建议用户在设置新文件规范后 通过函数 Rendition::SetMediaClipContentType 设置内容类型。

参数

  [in] | file_specification | A file specification object.

返回
  None.

## ◆ SetMediaClipName()

void foxit::pdf::Rendition::SetMediaClipName | ( | const WString & | name | ) |

设置媒体剪辑的名称，用于用户界面。

参数

  [in] | name | 要为媒体剪辑设置的名称字符串。

返回
  无。

## ◆ SetMediaDescriptions()

void foxit::pdf::Rendition::SetMediaDescriptions | ( | const WStringArray & | description_array | ) |

设置多语言文本数组，在无法播放媒体剪辑数据时 提供替代文本描述。

多语言文本数组中的字符串成对出现：每对中的第一个字符串（ASCII字符串） 是语言标识符，第二个字符串是描述。

参数

  [in] | description_array | 用于描述的多语言文本数组。

返回
  无。

## ◆ SetMonitorSpecifier()

void foxit::pdf::Rendition::SetMonitorSpecifier | ( | MonitorSpecifier | monitor_specifier,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置监视器指定类型值。

监视器指定用于指定在多监视器系统中浮动或 全屏窗口应出现在哪个监视器上。

参数

  [in] | monitor_specifier | 监视器指定类型值。请参考从 Rendition::e_MonitorSpecifierLargest 开始的值，这应该是这些值中的一个。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetPermission()

void foxit::pdf::Rendition::SetPermission | ( | MediaPermission | permission | ) |

设置媒体权限。

媒体权限指示在什么情况下可以接受写入临时文件 来播放媒体剪辑。

参数

  [in] | permission | 媒体权限值。请参考从 Rendition::e_MediaPermTempNever 开始的值，这应该是这些值中的一个。

返回
  无。

## ◆ SetRenditionName()

void foxit::pdf::Rendition::SetRenditionName | ( | const WString & | name | ) |

设置名称。

此名称可用于JavaScript动作的名称树查找，也可用于用户界面。

参数

  [in] | name | 当前演示对象的名称。

返回
  无。

## ◆ SetRepeatCount()

void foxit::pdf::Rendition::SetRepeatCount | ( | int | count,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置重复计数，类似于SMIL的repeatCount属性。

参数

  [in] | count | 要设置的重复计数。0 表示永远重复。此值不应为负值。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetVolume()

void foxit::pdf::Rendition::SetVolume | ( | int | volume,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置音量，以录制音量级别的百分比指定所需的音量级别。

参数

  [in] | volume | 要设置的音量值。0 表示静音。此值不应为负数。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。

## ◆ SetWindowType()

void foxit::pdf::Rendition::SetWindowType | ( | WindowType | window_type,
|  | MediaOptionType | opt_type = `e_MediaOptionBestEffort`
| ) |  |

设置媒体应播放的窗口类型。

参数

  [in] | window_type | 窗口类型值。请参考从 Rendition::e_WindowTypeFloating 开始的值，这应该是这些值中的一个。
  [in] | opt_type | 媒体选项类型。请参考从 Rendition::e_MediaOptionMustBeHonored 开始的值，这应该是这些值中的一个。 默认值：Rendition::e_MediaOptionBestEffort。

返回
  无。