Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::Rendition类 参考

## Public 成员函数
| AddMediaPlayer (type, player)
| 为指定类型添加媒体播放器对象。 更多...
| constructor (pdf_doc, rendition_dict)
| 构造函数,带参数。 更多...
| EnableAutoPlay (is_auto_play, opt_type)
| 设置标志以决定媒体是否应在激活时自动播放。 更多...
| EnableControlBarVisible (is_visible, opt_type)
| 设置控制栏可见性标志。 更多...
| EnableFloatingWindowCloseButton (is_visible, opt_type)
| 设置标志以指定浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。 更多...
| EnableFloatingWindowTitleBar (is_visible, opt_type)
| 设置标志以指定浮动窗口是否应具有标题栏。 更多...
| GetBackgroundColor ()
| 获取正在播放媒体的矩形的背景颜色。 更多...
| GetBackgroundOpacity ()
| 获取背景不透明度。（全屏和隐藏窗口忽略） 更多...
| GetDict ()
| 获取当前对象的PDF字典。 更多...
| GetDuration ()
| 获取固有持续时间。 更多...
| GetFitStyle ()
| 获取适应样式。 更多...
| GetFloatingWindowHeight ()
| 获取浮动窗口的高度，以像素为单位。 更多...
| GetFloatingWindowOffscreenEvent ()
| 获取事件类型，指定如果浮动窗口 完全或部分离屏（即，在任何物理监视器上都不可见）时应发生什么。 更多...
| GetFloatingWindowPosition ()
| 获取浮动窗口应定位到相关窗口的位置。 更多...
| GetFloatingWindowRelatedWindowType ()
| 获取窗口相对类型。 更多...
| GetFloatingWindowResizeType ()
| 获取调整大小类型，指定用户是否可以调整浮动窗口的大小。 更多...
| GetFloatingWindowTitles ()
| 获取多语言文本数组，该数组提供要在浮动窗口标题栏上显示的文本。 更多...
| GetFloatingWindowWidth ()
| 获取浮动窗口的宽度，以像素为单位。 更多...
| GetMediaBaseURL ()
| 获取基础URL。 更多...
| GetMediaClipContentType ()
| 获取媒体数据的内容类型(MIME类型)。 更多...
| GetMediaClipFile ()
| 获取实际媒体数据的文件规范。 更多...
| GetMediaClipName ()
| 获取媒体剪辑的名称,用于用户界面。 更多...
| GetMediaDescriptions ()
| 获取多语言文本数组,该数组为媒体剪辑数据提供备用文本描述, 以防无法播放。 更多...
| GetMediaPlayer (type, index)
| 根据索引获取指定类型的媒体播放器对象。 更多...
| GetMediaPlayerCount (type)
| 获取指定类型的媒体播放器对象数量。 更多...
| GetMonitorSpecifier ()
| 获取监视器指定器类型值。 更多...
| GetPermission ()
| 获取媒体权限。 更多...
| GetRenditionName ()
| 获取名称。 更多...
| GetRepeatCount ()
| 获取重复计数，类似于 SMIL 的 repeatCount 属性。 更多...
| GetVolume ()
| 获取音量,将所需音量级别指定为录制音量级别的百分比。 更多...
| GetWindowType ()
| 获取媒体应在其中播放的窗口类型。 更多...
| HasFloatingWindowCloseButton ()
| 检查浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。 更多...
| HasFloatingWindowTitleBar ()
| 检查浮动窗口是否应具有标题栏。 更多...
| HasMediaClip ()
| 检查当前演绎对象是否包含媒体剪辑。 更多...
| IsAutoPlay ()
| 检查媒体是否应在激活时自动播放。 更多...
| IsControlBarVisible ()
| 检查播放时是否显示播放器特定的控制器用户界面 (例如,播放/暂停/停止控制)。 更多...
| IsEmpty ()
| 检查当前对象是否为空。 更多...
| RemoveMediaPlayer (type, player)
| 删除指定类型的媒体播放器对象。 更多...
| SetBackgroundColor (color, opt_type)
| 设置正在播放媒体的矩形的背景颜色。 更多...
| SetBackgroundOpacity (opacity, opt_type)
| 设置背景不透明度。（全屏和隐藏窗口忽略） 更多...
| SetDuration (duration, opt_type)
| 设置固有持续时间。 更多...
| SetFitStyle (fit_style, opt_type)
| 设置适应样式。 更多...
| SetFloatingWindowOffscreenEvent (offscreen_event, opt_type)
| 设置事件类型，指定如果浮动窗口 完全或部分离屏（即，在任何物理监视器上都不可见）时应发生什么。 更多...
| SetFloatingWindowPosition (position, opt_type)
| 设置浮动窗口应定位到相关窗口的位置。 更多...
| SetFloatingWindowRelatedWindowType (window_type, opt_type)
| 设置窗口相对类型。 更多...
| SetFloatingWindowResizeType (resize_type, opt_type)
| 设置调整大小类型，指定用户是否可以调整浮动窗口的大小。 更多...
| SetFloatingWindowSize (width, height, opt_type)
| 设置浮动窗口的大小，以像素为单位。 更多...
| SetFloatingWindowTitles (titles, opt_type)
| 设置多语言文本数组，该数组提供要在浮动窗口标题栏上显示的文本。 更多...
| SetMediaBaseURL (base_url, opt_type)
| 设置基础URL。 更多...
| SetMediaClipContentType (content_type)
| 设置媒体数据的内容类型(MIME类型)。 更多...
| SetMediaClipFile (file_specification)
| 设置实际媒体数据的文件规范。 更多...
| SetMediaClipName (name)
| 设置媒体剪辑的名称,用于用户界面。 更多...
| SetMediaDescriptions (description_array)
| 设置多语言文本数组,该数组为媒体剪辑数据提供备用文本描述, 以防无法播放。 更多...
| SetMonitorSpecifier (monitor_specifier, opt_type)
| 设置监视器指定器类型值。 更多...
| SetPermission (permission)
| 设置媒体权限。 更多...
| SetRenditionName (name)
| 设置名称。 更多...
| SetRepeatCount (count, opt_type)
| 设置重复计数，类似于 SMIL 的 repeatCount 属性。 更多...
| SetVolume (volume, opt_type)
| 设置音量,将所需音量级别指定为录制音量级别的百分比。 更多...
| SetWindowType (window_type, opt_type)
| 设置媒体应在其中播放的窗口类型。 更多...

