Foxit PDF SDK

fs_rendition.h
Go to the documentation of this file.
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,
140 e_WindowTypeAnnotRect = 3
141 } WindowType;
142
150 typedef enum _MonitorSpecifier {
152 e_MonitorSpecifierLargest = 0,
154 e_MonitorSpecifierSmallest = 1,
156 e_MonitorSpecifierPrimary = 2,
158 e_MonitorSpecifierGreatestColorDepth = 3,
160 e_MonitorSpecifierGreatestArea = 4,
162 e_MonitorSpecifierGreatestHeight = 5,
164 e_MonitorSpecifierGreatestWidth = 6
165 } MonitorSpecifier;
166
173 typedef enum _FloatingWindowRelatedWindowType {
175 e_FloatingWindowRelatedWindowDocument = 0,
177 e_FloatingWindowRelatedWindowApplication = 1,
179 e_FloatingWindowRelatedWindowFullDesktop = 2,
181 e_FloatingWindowRelatedWindowMonitor = 3
182 } FloatingWindowRelatedWindowType;
183
189 typedef enum _FloatingWindowResizeType {
191 e_FloatingWindowResizeTypeNo = 0,
193 e_FloatingWindowResizeTypeAspectRatio = 1,
195 e_FloatingWindowResizeTypeAnyway = 2
196 } FloatingWindowResizeType;
197
205 typedef enum _FloatingWindowOffscreenEvent {
207 e_FloatingWindowOffscreenEventNone = 0,
209 e_FloatingWindowOffscreenEventMoveResize = 1,
211 e_FloatingWindowOffscreenEventNonViable = 2
212 } FloatingWindowOffscreenEvent;
213
214
224 Rendition(const PDFDoc& pdf_doc, objects::PDFDictionary* rendition_dict = NULL);
226 ~Rendition();
227
233 Rendition(const Rendition& other);
241 Rendition& operator = (const Rendition& other);
249 bool operator == (const Rendition& other) const;
257 bool operator != (const Rendition& other) const;
265 bool IsEmpty() const;
266
272 objects::PDFDictionary* GetDict() const;
273
281 WString GetRenditionName() const;
291 void SetRenditionName(const WString& name);
292
299 bool HasMediaClip() const;
305 WString GetMediaClipName() const;
313 void SetMediaClipName(const WString& name);
319 FileSpec GetMediaClipFile() const;
330 void SetMediaClipFile(FileSpec file_specification);
331
341 String GetMediaClipContentType() const;
355 void SetMediaClipContentType(const char* content_type);
356
366 MediaPermission GetPermission() const;
378 void SetPermission(MediaPermission permission);
379
389 WStringArray GetMediaDescriptions() const;
401 void SetMediaDescriptions(const WStringArray &description_array);
402
410 String GetMediaBaseURL() const;
423 void SetMediaBaseURL(const String& base_url, MediaOptionType opt_type = e_MediaOptionBestEffort);
424
433 int GetMediaPlayerCount(MediaPlayerType type) const;
444 MediaPlayer GetMediaPlayer(MediaPlayerType type, int index) const;
462 int AddMediaPlayer(MediaPlayerType type, const MediaPlayer &player);
472 void RemoveMediaPlayer(MediaPlayerType type, const MediaPlayer &player);
473
480 int GetVolume() const;
491 void SetVolume(int volume, MediaOptionType opt_type = e_MediaOptionBestEffort);
492
501 bool IsControlBarVisible() const;
516 void EnableControlBarVisible(bool is_visible, MediaOptionType opt_type = e_MediaOptionBestEffort);
517
528 MediaPlayerFitStyle GetFitStyle() const;
543 void SetFitStyle(MediaPlayerFitStyle fit_style, MediaOptionType opt_type = e_MediaOptionBestEffort);
544
556 int GetDuration() const;
572 void SetDuration(int duration, MediaOptionType opt_type = e_MediaOptionBestEffort);
573
582 bool IsAutoPlay() const;
595 void EnableAutoPlay(bool is_auto_play, MediaOptionType opt_type = e_MediaOptionBestEffort);
596
603 int GetRepeatCount() const;
614 void SetRepeatCount(int count, MediaOptionType opt_type = e_MediaOptionBestEffort);
615
623 WindowType GetWindowType() const;
635 void SetWindowType(WindowType window_type, MediaOptionType opt_type = e_MediaOptionBestEffort);
636
643 RGB GetBackgroundColor() const;
654 void SetBackgroundColor(RGB color, MediaOptionType opt_type = e_MediaOptionBestEffort);
655
664 float GetBackgroundOpacity() const;
676 void SetBackgroundOpacity(float opacity, MediaOptionType opt_type = e_MediaOptionBestEffort);
677
689 MonitorSpecifier GetMonitorSpecifier() const;
704 void SetMonitorSpecifier(MonitorSpecifier monitor_specifier, MediaOptionType opt_type = e_MediaOptionBestEffort);
705
713 int GetFloatingWindowWidth() const;
721 int GetFloatingWindowHeight() const;
735 void SetFloatingWindowSize(int width, int height, MediaOptionType opt_type = e_MediaOptionBestEffort);
736
748 FloatingWindowRelatedWindowType GetFloatingWindowRelatedWindowType() const;
764 void SetFloatingWindowRelatedWindowType(FloatingWindowRelatedWindowType window_type, MediaOptionType opt_type = e_MediaOptionBestEffort);
765
776 common::Position GetFloatingWindowPosition() const;
792 void SetFloatingWindowPosition(common::Position position, MediaOptionType opt_type = e_MediaOptionBestEffort);
793
805 FloatingWindowOffscreenEvent GetFloatingWindowOffscreenEvent() const;
821 void SetFloatingWindowOffscreenEvent(FloatingWindowOffscreenEvent offscreen_event, MediaOptionType opt_type = e_MediaOptionBestEffort);
822
832 bool HasFloatingWindowTitleBar() const;
846 void EnableFloatingWindowTitleBar(bool is_visible, MediaOptionType opt_type = e_MediaOptionBestEffort);
847
859 bool HasFloatingWindowCloseButton() const;
875 void EnableFloatingWindowCloseButton(bool is_visible, MediaOptionType opt_type = e_MediaOptionBestEffort);
876
886 FloatingWindowResizeType GetFloatingWindowResizeType() const;
901 void SetFloatingWindowResizeType(FloatingWindowResizeType resize_type, MediaOptionType opt_type = e_MediaOptionBestEffort);
902
912 WStringArray GetFloatingWindowTitles() const;
927 void SetFloatingWindowTitles(const WStringArray& titles, MediaOptionType opt_type = e_MediaOptionBestEffort);
928
929 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
930 explicit Rendition(FS_HANDLE handle = NULL);
931 };
932
936 class MediaPlayer FS_FINAL : public Base {
937 public:
951 MediaPlayer(objects::PDFDictionary* media_player_dict = NULL);
952
954 ~MediaPlayer();
955
961 MediaPlayer(const MediaPlayer& other);
962
970 MediaPlayer& operator = (const MediaPlayer& other);
971
979 bool operator == (const MediaPlayer& other) const;
980
988 bool operator != (const MediaPlayer& other) const;
989
997 bool IsEmpty() const;
998
1004 objects::PDFDictionary* GetDict() const;
1005
1013 String GetSoftwareURI() const;
1014
1025 void SetSoftwareURI(const String& uri);
1026
1037 StringArray GetOSIdentifiers() const;
1038
1051 void SetOSIdentifiers(const StringArray& identifier_array);
1052
1053 // User is strongly recommended NOT to use this method; otherwise unknown situation may occur.
1054 explicit MediaPlayer(FS_HANDLE handle);
1055 };
1056 } // namespace pdf
1057 } // namespace foxit
1058
1059 #endif // FS_RENDITION_H_
1060
foxit::pdf::Rendition::e_FloatingWindowResizeTypeNo
May not be resized.
Definition: fs_rendition.h:191
foxit::pdf::Rendition::e_MonitorSpecifierSmallest
The monitor that contains the smallest section of the document window.
Definition: fs_rendition.h:154
foxit::pdf::Rendition::e_MediaPlayerFitStyleFill
The media's width and height are scaled independently so that the media and play rectangles are the s...
Definition: fs_rendition.h:109
foxit::pdf::Rendition::SetFloatingWindowTitles
void SetFloatingWindowTitles(const WStringArray &titles, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the multi-language text array which provides text to display on the floating window's title bar.
foxit::pdf::MediaPlayer
Definition: fs_rendition.h:936
foxit::pdf::Rendition::GetFloatingWindowHeight
int GetFloatingWindowHeight() const
Get the height of floating window, in pixels.
foxit::pdf::Rendition::e_MediaPermTempAccess
Allowed only if the document permissions allow content extraction, including for accessibility purpos...
Definition: fs_rendition.h:66
foxit::FS_HANDLE
void * FS_HANDLE
Handle type.
Definition: fs_basictypes.h:213
foxit::pdf::FileSpec
Definition: fs_filespec.h:38
foxit::pdf::Rendition::GetMediaClipFile
FileSpec GetMediaClipFile() const
Get the file specification of the actual media data.
foxit::pdf::Rendition::e_FloatingWindowRelatedWindowDocument
The document window.
Definition: fs_rendition.h:175
foxit::pdf::Rendition::MediaOptionType
MediaOptionType
Enumeration for media option type.
Definition: fs_rendition.h:46
foxit::pdf::Rendition::e_MonitorSpecifierLargest
The monitor that contains the largest section of the document window.
Definition: fs_rendition.h:152
foxit::StringArray
Definition: fs_basictypes.h:229
foxit::pdf::Rendition::SetFloatingWindowRelatedWindowType
void SetFloatingWindowRelatedWindowType(FloatingWindowRelatedWindowType window_type, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the window relative type.
foxit::pdf::Rendition::GetRenditionName
WString GetRenditionName() const
Get the name.
foxit::pdf::Rendition::GetMediaPlayer
MediaPlayer GetMediaPlayer(MediaPlayerType type, int index) const
Get a media player object by index for specified type.
foxit::pdf::Rendition::e_MediaPlayerAvailable
Any of players in this type may be used in playing the associated media clip.
Definition: fs_rendition.h:80
foxit::common::Position
Position
Enumeration for watermark position in a PDF page.
Definition: fs_common.h:128
foxit::pdf::Rendition::e_FloatingWindowOffscreenEventMoveResize
Move or resize.
Definition: fs_rendition.h:209
foxit::pdf::Rendition::SetWindowType
void SetWindowType(WindowType window_type, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the type of window that the media should play in.
foxit::pdf::Rendition::EnableFloatingWindowTitleBar
void EnableFloatingWindowTitleBar(bool is_visible, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set flag to specify if the floating window should have a title bar.
foxit::pdf::Rendition::e_WindowTypeFloating
Window type: a floating window.
Definition: fs_rendition.h:131
foxit::pdf::Rendition::GetFloatingWindowTitles
WStringArray GetFloatingWindowTitles() const
Get the multi-language text array which provides text to display on the floating window's title bar.
foxit::pdf::Rendition::SetRepeatCount
void SetRepeatCount(int count, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the repeat count, similar to SMIL's repeatCount attribute.
foxit::pdf::Rendition::operator!=
bool operator!=(const Rendition &other) const
Not equal operator.
foxit::pdf::Rendition::SetFloatingWindowOffscreenEvent
void SetFloatingWindowOffscreenEvent(FloatingWindowOffscreenEvent offscreen_event, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the event type which specifies what should occur if the floating window is positioned totally or ...
foxit::pdf::Rendition::SetFloatingWindowSize
void SetFloatingWindowSize(int width, int height, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the size of floating window, in pixels.
foxit::pdf::Rendition::FloatingWindowResizeType
FloatingWindowResizeType
Enumeration for resize type of floating window.
Definition: fs_rendition.h:189
foxit::pdf::MediaPlayer::GetDict
objects::PDFDictionary * GetDict() const
Get the PDF dictionary of current object.
fs_common.h
Header file for common definitions and classes.
foxit::pdf::Rendition::e_FloatingWindowRelatedWindowFullDesktop
The full virtual desktop.
Definition: fs_rendition.h:179
foxit::pdf::Rendition::SetFloatingWindowPosition
void SetFloatingWindowPosition(common::Position position, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the position where floating window should be positioned to the related window.
foxit::pdf::Rendition::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::Rendition::SetDuration
void SetDuration(int duration, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the intrinsic duration.
foxit::pdf::Rendition::SetMediaClipFile
void SetMediaClipFile(FileSpec file_specification)
Set the file specification of the actual media data.
foxit::pdf::Rendition::e_MonitorSpecifierGreatestHeight
Monitor with the greatest height (in pixels)
Definition: fs_rendition.h:162
foxit::pdf::Rendition::GetFloatingWindowRelatedWindowType
FloatingWindowRelatedWindowType GetFloatingWindowRelatedWindowType() const
Get the window relative type.
foxit::pdf::MediaPlayer::SetSoftwareURI
void SetSoftwareURI(const String &uri)
Get software URI that identifies a piece of software.
foxit::pdf::Rendition::~Rendition
~Rendition()
Destructor.
foxit::pdf::Rendition::e_MonitorSpecifierPrimary
Primary monitor. If no monitor is considered primary, use case 0.
Definition: fs_rendition.h:156
foxit::pdf::Rendition::e_WindowTypeHidden
Window type: a hidden window.
Definition: fs_rendition.h:135
foxit::pdf::Rendition::e_MonitorSpecifierGreatestArea
Monitor with the greatest area (in pixels squared)
Definition: fs_rendition.h:160
foxit::pdf::Rendition
Definition: fs_rendition.h:38
foxit::pdf::MediaPlayer::operator!=
bool operator!=(const MediaPlayer &other) const
Not equal operator.
foxit::pdf::Rendition::SetMediaBaseURL
void SetMediaBaseURL(const String &base_url, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the base URL.
foxit::pdf::Rendition::GetDict
objects::PDFDictionary * GetDict() const
Get PDF dictionary of current object.
foxit::pdf::Rendition::GetRepeatCount
int GetRepeatCount() const
Get the repeat count, similar to SMIL's repeatCount attribute.
foxit::pdf::Rendition::FloatingWindowOffscreenEvent
FloatingWindowOffscreenEvent
Enumeration for offscreen event type of floating window.
Definition: fs_rendition.h:205
foxit::pdf::Rendition::e_MediaPermTempExtract
Allowed only if the document permissions allow content extraction.
Definition: fs_rendition.h:64
foxit::pdf::Rendition::e_FloatingWindowResizeTypeAnyway
May be resized without preserving aspect ratio.
Definition: fs_rendition.h:195
foxit::pdf::Rendition::SetMediaClipContentType
void SetMediaClipContentType(const char *content_type)
Set the content type (MIME type) of the media data.
foxit::pdf::Rendition::SetBackgroundOpacity
void SetBackgroundOpacity(float opacity, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the background opacity. (ignored for full-screen and hidden windows)
foxit::pdf::Rendition::GetBackgroundColor
RGB GetBackgroundColor() const
Get the background color for the rectangle in which the media is being played.
foxit::pdf::Rendition::GetMediaClipContentType
String GetMediaClipContentType() const
Get the content type (MIME type) of the media data.
foxit::pdf::Rendition::GetMediaClipName
WString GetMediaClipName() const
Get the name of the media clip, for use in user interface.
CFX_ByteString
BYTE STRING CLASS.
Definition: fx_string.h:317
foxit::pdf::Rendition::e_MediaOptionMustBeHonored
Options defined in this type must be honored for rendition object to be considered viable.
Definition: fs_rendition.h:48
foxit::pdf::Rendition::IsControlBarVisible
bool IsControlBarVisible() const
Check whether to display a player-specific controller user interface (for example,...
foxit::pdf::Rendition::GetMonitorSpecifier
MonitorSpecifier GetMonitorSpecifier() const
Get the monitor specifier type value.
foxit::pdf::Rendition::MediaPlayerFitStyle
MediaPlayerFitStyle
Enumeration for the fit style.
Definition: fs_rendition.h:92
foxit::pdf::Rendition::GetPermission
MediaPermission GetPermission() const
Get the media permission.
foxit::pdf::Rendition::GetMediaDescriptions
WStringArray GetMediaDescriptions() const
Get the multi-language text array that provides alternate text descriptions for the media clip data i...
foxit::pdf::Rendition::e_FloatingWindowOffscreenEventNonViable
Consider the object non-viable.
Definition: fs_rendition.h:211
foxit::pdf::Rendition::operator==
bool operator==(const Rendition &other) const
Equal operator.
foxit::pdf::Rendition::e_FloatingWindowRelatedWindowApplication
The application window.
Definition: fs_rendition.h:177
foxit::pdf::MediaPlayer::GetSoftwareURI
String GetSoftwareURI() const
Get software URI that identifies a piece of software.
foxit::pdf::Rendition::HasMediaClip
bool HasMediaClip() const
Check if current rendition object contains a media clip.
foxit::pdf::Rendition::EnableFloatingWindowCloseButton
void EnableFloatingWindowCloseButton(bool is_visible, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the flag to specify if the floating window should include user interface elements that allow a us...
foxit::pdf::Rendition::e_FloatingWindowRelatedWindowMonitor
Depends on monitor specifier.
Definition: fs_rendition.h:181
foxit::pdf::Rendition::SetMonitorSpecifier
void SetMonitorSpecifier(MonitorSpecifier monitor_specifier, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the monitor specifier type value.
foxit::pdf::MediaPlayer::IsEmpty
bool IsEmpty() const
Check whether current object is empty or not.
foxit::pdf::Rendition::e_MediaPermTempAlways
Always allowed.
Definition: fs_rendition.h:68
fs_pdfobject.h
Header file for PDF object related definitions and classes.
foxit::pdf::Rendition::e_FloatingWindowOffscreenEventNone
Nothing.
Definition: fs_rendition.h:207
foxit::pdf::Rendition::SetMediaClipName
void SetMediaClipName(const WString &name)
Set the name of the media clip, for use in user interface.
foxit::pdf::Rendition::SetMediaDescriptions
void SetMediaDescriptions(const WStringArray &description_array)
Set the multi-language text array that provides alternate text descriptions for the media clip data i...
foxit
Foxit namespace.
Definition: fs_taggedpdf.h:27
foxit::pdf::Rendition::e_MediaOptionBestEffort
Options defined in this type need only be honored in a "best effort" sense.
Definition: fs_rendition.h:50
foxit::pdf::MediaPlayer::operator==
bool operator==(const MediaPlayer &other) const
Equal operator.
foxit::pdf::Rendition::e_WindowTypeAnnotRect
Window type: the rectangle occupied by the screen annotation which is associated with the rendition o...
Definition: fs_rendition.h:140
foxit::pdf::MediaPlayer::GetOSIdentifiers
StringArray GetOSIdentifiers() const
Get the string array that represents operating system identifiers.
foxit::pdf::Rendition::SetFitStyle
void SetFitStyle(MediaPlayerFitStyle fit_style, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the fit style.
foxit::pdf::Rendition::EnableControlBarVisible
void EnableControlBarVisible(bool is_visible, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the control bar visibility flag.
foxit::pdf::Rendition::HasFloatingWindowTitleBar
bool HasFloatingWindowTitleBar() const
Check if the floating window should have a title bar.
foxit::pdf::Rendition::MediaPlayerType
MediaPlayerType
Enumeration for PDF media player classified type.
Definition: fs_rendition.h:76
foxit::pdf::Rendition::e_MonitorSpecifierGreatestColorDepth
Monitor with the greatest color depth.
Definition: fs_rendition.h:158
foxit::pdf::objects::PDFDictionary
Definition: fs_pdfobject.h:850
foxit::pdf::Rendition::AddMediaPlayer
int AddMediaPlayer(MediaPlayerType type, const MediaPlayer &player)
Add a media player object for specified type.
foxit::pdf::Rendition::e_FloatingWindowResizeTypeAspectRatio
May be resized only if aspect ratio is preserved.
Definition: fs_rendition.h:193
foxit::pdf::Rendition::GetDuration
int GetDuration() const
Get the intrinsic duration.
foxit::pdf::Rendition::GetBackgroundOpacity
float GetBackgroundOpacity() const
Get the background opacity. (ignored for full-screen and hidden windows)
foxit::pdf::Rendition::FloatingWindowRelatedWindowType
FloatingWindowRelatedWindowType
Enumeration for the type of floating window's related window.
Definition: fs_rendition.h:173
foxit::pdf::Rendition::GetFitStyle
MediaPlayerFitStyle GetFitStyle() const
Get the fit style.
foxit::pdf::Rendition::SetPermission
void SetPermission(MediaPermission permission)
Set the media permission.
foxit::pdf::Rendition::GetWindowType
WindowType GetWindowType() const
Get the type of window that the media should play in.
foxit::pdf::Rendition::e_MediaPlayerFitStyleSlice
The media's width and height are scaled while preserving the aspect ratio so that the play rectangle ...
Definition: fs_rendition.h:104
foxit::pdf::Rendition::e_MediaPlayerMustUsed
One of players in this type must be used in playing the associated media clip.
Definition: fs_rendition.h:78
foxit::pdf::MediaPlayer::operator=
MediaPlayer & operator=(const MediaPlayer &other)
Assign operator.
NULL
#define NULL
The null-pointer value.
Definition: fx_system.h:792
foxit::pdf::Rendition::MediaPermission
MediaPermission
Enumeration for PDF media player permission.
Definition: fs_rendition.h:60
foxit::pdf::Rendition::IsAutoPlay
bool IsAutoPlay() const
Check whether the media should automatically play when activated.
foxit::pdf::Rendition::GetFloatingWindowOffscreenEvent
FloatingWindowOffscreenEvent GetFloatingWindowOffscreenEvent() const
Get the event type which specifies what should occur if the floating window is positioned totally or ...
foxit::RGB
uint32 RGB
RGB color type, 24 bits, ((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:211
foxit::pdf::PDFDoc
Definition: fs_pdfdoc.h:776
foxit::pdf::MediaPlayer::~MediaPlayer
~MediaPlayer()
Destructor.
foxit::pdf::MediaPlayer::SetOSIdentifiers
void SetOSIdentifiers(const StringArray &identifier_array)
Set the string array that represents operating system identifiers.
foxit::pdf::Rendition::SetBackgroundColor
void SetBackgroundColor(RGB color, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the background color for the rectangle in which the media is being played.
foxit::pdf::Rendition::operator=
Rendition & operator=(const Rendition &other)
Assign operator.
foxit::pdf::Rendition::e_MediaPlayerFitStyleScroll
The media is not scaled. A scrolling user interface is provided if the media rectangle is wider or ta...
Definition: fs_rendition.h:114
foxit::pdf::Rendition::GetMediaBaseURL
String GetMediaBaseURL() const
Get the base URL.
foxit::pdf::Rendition::GetFloatingWindowPosition
common::Position GetFloatingWindowPosition() const
Get the position where floating window should be positioned to the related window.
foxit::WStringArray
Definition: fs_basictypes.h:227
foxit::pdf::Rendition::e_MediaPlayerFitStyleMeet
The media's width and height are scaled while preserving the aspect ratio so that the media and play ...
Definition: fs_rendition.h:98
foxit::pdf::Rendition::SetRenditionName
void SetRenditionName(const WString &name)
Get the name.
foxit::pdf::Rendition::e_MediaPlayerFitStyleDefault
Use the player's default setting (author has no preference).
Definition: fs_rendition.h:121
foxit::pdf::Rendition::RemoveMediaPlayer
void RemoveMediaPlayer(MediaPlayerType type, const MediaPlayer &player)
Remove a media player object for specified type.
foxit::pdf::Rendition::GetFloatingWindowWidth
int GetFloatingWindowWidth() const
Get the width of floating window, in pixels.
foxit::pdf::Rendition::EnableAutoPlay
void EnableAutoPlay(bool is_auto_play, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the flag to decide whether the media should automatically play when activated.
CFX_WideString
WIDE STRING CLASS.
Definition: fx_string.h:1461
foxit::pdf::MediaPlayer::MediaPlayer
MediaPlayer(objects::PDFDictionary *media_player_dict=0)
Constructor, with parameters.
foxit::pdf::Rendition::e_MediaPlayerFitStyleHidden
The media is not scaled. Only the portions of the media rectangle that intersect the play rectangle a...
Definition: fs_rendition.h:119
foxit::pdf::Rendition::MonitorSpecifier
MonitorSpecifier
Enumeration for monitor specifier type.
Definition: fs_rendition.h:150
foxit::pdf::Rendition::GetMediaPlayerCount
int GetMediaPlayerCount(MediaPlayerType type) const
Get the count of media player objects for specified type.
foxit::pdf::Rendition::HasFloatingWindowCloseButton
bool HasFloatingWindowCloseButton() const
Check if the floating window should include user interface elements that allow a user to close a floa...
foxit::pdf::Rendition::e_MonitorSpecifierGreatestWidth
Monitor with the greatest width (in pixels)
Definition: fs_rendition.h:164
foxit::pdf::Rendition::GetFloatingWindowResizeType
FloatingWindowResizeType GetFloatingWindowResizeType() const
Get the resize type which specifies whether the floating window may be resized by a user.
foxit::pdf::Rendition::Rendition
Rendition(const PDFDoc &pdf_doc, objects::PDFDictionary *rendition_dict=0)
Constructor, with parameters.
foxit::pdf::Rendition::e_MediaPermTempNever
Never allowed.
Definition: fs_rendition.h:62
foxit::pdf::Rendition::GetVolume
int GetVolume() const
Get the volume that specifies the desired volume level as a percentage of recorded volume level.
foxit::Base
Definition: fs_basictypes.h:451
foxit::pdf::Rendition::SetVolume
void SetVolume(int volume, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the volume that specifies the desired volume level as a percentage of recorded volume level.
foxit::pdf::Rendition::SetFloatingWindowResizeType
void SetFloatingWindowResizeType(FloatingWindowResizeType resize_type, MediaOptionType opt_type=e_MediaOptionBestEffort)
Set the resize type which specifies whether the floating window may be resized by a user.
foxit::pdf::Rendition::e_WindowTypeFullScreen
Window type: a full-screen window that obscures all other windows.
Definition: fs_rendition.h:133
foxit::pdf::Rendition::WindowType
WindowType
Enumeration for the type of window that the media should play in.
Definition: fs_rendition.h:129
foxit::pdf::Rendition::e_MediaPlayerNotUsed
Players in this type must not be used in playing the associated media clip.
Definition: fs_rendition.h:82