Foxit PDF SDK
 All Classes Namespaces Functions Enumerations Enumerator Properties Pages
foxit.pdf.actions.MediaPlayerCallback Class Reference

Inherits SystemIDisposable.

Public Types

enum  JSMediaPlayerState {
  JSMediaPlayerState.e_JSMediaPlayerStateOpen = 0, JSMediaPlayerState.e_JSMediaPlayerStateClose = 1, JSMediaPlayerState.e_JSMediaPlayerStatePlaying = 2, JSMediaPlayerState.e_JSMediaPlayerStateStop = 3,
  JSMediaPlayerState.e_JSMediaPlayerStateSuspend = 4
}
 Enumeration for media player state. More...
 

Public Member Functions

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

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 Enumeration Documentation

Enumeration for media player state.

Values of this enumeration should be used alone.

Enumerator
e_JSMediaPlayerStateOpen 

media player state: Open.

e_JSMediaPlayerStateClose 

media player state: Close.

e_JSMediaPlayerStatePlaying 

media player state: Playing.

e_JSMediaPlayerStateStop 

media player state: Stop.

e_JSMediaPlayerStateSuspend 

media player state: Suspend.

Member Function Documentation

void foxit.pdf.actions.MediaPlayerCallback.Close ( )
inlinevirtual

A callback function to close the media player.

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

Returns
None.
MediaSettings foxit.pdf.actions.MediaPlayerCallback.GetPlayerSettings ( )
inlinevirtual

A callback function to get the media player settings.

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

Returns
A MediaSettings object.
MediaPlayerCallback.JSMediaPlayerState foxit.pdf.actions.MediaPlayerCallback.GetState ( )
inlinevirtual

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.
bool foxit.pdf.actions.MediaPlayerCallback.Play ( )
inlinevirtual

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.
void foxit.pdf.actions.MediaPlayerCallback.Release ( )
inlinevirtual

A callback function used to release current callback object itself.

Returns
None.
bool foxit.pdf.actions.MediaPlayerCallback.Seek ( int  current_pos)
inlinevirtual

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.
bool foxit.pdf.actions.MediaPlayerCallback.Stop ( )
inlinevirtual

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.