## 静态 Public 属性
static | e_FloatingWindowOffscreenEventMoveResize
| 移动或调整大小
static | e_FloatingWindowOffscreenEventNone
| 浮动窗口的离屏事件类型枚举。 更多...
static | e_FloatingWindowOffscreenEventNonViable
| 认为对象不可行
static | e_FloatingWindowRelatedWindowApplication
| 应用程序窗口
static | e_FloatingWindowRelatedWindowDocument
| 浮动窗口的相关窗口类型枚举。 更多...
static | e_FloatingWindowRelatedWindowFullDesktop
| 完整虚拟桌面
static | e_FloatingWindowRelatedWindowMonitor
| 取决于监视器指定器。
static | e_FloatingWindowResizeTypeAnyway
| 可以在不保持纵横比的情况下调整大小
static | e_FloatingWindowResizeTypeAspectRatio
| 仅在保持纵横比时才可调整大小
static | e_FloatingWindowResizeTypeNo
| 浮动窗口的调整大小类型枚举。 更多...
static | e_MediaOptionBestEffort
| 此类型中定义的选项只需在"尽力而为"的意义上被遵守。
static | e_MediaOptionMustBeHonored
| 媒体选项类型枚举。 更多...
static | e_MediaPermTempAccess
| 仅当文档权限允许内容提取（包括用于辅助功能目的）时才允许。
static | e_MediaPermTempAlways
| 始终允许。
static | e_MediaPermTempExtract
| 仅当文档权限允许内容提取时才允许。
static | e_MediaPermTempNever
| PDF 媒体播放器权限枚举。 更多...
static | e_MediaPlayerAvailable
| 此类型中的任何播放器都可以用于播放相关的媒体剪辑。
static | e_MediaPlayerFitStyleDefault
| 使用播放器的默认设置（作者没有偏好）。
static | e_MediaPlayerFitStyleFill
| 媒体的宽度和高度独立缩放，以便媒体和播放矩形相同； 纵横比不一定保留。与 SMIL 的 fit 属性的 "fill" 值相同。
static | e_MediaPlayerFitStyleHidden
| 媒体不缩放。仅显示与播放矩形相交的 媒体矩形部分。与 SMIL 的 fit 属性的 "hidden" 值相同。
static | e_MediaPlayerFitStyleMeet
| 适应样式枚举。 更多...
static | e_MediaPlayerFitStyleScroll
| 媒体不缩放。如果媒体矩形比播放矩形更宽或更高， 则提供滚动用户界面。与 SMIL 的 fit 属性的 "scroll" 值相同。
static | e_MediaPlayerFitStyleSlice
| 在保持纵横比的同时缩放媒体的宽度和高度，以便 播放矩形完全填充，并且不适合 播放矩形内的媒体内容量最小化。与 SMIL 的 fit 属性的 "slice" 值相同。
static | e_MediaPlayerMustUsed
| PDF 媒体播放器分类类型枚举。 更多...
static | e_MediaPlayerNotUsed
| 此类型中的播放器不得用于播放相关的媒体剪辑。
static | e_MonitorSpecifierGreatestArea
| 具有最大面积的监视器（以像素平方计）
static | e_MonitorSpecifierGreatestColorDepth
| 具有最大色深的监视器
static | e_MonitorSpecifierGreatestHeight
| 具有最大高度的监视器（以像素计）
static | e_MonitorSpecifierGreatestWidth
| 具有最大宽度的监视器（以像素计）
static | e_MonitorSpecifierLargest
| 监视器指定器类型枚举。 更多...
static | e_MonitorSpecifierPrimary
| 主监视器。如果没有监视器被视为主监视器，则使用情况 0
static | e_MonitorSpecifierSmallest
| 包含文档窗口最小部分的监视器
static | e_WindowTypeAnnotRect
| 窗口类型：与演绎对象关联的 屏幕注释占据的矩形。
static | e_WindowTypeFloating
| 媒体应在其中播放的窗口类型枚举。 更多...
static | e_WindowTypeFullScreen
| 窗口类型：遮蔽所有其他窗口的全屏窗口
static | e_WindowTypeHidden
| 窗口类型：隐藏窗口

