Foxit PDF SDK

构造函数 | 属性 | 所有成员列表
FSRendition类 参考
类 FSRendition 继承关系图:

## 构造函数
(int) | - addMediaPlayer:player:
| 为指定类型添加媒体播放器对象。 更多...
(void) | - enableAutoPlay:opt_type:
| 设置标志以决定媒体激活时是否应自动播放。 更多...
(void) | - enableControlBarVisible:opt_type:
| 设置控制栏可见性标志。 更多...
(void) | - enableFloatingWindowCloseButton:opt_type:
| 设置标志以指定浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。 更多...
(void) | - enableFloatingWindowTitleBar:opt_type:
| 设置标志以指定浮动窗口是否应有标题栏。 更多...
(unsigned int) | - getBackgroundColor
| 获取媒体正在播放的矩形的背景颜色。 更多...
(float) | - getBackgroundOpacity
| 获取背景不透明度。（对于全屏和隐藏窗口将被忽略） 更多...
(FSPDFDictionary *) | - getDict
| 获取当前对象的PDF字典。 更多...
(int) | - getDuration
| 获取内在持续时间。 更多...
(FSRenditionMediaPlayerFitStyle) | - getFitStyle
| 获取适配样式。 更多...
(int) | - getFloatingWindowHeight
| 获取浮动窗口的高度，以像素为单位。 更多...
(FSRenditionFloatingWindowOffscreenEvent) | - getFloatingWindowOffscreenEvent
| 获取事件类型，指定如果浮动窗口完全或部分位于屏幕外 （即在任何物理监视器上都不可见）时应发生什么。 更多...
(FSPosition) | - getFloatingWindowPosition
| 获取浮动窗口应相对于相关窗口定位的位置。 更多...
(FSRenditionFloatingWindowRelatedWindowType) | - getFloatingWindowRelatedWindowType
| 获取窗口相对类型。 更多...
(FSRenditionFloatingWindowResizeType) | - getFloatingWindowResizeType
| 获取调整大小类型，指定浮动窗口是否可以由用户调整大小。 更多...
(NSArray< NSString * > *) | - getFloatingWindowTitles
| 获取多语言文本数组，提供要在浮动窗口标题栏上显示的文本。 更多...
(int) | - getFloatingWindowWidth
| 获取浮动窗口的宽度，以像素为单位。 更多...
(NSString *) | - getMediaBaseURL
| 获取基础URL。 更多...
(FSMediaPlayer *) | - getMediaPlayer:index:
| 根据索引获取指定类型的媒体播放器对象。 更多...
(int) | - getMediaPlayerCount:
| 获取指定类型的媒体播放器对象数量。 更多...
(FSRenditionMonitorSpecifier) | - getMonitorSpecifier
| 获取监视器指定类型值。 更多...
(int) | - getRepeatCount
| 获取重复计数，类似于SMIL的repeatCount属性。 更多...
(int) | - getVolume
| 获取音量，以录制音量级别的百分比指定所需的音量级别。 更多...
(FSRenditionWindowType) | - getWindowType
| 获取媒体应播放的窗口类型。 更多...
(BOOL) | - hasFloatingWindowCloseButton
| 检查浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。 更多...
(BOOL) | - hasFloatingWindowTitleBar
| 检查浮动窗口是否应有标题栏。 更多...
(BOOL) | - hasMediaClip
| 检查当前演示对象是否包含媒体剪辑。 更多...
(id) | - initWithOther:
| 使用另一个演示对象的构造函数。 更多...
(id) | - initWithPdf_doc:rendition_dict:
| 带参数的构造函数。 更多...
(BOOL) | - isAutoPlay
| 检查媒体激活时是否应自动播放。 更多...
(BOOL) | - isControlBarVisible
| 检查播放时是否显示播放器特定的控制器用户界面 （例如，播放/暂停/停止控件）。 更多...
(BOOL) | - isEmpty
| 检查当前对象是否为空。 更多...
(void) | - removeMediaPlayer:player:
| 删除指定类型的媒体播放器对象。 更多...
(void) | - setBackgroundColor:opt_type:
| 设置媒体正在播放的矩形的背景颜色。 更多...
(void) | - setBackgroundOpacity:opt_type:
| 设置背景不透明度。（对于全屏和隐藏窗口将被忽略） 更多...
(void) | - setDuration:opt_type:
| 设置内在持续时间。 更多...
(void) | - setFitStyle:opt_type:
| 设置适配样式。 更多...
(void) | - setFloatingWindowOffscreenEvent:opt_type:
| 设置事件类型，指定如果浮动窗口完全或部分位于屏幕外 （即在任何物理监视器上都不可见）时应发生什么。 更多...
(void) | - setFloatingWindowPosition:opt_type:
| 设置浮动窗口应相对于相关窗口定位的位置。 更多...
(void) | - setFloatingWindowRelatedWindowType:opt_type:
| 设置窗口相对类型。 更多...
(void) | - setFloatingWindowResizeType:opt_type:
| 设置调整大小类型，指定浮动窗口是否可以由用户调整大小。 更多...
(void) | - setFloatingWindowSize:height:opt_type:
| 设置浮动窗口的大小，以像素为单位。 更多...
(void) | - setFloatingWindowTitles:opt_type:
| 设置多语言文本数组，提供要在浮动窗口标题栏上显示的文本。 更多...
(void) | - setMediaBaseURL:opt_type:
| 设置基础URL。 更多...
(void) | - setMonitorSpecifier:opt_type:
| 设置监视器指定类型值。 更多...
(void) | - setRepeatCount:opt_type:
| 设置重复计数，类似于SMIL的repeatCount属性。 更多...
(void) | - setVolume:opt_type:
| 设置音量，以录制音量级别的百分比指定所需的音量级别。 更多...
(void) | - setWindowType:opt_type:
| 设置媒体应播放的窗口类型。 更多...

