Foxit PDF SDK
|
Public Member Functions | |
Rendition (foxit.pdf.PDFDoc pdf_doc, PDFDictionary rendition_dict) | |
Constructor, with parameters. More... | |
Rendition (Rendition other) | |
Constructor, with another rendition object. More... | |
int | AddMediaPlayer (Rendition.MediaPlayerType type, MediaPlayer player) |
Add a media player object for specified type. More... | |
void | EnableAutoPlay (bool is_auto_play, Rendition.MediaOptionType opt_type) |
Check whether the media should automatically play when activated. More... | |
void | EnableControlBarVisible (bool is_visible, Rendition.MediaOptionType opt_type) |
Set the control bar visibility flag. More... | |
void | EnableFloatingWindowCloseButton (bool is_visible, Rendition.MediaOptionType opt_type) |
Set the flag to specify if the floating window should include user interface elements that allow a user to close a floating window. More... | |
void | EnableFloatingWindowTitleBar (bool is_visible, Rendition.MediaOptionType opt_type) |
Set flag to specify if the floating window should have a title bar. More... | |
int | GetBackgroundColor () |
Get the background color for the rectangle in which the media is being played. More... | |
float | GetBackgroundOpacity () |
Get the background opacity. (ignored for full-screen and hidden windows) More... | |
PDFDictionary | GetDict () |
Get PDF dictionary of current object. More... | |
int | GetDuration () |
Get the intrinsic duration. More... | |
Rendition.MediaPlayerFitStyle | GetFitStyle () |
Get the fit style. More... | |
int | GetFloatingWindowHeight () |
Get the height of floating window, in pixels. More... | |
Rendition.FloatingWindowOffscreenEvent | GetFloatingWindowOffscreenEvent () |
Get the event type which specifies what should occur if the floating window is positioned totally or partially offscreen (that is, not visible on any physical monitor). More... | |
Position | GetFloatingWindowPosition () |
Get the position where floating window should be positioned to the related window. More... | |
Rendition.FloatingWindowRelatedWindowType | GetFloatingWindowRelatedWindowType () |
Get the window relative type. More... | |
Rendition.FloatingWindowResizeType | GetFloatingWindowResizeType () |
Get the resize type which specifies whether the floating window may be resized by a user. More... | |
WStringArray | GetFloatingWindowTitles () |
Get the multi-language text array which provides text to display on the floating window's title bar. More... | |
int | GetFloatingWindowWidth () |
Get the width of floating window, in pixels. More... | |
string | GetMediaBaseURL () |
Get the base URL. More... | |
string | GetMediaClipContentType () |
Get the content type (MIME type) of the media data. More... | |
FileSpec | GetMediaClipFile () |
Get the file specification of the actual media data. More... | |
string | GetMediaClipName () |
Get the name of the media clip, for use in user interface. More... | |
WStringArray | GetMediaDescriptions () |
Get the multi-language text array that provides alternate text descriptions for the media clip data in case it cannot be played. More... | |
MediaPlayer | GetMediaPlayer (Rendition.MediaPlayerType type, int index) |
Get a media player object by index for specified type. More... | |
int | GetMediaPlayerCount (Rendition.MediaPlayerType type) |
Get the count of media player objects for specified type. More... | |
Rendition.MonitorSpecifier | GetMonitorSpecifier () |
Get the monitor specifier type value. More... | |
Rendition.MediaPermission | GetPermission () |
Get the media permission. More... | |
string | GetRenditionName () |
Get the name. More... | |
int | GetRepeatCount () |
Get the repeat count, similar to SMIL's repeatCount attribute. More... | |
int | GetVolume () |
Get the volume that specifies the desired volume level as a percentage of recorded volume level. More... | |
Rendition.WindowType | GetWindowType () |
Get the type of window that the media should play in. More... | |
bool | HasFloatingWindowCloseButton () |
Check if the floating window should include user interface elements that allow a user to close a floating window. More... | |
bool | HasFloatingWindowTitleBar () |
Check if the floating window should have a title bar. More... | |
bool | HasMediaClip () |
Check if current rendition object contains a media clip. More... | |
bool | IsAutoPlay () |
Check whether the media should automatically play when activated. More... | |
bool | IsControlBarVisible () |
Check whether to display a player-specific controller user interface (for example, play/pause/stop controls) when playing. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
void | RemoveMediaPlayer (Rendition.MediaPlayerType type, MediaPlayer player) |
Remove a media player object for specified type. More... | |
void | SetBackgroundColor (int color, Rendition.MediaOptionType opt_type) |
Set the background color for the rectangle in which the media is being played. More... | |
void | SetBackgroundOpacity (float opacity, Rendition.MediaOptionType opt_type) |
Set the background opacity. (ignored for full-screen and hidden windows) More... | |
void | SetDuration (int duration, Rendition.MediaOptionType opt_type) |
Set the intrinsic duration. More... | |
void | SetFitStyle (Rendition.MediaPlayerFitStyle fit_style, Rendition.MediaOptionType opt_type) |
Set the fit style. More... | |
void | SetFloatingWindowOffscreenEvent (Rendition.FloatingWindowOffscreenEvent offscreen_event, Rendition.MediaOptionType opt_type) |
Set the event type which specifies what should occur if the floating window is positioned totally or partially offscreen (that is, not visible on any physical monitor). More... | |
void | SetFloatingWindowPosition (Position position, Rendition.MediaOptionType opt_type) |
Set the position where floating window should be positioned to the related window. More... | |
void | SetFloatingWindowRelatedWindowType (Rendition.FloatingWindowRelatedWindowType window_type, Rendition.MediaOptionType opt_type) |
Set the window relative type. More... | |
void | SetFloatingWindowResizeType (Rendition.FloatingWindowResizeType resize_type, Rendition.MediaOptionType opt_type) |
Set the resize type which specifies whether the floating window may be resized by a user. More... | |
void | SetFloatingWindowSize (int width, int height, Rendition.MediaOptionType opt_type) |
Set the size of floating window, in pixels. More... | |
void | SetFloatingWindowTitles (WStringArray titles, Rendition.MediaOptionType opt_type) |
Set the multi-language text array which provides text to display on the floating window's title bar. More... | |
void | SetMediaBaseURL (string base_url, Rendition.MediaOptionType opt_type) |
Set the base URL. More... | |
void | SetMediaClipContentType (string content_type) |
Set the content type (MIME type) of the media data. More... | |
void | SetMediaClipFile (FileSpec file_specification) |
Set the file specification of the actual media data. More... | |
void | SetMediaClipName (string name) |
Set the name of the media clip, for use in user interface. More... | |
void | SetMediaDescriptions (WStringArray description_array) |
Set the multi-language text array that provides alternate text descriptions for the media clip data in case it cannot be played. More... | |
void | SetMonitorSpecifier (Rendition.MonitorSpecifier monitor_specifier, Rendition.MediaOptionType opt_type) |
Set the monitor specifier type value. More... | |
void | SetPermission (Rendition.MediaPermission permission) |
Set the media permission. More... | |
void | SetRenditionName (string name) |
Get the name. More... | |
void | SetRepeatCount (int count, Rendition.MediaOptionType opt_type) |
Set the repeat count, similar to SMIL's repeatCount attribute. More... | |
void | SetVolume (int volume, Rendition.MediaOptionType opt_type) |
Set the volume that specifies the desired volume level as a percentage of recorded volume level. More... | |
void | SetWindowType (Rendition.WindowType window_type, Rendition.MediaOptionType opt_type) |
Set the type of window that the media should play in. More... | |
Rendition object is used as a media object that specifies what to play, how to play it and where to play it. (For more details, please refer to <PDF Reference 1.7> P758 Section "9.1.2 Renditions", P762 "Media Renditions")
Enumeration for offscreen event type of floating window.
Values of this enumeration should be used alone.
Offscreen event type is used to specifies what should occur if the floating window is positioned totally or partially offscreen (that is, not visible on any physical monitor).
Enumerator | |
---|---|
e_FloatingWindowOffscreenEventNone |
Nothing. |
e_FloatingWindowOffscreenEventMoveResize |
Move or resize. |
e_FloatingWindowOffscreenEventNonViable |
Consider the object non-viable. |
Enumeration for the type of floating window's related window.
Values of this enumeration should be used alone.
Related window type specifies the place to which the floating window should be positioned.
Enumeration for resize type of floating window.
Values of this enumeration should be used alone.
Enumeration for media option type.
Values of this enumeration should be used alone.
Please refer to <PDF reference 1.7> P757 Section "9.1.1 Viability" for more details.
Enumeration for PDF media player permission.
Values of this enumeration should be used alone.
Media permission indicates the circumstances under which it is acceptable to write a temporary file in order to play a media clip.
Enumeration for the fit style.
Values of this enumeration should be used alone.
Fit style (manner) specifies how the player should treat a visual media type that does not exactly fit the rectangle in which it plays.
Enumeration for PDF media player classified type.
Values of this enumeration should be used alone.
Enumeration for monitor specifier type.
Values of this enumeration should be used alone.
Monitor specifier is used to specify which monitor in a multi-monitor system a floating or full-screen window should appear on.
Enumeration for the type of window that the media should play in.
Values of this enumeration should be used alone.
|
inline |
Constructor, with parameters.
[in] | pdf_doc | A valid PDF document object. |
[in] | rendition_dict | The PDF dictionary for a rendition object in PDF document represented by parameter pdf_doc. If this is null that means to construct a new rendition object in PDF document represented by parameter pdf_obj. |
|
inline |
Constructor, with another rendition object.
[in] | other | Another rendition object. |
|
inline |
Add a media player object for specified type.
Usually, a media player object should be only be added to a rendition object with specified media player type. User is not recommended to add the same media player object to different renditions or different media player types of one rendition; otherwise unexpected issues (such as crash) may occur later. If user does not want to construct another media player and set same values, user can clone the dictionary of original media player object and use the cloned dictionary to construct another media player directly.
[in] | type | Media player type. Please refer to values starting from foxit.pdf.Rendition.MediaPlayerType.e_MediaPlayerMustUsed and this should be one of these values. |
[in] | player | A media player object to be added for specified type. If the media player has existed for specified type, this function will return the index of the media player. |
|
inline |
Check whether the media should automatically play when activated.
[in] | is_auto_play | true means the media should automatically play when activated, while false means the media should be initially paused when activated (for example, the first frame is displayed). Relevant only for media that may be paused. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the control bar visibility flag.
Control bar visibility flag is used to decide whether to display a player-specific controller user interface (for example, play/pause/stop controls) when playing.
[in] | is_visible | true means to display a player-specific controller user interface, while false means not to display such user interface. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the flag to specify if the floating window should include user interface elements that allow a user to close a floating window.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
[in] | is_visible | true means the floating window should include user interface elements that allow a user to close a floating window, while false means the floating window does not need to include such user interface element. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set flag to specify if the floating window should have a title bar.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
[in] | is_visible | true means the floating window should have a title bar, while false means the floating window does not need to have a title bar. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Get the background color for the rectangle in which the media is being played.
|
inline |
Get the background opacity. (ignored for full-screen and hidden windows)
|
inline |
Get PDF dictionary of current object.
|
inline |
Get the intrinsic duration.
|
inline |
Get the fit style.
Fit style (manner) specifies how the player should treat a visual media type that does not exactly fit the rectangle in which it plays.
|
inline |
Get the height of floating window, in pixels.
This property is necessary when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
|
inline |
Get the event type which specifies what should occur if the floating window is positioned totally or partially offscreen (that is, not visible on any physical monitor).
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
|
inline |
Get the position where floating window should be positioned to the related window.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
Window relative specifies the place to which the floating window should be positioned.
|
inline |
Get the window relative type.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
Related window type specifies the place to which the floating window should be positioned.
|
inline |
Get the resize type which specifies whether the floating window may be resized by a user.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
|
inline |
Get the multi-language text array which provides text to display on the floating window's title bar.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
Strings in the multi-language text array are in pair: the first string (ASCII string) in each pair is language identifier and the second string is the caption.
|
inline |
Get the width of floating window, in pixels.
This property is necessary when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
|
inline |
Get the base URL.
Base URL is an absolute URL which is used in resolving any relative URLs found within the media data.
|
inline |
Get the content type (MIME type) of the media data.
Content type specifies the type of the media data represented by file specification. The content type string should conform to the content type specification described in Internet RFC 2045, Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
|
inline |
Get the file specification of the actual media data.
|
inline |
Get the name of the media clip, for use in user interface.
|
inline |
Get the multi-language text array that provides alternate text descriptions for the media clip data in case it cannot be played.
Strings in the multi-language text array are in pair: the first string (ASCII string) in each pair is language identifier and the second string is the description.
|
inline |
Get a media player object by index for specified type.
[in] | type | Media player type. Please refer to values starting from foxit.pdf.Rendition.MediaPlayerType.e_MediaPlayerMustUsed and this should be one of these values. |
[in] | index | Index of the media player object to be retrieved. Valid range: from 0 to (count-1). count is returned by function Rendition.GetMediaPlayerCount . |
|
inline |
Get the count of media player objects for specified type.
[in] | type | Media player type. Please refer to values starting from foxit.pdf.Rendition.MediaPlayerType.e_MediaPlayerMustUsed and this should be one of these values. |
|
inline |
Get the monitor specifier type value.
Monitor specifier is used to specify which monitor in a multi-monitor system a floating or full-screen window should appear on.
|
inline |
Get the media permission.
Media permission indicates the circumstances under which it is acceptable to write a temporary file in order to play a media clip.
|
inline |
Get the name.
This name can be used for name tree lookup by JavaSript actions and can also be used in user interface.
|
inline |
Get the repeat count, similar to SMIL's repeatCount attribute.
|
inline |
Get the volume that specifies the desired volume level as a percentage of recorded volume level.
|
inline |
Get the type of window that the media should play in.
|
inline |
Check if the floating window should include user interface elements that allow a user to close a floating window.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
|
inline |
Check if the floating window should have a title bar.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
|
inline |
Check if current rendition object contains a media clip.
|
inline |
Check whether the media should automatically play when activated.
|
inline |
Check whether to display a player-specific controller user interface (for example, play/pause/stop controls) when playing.
|
inline |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
|
inline |
Remove a media player object for specified type.
[in] | type | Media player type. Please refer to values starting from foxit.pdf.Rendition.MediaPlayerType.e_MediaPlayerMustUsed and this should be one of these values. |
[in] | player | A media player object to be removed. |
|
inline |
Set the background color for the rectangle in which the media is being played.
[in] | color | Background color to set. Format: 0xRRGGBB. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the background opacity. (ignored for full-screen and hidden windows)
[in] | opacity | Background opacity. Valid range: 0.0 to 1.0. 0.0 means full transparency and 1.0 means full opaque. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the intrinsic duration.
[in] | duration | Intrinsic duration value to set. It should be:
|
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the fit style.
Fit style (manner) specifies how the player should treat a visual media type that does not exactly fit the rectangle in which it plays.
[in] | fit_style | Fit style value. Please refer to values starting from foxit.pdf.Rendition.MediaPlayerFitStyle.e_MediaPlayerFitStyleMeet and this should be one of these values. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the event type which specifies what should occur if the floating window is positioned totally or partially offscreen (that is, not visible on any physical monitor).
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
[in] | offscreen_event | Event type for offscreen situation of floating window. Please refer to values starting from foxit.pdf.Rendition.FloatingWindowOffscreenEvent.e_FloatingWindowOffscreenEventNone and this should be one of these values. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the position where floating window should be positioned to the related window.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
Window relative specifies the place to which the floating window should be positioned.
[in] | position | Window relative type. Please refer to values starting from foxit.pdf.Rendition.FloatingWindowRelatedWindowType.e_FloatingWindowRelatedWindowDocument and this should be one of these values. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the window relative type.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
Related window type specifies the place to which the floating window should be positioned.
[in] | window_type | Related window type. Please refer to values starting from foxit.pdf.Rendition.FloatingWindowRelatedWindowType.e_FloatingWindowRelatedWindowDocument and this should be one of these values. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the resize type which specifies whether the floating window may be resized by a user.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
[in] | resize_type | Resize type. Please refer to values starting from foxit.pdf.Rendition.FloatingWindowResizeType.e_FloatingWindowResizeTypeNo and this should be one of these values. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the size of floating window, in pixels.
This property is necessary when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
[in] | width | Width of floating window, in pixels. This value should be larger than 0. |
[in] | height | Height of floating window, in pixels. This value should be larger than 0. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the multi-language text array which provides text to display on the floating window's title bar.
This property is only useful when the windows type is foxit.pdf.Rendition.WindowType.e_WindowTypeFloating .
Strings in the multi-language text array are in pair: the first string (ASCII string) in each pair is language identifier and the second string is the caption.
[in] | titles | A string array that represents multi-language text array. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the base URL.
Base URL is an absolute URL which is used in resolving any relative URLs found within the media data.
[in] | base_url | The base URL to set. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the content type (MIME type) of the media data.
Content type specifies the type of the media data represented by file specification. The content type string should conform to the content type specification described in Internet RFC 2045, Multipurpose Internet Mail Extensions (MIME) Part One: Format of Internet Message Bodies.
User is recommended to set the content type when setting a new file specification by function Rendition.SetMediaClipFile .
[in] | content_type | Content type (MIME type). |
|
inline |
Set the file specification of the actual media data.
This property is necessary for a rendition object. And user is recommended to set the content type by function Rendition.SetMediaClipContentType after setting a new file specification.
[in] | file_specification | A file specification object. |
|
inline |
Set the name of the media clip, for use in user interface.
[in] | name | Name string to be set for the media clip. |
|
inline |
Set the multi-language text array that provides alternate text descriptions for the media clip data in case it cannot be played.
Strings in the multi-language text array are in pair: the first string (ASCII string) in each pair is language identifier and the second string is the description.
[in] | description_array | A multi-language text array for description. |
|
inline |
Set the monitor specifier type value.
Monitor specifier is used to specify which monitor in a multi-monitor system a floating or full-screen window should appear on.
[in] | monitor_specifier | Monitor specifier type value. Please refer to values starting from foxit.pdf.Rendition.MonitorSpecifier.e_MonitorSpecifierLargest and this should be one of these values. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the media permission.
Media permission indicates the circumstances under which it is acceptable to write a temporary file in order to play a media clip.
[in] | permission | Media permission value. Please refer to values starting from foxit.pdf.Rendition.MediaPermission.e_MediaPermTempNever and this should be one of these values. |
|
inline |
Get the name.
This name can be used for name tree lookup by JavaSript actions and can also be used in user interface.
[in] | name | Name of current rendition object. |
|
inline |
Set the repeat count, similar to SMIL's repeatCount attribute.
[in] | count | The repeat count to be set. 0 means repeat forever. This value should not be negative value. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the volume that specifies the desired volume level as a percentage of recorded volume level.
[in] | volume | Volume value to set. 0 means mute. This value should not be negative. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |
|
inline |
Set the type of window that the media should play in.
[in] | window_type | Windows type value. Please refer to values starting from foxit.pdf.Rendition.WindowType.e_WindowTypeFloating and this should be one of these values. |
[in] | opt_type | Media option type. Please refer to values starting from foxit.pdf.Rendition.MediaOptionType.e_MediaOptionMustBeHonored and this should be one of these values. |