## 详细描述

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

## 成员函数说明

## ◆ AddMediaPlayer()

FSDK::Rendition::AddMediaPlayer | ( | type | ,
|  | player |
| ) |  |

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

通常,媒体播放器对象应该只添加到具有指定媒体播放器类型的演绎对象。 不建议用户将同一媒体播放器对象添加到不同的演绎或 一个演绎的不同媒体播放器类型;否则后续可能会出现意外问题(如崩溃)。 如果用户不想构造另一个媒体播放器并设置相同的值,用户可以克隆 原始媒体播放器对象的字典,并使用克隆的字典直接构造另一个媒体播放器。

参数

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

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

## ◆ constructor()

FSDK::Rendition::constructor | ( | pdf_doc | ,
|  | rendition_dict |
| ) |  |

构造函数,带参数。

参数

  [in] | pdf_doc | 一个有效的PDF文档对象。
  [in] | rendition_dict | 参数pdf_doc表示的PDF文档中演绎对象的PDF字典。如果为null则表示 在参数pdf_obj表示的PDF文档中构造一个新的演绎对象。 默认值:null。

## ◆ EnableAutoPlay()

FSDK::Rendition::EnableAutoPlay | ( | is_auto_play | ,
|  | opt_type |
| ) |  |

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

参数

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

返回
  无。

## ◆ EnableControlBarVisible()

FSDK::Rendition::EnableControlBarVisible | ( | is_visible | ,
|  | opt_type |
| ) |  |

设置控制栏可见性标志。

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

参数

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

返回
  无。

## ◆ EnableFloatingWindowCloseButton()

FSDK::Rendition::EnableFloatingWindowCloseButton | ( | is_visible | ,
|  | opt_type |
| ) |  |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。

参数

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

返回
  无。

## ◆ EnableFloatingWindowTitleBar()

FSDK::Rendition::EnableFloatingWindowTitleBar | ( | is_visible | ,
|  | opt_type |
| ) |  |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。

参数

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

返回
  无。

## ◆ GetBackgroundColor()

FSDK::Rendition::GetBackgroundColor | ( |  | ) |

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

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

## ◆ GetBackgroundOpacity()

FSDK::Rendition::GetBackgroundOpacity | ( |  | ) |

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

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

## ◆ GetDict()

FSDK::Rendition::GetDict | ( |  | ) |

获取当前对象的PDF字典。

