Foxit PDF SDK  9.1
FSPlayerArgs Class Reference

PDF/X-1a.
More...

Inheritance diagram for FSPlayerArgs:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 Constructor.
More...
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithDoc:screen_annot:rendition:URL:audio_format:player_settings:
 Constructor, with parameters.
More...
 
(id) - initWithPlayer_args:
 Constructor, with another player args object.
More...
 
(void) - set:screen_annot:rendition:URL:audio_format:player_settings:
 Set values.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

NSString * audio_format
 The audio format, such as "audio/wav".
More...
 
FSPDFDocdoc
 The FSPDFDoc object of the document.
More...
 
FSMediaSettingsplayer_settings
 A FSMediaSettings object.
More...
 
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.
More...
 

Detailed Description

PDF/X-1a.

PDF/X-3.

PDF/X-4.

PDF/X-4p.

PDF/X-1a (Coated GRACoL 2006).

PDF/X-1a (ISO Coated v2 (ECI)).

PDF/X-1a (Japan Color 2001 Coated).

PDF/X-1a (PSO Coated v3 (ECI)).

PDF/X-3 (Coated GRACoL 2006).

PDF/X-3 (ISO Coated v2 (ECI)).

PDF/X-3 (Japan Color 2001 Coated).

PDFX-3 (PSO Coated v3 (ECI)).

PDF/X-4 (Coated GRACoL 2006).

PDF/X-4 (ISO Coated v2 (ECI)).

PDF/X-4 (Japan Color 2001 Coated).

PDF/X-4 (PSO Coated v3 (ECI)).

PDF/X-4 and create language layer views (ISO Coated v2 (ECI))).

This class represents player args.

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

Constructor.

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithDoc:screen_annot:rendition:URL:audio_format:player_settings:

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

Constructor, with parameters.

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

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

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ audio_format

- (NSString *) audio_format
readwritenonatomiccopy

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

◆ doc

- (FSPDFDoc *) doc
readwritenonatomiccopy

The FSPDFDoc object of the document.

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

◆ player_settings

- (FSMediaSettings *) player_settings
readwritenonatomiccopy

A FSMediaSettings object.

◆ rendition

- (FSRendition *) rendition
readwritenonatomiccopy

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
readwritenonatomiccopy

A FSScreen object.

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

◆ uRL

- (NSString *) uRL
readwritenonatomiccopy

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