Foxit PDF SDK
fsdk.MediaSettings Class Reference

Public Member Functions

def GetAuto_play ()
 Get specify whether the media clip should begin playing automatically after the player is opened. More...
 
def GetBase_url ()
 Get the base URL to be used to resolve any relative URLs used in the media clip. More...
 
def GetBg_color ()
 Get the background color for the media player window. More...
 
def GetBg_opacity ()
 Get the background opacity for the media player window. More...
 
def GetDuration ()
 Get the amount of time in seconds that playback will take. More...
 
def GetFloating_wnd_info ()
 Get a FloatingInfo containing properties (listed below) that define the location and style of a floating window. More...
 
def GetIs_visible ()
 Get a boolean value that specifies whether the player should be visible. More...
 
def GetPage ()
 Get for a docked media player, this property is the number of the page on which the player should be docked. More...
 
def GetRepeat ()
 Get the number of times the media playback should automatically repeat. More...
 
def GetShow_ui ()
 Get a boolean value that specifies whether the controls of the media player should be visible or not. More...
 
def GetVolume ()
 Get specify the playback volume. More...
 
def GetWindow_type ()
 Get that defines which type of window the media player should be created in. More...
 
def Set (auto_play, base_url, bg_color, bg_opacity, duration, page, repeat, show_ui, is_visible, volume, window_type, floating_wnd_info)
 Set values.
More...
 
def SetAuto_play (value)
 Set specify whether the media clip should begin playing automatically after the player is opened. More...
 
def SetBase_url (value)
 Set the base URL to be used to resolve any relative URLs used in the media clip. More...
 
def SetBg_color (value)
 Set the background color for the media player window. More...
 
def SetBg_opacity (value)
 Set the background opacity for the media player window. More...
 
def SetDuration (value)
 Set the amount of time in seconds that playback will take. More...
 
def SetFloating_wnd_info (value)
 Set a FloatingInfo containing properties (listed below) that define the location and style of a floating window. More...
 
def SetIs_visible (value)
 Set a boolean value that specifies whether the player should be visible. More...
 
def SetPage (value)
 Set for a docked media player, this property is the number of the page on which the player should be docked. More...
 
def SetRepeat (value)
 Set the number of times the media playback should automatically repeat. More...
 
def SetShow_ui (value)
 Set a boolean value that specifies whether the controls of the media player should be visible or not. More...
 
def SetVolume (value)
 Set specify the playback volume. More...
 
def SetWindow_type (value)
 Set that defines which type of window the media player should be created in. More...
 

Detailed Description

This class represents media settings.

Member Function Documentation

◆ GetAuto_play()

fsdk.MediaSettings.GetAuto_play ( )

Get specify whether the media clip should begin playing automatically after the player is opened.

true means auto play, while false means not.

Returns
Specify whether the media clip should begin playing automatically after the player is opened.

◆ GetBase_url()

fsdk.MediaSettings.GetBase_url ( )

Get the base URL to be used to resolve any relative URLs used in the media clip.

For example, if the media opens a web page. There is no default value; if this is not specified, the interpretation of a relative URL will vary depending the media player, but in most cases will not work.

Returns
The base URL to be used to resolve any relative URLs used in the media clip.

◆ GetBg_color()

fsdk.MediaSettings.GetBg_color ( )

Get the background color for the media player window.

Returns
The background color for the media player window. Format: 0xRRGGBB.

◆ GetBg_opacity()

fsdk.MediaSettings.GetBg_opacity ( )

Get the background opacity for the media player window.

Returns
The background opacity for the media player window.

◆ GetDuration()

fsdk.MediaSettings.GetDuration ( )

Get the amount of time in seconds that playback will take.

Returns
The amount of time in seconds that playback will take.

◆ GetFloating_wnd_info()

fsdk.MediaSettings.GetFloating_wnd_info ( )

Get a FloatingInfo containing properties (listed below) that define the location and style of a floating window.

Returns
A FloatingInfo containing properties (listed below) that define the location and style of a floating window.

◆ GetIs_visible()

fsdk.MediaSettings.GetIs_visible ( )

Get a boolean value that specifies whether the player should be visible.

Returns
A boolean value that specifies whether the player should be visible.

◆ GetPage()

fsdk.MediaSettings.GetPage ( )

Get for a docked media player, this property is the number of the page on which the player should be docked.

Returns
For a docked media player, this property is the number of the page on which the player should be docked. For other types of media players, this property is ignored.

◆ GetRepeat()

fsdk.MediaSettings.GetRepeat ( )

Get the number of times the media playback should automatically repeat.

The default value of 1 causes the media to be played once.

Returns
The number of times the media playback should automatically repeat.

◆ GetShow_ui()

fsdk.MediaSettings.GetShow_ui ( )

Get a boolean value that specifies whether the controls of the media player should be visible or not.

Returns
A boolean value that specifies whether the controls of the media player should be visible or not.

◆ GetVolume()

