|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetAudio_format () |
| Get the audio format, such as "audio/wav". More... | |
| def | GetDoc () |
| Get the PDFDoc object of the document. More... | |
| def | GetPlayer_settings () |
| Get a MediaSettings object. More... | |
| def | GetRendition () |
| Get a fsdk.Rendition object (either a MediaRendition or a RenditionList). More... | |
| def | GetScreen_annot () |
| Get a fsdk.Screen object. More... | |
| def | GetURL () |
| Get either URL or rendition is required, with URL taking precedence. More... | |
| def | Set (doc, screen_annot, rendition, URL, audio_format, player_settings) |
| Set values. More... | |
| def | SetAudio_format (value) |
| Set the audio format, such as "audio/wav". More... | |
| def | SetDoc (value) |
| Set the PDFDoc object of the document. More... | |
| def | SetPlayer_settings (value) |
| Set a MediaSettings object. More... | |
| def | SetRendition (value) |
| Set a fsdk.Rendition object (either a MediaRendition or a RenditionList). More... | |
| def | SetScreen_annot (value) |
| Set a fsdk.Screen object. More... | |
| def | SetURL (value) |
| Set either URL or rendition is required, with URL taking precedence. More... | |
This class represents player args.
| fsdk.PlayerArgs.GetAudio_format | ( | ) |
Get the audio format, such as "audio/wav".
| fsdk.PlayerArgs.GetDoc | ( | ) |
| fsdk.PlayerArgs.GetPlayer_settings | ( | ) |
Get a MediaSettings object.
| fsdk.PlayerArgs.GetRendition | ( | ) |
Get a fsdk.Rendition object (either a MediaRendition or a RenditionList).
Required unless rendition is found in the event object or URL is present.
| fsdk.PlayerArgs.GetScreen_annot | ( | ) |
Get a fsdk.Screen object.
Required for docked playback unless it is found in the "event" or "MediaSettings" of javascript.
| fsdk.PlayerArgs.GetURL | ( | ) |
Get either URL or rendition is required, with URL taking precedence.
| def fsdk.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 fsdk.Screen object. Required for docked playback unless it is found in the event object or MediaSettings. |
| [in] | rendition | A fsdk.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. |
| fsdk.PlayerArgs.SetAudio_format | ( | value | ) |
Set the audio format, such as "audio/wav".
| [in] | value | The audio format, such as "audio/wav". |
| fsdk.PlayerArgs.SetDoc | ( | value | ) |
| fsdk.PlayerArgs.SetPlayer_settings | ( | value | ) |
| fsdk.PlayerArgs.SetRendition | ( | value | ) |
Set a fsdk.Rendition object (either a MediaRendition or a RenditionList).
Required unless rendition is found in the event object or URL is present.
| [in] | value | A fsdk.Rendition object (either a MediaRendition or a RenditionList). |
| fsdk.PlayerArgs.SetScreen_annot | ( | value | ) |
Set a fsdk.Screen object.
Required for docked playback unless it is found in the "event" or "MediaSettings" of javascript.
| [in] | value | A fsdk.Screen object. |
| fsdk.PlayerArgs.SetURL | ( | value | ) |
Set either URL or rendition is required, with URL taking precedence.
| [in] | value | Either URL or rendition is required, with URL taking precedence. |