Foxit PDF SDK
FoxitPDFSDKPython2.PlayerArgs Class Reference

Inherits FoxitPDFSDKPython2._object.

Public Member Functions

def PlayerArgs ()
 Constructor.

 
def PlayerArgs (doc, screen_annot, rendition, URL, audio_format, player_settings)
 Constructor, with parameters.
More...
 
def PlayerArgs (player_args)
 Constructor, with another player args object.
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.

 

Detailed Description

This class represents player args.

Constructor & Destructor Documentation

◆ PlayerArgs() [1/2]

def FoxitPDFSDKPython2.PlayerArgs.PlayerArgs (   doc,
  screen_annot,
  rendition,
  URL,
  audio_format,
  player_settings 
)

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 FoxitPDFSDKPython2.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]

def FoxitPDFSDKPython2.PlayerArgs.PlayerArgs (   player_args)

Constructor, with another player args object.

Parameters
[in]player_argsAnother player args object.

Member Function Documentation

◆ Set()

def FoxitPDFSDKPython2.PlayerArgs.Set (   doc,
  screen_annot,
  rendition,
  URL,
  audio_format,
  player_settings 
)

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 FoxitPDFSDKPython2.Screen object. Required for docked playback unless it is found in the event object or MediaSettings.
[in]renditionA FoxitPDFSDKPython2.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.

Member Data Documentation

◆ doc

FoxitPDFSDKPython2.PlayerArgs.doc = _swig_property(_fsdk.PlayerArgs_doc_get, _fsdk.PlayerArgs_doc_set)
static

The PDFDoc object of the document.

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

◆ rendition

FoxitPDFSDKPython2.PlayerArgs.rendition = _swig_property(_fsdk.PlayerArgs_rendition_get, _fsdk.PlayerArgs_rendition_set)
static

A FoxitPDFSDKPython2.Rendition object (either a MediaRendition or a RenditionList).

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

◆ screen_annot

FoxitPDFSDKPython2.PlayerArgs.screen_annot = _swig_property(_fsdk.PlayerArgs_screen_annot_get, _fsdk.PlayerArgs_screen_annot_set)
static

A FoxitPDFSDKPython2.Screen object.

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