Foxit PDF SDK  9.1
FSRendition Class Reference
Inheritance diagram for FSRendition:
FSBase

Instance Methods

(int) - addMediaPlayer:player:
 Add a media player object for specified type.
More...
 
(void) - dealloc
 
(void) - enableAutoPlay:
 Set the flag to decide whether the media should automatically play when activated.
More...
 
(void) - enableAutoPlay:opt_type:
 Set the flag to decide whether the media should automatically play when activated.
More...
 
(void) - enableControlBarVisible:
 Set the control bar visibility flag.
More...
 
(void) - enableControlBarVisible:opt_type:
 Set the control bar visibility flag.
More...
 
(void) - enableFloatingWindowCloseButton:
 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) - enableFloatingWindowCloseButton: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:
 Set flag to specify if the floating window should have a title bar.
More...
 
(void) - enableFloatingWindowTitleBar:opt_type:
 Set flag to specify if the floating window should have a title bar.
More...
 
(void *) - getCptr
 
(FSPDFDictionary *) - getDict
 Get PDF dictionary of current object.
More...
 
(int) - getFloatingWindowHeight
 Get the height of floating window, in pixels.
More...
 
(int) - getFloatingWindowWidth
 Get the width of floating window, in pixels.
More...
 
(FSMediaPlayer *) - getMediaPlayer:index:
 Get a media player object by index for specified type.
More...
 
(int) - getMediaPlayerCount:
 Get the count of media player objects for specified type.
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...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithOther:
 Constructor, with another rendition object.
More...
 
(id) - initWithPdf_doc:
 Constructor, with parameters.
More...
 
(id) - initWithPdf_doc:rendition_dict:
 Constructor, with parameters.
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...
 
(id) - NS_UNAVAILABLE
 
(void) - removeMediaPlayer:player:
 Remove a media player object for specified type.
More...
 
