Foxit PDF SDK
FSPlayerArgs Class Reference

Inherits NSObject.

Instance Methods

(id) - init
 Constructor.

 
(id) - initWithPlayer_args:
 Constructor, with another player args object.
More...
 
(void) - set:screen_annot:rendition:URL:audio_format:player_settings:
 Set values.
More...
 

Properties

NSString * audio_format
 The audio format, such as "audio/wav".

 
FSPDFDocdoc
 The FSPDFDoc object of the document.
More...
 
FSMediaSettingsplayer_settings
 A FSMediaSettings object.

 
FSRenditionrendition
 A FSRendition object (either a MediaRendition or a RenditionList).
More...
 
FSScreenscreen_annot
 A FSScreen object.
More...
 
NSString * uRL
 Either URL or rendition is required, with URL taking precedence.

 

Detailed Description

This class represents player args.

Method Documentation

◆ initWithPlayer_args:()

- (id) initWithPlayer_args: (FSPlayerArgs*)  player_args

Constructor, with another player args object.

Parameters
[in]player_argsAnother player args object.

◆ set:screen_annot:rendition:URL:audio_format:player_settings:()

- (void) set: (FSPDFDoc*)  doc
screen_annot: (FSScreen*)  screen_annot
rendition: (FSRendition*)  rendition
URL: (NSString *)  URL
audio_format: (NSString *)  audio_format
player_settings: (FSMediaSettings*)  player_settings 

Set values.

Parameters
[in]docThe FSPDFDoc object of the document. Required if both annot and rendition are omitted, for example, for URL playback.
[in]screen_annotA FSScreen object. Required for docked playback unless it is found in the event object or MediaSettings.
[in]renditionA FSRendition 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 FSMediaSettings object.
Returns
None.

Property Documentation

◆ doc

- (FSPDFDoc *) doc
readwritenonatomicweak

The FSPDFDoc object of the document.

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

◆ rendition

- (FSRendition *) rendition
readwritenonatomicweak

A FSRendition object (either a MediaRendition or a RenditionList).

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

◆ screen_annot

- (FSScreen *) screen_annot
readwritenonatomicweak

A FSScreen object.

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