## 属性
NSString * | mediaClipContentType
| 获取媒体数据的内容类型（MIME类型）。 更多...
FSFileSpec * | mediaClipFile
| 获取实际媒体数据的文件规范。
NSString * | mediaClipName
| 获取媒体剪辑的名称，用于用户界面。
NSArray< NSString * > * | mediaDescriptions
| 获取多语言文本数组，在无法播放媒体剪辑数据时 提供替代文本描述。 更多...
FSRenditionMediaPermission | permission
| 获取媒体权限。 更多...
NSString * | renditionName
| 获取名称。 更多...

## 详细描述

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

## 函数文档

## ◆ addMediaPlayer:player:()

- (int) addMediaPlayer: |  | (FSRenditionMediaPlayerType) | type
player: |  | (FSMediaPlayer*) | player

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

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

参数

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

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

## ◆ enableAutoPlay:opt_type:()

- (void) enableAutoPlay: |  | (BOOL) | is_auto_play
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

参数

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

返回
  无。

## ◆ enableControlBarVisible:opt_type:()

- (void) enableControlBarVisible: |  | (BOOL) | is_visible
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

设置控制栏可见性标志。

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

参数

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

返回
  无。

## ◆ enableFloatingWindowCloseButton:opt_type:()

- (void) enableFloatingWindowCloseButton: |  | (BOOL) | is_visible
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

此属性仅在窗口类型为 FSRenditionWindowTypeFloating 时有用。

参数

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

返回
  无。

## ◆ enableFloatingWindowTitleBar:opt_type:()

- (void) enableFloatingWindowTitleBar: |  | (BOOL) | is_visible
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

此属性仅在窗口类型为 FSRenditionWindowTypeFloating 时有用。

参数

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

返回
  无。

## ◆ getBackgroundColor()

- (unsigned int) getBackgroundColor |  |  |

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

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

## ◆ getBackgroundOpacity()

- (float) getBackgroundOpacity |  |  |

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

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

## ◆ getDict()

- (FSPDFDictionary *) getDict |  |  |

获取当前对象的PDF字典。

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

## ◆ getDuration()

- (int) getDuration |  |  |

获取内在持续时间。

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

## ◆ getFitStyle()

- (FSRenditionMediaPlayerFitStyle) getFitStyle |  |  |

获取适配样式。

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

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

## ◆ getFloatingWindowHeight()

- (int) getFloatingWindowHeight |  |  |

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

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

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

## ◆ getFloatingWindowOffscreenEvent()

- (FSRenditionFloatingWindowOffscreenEvent) getFloatingWindowOffscreenEvent |  |  |

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

此属性仅在窗口类型为 FSRenditionWindowTypeFloating 时有用。

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

## ◆ getFloatingWindowPosition()

- (FSPosition) getFloatingWindowPosition |  |  |

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

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

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

## ◆ getFloatingWindowRelatedWindowType()

- (FSRenditionFloatingWindowRelatedWindowType) getFloatingWindowRelatedWindowType |  |  |

获取窗口相对类型。

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

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

## ◆ getFloatingWindowResizeType()

- (FSRenditionFloatingWindowResizeType) getFloatingWindowResizeType |  |  |

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

此属性仅在窗口类型为 FSRenditionWindowTypeFloating 时有用。

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

## ◆ getFloatingWindowTitles()

- (NSArray< NSString * > *) getFloatingWindowTitles |  |  |

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

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

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

## ◆ getFloatingWindowWidth()

- (int) getFloatingWindowWidth |  |  |

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

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

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

## ◆ getMediaBaseURL()

- (NSString *) getMediaBaseURL |  |  |

获取基础URL。

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

返回
  基础URL。

## ◆ getMediaPlayer:index:()

- (FSMediaPlayer *) getMediaPlayer: |  | (FSRenditionMediaPlayerType) | type
index: |  | (int) | index

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

参数

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

返回
  媒体播放器对象。

## ◆ getMediaPlayerCount:()

- (int) getMediaPlayerCount: |  | (FSRenditionMediaPlayerType) | type |

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

参数

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

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

## ◆ getMonitorSpecifier()

- (FSRenditionMonitorSpecifier) getMonitorSpecifier |  |  |

获取监视器指定类型值。

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

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

## ◆ getRepeatCount()

- (int) getRepeatCount |  |  |

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

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

## ◆ getVolume()

- (int) getVolume |  |  |

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

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

