Foxit PDF SDK
|
Inherits FoxitPDFSDKPython2._object.
Public Member Functions | |
def | PlayerArgs () |
Constructor. More... | |
def | Set (doc, screen_annot, rendition, URL, audio_format, player_settings) |
Set values. More... | |
Static Public Attributes | |
audio_format = _swig_property(_fsdk.PlayerArgs_audio_format_get, _fsdk.PlayerArgs_audio_format_set) | |
The audio format, such as "audio/wav". | |
doc = _swig_property(_fsdk.PlayerArgs_doc_get, _fsdk.PlayerArgs_doc_set) | |
The PDFDoc object of the document. More... | |
player_settings = _swig_property(_fsdk.PlayerArgs_player_settings_get, _fsdk.PlayerArgs_player_settings_set) | |
A MediaSettings object. | |
rendition = _swig_property(_fsdk.PlayerArgs_rendition_get, _fsdk.PlayerArgs_rendition_set) | |
A FoxitPDFSDKPython2.Rendition object (either a MediaRendition or a RenditionList). More... | |
screen_annot = _swig_property(_fsdk.PlayerArgs_screen_annot_get, _fsdk.PlayerArgs_screen_annot_set) | |
A FoxitPDFSDKPython2.Screen object. More... | |
URL = _swig_property(_fsdk.PlayerArgs_URL_get, _fsdk.PlayerArgs_URL_set) | |
Either URL or rendition is required, with URL taking precedence. | |
This class represents player args.
def FoxitPDFSDKPython2.PlayerArgs.PlayerArgs | ( | ) |
Constructor.
Constructor, with another player args object.
Constructor, with parameters.
[in] | doc | The PDFDoc object of the document. Required if both annot and rendition are omitted, for example, for URL playback. |
[in] | screen_annot | A FoxitPDFSDKPython2.Screen object. Required for docked playback unless it is found in the event object or MediaSettings. |
[in] | rendition | A pdf::Rendition object (either a MediaRendition or a RenditionList). Required unless rendition is found in the event object or URL is present. |
[in] | URL | Either URL or rendition is required, with URL taking precedence. |
[in] | audio_format | The audio format, such as "audio/wav". |
[in] | player_settings | A MediaSettings object. |
[in] | player_args | Another player args object. |
def FoxitPDFSDKPython2.PlayerArgs.Set | ( | doc, | |
screen_annot, | |||
rendition, | |||
URL, | |||
audio_format, | |||
player_settings | |||
) |
Set values.
[in] | doc | The PDFDoc object of the document. Required if both annot and rendition are omitted, for example, for URL playback. |
[in] | screen_annot | A FoxitPDFSDKPython2.Screen object. Required for docked playback unless it is found in the event object or MediaSettings. |
[in] | rendition | A FoxitPDFSDKPython2.Rendition object (either a MediaRendition or a RenditionList). Required unless rendition is found in the event object or URL is present. |
[in] | URL | Either URL or rendition is required, with URL taking precedence. |
[in] | audio_format | The audio format, such as "audio/wav". |
[in] | player_settings | A MediaSettings object. |
|
static |
The PDFDoc object of the document.
Required if both annot and rendition are omitted, for example, for URL playback.
|
static |
A FoxitPDFSDKPython2.Rendition object (either a MediaRendition or a RenditionList).
Required unless rendition is found in the event object or URL is present.
|
static |
A FoxitPDFSDKPython2.Screen object.
Required for docked playback unless it is found in the "event" or "MediaSettings" of javascript.