返回
  PDF字典。如果出现任何错误,此函数将返回null。

## ◆ GetDuration()

FSDK::Rendition::GetDuration | ( |  | ) |

获取固有持续时间。

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

## ◆ GetFitStyle()

FSDK::Rendition::GetFitStyle | ( |  | ) |

获取适应样式。

适应样式(方式)指定播放器应如何处理不完全适合其播放矩形的可视媒体类型。

返回
  适应样式值。请参考从FSDK.Rendition.e_MediaPlayerFitStyleMeet开始的值, 这将是这些值之一。如果演绎对象中未定义此类属性的值, 默认将返回FSDK.Rendition.e_MediaPlayerFitStyleDefault。

## ◆ GetFloatingWindowHeight()

FSDK::Rendition::GetFloatingWindowHeight | ( |  | ) |

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

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

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

## ◆ GetFloatingWindowOffscreenEvent()

FSDK::Rendition::GetFloatingWindowOffscreenEvent | ( |  | ) |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。

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

## ◆ GetFloatingWindowPosition()

FSDK::Rendition::GetFloatingWindowPosition | ( |  | ) |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。
窗口相对位置指定浮动窗口应定位到的位置。

返回
  位置值。请参考从 FSDK.e_PosTopLeft 开始的值， 这将是这些值之一。如果演绎对象中未定义此类属性的值， 默认将返回 FSDK.e_PosCenter。

## ◆ GetFloatingWindowRelatedWindowType()

FSDK::Rendition::GetFloatingWindowRelatedWindowType | ( |  | ) |

获取窗口相对类型。

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。
相关窗口类型指定浮动窗口应定位到的位置。

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

## ◆ GetFloatingWindowResizeType()

FSDK::Rendition::GetFloatingWindowResizeType | ( |  | ) |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。

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

## ◆ GetFloatingWindowTitles()

FSDK::Rendition::GetFloatingWindowTitles | ( |  | ) |

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

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

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

## ◆ GetFloatingWindowWidth()

FSDK::Rendition::GetFloatingWindowWidth | ( |  | ) |

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

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

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

## ◆ GetMediaBaseURL()

FSDK::Rendition::GetMediaBaseURL | ( |  | ) |

获取基础URL。

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

返回
  基础URL。

## ◆ GetMediaClipContentType()

FSDK::Rendition::GetMediaClipContentType | ( |  | ) |

获取媒体数据的内容类型(MIME类型)。

内容类型指定由文件规范表示的媒体数据的类型。 内容类型字符串应符合Internet RFC 2045中描述的内容类型规范, 多用途互联网邮件扩展(MIME)第一部分:互联网消息正文格式。

返回
  内容类型(MIME类型)。

## ◆ GetMediaClipFile()

FSDK::Rendition::GetMediaClipFile | ( |  | ) |

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

返回
  文件规范对象。

## ◆ GetMediaClipName()

FSDK::Rendition::GetMediaClipName | ( |  | ) |

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

返回
  媒体剪辑的名称。

## ◆ GetMediaDescriptions()

FSDK::Rendition::GetMediaDescriptions | ( |  | ) |

获取多语言文本数组,该数组为媒体剪辑数据提供备用文本描述, 以防无法播放。

多语言文本数组中的字符串成对出现:每对中的第一个字符串(ASCII字符串) 是语言标识符,第二个字符串是描述。

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

## ◆ GetMediaPlayer()

FSDK::Rendition::GetMediaPlayer | ( | type | ,
|  | index |
| ) |  |

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

参数

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

返回
  媒体播放器对象。

## ◆ GetMediaPlayerCount()

FSDK::Rendition::GetMediaPlayerCount | ( | type |  | ) |

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

参数

  [in] | type | 媒体播放器类型。请参考从FSDK.Rendition.e_MediaPlayerMustUsed开始的值, 这应该是这些值之一。

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

## ◆ GetMonitorSpecifier()

FSDK::Rendition::GetMonitorSpecifier | ( |  | ) |

获取监视器指定器类型值。

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

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

## ◆ GetPermission()

FSDK::Rendition::GetPermission | ( |  | ) |

获取媒体权限。

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

返回
  媒体权限值。请参考从FSDK.Rendition.e_MediaPermTempNever开始的值, 这将是这些值之一。

## ◆ GetRenditionName()

FSDK::Rendition::GetRenditionName | ( |  | ) |

