Foxit PDF SDK
fsdk.PlayerArgs Class Reference

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

Detailed Description

This class represents player args.

Member Function Documentation

◆ GetAudio_format()

fsdk.PlayerArgs.GetAudio_format ( )

Get the audio format, such as "audio/wav".

Returns
The audio format, such as "audio/wav".

◆ GetDoc()

fsdk.PlayerArgs.GetDoc ( )

Get the PDFDoc object of the document.

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

Returns
The PDFDoc object of the document.

◆ GetPlayer_settings()

fsdk.PlayerArgs.GetPlayer_settings ( )

Get a MediaSettings object.

Returns
A MediaSettings object.

◆ GetRendition()

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.

Returns
A fsdk.Rendition object (either a MediaRendition or a RenditionList).

◆ GetScreen_annot()

fsdk.PlayerArgs.GetScreen_annot ( )

Get a fsdk.Screen object.

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

Returns
A fsdk.Screen object.

◆ GetURL()

fsdk.PlayerArgs.GetURL ( )

Get either URL or rendition is required, with URL taking precedence.

Returns
Either URL or rendition is required, with URL taking precedence.

◆ Set()

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

◆ SetAudio_format()

fsdk.PlayerArgs.SetAudio_format (   value)

Set the audio format, such as "audio/wav".

Parameters
[in]valueThe audio format, such as "audio/wav".
Returns
None.

◆ SetDoc()

fsdk.PlayerArgs.SetDoc (   value)

Set the PDFDoc object of the document.

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

Parameters
[in]valueThe PDFDoc object of the document.
Returns
None.

◆ SetPlayer_settings()

fsdk.PlayerArgs.SetPlayer_settings (   value)

Set a MediaSettings object.

Parameters
[in]valueA MediaSettings object.
Returns
None.

◆ SetRendition()

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.

Parameters
[in]valueA fsdk.Rendition object (either a MediaRendition or a RenditionList).
Returns
None.

◆ SetScreen_annot()

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.

Parameters
[in]valueA fsdk.Screen object.
Returns
None.

◆ SetURL()

fsdk.PlayerArgs.SetURL (   value)

Set either URL or rendition is required, with URL taking precedence.

Parameters
[in]valueEither URL or rendition is required, with URL taking precedence.
Returns
None.