Foxit PDF SDK

Public Member Functions | Static Public Attributes | List of all members
FoxitPDFSDKPython2.MediaPlayerCallback Class Reference

Inherits FoxitPDFSDKPython2._object.

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

## Static Public Attributes
| e_JSMediaPlayerStateClose = _fsdk.MediaPlayerCallback_e_JSMediaPlayerStateClose
| media player state: Close.
| e_JSMediaPlayerStateOpen = _fsdk.MediaPlayerCallback_e_JSMediaPlayerStateOpen
| media player state: Open.
| e_JSMediaPlayerStatePlaying = _fsdk.MediaPlayerCallback_e_JSMediaPlayerStatePlaying
| media player state: Playing.
| e_JSMediaPlayerStateStop = _fsdk.MediaPlayerCallback_e_JSMediaPlayerStateStop
| media player state: Stop.
| e_JSMediaPlayerStateSuspend = _fsdk.MediaPlayerCallback_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()

def FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.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 MediaSettings object.

## ◆ GetState()

def FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.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()

def FoxitPDFSDKPython2.MediaPlayerCallback.Release | ( |  | ) |

A callback function used to release current callback object itself.

Returns
  None.

## ◆ Seek()

def FoxitPDFSDKPython2.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_pos | Indicate the playback location.

Returns
  true means success, while false means failure.

## ◆ Stop()

def FoxitPDFSDKPython2.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.