fsdk.MediaSettings.GetVolume ( )

Get specify the playback volume.

Returns
Specify the playback volume. A value of 0 is muted, a value of 100 is normal (full) volume.

◆ GetWindow_type()

fsdk.MediaSettings.GetWindow_type ( )

Get that defines which type of window the media player should be created in.

Returns
That defines which type of window the media player should be created in. Please refer to values starting from fsdk.MediaSettingsE_PlayerWindowTypeDockedPage and this should be one of these values.

◆ Set()

def fsdk.MediaSettings.Set (   auto_play,
  base_url,
  bg_color,
  bg_opacity,
  duration,
  page,
  repeat,
  show_ui,
  is_visible,
  volume,
  window_type,
  floating_wnd_info 
)

Set values.

Parameters
[in]auto_playSpecify whether the media clip should begin playing automatically after the player is opened.
[in]base_urlThe base URL to be used to resolve any relative URLs used in the media clip.
[in]bg_colorThe background color for the media player window.
[in]bg_opacityThe background opacity for the media player window.
[in]durationThe amount of time in seconds that playback will take.
[in]pageThe number of the page on which the player should be docked.
[in]repeatThe number of times the media playback should automatically repeat.
[in]show_uiA boolean value that specifies whether the controls of the media player should be visible or not.
[in]is_visibleA boolean value that specifies whether the player should be visible.
[in]volumeSpecify the playback volume. A value of 0 is muted, a value of 100 is normal (full) volume.
[in]window_typeThat defines which type of window the media player should be created in.
[in]floating_wnd_infoA FloatingInfo object containing properties (listed below) that define the location and style of a floating window.
Returns
None.

◆ SetAuto_play()

fsdk.MediaSettings.SetAuto_play (   value)

Set specify whether the media clip should begin playing automatically after the player is opened.

true means auto play, while false means not.

Parameters
[in]valueSpecify whether the media clip should begin playing automatically after the player is opened.
Returns
None.

◆ SetBase_url()

fsdk.MediaSettings.SetBase_url (   value)

Set the base URL to be used to resolve any relative URLs used in the media clip.

For example, if the media opens a web page. There is no default value; if this is not specified, the interpretation of a relative URL will vary depending the media player, but in most cases will not work.

Parameters
[in]valueThe base URL to be used to resolve any relative URLs used in the media clip.
Returns
None.

◆ SetBg_color()

fsdk.MediaSettings.SetBg_color (   value)

Set the background color for the media player window.

Parameters
[in]valueThe background color for the media player window. Format: 0xRRGGBB.
Returns
None.

◆ SetBg_opacity()

fsdk.MediaSettings.SetBg_opacity (   value)

Set the background opacity for the media player window.

Parameters
[in]valueThe background opacity for the media player window.
Returns
None.

◆ SetDuration()

fsdk.MediaSettings.SetDuration (   value)

Set the amount of time in seconds that playback will take.

Parameters
[in]valueThe amount of time in seconds that playback will take.
Returns
None.

◆ SetFloating_wnd_info()

fsdk.MediaSettings.SetFloating_wnd_info (   value)

Set a FloatingInfo containing properties (listed below) that define the location and style of a floating window.

Parameters
[in]valueA FloatingInfo containing properties (listed below) that define the location and style of a floating window.
Returns
None.

◆ SetIs_visible()

fsdk.MediaSettings.SetIs_visible (   value)

Set a boolean value that specifies whether the player should be visible.

Parameters
[in]valueA boolean value that specifies whether the player should be visible.
Returns
None.

◆ SetPage()

fsdk.MediaSettings.SetPage (   value)

Set for a docked media player, this property is the number of the page on which the player should be docked.

Parameters
[in]valueFor a docked media player, this property is the number of the page on which the player should be docked. For other types of media players, this property is ignored.
Returns
None.

◆ SetRepeat()

fsdk.MediaSettings.SetRepeat (   value)

Set the number of times the media playback should automatically repeat.

The default value of 1 causes the media to be played once.

Parameters
[in]valueThe number of times the media playback should automatically repeat.
Returns
None.

◆ SetShow_ui()

fsdk.MediaSettings.SetShow_ui (   value)

Set a boolean value that specifies whether the controls of the media player should be visible or not.

Parameters
[in]valueA boolean value that specifies whether the controls of the media player should be visible or not.
Returns
None.

◆ SetVolume()

fsdk.MediaSettings.SetVolume (   value)

Set specify the playback volume.

Parameters
[in]valueSpecify the playback volume. A value of 0 is muted, a value of 100 is normal (full) volume.
Returns
None.

◆ SetWindow_type()

fsdk.MediaSettings.SetWindow_type (   value)

Set that defines which type of window the media player should be created in.

Parameters
[in]valueThat defines which type of window the media player should be created in. Please refer to values starting from fsdk.MediaSettingsE_PlayerWindowTypeDockedPage and this should be one of these values.
Returns
None.