|
Foxit PDF SDK
|
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... | |
This class represents media settings.
| 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.
| 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.
| fsdk.MediaSettings.GetBg_color | ( | ) |
Get the background color for the media player window.
| fsdk.MediaSettings.GetBg_opacity | ( | ) |
Get the background opacity for the media player window.
| fsdk.MediaSettings.GetDuration | ( | ) |
Get the amount of time in seconds that playback will take.
| fsdk.MediaSettings.GetFloating_wnd_info | ( | ) |
Get a FloatingInfo containing properties (listed below) that define the location and style of a floating window.
| fsdk.MediaSettings.GetIs_visible | ( | ) |
Get a boolean value that specifies whether the player should be visible.
| fsdk.MediaSettings.GetPage | ( | ) |
Get for a docked media player, this property is the number of the page on which the player should be docked.
| 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.
| fsdk.MediaSettings.GetShow_ui | ( | ) |
Get a boolean value that specifies whether the controls of the media player should be visible or not.
| fsdk.MediaSettings.GetVolume | ( | ) |
Get specify the playback volume.
| fsdk.MediaSettings.GetWindow_type | ( | ) |
Get that defines which type of window the media player should be created in.
| 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.
| [in] | auto_play | Specify whether the media clip should begin playing automatically after the player is opened. |
| [in] | base_url | The base URL to be used to resolve any relative URLs used in the media clip. |
| [in] | bg_color | The background color for the media player window. |
| [in] | bg_opacity | The background opacity for the media player window. |
| [in] | duration | The amount of time in seconds that playback will take. |
| [in] | page | The number of the page on which the player should be docked. |
| [in] | repeat | The number of times the media playback should automatically repeat. |
| [in] | show_ui | A boolean value that specifies whether the controls of the media player should be visible or not. |
| [in] | is_visible | A boolean value that specifies whether the player should be visible. |
| [in] | volume | Specify the playback volume. A value of 0 is muted, a value of 100 is normal (full) volume. |
| [in] | window_type | That defines which type of window the media player should be created in. |
| [in] | floating_wnd_info | A FloatingInfo object containing properties (listed below) that define the location and style of a floating window. |
| 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.
| [in] | value | Specify whether the media clip should begin playing automatically after the player is opened. |
| 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.
| [in] | value | The base URL to be used to resolve any relative URLs used in the media clip. |
| fsdk.MediaSettings.SetBg_color | ( | value | ) |
Set the background color for the media player window.
| [in] | value | The background color for the media player window. Format: 0xRRGGBB. |
| fsdk.MediaSettings.SetBg_opacity | ( | value | ) |
Set the background opacity for the media player window.
| [in] | value | The background opacity for the media player window. |
| fsdk.MediaSettings.SetDuration | ( | value | ) |
Set the amount of time in seconds that playback will take.
| [in] | value | The amount of time in seconds that playback will take. |
| fsdk.MediaSettings.SetFloating_wnd_info | ( | value | ) |
Set a FloatingInfo containing properties (listed below) that define the location and style of a floating window.
| [in] | value | A FloatingInfo containing properties (listed below) that define the location and style of a floating window. |
| fsdk.MediaSettings.SetIs_visible | ( | value | ) |
Set a boolean value that specifies whether the player should be visible.
| [in] | value | A boolean value that specifies whether the player should be visible. |
| 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.
| [in] | value | 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. |
| 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.
| [in] | value | The number of times the media playback should automatically repeat. |
| fsdk.MediaSettings.SetShow_ui | ( | value | ) |
Set a boolean value that specifies whether the controls of the media player should be visible or not.
| [in] | value | A boolean value that specifies whether the controls of the media player should be visible or not. |
| fsdk.MediaSettings.SetVolume | ( | value | ) |
Set specify the playback volume.
| [in] | value | Specify the playback volume. A value of 0 is muted, a value of 100 is normal (full) volume. |
| fsdk.MediaSettings.SetWindow_type | ( | value | ) |
Set that defines which type of window the media player should be created in.
| [in] | value | 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. |