|
Foxit PDF SDK
|
Public Member Functions | |
| def | AddMediaPlayer (type, player) |
| Add a media player object for specified type. More... | |
| def | EnableAutoPlay (is_auto_play, opt_type) |
| Set the flag to decide whether the media should automatically play when activated. More... | |
| def | EnableControlBarVisible (is_visible, opt_type) |
| Set the control bar visibility flag. More... | |
| def | EnableFloatingWindowCloseButton (is_visible, 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... | |
| def | EnableFloatingWindowTitleBar (is_visible, opt_type) |
| Set flag to specify if the floating window should have a title bar. More... | |
| def | GetBackgroundColor () |
| Get the background color for the rectangle in which the media is being played. More... | |
| def | GetBackgroundOpacity () |
| Get the background opacity. (ignored for full-screen and hidden windows) More... | |
| def | GetDict () |
| Get PDF dictionary of current object. More... | |
| def | GetDuration () |
| Get the intrinsic duration. More... | |
| def | GetFitStyle () |
| Get the fit style. More... | |
| def | GetFloatingWindowHeight () |
| Get the height of floating window, in pixels. More... | |
| def | 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... | |
| def | GetFloatingWindowPosition () |
| Get the position where floating window should be positioned to the related window. More... | |
| def | GetFloatingWindowRelatedWindowType () |
| Get the window relative type. More... | |
| def | GetFloatingWindowResizeType () |
| Get the resize type which specifies whether the floating window may be resized by a user. More... | |
| def | GetFloatingWindowTitles () |
| Get the multi-language text array which provides text to display on the floating window's title bar. More... | |
| def | GetFloatingWindowWidth () |
| Get the width of floating window, in pixels. More... | |
| def | GetMediaBaseURL () |
| Get the base URL. More... | |
| def | GetMediaClipContentType () |
| Get the content type (MIME type) of the media data. More... | |
| def | GetMediaClipFile () |
| Get the file specification of the actual media data. More... | |
| def | GetMediaClipName () |
| Get the name of the media clip, for use in user interface. More... | |
| def | GetMediaDescriptions () |
| Get the multi-language text array that provides alternate text descriptions for the media clip data in case it cannot be played. More... | |
| def | GetMediaPlayer (type, index) |
| Get a media player object by index for specified type. More... | |
| def | GetMediaPlayerCount (type) |
| Get the count of media player objects for specified type. More... | |
| def | GetMonitorSpecifier () |
| Get the monitor specifier type value. More... | |
| def | GetPermission () |
| Get the media permission. More... | |
| def | GetRenditionName () |
| Get the name. More... | |
| def | GetRepeatCount () |
| Get the repeat count, similar to SMIL's repeatCount attribute. More... | |
| def | GetVolume () |
| Get the volume that specifies the desired volume level as a percentage of recorded volume level. More... | |
| def | GetWindowType () |
| Get the type of window that the media should play in. More... | |
| def | HasFloatingWindowCloseButton () |
| Check if the floating window should include user interface elements that allow a user to close a floating window. More... | |
| def | HasFloatingWindowTitleBar () |
| Check if the floating window should have a title bar. More... | |
| def | HasMediaClip () |
| Check if current rendition object contains a media clip. More... | |
| def | IsAutoPlay () |
| Check whether the media should automatically play when activated. More... | |
| def | IsControlBarVisible () |
| Check whether to display a player-specific controller user interface (for example, play/pause/stop controls) when playing. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
| def | RemoveMediaPlayer (type, player) |
| Remove a media player object for specified type. More... | |
| def | SetBackgroundColor (color, opt_type) |
| Set the background color for the rectangle in which the media is being played. More... | |
| def | SetBackgroundOpacity (opacity, opt_type) |
| Set the background opacity. (ignored for full-screen and hidden windows) More... | |
| def | SetDuration (duration, opt_type) |
| Set the intrinsic duration. More... | |
| def | SetFitStyle (fit_style, opt_type) |
| Set the fit style. More... | |
| def | SetFloatingWindowOffscreenEvent (offscreen_event, 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... | |
| def | SetFloatingWindowPosition (position, opt_type) |
| Set the position where floating window should be positioned to the related window. More... | |
| def | SetFloatingWindowRelatedWindowType (window_type, opt_type) |
| Set the window relative type. More... | |
| def | SetFloatingWindowResizeType (resize_type, opt_type) |
| Set the resize type which specifies whether the floating window may be resized by a user. More... | |
| def | SetFloatingWindowSize (width, height, opt_type) |
| Set the size of floating window, in pixels. More... | |
| def | SetFloatingWindowTitles (titles, opt_type) |
| Set the multi-language text array which provides text to display on the floating window's title bar. More... | |
| def | SetMediaBaseURL (base_url, opt_type) |
| Set the base URL. More... | |
| def | SetMediaClipContentType (content_type) |
| Set the content type (MIME type) of the media data. More... | |
| def | SetMediaClipFile (file_specification) |
| Set the file specification of the actual media data. More... | |
| def | SetMediaClipName (name) |
| Set the name of the media clip, for use in user interface. More... | |
| def | SetMediaDescriptions (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... | |
| def | SetMonitorSpecifier (monitor_specifier, opt_type) |
| Set the monitor specifier type value. More... | |
| def | SetPermission (permission) |
| Set the media permission. More... | |
| def | SetRenditionName (name) |
| Get the name. More... | |
| def | SetRepeatCount (count, opt_type) |
| Set the repeat count, similar to SMIL's repeatCount attribute. More... | |
| def | SetVolume (volume, opt_type) |
| Set the volume that specifies the desired volume level as a percentage of recorded volume level. More... | |
| def | SetWindowType (window_type, 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")
| def fsdk.Rendition.AddMediaPlayer | ( | type, | |
| 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.
| [in] | type | Media player type. Please refer to values starting from fsdk.RenditionE_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. |
| def fsdk.Rendition.EnableAutoPlay | ( | is_auto_play, | |
| opt_type | |||
| ) |
Set the flag to decide 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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.EnableControlBarVisible | ( | is_visible, | |
| 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.
| [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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.EnableFloatingWindowCloseButton | ( | is_visible, | |
| 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 fsdk.RenditionE_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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.EnableFloatingWindowTitleBar | ( | is_visible, | |
| 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 fsdk.RenditionE_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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.GetBackgroundColor | ( | ) |
Get the background color for the rectangle in which the media is being played.
| def fsdk.Rendition.GetBackgroundOpacity | ( | ) |
Get the background opacity. (ignored for full-screen and hidden windows)
| def fsdk.Rendition.GetDict | ( | ) |
Get PDF dictionary of current object.
| def fsdk.Rendition.GetDuration | ( | ) |
Get the intrinsic duration.
-2: use intrinsic duration;
-1: infinity duration;
>= 0: explicit duration.
| def fsdk.Rendition.GetFitStyle | ( | ) |
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.
| def fsdk.Rendition.GetFloatingWindowHeight | ( | ) |
Get the height of floating window, in pixels.
This property is necessary when the windows type is fsdk.RenditionE_WindowTypeFloating .
| def fsdk.Rendition.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).
This property is only useful when the windows type is fsdk.RenditionE_WindowTypeFloating .
| def fsdk.Rendition.GetFloatingWindowPosition | ( | ) |
Get the position where floating window should be positioned to the related window.
This property is only useful when the windows type is fsdk.RenditionE_WindowTypeFloating .
Window relative specifies the place to which the floating window should be positioned.
| def fsdk.Rendition.GetFloatingWindowRelatedWindowType | ( | ) |
Get the window relative type.
This property is only useful when the windows type is fsdk.RenditionE_WindowTypeFloating .
Related window type specifies the place to which the floating window should be positioned.
| def fsdk.Rendition.GetFloatingWindowResizeType | ( | ) |
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 fsdk.RenditionE_WindowTypeFloating .
| def fsdk.Rendition.GetFloatingWindowTitles | ( | ) |
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 fsdk.RenditionE_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.
| def fsdk.Rendition.GetFloatingWindowWidth | ( | ) |
Get the width of floating window, in pixels.
This property is necessary when the windows type is fsdk.RenditionE_WindowTypeFloating .
| def fsdk.Rendition.GetMediaBaseURL | ( | ) |
Get the base URL.
Base URL is an absolute URL which is used in resolving any relative URLs found within the media data.
| def fsdk.Rendition.GetMediaClipContentType | ( | ) |
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.
| def fsdk.Rendition.GetMediaClipFile | ( | ) |
Get the file specification of the actual media data.
| def fsdk.Rendition.GetMediaClipName | ( | ) |
Get the name of the media clip, for use in user interface.
| def fsdk.Rendition.GetMediaDescriptions | ( | ) |
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.
| def fsdk.Rendition.GetMediaPlayer | ( | type, | |
| index | |||
| ) |
Get a media player object by index for specified type.
| [in] | type | Media player type. Please refer to values starting from fsdk.RenditionE_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 fsdk.Rendition.GetMediaPlayerCount . |
| def fsdk.Rendition.GetMediaPlayerCount | ( | type | ) |
Get the count of media player objects for specified type.
| [in] | type | Media player type. Please refer to values starting from fsdk.RenditionE_MediaPlayerMustUsed and this should be one of these values. |
| def fsdk.Rendition.GetMonitorSpecifier | ( | ) |
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.
| def fsdk.Rendition.GetPermission | ( | ) |
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.
| def fsdk.Rendition.GetRenditionName | ( | ) |
Get the name.
This name can be used for name tree lookup by JavaSript actions and can also be used in user interface.
| def fsdk.Rendition.GetRepeatCount | ( | ) |
Get the repeat count, similar to SMIL's repeatCount attribute.
| def fsdk.Rendition.GetVolume | ( | ) |
Get the volume that specifies the desired volume level as a percentage of recorded volume level.
| def fsdk.Rendition.GetWindowType | ( | ) |
Get the type of window that the media should play in.
| def fsdk.Rendition.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 fsdk.RenditionE_WindowTypeFloating .
| def fsdk.Rendition.HasFloatingWindowTitleBar | ( | ) |
Check if the floating window should have a title bar.
This property is only useful when the windows type is fsdk.RenditionE_WindowTypeFloating .
| def fsdk.Rendition.HasMediaClip | ( | ) |
Check if current rendition object contains a media clip.
| def fsdk.Rendition.IsAutoPlay | ( | ) |
Check whether the media should automatically play when activated.
| def fsdk.Rendition.IsControlBarVisible | ( | ) |
Check whether to display a player-specific controller user interface (for example, play/pause/stop controls) when playing.
| def fsdk.Rendition.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| def fsdk.Rendition.RemoveMediaPlayer | ( | type, | |
| player | |||
| ) |
Remove a media player object for specified type.
| [in] | type | Media player type. Please refer to values starting from fsdk.RenditionE_MediaPlayerMustUsed and this should be one of these values. |
| [in] | player | A media player object to be removed. |
| def fsdk.Rendition.SetBackgroundColor | ( | color, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetBackgroundOpacity | ( | opacity, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetDuration | ( | duration, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetFitStyle | ( | fit_style, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_MediaPlayerFitStyleMeet and this should be one of these values. |
| [in] | opt_type | Media option type. Please refer to values starting from fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetFloatingWindowOffscreenEvent | ( | offscreen_event, | |
| 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).
This property is only useful when the windows type is fsdk.RenditionE_WindowTypeFloating .
| [in] | offscreen_event | Event type for offscreen situation of floating window. Please refer to values starting from fsdk.RenditionE_FloatingWindowOffscreenEventNone and this should be one of these values. |
| [in] | opt_type | Media option type. Please refer to values starting from fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetFloatingWindowPosition | ( | position, | |
| opt_type | |||
| ) |
Set the position where floating window should be positioned to the related window.
This property is only useful when the windows type is fsdk.RenditionE_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 fsdk.RenditionE_FloatingWindowRelatedWindowDocument and this should be one of these values. |
| [in] | opt_type | Media option type. Please refer to values starting from fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetFloatingWindowRelatedWindowType | ( | window_type, | |
| opt_type | |||
| ) |
Set the window relative type.
This property is only useful when the windows type is fsdk.RenditionE_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 fsdk.RenditionE_FloatingWindowRelatedWindowDocument and this should be one of these values. |
| [in] | opt_type | Media option type. Please refer to values starting from fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetFloatingWindowResizeType | ( | resize_type, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_WindowTypeFloating .
| [in] | resize_type | Resize type. Please refer to values starting from fsdk.RenditionE_FloatingWindowResizeTypeNo and this should be one of these values. |
| [in] | opt_type | Media option type. Please refer to values starting from fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetFloatingWindowSize | ( | width, | |
| height, | |||
| opt_type | |||
| ) |
Set the size of floating window, in pixels.
This property is necessary when the windows type is fsdk.RenditionE_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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetFloatingWindowTitles | ( | titles, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetMediaBaseURL | ( | base_url, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetMediaClipContentType | ( | content_type | ) |
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 fsdk.Rendition.SetMediaClipFile .
| [in] | content_type | Content type (MIME type). |
| def fsdk.Rendition.SetMediaClipFile | ( | file_specification | ) |
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 fsdk.Rendition.SetMediaClipContentType after setting a new file specification.
| [in] | file_specification | A file specification object. |
| def fsdk.Rendition.SetMediaClipName | ( | name | ) |
Set the name of the media clip, for use in user interface.
| [in] | name | Name string to be set for the media clip. |
| def fsdk.Rendition.SetMediaDescriptions | ( | description_array | ) |
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. |
| def fsdk.Rendition.SetMonitorSpecifier | ( | monitor_specifier, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_MonitorSpecifierLargest and this should be one of these values. |
| [in] | opt_type | Media option type. Please refer to values starting from fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetPermission | ( | permission | ) |
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 fsdk.RenditionE_MediaPermTempNever and this should be one of these values. |
| def fsdk.Rendition.SetRenditionName | ( | name | ) |
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. |
| def fsdk.Rendition.SetRepeatCount | ( | count, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetVolume | ( | volume, | |
| opt_type | |||
| ) |
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 fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |
| def fsdk.Rendition.SetWindowType | ( | window_type, | |
| opt_type | |||
| ) |
Set the type of window that the media should play in.
| [in] | window_type | Windows type value. Please refer to values starting from fsdk.RenditionE_WindowTypeFloating and this should be one of these values. |
| [in] | opt_type | Media option type. Please refer to values starting from fsdk.RenditionE_MediaOptionMustBeHonored and this should be one of these values. Default value: fsdk.RenditionE_MediaOptionBestEffort . |