Foxit PDF SDK
|
Public Member Functions | |
constructor (doc, screen_annot, rendition, URL, audio_format, player_settings) | |
Constructor, with parameters. More... | |
Set (doc, screen_annot, rendition, URL, audio_format, player_settings) | |
Set values. More... | |
Public Attributes | |
audio_format | |
The audio format, such as "audio/wav". | |
doc | |
The FSDK.PDFDoc object of the document. More... | |
player_settings | |
A FSDK.MediaSettings object. | |
rendition | |
A FSDK.Rendition object (either a MediaRendition or a RenditionList). More... | |
screen_annot | |
A FSDK.Screen object. More... | |
URL | |
Either URL or rendition is required, with URL taking precedence. | |
This class represents player args.
FSDK.PlayerArgs.constructor | ( | doc | , |
screen_annot | , | ||
rendition | , | ||
URL | , | ||
audio_format | , | ||
player_settings | |||
) |
Constructor, with parameters.
[in] | doc | The FSDK.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 FSDK.MediaSettings object. |
FSDK.PlayerArgs.Set | ( | doc | , |
screen_annot | , | ||
rendition | , | ||
URL | , | ||
audio_format | , | ||
player_settings | |||
) |
Set values.
[in] | doc | The FSDK.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 FSDK.MediaSettings object. |
FSDK.PlayerArgs.doc |
The FSDK.PDFDoc object of the document.
Required if both annot and rendition are omitted, for example, for URL playback.
FSDK.PlayerArgs.rendition |
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.screen_annot |
A FSDK.Screen object.
Required for docked playback unless it is found in the "event" or "MediaSettings" of javascript.