获取名称。

此名称可用于JavaSript操作的名称树查找,也可用于用户界面。

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

## ◆ GetRepeatCount()

FSDK::Rendition::GetRepeatCount | ( |  | ) |

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

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

## ◆ GetVolume()

FSDK::Rendition::GetVolume | ( |  | ) |

获取音量,将所需音量级别指定为录制音量级别的百分比。

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

## ◆ GetWindowType()

FSDK::Rendition::GetWindowType | ( |  | ) |

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

返回
  窗口类型值。请参考从 FSDK.Rendition.e_WindowTypeFloating 开始的值，这将是这些值之一。如果演绎对象中未定义此类属性的值， 默认将返回 FSDK.Rendition.e_WindowTypeAnnotRect。

## ◆ HasFloatingWindowCloseButton()

FSDK::Rendition::HasFloatingWindowCloseButton | ( |  | ) |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。

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

## ◆ HasFloatingWindowTitleBar()

FSDK::Rendition::HasFloatingWindowTitleBar | ( |  | ) |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。

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

## ◆ HasMediaClip()

FSDK::Rendition::HasMediaClip | ( |  | ) |

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

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

## ◆ IsAutoPlay()

FSDK::Rendition::IsAutoPlay | ( |  | ) |

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

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

## ◆ IsControlBarVisible()

FSDK::Rendition::IsControlBarVisible | ( |  | ) |

检查播放时是否显示播放器特定的控制器用户界面 (例如,播放/暂停/停止控制)。

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

## ◆ IsEmpty()

FSDK::Rendition::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

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

## ◆ RemoveMediaPlayer()

FSDK::Rendition::RemoveMediaPlayer | ( | type | ,
|  | player |
| ) |  |

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

参数

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

返回
  无。

## ◆ SetBackgroundColor()

FSDK::Rendition::SetBackgroundColor | ( | color | ,
|  | opt_type |
| ) |  |

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

参数

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

返回
  无。

## ◆ SetBackgroundOpacity()

FSDK::Rendition::SetBackgroundOpacity | ( | opacity | ,
|  | opt_type |
| ) |  |

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

参数

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

返回
  无。

## ◆ SetDuration()

FSDK::Rendition::SetDuration | ( | duration | ,
|  | opt_type |
| ) |  |

设置固有持续时间。

参数

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

返回
  无。

## ◆ SetFitStyle()

FSDK::Rendition::SetFitStyle | ( | fit_style | ,
|  | opt_type |
| ) |  |

设置适应样式。

适应样式(方式)指定播放器应如何处理不完全适合其播放矩形的可视媒体类型。

参数

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

返回
  无。

## ◆ SetFloatingWindowOffscreenEvent()

FSDK::Rendition::SetFloatingWindowOffscreenEvent | ( | offscreen_event | ,
|  | opt_type |
| ) |  |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。

参数

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

返回
  无。

## ◆ SetFloatingWindowPosition()

FSDK::Rendition::SetFloatingWindowPosition | ( | position | ,
|  | opt_type |
| ) |  |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。
窗口相对位置指定浮动窗口应定位到的位置。

参数

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

返回
  无。

## ◆ SetFloatingWindowRelatedWindowType()

FSDK::Rendition::SetFloatingWindowRelatedWindowType | ( | window_type | ,
|  | opt_type |
| ) |  |

设置窗口相对类型。

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。
相关窗口类型指定浮动窗口应定位到的位置。

参数

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

返回
  无。

## ◆ SetFloatingWindowResizeType()

FSDK::Rendition::SetFloatingWindowResizeType | ( | resize_type | ,
|  | opt_type |
| ) |  |

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

仅当窗口类型为 FSDK.Rendition.e_WindowTypeFloating 时，此属性才有用。

参数

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

返回
  无。

## ◆ SetFloatingWindowSize()

