foxit.pdf.MediaPlayer Class Reference
Inheritance diagram for foxit.pdf.MediaPlayer:
foxit.common.Base

Public Member Functions

 MediaPlayer (MediaPlayer other)
 Constructor, with another media player object.

 
PDFDictionary GetDict ()
 Get the PDF dictionary of current object.
More...
 
StringArray GetOSIdentifiers ()
 Get the string array that represents operating system identifiers.
More...
 
string GetSoftwareURI ()
 Get software URI that identifies a piece of software.
More...
 
bool IsEmpty ()
 Check whether current object is empty or not.
More...
 
void SetOSIdentifiers (StringArray identifier_array)
 Set the string array that represents operating system identifiers.
More...
 
void SetSoftwareURI (string uri)
 Get software URI that identifies a piece of software.
More...
 

Detailed Description

Class MediaPlayer provides methods to access to information regarding a specific media player.

Member Function Documentation

◆ GetDict()

PDFDictionary foxit.pdf.MediaPlayer.GetDict ( )
inline

Get the PDF dictionary of current object.

Returns
PDF dictionary of current object.

◆ GetOSIdentifiers()

StringArray foxit.pdf.MediaPlayer.GetOSIdentifiers ( )
inline

Get the string array that represents operating system identifiers.

Operating system identifiers in this array indicate which operating systems this object applies to. The defined values are the same as those defined for SMIL 2.0's systemOperatingSystem attribute. There may not be multiple copies of the same identifier in the array.

Returns
A string array that represents operating system identifiers. An empty array is considered to represent all operating systems.

◆ GetSoftwareURI()

string foxit.pdf.MediaPlayer.GetSoftwareURI ( )
inline

Get software URI that identifies a piece of software.

For more details, please refer to <PDF reference 1.7> P780 "Software URIs".

Returns
Software URI.

◆ IsEmpty()

bool foxit.pdf.MediaPlayer.IsEmpty ( )
inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ SetOSIdentifiers()

void foxit.pdf.MediaPlayer.SetOSIdentifiers ( StringArray  identifier_array)
inline

Set the string array that represents operating system identifiers.

Operating system identifiers in this array indicate which operating systems this object applies to. The defined values are the same as those defined for SMIL 2.0's systemOperatingSystem attribute. There may not be multiple copies of the same identifier in the array.

Parameters
identifier_arrayA string array that represents operating system identifiers. An empty array is considered to represent all operating systems.
Returns
None.

◆ SetSoftwareURI()

void foxit.pdf.MediaPlayer.SetSoftwareURI ( string  uri)
inline

Get software URI that identifies a piece of software.

This property is necessary for a MediaPlayer object. For more details, please refer to <PDF reference 1.7> P780 "Software URIs".

Parameters
uriSoftware URI. It should not be an empty string.
Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.