Foxit PDF SDK

fs_rendition.h
浏览该文件的文档.
1
14 #ifndef FS_RENDITION_H_
15 #define FS_RENDITION_H_
16
17 #include "common/fs_common.h"
18 #include "pdf/objects/fs_pdfobject.h"
19
25 namespace foxit {
29 namespace pdf {
30 // forward declaration
31 class FileSpec;
32 class MediaPlayer;
33
38 class Rendition FS_FINAL : public Base {
39 public:
46 typedef enum _MediaOptionType {
48 e_MediaOptionMustBeHonored = 0,
50 e_MediaOptionBestEffort = 1
51 } MediaOptionType;
52
60 typedef enum _MediaPermission {
62 e_MediaPermTempNever = 0,
64 e_MediaPermTempExtract = 1,
66 e_MediaPermTempAccess = 2,
68 e_MediaPermTempAlways = 3
69 } MediaPermission;
70
76 typedef enum _MediaPlayerType {
78 e_MediaPlayerMustUsed = 0,
80 e_MediaPlayerAvailable = 1,
82 e_MediaPlayerNotUsed = 2
83 } MediaPlayerType;
84
92 typedef enum _MediaPlayerFitStyle {
98 e_MediaPlayerFitStyleMeet = 0,
104 e_MediaPlayerFitStyleSlice = 1,
109 e_MediaPlayerFitStyleFill = 2,
114 e_MediaPlayerFitStyleScroll = 3,
119 e_MediaPlayerFitStyleHidden = 4,
121 e_MediaPlayerFitStyleDefault = 5
122 } MediaPlayerFitStyle;
123
129 typedef enum _WindowType {
131 e_WindowTypeFloating = 0,
133 e_WindowTypeFullScreen = 1,
135 e_WindowTypeHidden = 2,
139 e_WindowTypeAnnotRect = 3
140 } WindowType;
141
149 typedef enum _MonitorSpecifier {
151 e_MonitorSpecifierLargest = 0,
153 e_MonitorSpecifierSmallest = 1,
155 e_MonitorSpecifierPrimary = 2,
157 e_MonitorSpecifierGreatestColorDepth = 3,
159 e_MonitorSpecifierGreatestArea = 4,
161 e_MonitorSpecifierGreatestHeight = 5,
163 e_MonitorSpecifierGreatestWidth = 6
164 } MonitorSpecifier;
165
172 typedef enum _FloatingWindowRelatedWindowType {
174 e_FloatingWindowRelatedWindowDocument = 0,
176 e_FloatingWindowRelatedWindowApplication = 1,
178 e_FloatingWindowRelatedWindowFullDesktop = 2,
180 e_FloatingWindowRelatedWindowMonitor = 3
181 } FloatingWindowRelatedWindowType;
182
188 typedef enum _FloatingWindowResizeType {
190 e_FloatingWindowResizeTypeNo = 0,
192 e_FloatingWindowResizeTypeAspectRatio = 1,
194 e_FloatingWindowResizeTypeAnyway = 2
195 } FloatingWindowResizeType;
196
204 typedef enum _FloatingWindowOffscreenEvent {
206 e_FloatingWindowOffscreenEventNone = 0,
208 e_FloatingWindowOffscreenEventMoveResize = 1,
210 e_FloatingWindowOffscreenEventNonViable = 2
211 } FloatingWindowOffscreenEvent;
212
213
223 Rendition(const PDFDoc& pdf_doc, objects::PDFDictionary* rendition_dict = NULL);
225 ~Rendition();
226
232 Rendition(const Rendition& other);
240 Rendition& operator = (const Rendition& other);
248 bool operator == (const Rendition& other) const;
256 bool operator != (const Rendition& other) const;
264 bool IsEmpty() const;
265
271 objects::PDFDictionary* GetDict() const;
272
280 WString GetRenditionName() const;
290 void SetRenditionName(const WString& name);
291
298 bool HasMediaClip() const;
304 WString GetMediaClipName() const;
312 void SetMediaClipName(const WString& name);
318 FileSpec GetMediaClipFile() const;
329 void SetMediaClipFile(FileSpec file_specification);
330
340 String GetMediaClipContentType() const;
354 void SetMediaClipContentType(const char* content_type);
355
365 MediaPermission GetPermission() const;
377 void SetPermission(MediaPermission permission);
378
388 WStringArray GetMediaDescriptions() const;
400 void SetMediaDescriptions(const WStringArray &description_array);
401
409 String GetMediaBaseURL() const;
422 void SetMediaBaseURL(const String& base_url, MediaOptionType opt_type = e_MediaOptionBestEffort);
423
432 int GetMediaPlayerCount(MediaPlayerType type) const;
443 MediaPlayer GetMediaPlayer(MediaPlayerType type, int index) const;
461 int AddMediaPlayer(MediaPlayerType type, const MediaPlayer &player);
471 void RemoveMediaPlayer(MediaPlayerType type, const MediaPlayer &player);
472
479 int GetVolume() const;
490 void SetVolume(int volume, MediaOptionType opt_type = e_MediaOptionBestEffort);
491
500 bool IsControlBarVisible() const;
515 void EnableControlBarVisible(bool is_visible, MediaOptionType opt_type = e_MediaOptionBestEffort);
516
527 MediaPlayerFitStyle GetFitStyle() const;
542 void SetFitStyle(MediaPlayerFitStyle fit_style, MediaOptionType opt_type = e_MediaOptionBestEffort);
543
555 int GetDuration() const;
571 void SetDuration(int duration, MediaOptionType opt_type = e_MediaOptionBestEffort);
572
581 bool IsAutoPlay() const;
594 void EnableAutoPlay(bool is_auto_play, MediaOptionType opt_type = e_MediaOptionBestEffort);
595
602 int GetRepeatCount() const;
613 void SetRepeatCount(int count, MediaOptionType opt_type = e_MediaOptionBestEffort);
614
622 WindowType GetWindowType() const;
634 void SetWindowType(WindowType window_type, MediaOptionType opt_type = e_MediaOptionBestEffort);
635
642 RGB GetBackgroundColor() const;
653 void SetBackgroundColor(RGB color, MediaOptionType opt_type = e_MediaOptionBestEffort);
654
663 float GetBackgroundOpacity() const;
675 void SetBackgroundOpacity(float opacity, MediaOptionType opt_type = e_MediaOptionBestEffort);
676
688 MonitorSpecifier GetMonitorSpecifier() const;
703 void SetMonitorSpecifier(MonitorSpecifier monitor_specifier, MediaOptionType opt_type = e_MediaOptionBestEffort);
704
712 int GetFloatingWindowWidth() const;
720 int GetFloatingWindowHeight() const;
734 void SetFloatingWindowSize(int width, int height, MediaOptionType opt_type = e_MediaOptionBestEffort);
735
747 FloatingWindowRelatedWindowType GetFloatingWindowRelatedWindowType() const;
763 void SetFloatingWindowRelatedWindowType(FloatingWindowRelatedWindowType window_type, MediaOptionType opt_type = e_MediaOptionBestEffort);
764
775 common::Position GetFloatingWindowPosition() const;
791 void SetFloatingWindowPosition(common::Position position, MediaOptionType opt_type = e_MediaOptionBestEffort);
792
804 FloatingWindowOffscreenEvent GetFloatingWindowOffscreenEvent() const;
820 void SetFloatingWindowOffscreenEvent(FloatingWindowOffscreenEvent offscreen_event, MediaOptionType opt_type = e_MediaOptionBestEffort);
821
831 bool HasFloatingWindowTitleBar() const;
845 void EnableFloatingWindowTitleBar(bool is_visible, MediaOptionType opt_type = e_MediaOptionBestEffort);
846
858 bool HasFloatingWindowCloseButton() const;
874 void EnableFloatingWindowCloseButton(bool is_visible, MediaOptionType opt_type = e_MediaOptionBestEffort);
875
885 FloatingWindowResizeType GetFloatingWindowResizeType() const;
900 void SetFloatingWindowResizeType(FloatingWindowResizeType resize_type, MediaOptionType opt_type = e_MediaOptionBestEffort);
901
911 WStringArray GetFloatingWindowTitles() const;
926 void SetFloatingWindowTitles(const WStringArray& titles, MediaOptionType opt_type = e_MediaOptionBestEffort);
927
928 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
929 explicit Rendition(FS_HANDLE handle = NULL);
930 };
931
935 class MediaPlayer FS_FINAL : public Base {
936 public:
950 MediaPlayer(objects::PDFDictionary* media_player_dict = NULL);
951
953 ~MediaPlayer();
954
960 MediaPlayer(const MediaPlayer& other);
961
969 MediaPlayer& operator = (const MediaPlayer& other);
970
978 bool operator == (const MediaPlayer& other) const;
979
987 bool operator != (const MediaPlayer& other) const;
988
996 bool IsEmpty() const;
997
1003 objects::PDFDictionary* GetDict() const;
1004
1012 String GetSoftwareURI() const;
1013
1024 void SetSoftwareURI(const String& uri);
1025
1036 StringArray GetOSIdentifiers() const;
1037
1050 void SetOSIdentifiers(const StringArray& identifier_array);
1051
1052 // 强烈建议用户不要使用此方法；否则可能会出现未知情况。
1053 explicit MediaPlayer(FS_HANDLE handle);
1054 };
1055 } // namespace pdf
1056 } // namespace foxit
1057
1058 #endif // FS_RENDITION_H_
1059
foxit::pdf::Rendition::e_FloatingWindowResizeTypeNo
不能调整大小
Definition: fs_rendition.h:190
foxit::pdf::Rendition::e_MonitorSpecifierSmallest
包含文档窗口最小部分的监视器
Definition: fs_rendition.h:153
foxit::pdf::Rendition::e_MediaPlayerFitStyleFill
媒体的宽度和高度独立缩放，使得媒体和播放矩形相同； 宽高比不一定保持。与SMIL的fit属性的"fill"值相同。
Definition: fs_rendition.h:109
foxit::pdf::Rendition::SetFloatingWindowTitles
void SetFloatingWindowTitles(const WStringArray &titles, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置多语言文本数组，提供要在浮动窗口标题栏上显示的文本。
foxit::pdf::MediaPlayer
Definition: fs_rendition.h:935
foxit::pdf::Rendition::GetFloatingWindowHeight
int GetFloatingWindowHeight() const
获取浮动窗口的高度，以像素为单位。
foxit::pdf::Rendition::e_MediaPermTempAccess
只有当文档权限允许内容提取（包括用于辅助功能目的）时才允许。
Definition: fs_rendition.h:66
foxit::FS_HANDLE
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:214
foxit::pdf::FileSpec
Definition: fs_filespec.h:38
foxit::pdf::Rendition::GetMediaClipFile
FileSpec GetMediaClipFile() const
获取实际媒体数据的文件规范。
foxit::pdf::Rendition::e_FloatingWindowRelatedWindowDocument
文档窗口
Definition: fs_rendition.h:174
foxit::pdf::Rendition::MediaOptionType
MediaOptionType
媒体选项类型的枚举。
Definition: fs_rendition.h:46
foxit::pdf::Rendition::e_MonitorSpecifierLargest
包含文档窗口最大部分的监视器
Definition: fs_rendition.h:151
foxit::StringArray
Definition: fs_basictypes.h:230
foxit::pdf::Rendition::SetFloatingWindowRelatedWindowType
void SetFloatingWindowRelatedWindowType(FloatingWindowRelatedWindowType window_type, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置窗口相对类型。
foxit::pdf::Rendition::GetRenditionName
WString GetRenditionName() const
获取名称。
foxit::pdf::Rendition::GetMediaPlayer
MediaPlayer GetMediaPlayer(MediaPlayerType type, int index) const
根据索引获取指定类型的媒体播放器对象。
foxit::pdf::Rendition::e_MediaPlayerAvailable
此类型中的任何播放器都可以用于播放相关的媒体剪辑。
Definition: fs_rendition.h:80
foxit::common::Position
Position
PDF页面中水印位置枚举。
Definition: fs_common.h:128
foxit::pdf::Rendition::e_FloatingWindowOffscreenEventMoveResize
移动或调整大小
Definition: fs_rendition.h:208
foxit::pdf::Rendition::SetWindowType
void SetWindowType(WindowType window_type, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置媒体应播放的窗口类型。
foxit::pdf::Rendition::EnableFloatingWindowTitleBar
void EnableFloatingWindowTitleBar(bool is_visible, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置标志以指定浮动窗口是否应有标题栏。
foxit::pdf::Rendition::e_WindowTypeFloating
窗口类型：浮动窗口
Definition: fs_rendition.h:131
foxit::pdf::Rendition::GetFloatingWindowTitles
WStringArray GetFloatingWindowTitles() const
获取多语言文本数组，提供要在浮动窗口标题栏上显示的文本。
foxit::pdf::Rendition::SetRepeatCount
void SetRepeatCount(int count, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置重复计数，类似于SMIL的repeatCount属性。
foxit::pdf::Rendition::operator!=
bool operator!=(const Rendition &other) const
不等于操作符。
foxit::pdf::Rendition::SetFloatingWindowOffscreenEvent
void SetFloatingWindowOffscreenEvent(FloatingWindowOffscreenEvent offscreen_event, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置事件类型，指定如果浮动窗口完全或部分位于屏幕外 （即在任何物理监视器上都不可见）时应发生什么。
foxit::pdf::Rendition::SetFloatingWindowSize
void SetFloatingWindowSize(int width, int height, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置浮动窗口的大小，以像素为单位。
foxit::pdf::Rendition::FloatingWindowResizeType
FloatingWindowResizeType
浮动窗口调整大小类型的枚举。
Definition: fs_rendition.h:188
foxit::pdf::MediaPlayer::GetDict
objects::PDFDictionary * GetDict() const
获取当前对象的PDF字典。
fs_common.h
通用定义和类的头文件。
foxit::pdf::Rendition::e_FloatingWindowRelatedWindowFullDesktop
完整的虚拟桌面
Definition: fs_rendition.h:178
foxit::pdf::Rendition::SetFloatingWindowPosition
void SetFloatingWindowPosition(common::Position position, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置浮动窗口应相对于相关窗口定位的位置。
foxit::pdf::Rendition::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::pdf::Rendition::SetDuration
void SetDuration(int duration, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置内在持续时间。
foxit::pdf::Rendition::SetMediaClipFile
void SetMediaClipFile(FileSpec file_specification)
设置实际媒体数据的文件规范。
foxit::pdf::Rendition::e_MonitorSpecifierGreatestHeight
具有最大高度的监视器（以像素为单位）
Definition: fs_rendition.h:161
foxit::pdf::Rendition::GetFloatingWindowRelatedWindowType
FloatingWindowRelatedWindowType GetFloatingWindowRelatedWindowType() const
获取窗口相对类型。
foxit::pdf::MediaPlayer::SetSoftwareURI
void SetSoftwareURI(const String &uri)
设置标识软件的软件URI。
foxit::pdf::Rendition::~Rendition
~Rendition()
析构函数。
foxit::pdf::Rendition::e_MonitorSpecifierPrimary
主监视器。如果没有监视器被认为是主要的，使用情况0
Definition: fs_rendition.h:155
foxit::pdf::Rendition::e_WindowTypeHidden
窗口类型：隐藏窗口
Definition: fs_rendition.h:135
foxit::pdf::Rendition::e_MonitorSpecifierGreatestArea
具有最大面积的监视器（以像素平方为单位）
Definition: fs_rendition.h:159
foxit::pdf::Rendition
Definition: fs_rendition.h:38
foxit::pdf::MediaPlayer::operator!=
bool operator!=(const MediaPlayer &other) const
不等于操作符。
foxit::pdf::Rendition::SetMediaBaseURL
void SetMediaBaseURL(const String &base_url, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置基础URL。
foxit::pdf::Rendition::GetDict
objects::PDFDictionary * GetDict() const
获取当前对象的PDF字典。
foxit::pdf::Rendition::GetRepeatCount
int GetRepeatCount() const
获取重复计数，类似于SMIL的repeatCount属性。
foxit::pdf::Rendition::FloatingWindowOffscreenEvent
FloatingWindowOffscreenEvent
浮动窗口屏幕外事件类型的枚举。
Definition: fs_rendition.h:204
foxit::pdf::Rendition::e_MediaPermTempExtract
只有当文档权限允许内容提取时才允许。
Definition: fs_rendition.h:64
foxit::pdf::Rendition::e_FloatingWindowResizeTypeAnyway
可以在不保持宽高比的情况下调整大小
Definition: fs_rendition.h:194
foxit::pdf::Rendition::SetMediaClipContentType
void SetMediaClipContentType(const char *content_type)
设置媒体数据的内容类型（MIME类型）。
foxit::pdf::Rendition::SetBackgroundOpacity
void SetBackgroundOpacity(float opacity, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置背景不透明度。（对于全屏和隐藏窗口将被忽略）
foxit::pdf::Rendition::GetBackgroundColor
RGB GetBackgroundColor() const
获取媒体正在播放的矩形的背景颜色。
foxit::pdf::Rendition::GetMediaClipContentType
String GetMediaClipContentType() const
获取媒体数据的内容类型（MIME类型）。
foxit::pdf::Rendition::GetMediaClipName
WString GetMediaClipName() const
获取媒体剪辑的名称，用于用户界面。
CFX_ByteString
字节字符串类
Definition: fx_string.h:317
foxit::pdf::Rendition::e_MediaOptionMustBeHonored
在此类型中定义的选项必须被遵守，演示对象才被认为是可行的。
Definition: fs_rendition.h:48
foxit::pdf::Rendition::IsControlBarVisible
bool IsControlBarVisible() const
检查播放时是否显示播放器特定的控制器用户界面 （例如，播放/暂停/停止控件）。
foxit::pdf::Rendition::GetMonitorSpecifier
MonitorSpecifier GetMonitorSpecifier() const
获取监视器指定类型值。
foxit::pdf::Rendition::MediaPlayerFitStyle
MediaPlayerFitStyle
适配样式的枚举。
Definition: fs_rendition.h:92
foxit::pdf::Rendition::GetPermission
MediaPermission GetPermission() const
获取媒体权限。
foxit::pdf::Rendition::GetMediaDescriptions
WStringArray GetMediaDescriptions() const
获取多语言文本数组，在无法播放媒体剪辑数据时 提供替代文本描述。
foxit::pdf::Rendition::e_FloatingWindowOffscreenEventNonViable
认为对象不可行
Definition: fs_rendition.h:210
foxit::pdf::Rendition::operator==
bool operator==(const Rendition &other) const
等于操作符。
foxit::pdf::Rendition::e_FloatingWindowRelatedWindowApplication
应用程序窗口
Definition: fs_rendition.h:176
foxit::pdf::MediaPlayer::GetSoftwareURI
String GetSoftwareURI() const
获取标识软件的软件URI。
foxit::pdf::Rendition::HasMediaClip
bool HasMediaClip() const
检查当前演示对象是否包含媒体剪辑。
foxit::pdf::Rendition::EnableFloatingWindowCloseButton
void EnableFloatingWindowCloseButton(bool is_visible, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置标志以指定浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。
foxit::pdf::Rendition::e_FloatingWindowRelatedWindowMonitor
依赖于监视器指定。
Definition: fs_rendition.h:180
foxit::pdf::Rendition::SetMonitorSpecifier
void SetMonitorSpecifier(MonitorSpecifier monitor_specifier, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置监视器指定类型值。
foxit::pdf::MediaPlayer::IsEmpty
bool IsEmpty() const
检查当前对象是否为空。
foxit::pdf::Rendition::e_MediaPermTempAlways
总是允许。
Definition: fs_rendition.h:68
fs_pdfobject.h
PDF对象相关定义和类的头文件。
foxit::pdf::Rendition::e_FloatingWindowOffscreenEventNone
什么都不做
Definition: fs_rendition.h:206
foxit::pdf::Rendition::SetMediaClipName
void SetMediaClipName(const WString &name)
设置媒体剪辑的名称，用于用户界面。
foxit::pdf::Rendition::SetMediaDescriptions
void SetMediaDescriptions(const WStringArray &description_array)
设置多语言文本数组，在无法播放媒体剪辑数据时 提供替代文本描述。
foxit
Foxit命名空间。
Definition: fs_taggedpdf.h:27
foxit::pdf::Rendition::e_MediaOptionBestEffort
在此类型中定义的选项只需要在"尽力而为"的意义上被遵守。
Definition: fs_rendition.h:50
foxit::pdf::MediaPlayer::operator==
bool operator==(const MediaPlayer &other) const
等于操作符。
foxit::pdf::Rendition::e_WindowTypeAnnotRect
窗口类型：与演示对象关联的屏幕注释所占据的矩形。
Definition: fs_rendition.h:139
foxit::pdf::MediaPlayer::GetOSIdentifiers
StringArray GetOSIdentifiers() const
获取表示操作系统标识符的字符串数组。
foxit::pdf::Rendition::SetFitStyle
void SetFitStyle(MediaPlayerFitStyle fit_style, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置适配样式。
foxit::pdf::Rendition::EnableControlBarVisible
void EnableControlBarVisible(bool is_visible, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置控制栏可见性标志。
foxit::pdf::Rendition::HasFloatingWindowTitleBar
bool HasFloatingWindowTitleBar() const
检查浮动窗口是否应有标题栏。
foxit::pdf::Rendition::MediaPlayerType
MediaPlayerType
PDF媒体播放器分类类型的枚举。
Definition: fs_rendition.h:76
foxit::pdf::Rendition::e_MonitorSpecifierGreatestColorDepth
具有最大颜色深度的监视器
Definition: fs_rendition.h:157
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:848
foxit::pdf::Rendition::AddMediaPlayer
int AddMediaPlayer(MediaPlayerType type, const MediaPlayer &player)
为指定类型添加媒体播放器对象。
foxit::pdf::Rendition::e_FloatingWindowResizeTypeAspectRatio
只有在保持宽高比的情况下才可以调整大小
Definition: fs_rendition.h:192
foxit::pdf::Rendition::GetDuration
int GetDuration() const
获取内在持续时间。
foxit::pdf::Rendition::GetBackgroundOpacity
float GetBackgroundOpacity() const
获取背景不透明度。（对于全屏和隐藏窗口将被忽略）
foxit::pdf::Rendition::FloatingWindowRelatedWindowType
FloatingWindowRelatedWindowType
浮动窗口相关窗口类型的枚举。
Definition: fs_rendition.h:172
foxit::pdf::Rendition::GetFitStyle
MediaPlayerFitStyle GetFitStyle() const
获取适配样式。
foxit::pdf::Rendition::SetPermission
void SetPermission(MediaPermission permission)
设置媒体权限。
foxit::pdf::Rendition::GetWindowType
WindowType GetWindowType() const
获取媒体应播放的窗口类型。
foxit::pdf::Rendition::e_MediaPlayerFitStyleSlice
在保持宽高比的同时缩放媒体的宽度和高度，使得 播放矩形完全填满，并且不适合 播放矩形内的媒体内容量最小化。与SMIL的fit属性的"slice"值相同。
Definition: fs_rendition.h:104
foxit::pdf::Rendition::e_MediaPlayerMustUsed
此类型中的播放器之一必须用于播放相关的媒体剪辑。
Definition: fs_rendition.h:78
foxit::pdf::MediaPlayer::operator=
MediaPlayer & operator=(const MediaPlayer &other)
赋值操作符。
NULL
#define NULL
空指针值。
Definition: fx_system.h:792
foxit::pdf::Rendition::MediaPermission
MediaPermission
PDF媒体播放器权限的枚举。
Definition: fs_rendition.h:60
foxit::pdf::Rendition::IsAutoPlay
bool IsAutoPlay() const
检查媒体激活时是否应自动播放。
foxit::pdf::Rendition::GetFloatingWindowOffscreenEvent
FloatingWindowOffscreenEvent GetFloatingWindowOffscreenEvent() const
获取事件类型，指定如果浮动窗口完全或部分位于屏幕外 （即在任何物理监视器上都不可见）时应发生什么。
foxit::RGB
uint32 RGB
RGB 颜色类型，24 位，((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:212
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:771
foxit::pdf::MediaPlayer::~MediaPlayer
~MediaPlayer()
析构函数。
foxit::pdf::MediaPlayer::SetOSIdentifiers
void SetOSIdentifiers(const StringArray &identifier_array)
设置表示操作系统标识符的字符串数组。
foxit::pdf::Rendition::SetBackgroundColor
void SetBackgroundColor(RGB color, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置媒体正在播放的矩形的背景颜色。
foxit::pdf::Rendition::operator=
Rendition & operator=(const Rendition &other)
赋值操作符。
foxit::pdf::Rendition::e_MediaPlayerFitStyleScroll
媒体不缩放。如果媒体矩形比播放矩形更宽或更高， 则提供滚动用户界面。与SMIL的fit属性的"scroll"值相同。
Definition: fs_rendition.h:114
foxit::pdf::Rendition::GetMediaBaseURL
String GetMediaBaseURL() const
获取基础URL。
foxit::pdf::Rendition::GetFloatingWindowPosition
common::Position GetFloatingWindowPosition() const
获取浮动窗口应相对于相关窗口定位的位置。
foxit::WStringArray
Definition: fs_basictypes.h:228
foxit::pdf::Rendition::e_MediaPlayerFitStyleMeet
在保持宽高比的同时缩放媒体的宽度和高度，使得 媒体和播放矩形具有最大可能的交集，同时仍然 显示所有媒体内容。与SMIL的fit属性的"meet"值相同。
Definition: fs_rendition.h:98
foxit::pdf::Rendition::SetRenditionName
void SetRenditionName(const WString &name)
设置名称。
foxit::pdf::Rendition::e_MediaPlayerFitStyleDefault
使用播放器的默认设置（作者没有偏好）。
Definition: fs_rendition.h:121
foxit::pdf::Rendition::RemoveMediaPlayer
void RemoveMediaPlayer(MediaPlayerType type, const MediaPlayer &player)
删除指定类型的媒体播放器对象。
foxit::pdf::Rendition::GetFloatingWindowWidth
int GetFloatingWindowWidth() const
获取浮动窗口的宽度，以像素为单位。
foxit::pdf::Rendition::EnableAutoPlay
void EnableAutoPlay(bool is_auto_play, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置标志以决定媒体激活时是否应自动播放。
CFX_WideString
宽字符串类
Definition: fx_string.h:1457
foxit::pdf::MediaPlayer::MediaPlayer
MediaPlayer(objects::PDFDictionary *media_player_dict=0)
带参数的构造函数。
foxit::pdf::Rendition::e_MediaPlayerFitStyleHidden
媒体不缩放。只显示媒体矩形与播放矩形 相交的部分。与SMIL的fit属性的"hidden"值相同。
Definition: fs_rendition.h:119
foxit::pdf::Rendition::MonitorSpecifier
MonitorSpecifier
监视器指定类型的枚举。
Definition: fs_rendition.h:149
foxit::pdf::Rendition::GetMediaPlayerCount
int GetMediaPlayerCount(MediaPlayerType type) const
获取指定类型的媒体播放器对象数量。
foxit::pdf::Rendition::HasFloatingWindowCloseButton
bool HasFloatingWindowCloseButton() const
检查浮动窗口是否应包含允许用户 关闭浮动窗口的用户界面元素。
foxit::pdf::Rendition::e_MonitorSpecifierGreatestWidth
具有最大宽度的监视器（以像素为单位）
Definition: fs_rendition.h:163
foxit::pdf::Rendition::GetFloatingWindowResizeType
FloatingWindowResizeType GetFloatingWindowResizeType() const
获取调整大小类型，指定浮动窗口是否可以由用户调整大小。
foxit::pdf::Rendition::Rendition
Rendition(const PDFDoc &pdf_doc, objects::PDFDictionary *rendition_dict=0)
带参数的构造函数。
foxit::pdf::Rendition::e_MediaPermTempNever
从不允许。
Definition: fs_rendition.h:62
foxit::pdf::Rendition::GetVolume
int GetVolume() const
获取音量，以录制音量级别的百分比指定所需的音量级别。
foxit::Base
Definition: fs_basictypes.h:449
foxit::pdf::Rendition::SetVolume
void SetVolume(int volume, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置音量，以录制音量级别的百分比指定所需的音量级别。
foxit::pdf::Rendition::SetFloatingWindowResizeType
void SetFloatingWindowResizeType(FloatingWindowResizeType resize_type, MediaOptionType opt_type=e_MediaOptionBestEffort)
设置调整大小类型，指定浮动窗口是否可以由用户调整大小。
foxit::pdf::Rendition::e_WindowTypeFullScreen
窗口类型：遮挡所有其他窗口的全屏窗口
Definition: fs_rendition.h:133
foxit::pdf::Rendition::WindowType
WindowType
媒体应播放的窗口类型的枚举。
Definition: fs_rendition.h:129
foxit::pdf::Rendition::e_MediaPlayerNotUsed
此类型中的播放器不得用于播放相关的媒体剪辑。
Definition: fs_rendition.h:82