Foxit PDF SDK
FSDK.MediaPlayerCallback Class Reference

Public Member Functions

 Close ()
 A callback function to close the media player. More...
 
 GetPlayerSettings ()
 A callback function to get the media player settings. More...
 
 GetState ()
 A callback function to get the media player state. More...
 
 Play ()
 A callback function to play the media player. More...
 
 Release ()
 A callback function used to release current callback object itself. More...
 
 Seek (current_pos)
 A callback function to seek the media player. More...
 
 Stop ()
 A callback function to stop the media player. More...
 

Static Public Attributes

static e_JSMediaPlayerStateClose
 media player state: Close.
 
static e_JSMediaPlayerStateOpen
 Enumeration for media player state. More...
 
static e_JSMediaPlayerStatePlaying
 media player state: Playing.
 
static e_JSMediaPlayerStateStop
 media player state: Stop.
 
static e_JSMediaPlayerStateSuspend
 media player state: Suspend.
 

Detailed Description

This class represents a callback object for performing media player actions. All the pure virtual functions in this class are used as callback functions and should be implemented by user.

Member Function Documentation

◆ Close()

FSDK.MediaPlayerCallback.Close ( )

A callback function to close the media player.

This callback function will be triggered by the javascript method "MediaPlayer.close".

Returns
None.

◆ GetPlayerSettings()

FSDK.MediaPlayerCallback.GetPlayerSettings ( )

A callback function to get the media player settings.

This callback function will be triggered by the javascript property "MediaPlayer.visible".

Returns
A FSDK.MediaSettings object.

◆ GetState()

FSDK.MediaPlayerCallback.GetState ( )

A callback function to get the media player state.

This callback function will be triggered by the javascript property "MediaPlayer.isOpen".

Returns
The media player state.

◆ Play()

FSDK.MediaPlayerCallback.Play ( )

A callback function to play the media player.

This callback function will be triggered by the javascript method "MediaPlayer.play".

Returns
true means success, while false means failure.

◆ Release()

FSDK.MediaPlayerCallback.Release ( )

A callback function used to release current callback object itself.

Returns
None.

◆ Seek()

FSDK.MediaPlayerCallback.Seek ( current_pos  )

A callback function to seek the media player.

This callback function will be triggered by the javascript method "MediaPlayer.seek".

Parameters
[in]current_posIndicate the playback location.
Returns
true means success, while false means failure.

◆ Stop()

FSDK.MediaPlayerCallback.Stop ( )

A callback function to stop the media player.

This callback function will be triggered by the javascript method "MediaPlayer.stop".

Returns
true means success, while false means failure.

Member Data Documentation

◆ e_JSMediaPlayerStateOpen

FSDK.MediaPlayerCallback.e_JSMediaPlayerStateOpen
static

Enumeration for media player state.

Values of this enumeration should be used alone.

media player state: Open.