## ◆ getWindowType()

- (FSRenditionWindowType) getWindowType |  |  |

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

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

## ◆ hasFloatingWindowCloseButton()

- (BOOL) hasFloatingWindowCloseButton |  |  |

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

此属性仅在窗口类型为 FSRenditionWindowTypeFloating 时有用。

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

## ◆ hasFloatingWindowTitleBar()

- (BOOL) hasFloatingWindowTitleBar |  |  |

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

此属性仅在窗口类型为 FSRenditionWindowTypeFloating 时有用。

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

## ◆ hasMediaClip()

- (BOOL) hasMediaClip |  |  |

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

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

## ◆ initWithOther:()

- (id) initWithOther: |  | (FSRendition*) | other |

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

参数

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

## ◆ initWithPdf_doc:rendition_dict:()

- (id) initWithPdf_doc: |  | (FSPDFDoc*) | pdf_doc
rendition_dict: |  | (FSPDFDictionary*) | rendition_dict

带参数的构造函数。

参数

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

## ◆ isAutoPlay()

- (BOOL) isAutoPlay |  |  |

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

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

## ◆ isControlBarVisible()

- (BOOL) isControlBarVisible |  |  |

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

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

## ◆ isEmpty()

- (BOOL) isEmpty |  |  |

检查当前对象是否为空。

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

返回
  YES 表示当前对象为空，NO 表示不为空。

## ◆ removeMediaPlayer:player:()

- (void) removeMediaPlayer: |  | (FSRenditionMediaPlayerType) | type
player: |  | (FSMediaPlayer*) | player

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

参数

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

返回
  无。

## ◆ setBackgroundColor:opt_type:()

- (void) setBackgroundColor: |  | (unsigned int) | color
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

参数

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

返回
  无。

## ◆ setBackgroundOpacity:opt_type:()

- (void) setBackgroundOpacity: |  | (float) | opacity
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

参数

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

返回
  无。

## ◆ setDuration:opt_type:()

- (void) setDuration: |  | (int) | duration
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

设置内在持续时间。

参数

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

返回
  无。

## ◆ setFitStyle:opt_type:()

- (void) setFitStyle: |  | (FSRenditionMediaPlayerFitStyle) | fit_style
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

设置适配样式。

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

参数

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

返回
  无。

## ◆ setFloatingWindowOffscreenEvent:opt_type:()

- (void) setFloatingWindowOffscreenEvent: |  | (FSRenditionFloatingWindowOffscreenEvent) | offscreen_event
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

此属性仅在窗口类型为 FSRenditionWindowTypeFloating 时有用。

参数

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

返回
  无。

## ◆ setFloatingWindowPosition:opt_type:()

- (void) setFloatingWindowPosition: |  | (FSPosition) | position
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

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

参数

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

返回
  无。

## ◆ setFloatingWindowRelatedWindowType:opt_type:()

- (void) setFloatingWindowRelatedWindowType: |  | (FSRenditionFloatingWindowRelatedWindowType) | window_type
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

设置窗口相对类型。

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

参数

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

返回
  无。

## ◆ setFloatingWindowResizeType:opt_type:()

- (void) setFloatingWindowResizeType: |  | (FSRenditionFloatingWindowResizeType) | resize_type
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

此属性仅在窗口类型为 FSRenditionWindowTypeFloating 时有用。

参数

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

返回
  无。

## ◆ setFloatingWindowSize:height:opt_type:()

- (void) setFloatingWindowSize: |  | (int) | width
height: |  | (int) | height
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

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

参数

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

返回
  无。

## ◆ setFloatingWindowTitles:opt_type:()

- (void) setFloatingWindowTitles: |  | (NSArray<NSString *> *) | titles
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

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

参数

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

返回
  无。

## ◆ setMediaBaseURL:opt_type:()

- (void) setMediaBaseURL: |  | (NSString *) | base_url
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

设置基础URL。

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

参数

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

返回
  无。

## ◆ setMonitorSpecifier:opt_type:()

- (void) setMonitorSpecifier: |  | (FSRenditionMonitorSpecifier) | monitor_specifier
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

设置监视器指定类型值。

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

参数

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

返回
  无。

## ◆ setRepeatCount:opt_type:()

- (void) setRepeatCount: |  | (int) | count
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

参数

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

返回
  无。

## ◆ setVolume:opt_type:()

- (void) setVolume: |  | (int) | volume
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

参数

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

返回
  无。

## ◆ setWindowType:opt_type:()

- (void) setWindowType: |  | (FSRenditionWindowType) | window_type
opt_type: |  | (FSRenditionMediaOptionType) | opt_type

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

参数

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

返回
  无。

## 属性说明

## ◆ mediaClipContentType

- (NSString *) mediaClipContentType
| read write nonatomic weak

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

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

## ◆ mediaDescriptions

- (NSArray< NSString * > *) mediaDescriptions
| read write nonatomic weak

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

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

## ◆ permission

- (FSRenditionMediaPermission) permission
| read write nonatomic assign

获取媒体权限。

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

## ◆ renditionName

- (NSString *) renditionName
| read write nonatomic weak

获取名称。

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