FSDK::Rendition::SetFloatingWindowSize | ( | width | ,
|  | height | ,
|  | opt_type |
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetFloatingWindowTitles()

FSDK::Rendition::SetFloatingWindowTitles | ( | titles | ,
|  | opt_type |
| ) |  |

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

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

参数

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

返回
  无。

## ◆ SetMediaBaseURL()

FSDK::Rendition::SetMediaBaseURL | ( | base_url | ,
|  | opt_type |
| ) |  |

设置基础URL。

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

参数

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

返回
  无。

## ◆ SetMediaClipContentType()

FSDK::Rendition::SetMediaClipContentType | ( | content_type |  | ) |

设置媒体数据的内容类型(MIME类型)。

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

参数

  [in] | content_type | 内容类型(MIME类型)。

返回
  无。

## ◆ SetMediaClipFile()

FSDK::Rendition::SetMediaClipFile | ( | file_specification |  | ) |

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

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

参数

  [in] | file_specification | 文件规范对象。

返回
  无。

## ◆ SetMediaClipName()

FSDK::Rendition::SetMediaClipName | ( | name |  | ) |

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

参数

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

返回
  无。

## ◆ SetMediaDescriptions()

FSDK::Rendition::SetMediaDescriptions | ( | description_array |  | ) |

设置多语言文本数组,该数组为媒体剪辑数据提供备用文本描述, 以防无法播放。

多语言文本数组中的字符串成对出现:每对中的第一个字符串(ASCII字符串) 是语言标识符,第二个字符串是描述。

参数

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

返回
  无。

## ◆ SetMonitorSpecifier()

FSDK::Rendition::SetMonitorSpecifier | ( | monitor_specifier | ,
|  | opt_type |
| ) |  |

设置监视器指定器类型值。

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

参数

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

返回
  无。

## ◆ SetPermission()

FSDK::Rendition::SetPermission | ( | permission |  | ) |

设置媒体权限。

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

参数

  [in] | permission | 媒体权限值。请参考从 FSDK.Rendition.e_MediaPermTempNever开始的值,这应该是这些值之一。

返回
  无。

## ◆ SetRenditionName()

FSDK::Rendition::SetRenditionName | ( | name |  | ) |

设置名称。

此名称可用于JavaSript操作的名称树查找,也可用于用户界面。

参数

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

返回
  无。

## ◆ SetRepeatCount()

FSDK::Rendition::SetRepeatCount | ( | count | ,
|  | opt_type |
| ) |  |

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

参数

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

返回
  无。

## ◆ SetVolume()

FSDK::Rendition::SetVolume | ( | volume | ,
|  | opt_type |
| ) |  |

设置音量,将所需音量级别指定为录制音量级别的百分比。

参数

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

返回
  无。

## ◆ SetWindowType()

FSDK::Rendition::SetWindowType | ( | window_type | ,
|  | opt_type |
| ) |  |

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

参数

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

返回
  无。

## 类成员变量说明

## ◆ e_FloatingWindowOffscreenEventNone

FSDK::Rendition::e_FloatingWindowOffscreenEventNone
| static

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

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

无操作

## ◆ e_FloatingWindowRelatedWindowDocument

FSDK::Rendition::e_FloatingWindowRelatedWindowDocument
| static

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

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

文档窗口

## ◆ e_FloatingWindowResizeTypeNo

FSDK::Rendition::e_FloatingWindowResizeTypeNo
| static

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

此枚举的值应单独使用。

不可调整大小

## ◆ e_MediaOptionMustBeHonored

FSDK::Rendition::e_MediaOptionMustBeHonored
| static

媒体选项类型枚举。

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

此类型中定义的选项必须被遵守，演绎对象才能被视为可行。

## ◆ e_MediaPermTempNever

FSDK::Rendition::e_MediaPermTempNever
| static

PDF 媒体播放器权限枚举。

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

从不允许。

## ◆ e_MediaPlayerFitStyleMeet

FSDK::Rendition::e_MediaPlayerFitStyleMeet
| static

适应样式枚举。

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

在保持纵横比的同时缩放媒体的宽度和高度，以便 媒体和播放矩形具有最大可能的交集，同时仍然 显示所有媒体内容。与 SMIL 的 fit 属性的 "meet" 值相同。

## ◆ e_MediaPlayerMustUsed

FSDK::Rendition::e_MediaPlayerMustUsed
| static

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

此枚举的值应单独使用。

此类型中的播放器之一必须用于播放相关的媒体剪辑。

## ◆ e_MonitorSpecifierLargest

FSDK::Rendition::e_MonitorSpecifierLargest
| static

监视器指定器类型枚举。

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

包含文档窗口最大部分的监视器

## ◆ e_WindowTypeFloating

FSDK::Rendition::e_WindowTypeFloating
| static

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

此枚举的值应单独使用。

窗口类型：浮动窗口