Foxit PDF SDK
|
Public Member Functions | |
PlayerArgs () | |
Constructor. | |
PlayerArgs (PDFDoc doc, Screen screen_annot, Rendition rendition, String URL, String audio_format, MediaSettings player_settings) | |
Constructor, with parameters. More... | |
PlayerArgs (PlayerArgs player_args) | |
Constructor, with another player args object. More... | |
synchronized void | delete () |
Clean up related resources immediately. More... | |
String | getAudio_format () |
Get the audio format, such as "audio/wav". More... | |
PDFDoc | getDoc () |
Get the PDFDoc object of the document. More... | |
MediaSettings | getPlayer_settings () |
Get a MediaSettings object. More... | |
Rendition | getRendition () |
Get a com.foxit.sdk.pdf.Rendition object (either a MediaRendition or a RenditionList). More... | |
Screen | getScreen_annot () |
Get a com.foxit.sdk.pdf.annots.Screen object. More... | |
String | getURL () |
Get either URL or rendition is required, with URL taking precedence. More... | |
void | set (PDFDoc doc, Screen screen_annot, Rendition rendition, String URL, String audio_format, MediaSettings player_settings) |
Set values. More... | |
void | setAudio_format (String value) |
Set the audio format, such as "audio/wav". More... | |
void | setDoc (PDFDoc value) |
Set the PDFDoc object of the document. More... | |
void | setPlayer_settings (MediaSettings value) |
Set a MediaSettings object. More... | |
void | setRendition (Rendition value) |
Set a com.foxit.sdk.pdf.Rendition object (either a MediaRendition or a RenditionList). More... | |
void | setScreen_annot (Screen value) |
Set a com.foxit.sdk.pdf.annots.Screen object. More... | |
void | setURL (String value) |
Set either URL or rendition is required, with URL taking precedence. More... | |
This class represents player args.
com.foxit.sdk.PlayerArgs.PlayerArgs | ( | PDFDoc | doc, |
Screen | screen_annot, | ||
Rendition | rendition, | ||
String | URL, | ||
String | audio_format, | ||
MediaSettings | player_settings | ||
) |
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 com.foxit.sdk.pdf.annots.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. |
com.foxit.sdk.PlayerArgs.PlayerArgs | ( | PlayerArgs | player_args | ) |
Constructor, with another player args object.
[in] | player_args | Another player args object. |
synchronized void com.foxit.sdk.PlayerArgs.delete | ( | ) |
Clean up related resources immediately.
com.foxit.sdk.PlayerArgs.getAudio_format | ( | ) |
Get the audio format, such as "audio/wav".
com.foxit.sdk.PlayerArgs.getDoc | ( | ) |
com.foxit.sdk.PlayerArgs.getPlayer_settings | ( | ) |
Get a MediaSettings object.
com.foxit.sdk.PlayerArgs.getRendition | ( | ) |
Get a com.foxit.sdk.pdf.Rendition object (either a MediaRendition or a RenditionList).
Required unless rendition is found in the event object or URL is present.
com.foxit.sdk.PlayerArgs.getScreen_annot | ( | ) |
Get a com.foxit.sdk.pdf.annots.Screen object.
Required for docked playback unless it is found in the "event" or "MediaSettings" of javascript.
com.foxit.sdk.PlayerArgs.getURL | ( | ) |
Get either URL or rendition is required, with URL taking precedence.
void com.foxit.sdk.PlayerArgs.set | ( | PDFDoc | doc, |
Screen | screen_annot, | ||
Rendition | rendition, | ||
String | URL, | ||
String | audio_format, | ||
MediaSettings | 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 com.foxit.sdk.pdf.annots.Screen object. Required for docked playback unless it is found in the event object or MediaSettings. |
[in] | rendition | A com.foxit.sdk.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. |
com.foxit.sdk.PlayerArgs.setAudio_format | ( | String | value | ) |
Set the audio format, such as "audio/wav".
[in] | value | The audio format, such as "audio/wav". |
com.foxit.sdk.PlayerArgs.setDoc | ( | PDFDoc | value | ) |
com.foxit.sdk.PlayerArgs.setPlayer_settings | ( | MediaSettings | value | ) |
com.foxit.sdk.PlayerArgs.setRendition | ( | Rendition | value | ) |
Set a com.foxit.sdk.pdf.Rendition object (either a MediaRendition or a RenditionList).
Required unless rendition is found in the event object or URL is present.
[in] | value | A com.foxit.sdk.pdf.Rendition object (either a MediaRendition or a RenditionList). |
com.foxit.sdk.PlayerArgs.setScreen_annot | ( | Screen | value | ) |
Set a com.foxit.sdk.pdf.annots.Screen object.
Required for docked playback unless it is found in the "event" or "MediaSettings" of javascript.
[in] | value | A com.foxit.sdk.pdf.annots.Screen object. |
com.foxit.sdk.PlayerArgs.setURL | ( | String | value | ) |
Set either URL or rendition is required, with URL taking precedence.
[in] | value | Either URL or rendition is required, with URL taking precedence. |