(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:
 Set the size of floating window, in pixels.
More...
 
(void) - setFloatingWindowSize:height:opt_type:
 Set the size of floating window, in pixels.
More...
 
(void) - setFloatingWindowTitles:opt_type:
 
(void) - setMediaBaseURL:opt_type:
 
(void) - setMonitorSpecifier:opt_type:
 
(void) - setRepeatCount:opt_type:
 
(void) - setVolume:opt_type:
 
(void) - setWindowType:opt_type:
 

Properties

unsigned int backgroundColor
 Get or Set the background color for the rectangle in which the media is being played.
More...
 
float backgroundOpacity
 Get or Set the background opacity. (ignored for full-screen and hidden windows)
More...
 
int duration
 Get or Set the intrinsic duration.
More...
 
FSRenditionMediaPlayerFitStyle fitStyle
 Get or Set the fit style.
More...
 
FSRenditionFloatingWindowOffscreenEvent floatingWindowOffscreenEvent
 Get or 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...
 
FSPosition floatingWindowPosition
 Get or Set the position where floating window should be positioned to the related window.
More...
 
FSRenditionFloatingWindowRelatedWindowType floatingWindowRelatedWindowType
 Get or Set the window relative type.
More...
 
FSRenditionFloatingWindowResizeType floatingWindowResizeType
 Get or Set the resize type which specifies whether the floating window may be resized by a user.
More...
 
NSArray< NSString * > * floatingWindowTitles
 Get or Set the multi-language text array which provides text to display on the floating window's title bar.
More...
 
NSString * mediaBaseURL
 Get or Set the base URL.
More...
 
NSString * mediaClipContentType
 Get or Set the content type (MIME type) of the media data.
More...
 
FSFileSpecmediaClipFile
 Get or Set the file specification of the actual media data.
More...
 
NSString * mediaClipName
 Get or Set the name of the media clip, for use in user interface.
More...
 
NSArray< NSString * > * mediaDescriptions
 Get or Set the multi-language text array that provides alternate text descriptions for the media clip data in case it cannot be played.
More...
 
FSRenditionMonitorSpecifier monitorSpecifier
 Get or Set the monitor specifier type value.
More...
 
FSRenditionMediaPermission permission
 Get or Set the media permission.
More...
 
NSString * renditionName
 Get or Set the name.
More...
 
int repeatCount
 Get or Set the repeat count, similar to SMIL's repeatCount attribute.
More...
 
int volume
 Get or Set the volume that specifies the desired volume level as a percentage of recorded volume level.
More...
 
FSRenditionWindowType windowType
 Get or Set the type of window that the media should play in.
More...
 

Additional Inherited Members

- Protected Attributes inherited from FSBase
BOOL swigCMemOwn
 
void * swigCPtr
 

Detailed Description

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")

Method Documentation

◆ addMediaPlayer:player:

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

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.

Parameters
[in]typeMedia player type. Please refer to values starting from FSRenditionMediaPlayerMustUsed and this should be one of these values.
[in]playerA 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.
Returns
Index of the input media player.

◆ dealloc

- (void) dealloc

Reimplemented from FSBase.

◆ enableAutoPlay:

- (void) enableAutoPlay: (BOOL)  is_auto_play

Set the flag to decide whether the media should automatically play when activated.

Parameters
[in]is_auto_playYES means the media should automatically play when activated, while NO means the media should be initially paused when activated (for example, the first frame is displayed). Relevant only for media that may be paused.
Returns
None.

◆ enableAutoPlay:opt_type:

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

Set the flag to decide whether the media should automatically play when activated.

Parameters
[in]is_auto_playYES means the media should automatically play when activated, while NO 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_typeMedia option type. Please refer to values starting from FSRenditionMediaOptionMustBeHonored and this should be one of these values. Default value: FSRenditionMediaOptionBestEffort.
Returns
None.

◆ enableControlBarVisible:

- (void) enableControlBarVisible: (BOOL)  is_visible

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.

Parameters
[in]is_visibleYES means to display a player-specific controller user interface, while NO means not to display such user interface.
Returns
None.

◆ enableControlBarVisible:opt_type:

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

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.

Parameters
[in]is_visibleYES means to display a player-specific controller user interface, while NO means not to display such user interface.
[in]opt_typeMedia option type. Please refer to values starting from FSRenditionMediaOptionMustBeHonored and this should be one of these values. Default value: FSRenditionMediaOptionBestEffort.
Returns
None.

◆ enableFloatingWindowCloseButton:

- (void) enableFloatingWindowCloseButton: (BOOL)  is_visible

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 FSRenditionWindowTypeFloating.

Parameters
[in]is_visibleYES means the floating window should include user interface elements that allow a user to close a floating window, while NO means the floating window does not need to include such user interface element.
Returns
None.

◆ enableFloatingWindowCloseButton:opt_type:

- (void) enableFloatingWindowCloseButton: (BOOL)  is_visible
opt_type: (FSRenditionMediaOptionType 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.

This property is only useful when the windows type is FSRenditionWindowTypeFloating.

Parameters
[in]is_visibleYES means the floating window should include user interface elements that allow a user to close a floating window, while NO means the floating window does not need to include such user interface element.
[in]opt_typeMedia option type. Please refer to values starting from FSRenditionMediaOptionMustBeHonored and this should be one of these values. Default value: FSRenditionMediaOptionBestEffort.
Returns
None.

◆ enableFloatingWindowTitleBar:

- (void) enableFloatingWindowTitleBar: (BOOL)  is_visible

Set flag to specify if the floating window should have a title bar.

This property is only useful when the windows type is FSRenditionWindowTypeFloating.

Parameters
[in]is_visibleYES means the floating window should have a title bar, while NO means the floating window does not need to have a title bar.
Returns
None.

◆ enableFloatingWindowTitleBar:opt_type:

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

Set flag to specify if the floating window should have a title bar.

This property is only useful when the windows type is FSRenditionWindowTypeFloating.

Parameters
[in]is_visibleYES means the floating window should have a title bar, while NO means the floating window does not need to have a title bar.
[in]opt_typeMedia option type. Please refer to values starting from FSRenditionMediaOptionMustBeHonored and this should be one of these values. Default value: FSRenditionMediaOptionBestEffort.
Returns
None.

◆ getCptr

- (void*) getCptr

Reimplemented from FSBase.

◆ getDict

- (FSPDFDictionary *) getDict

Get PDF dictionary of current object.

Returns
The PDF dictionary. If there is any error, this function will return nil.

◆ getFloatingWindowHeight

- (int) getFloatingWindowHeight

Get the height of floating window, in pixels.

This property is necessary when the windows type is FSRenditionWindowTypeFloating.

Returns
Height of floating window, in pixels.

◆ getFloatingWindowWidth

- (int) getFloatingWindowWidth

Get the width of floating window, in pixels.

This property is necessary when the windows type is FSRenditionWindowTypeFloating.

Returns
Width of floating window, in pixels.

◆ getMediaPlayer:index:

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

Get a media player object by index for specified type.

Parameters
[in]typeMedia player type. Please refer to values starting from FSRenditionMediaPlayerMustUsed and this should be one of these values.
[in]indexIndex of the media player object to be retrieved. Valid range: from 0 to (count-1). count is returned by function FSRendition::getMediaPlayerCount:.
Returns
A media player object.

◆ getMediaPlayerCount:

- (int) getMediaPlayerCount: (FSRenditionMediaPlayerType type

Get the count of media player objects for specified type.

Parameters
[in]typeMedia player type. Please refer to values starting from FSRenditionMediaPlayerMustUsed and this should be one of these values.
Returns
The count of media player objects for specified type.

◆ hasFloatingWindowCloseButton

- (BOOL) hasFloatingWindowCloseButton

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 FSRenditionWindowTypeFloating.

Returns
YES means the floating window should include user interface elements that allow a user to close a floating window, while NO means the floating window does not need to include such user interface element. If no value for such property is defined in the rendition object, YES would be returned by default.

◆ hasFloatingWindowTitleBar

- (BOOL) hasFloatingWindowTitleBar

Check if the floating window should have a title bar.

This property is only useful when the windows type is FSRenditionWindowTypeFloating.

Returns
YES means the floating window should have a title bar, while NO means the floating window does not need to have a title bar. If no value for such property is defined in the rendition object, YES would be returned by default.

◆ hasMediaClip

- (BOOL) hasMediaClip

Check if current rendition object contains a media clip.

Returns
YES means current rendition object contains a media clip, while NO means current rendition object does not contain any media clip.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

Reimplemented from FSBase.

◆ initWithOther:

- (id) initWithOther: (FSRendition*)  other

Constructor, with another rendition object.

Parameters
[in]otherAnother rendition object.

◆ initWithPdf_doc:

- (id) initWithPdf_doc: (FSPDFDoc*)  pdf_doc

Constructor, with parameters.

Parameters
[in]pdf_docA valid PDF document object.

◆ initWithPdf_doc:rendition_dict:

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

Constructor, with parameters.

Parameters
[in]pdf_docA valid PDF document object.
[in]rendition_dictThe PDF dictionary for a rendition object in PDF document represented by parameter pdf_doc. If this is nil that means to construct a new rendition object in PDF document represented by parameter pdf_obj. Default value: nil.

◆ isAutoPlay

- (BOOL) isAutoPlay

Check whether the media should automatically play when activated.

Returns
YES means the media should automatically play when activated, while NO means the media should be initially paused when activated (for example, the first frame is displayed). Relevant only for media that may be paused. If no value for such property is defined in the rendition object, YES would be returned by default.

◆ isControlBarVisible

- (BOOL) isControlBarVisible

Check whether to display a player-specific controller user interface (for example, play/pause/stop controls) when playing.

Returns
YES means to display a player-specific controller user interface, while NO means not to display such user interface. If no value for such property is defined in the rendition object, NO would be returned by default.

◆ isEmpty

- (BOOL) isEmpty

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
YES means current object is empty, while NO means not.

◆ NS_UNAVAILABLE

- (id) NS_UNAVAILABLE

◆ removeMediaPlayer:player:

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

Remove a media player object for specified type.

Parameters
[in]typeMedia player type. Please refer to values starting from FSRenditionMediaPlayerMustUsed and this should be one of these values.
[in]playerA media player object to be removed.
Returns
None.

◆ setBackgroundColor:opt_type:

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

◆ setBackgroundOpacity:opt_type:

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

◆ setDuration:opt_type:

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

◆ setFitStyle:opt_type:

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

◆ setFloatingWindowOffscreenEvent:opt_type:

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

◆ setFloatingWindowPosition:opt_type:

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

◆ setFloatingWindowRelatedWindowType:opt_type:

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

◆ setFloatingWindowResizeType:opt_type:

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

◆ setFloatingWindowSize:height:

- (void) setFloatingWindowSize: (int)  width
height: (int)  height 

Set the size of floating window, in pixels.

This property is necessary when the windows type is FSRenditionWindowTypeFloating.

Parameters
[in]widthWidth of floating window, in pixels. This value should be larger than 0.
[in]heightHeight of floating window, in pixels. This value should be larger than 0.
Returns
None.

◆ setFloatingWindowSize:height:opt_type:

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

Set the size of floating window, in pixels.

This property is necessary when the windows type is FSRenditionWindowTypeFloating.

Parameters
[in]widthWidth of floating window, in pixels. This value should be larger than 0.
[in]heightHeight of floating window, in pixels. This value should be larger than 0.
[in]opt_typeMedia option type. Please refer to values starting from FSRenditionMediaOptionMustBeHonored and this should be one of these values. Default value: FSRenditionMediaOptionBestEffort.
Returns
None.

◆ setFloatingWindowTitles:opt_type:

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

◆ setMediaBaseURL:opt_type:

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

◆ setMonitorSpecifier:opt_type:

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

◆ setRepeatCount:opt_type:

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

◆ setVolume:opt_type:

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

◆ setWindowType:opt_type:

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

Property Documentation

◆ backgroundColor

- (unsigned int) backgroundColor
readwritenonatomicassign

Get or Set the background color for the rectangle in which the media is being played.

◆ backgroundOpacity

- (float) backgroundOpacity
readwritenonatomicassign

Get or Set the background opacity. (ignored for full-screen and hidden windows)

◆ duration

- (int) duration
readwritenonatomicassign

Get or Set the intrinsic duration.

◆ fitStyle

- (FSRenditionMediaPlayerFitStyle) fitStyle
readwritenonatomicassign

Get or 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.

◆ floatingWindowOffscreenEvent

- (FSRenditionFloatingWindowOffscreenEvent) floatingWindowOffscreenEvent
readwritenonatomicassign

Get or 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 FSRenditionWindowTypeFloating.

◆ floatingWindowPosition

- (FSPosition) floatingWindowPosition
readwritenonatomicassign

Get or Set the position where floating window should be positioned to the related window.

This property is only useful when the windows type is FSRenditionWindowTypeFloating.
Window relative specifies the place to which the floating window should be positioned.

◆ floatingWindowRelatedWindowType

- (FSRenditionFloatingWindowRelatedWindowType) floatingWindowRelatedWindowType
readwritenonatomicassign

Get or Set the window relative type.

This property is only useful when the windows type is FSRenditionWindowTypeFloating.
Related window type specifies the place to which the floating window should be positioned.

◆ floatingWindowResizeType

- (FSRenditionFloatingWindowResizeType) floatingWindowResizeType
readwritenonatomicassign

Get or 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 FSRenditionWindowTypeFloating.

◆ floatingWindowTitles

- (NSArray< NSString * > *) floatingWindowTitles
readwritenonatomiccopy

Get or 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 FSRenditionWindowTypeFloating.
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.

◆ mediaBaseURL

- (NSString *) mediaBaseURL
readwritenonatomiccopy

Get or Set the base URL.

Base URL is an absolute URL which is used in resolving any relative URLs found within the media data.

◆ mediaClipContentType

- (NSString *) mediaClipContentType
readwritenonatomiccopy

Get or 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.

◆ mediaClipFile

- (FSFileSpec *) mediaClipFile
readwritenonatomiccopy

Get or Set the file specification of the actual media data.

◆ mediaClipName

- (NSString *) mediaClipName
readwritenonatomiccopy

Get or Set the name of the media clip, for use in user interface.

◆ mediaDescriptions

- (NSArray< NSString * > *) mediaDescriptions
readwritenonatomiccopy

Get or 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.

◆ monitorSpecifier

- (FSRenditionMonitorSpecifier) monitorSpecifier
readwritenonatomicassign

Get or 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.

◆ permission

- (FSRenditionMediaPermission) permission
readwritenonatomicassign

Get or 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.

◆ renditionName

- (NSString *) renditionName
readwritenonatomiccopy

Get or Set the name.

This name can be used for name tree lookup by JavaSript actions and can also be used in user interface.

◆ repeatCount

- (int) repeatCount
readwritenonatomicassign

Get or Set the repeat count, similar to SMIL's repeatCount attribute.

◆ volume

- (int) volume
readwritenonatomicassign

Get or Set the volume that specifies the desired volume level as a percentage of recorded volume level.

◆ windowType

- (FSRenditionWindowType) windowType
readwritenonatomicassign

Get or Set the type of window that the media should play in.