Foxit PDF SDK
foxit.pdf.actions.PlayerArgs Class Reference

Inherits SystemIDisposable.

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...
 
void Set (PDFDoc doc, Screen screen_annot, Rendition rendition, string URL, string audio_format, MediaSettings player_settings)
 Set values. More...
 

Properties

string audio_format [get, set]
 The audio format, such as "audio/wav".
 
PDFDocdoc [get, set]
 The PDFDoc object of the document. More...
 
MediaSettingsplayer_settings [get, set]
 A MediaSettings object.
 
Renditionrendition [get, set]
 A foxit.pdf.Rendition object (either a MediaRendition or a RenditionList). More...
 
Screenscreen_annot [get, set]
 A foxit.pdf.annots.Screen object. More...
 
string URL [get, set]
 Either URL or rendition is required, with URL taking precedence.
 

Detailed Description

This class represents player args.

Constructor & Destructor Documentation

◆ PlayerArgs() [1/2]

foxit.pdf.actions.PlayerArgs.PlayerArgs ( PDFDoc  doc,
Screen  screen_annot,
Rendition  rendition,
string  URL,
string  audio_format,
MediaSettings  player_settings 
)
inline

Constructor, with parameters.

Parameters
[in]docThe PDFDoc object of the document. Required if both annot and rendition are omitted, for example, for URL playback.
[in]screen_annotA foxit.pdf.annots.Screen object. Required for docked playback unless it is found in the event object or MediaSettings.
[in]renditionA pdf::Rendition object (either a MediaRendition or a RenditionList). Required unless rendition is found in the event object or URL is present.
[in]URLEither URL or rendition is required, with URL taking precedence.
[in]audio_formatThe audio format, such as "audio/wav".
[in]player_settingsA MediaSettings object.

◆ PlayerArgs() [2/2]

foxit.pdf.actions.PlayerArgs.PlayerArgs ( PlayerArgs  player_args)
inline

Constructor, with another player args object.

Parameters
[in]player_argsAnother player args object.

Member Function Documentation

◆ Set()

void foxit.pdf.actions.PlayerArgs.Set ( PDFDoc  doc,
Screen  screen_annot,
Rendition  rendition,
string  URL,
string  audio_format,
MediaSettings  player_settings 
)
inline

Set values.

Parameters
[in]docThe PDFDoc object of the document. Required if both annot and rendition are omitted, for example, for URL playback.
[in]screen_annotA foxit.pdf.annots.Screen object. Required for docked playback unless it is found in the event object or MediaSettings.
[in]renditionA foxit.pdf.Rendition object (either a MediaRendition or a RenditionList). Required unless rendition is found in the event object or URL is present.
[in]URLEither URL or rendition is required, with URL taking precedence.
[in]audio_formatThe audio format, such as "audio/wav".
[in]player_settingsA MediaSettings object.
Returns
None.

Property Documentation

◆ doc

PDFDoc foxit.pdf.actions.PlayerArgs.doc
getset

The PDFDoc object of the document.

Required if both annot and rendition are omitted, for example, for URL playback.

◆ rendition

Rendition foxit.pdf.actions.PlayerArgs.rendition
getset

A foxit.pdf.Rendition object (either a MediaRendition or a RenditionList).

Required unless rendition is found in the event object or URL is present.

◆ screen_annot

Screen foxit.pdf.actions.PlayerArgs.screen_annot
getset

A foxit.pdf.annots.Screen object.

Required for docked playback unless it is found in the "event" or "MediaSettings" of javascript.