Foxit PDF SDK
fsdk.MediaSettings类 参考

Public 成员函数

def GetAuto_play ()
 Get 指定媒体片段是否应在播放器打开后自动开始播放。 更多...
 
def GetBase_url ()
 Get 用于解析媒体片段中使用的任何相对URL的基础URL。 更多...
 
def GetBg_color ()
 Get 媒体播放器窗口的背景颜色。格式:0xRRGGBB 更多...
 
def GetBg_opacity ()
 Get 媒体播放器窗口的背景不透明度。 更多...
 
def GetDuration ()
 Get 播放将花费的时间(以秒为单位)。 更多...
 
def GetFloating_wnd_info ()
 Get 包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。 更多...
 
def GetIs_visible ()
 Get 布尔值,指定播放器是否应该可见。 更多...
 
def GetPage ()
 Get 对于停靠的媒体播放器,此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器,此属性被忽略。 更多...
 
def GetRepeat ()
 Get 媒体播放应自动重复的次数。 更多...
 
def GetShow_ui ()
 Get 布尔值,指定媒体播放器的控件是否应该可见。 更多...
 
def GetVolume ()
 Get 指定播放音量。值0表示静音,值100表示正常(全音量)。 更多...
 
def GetWindow_type ()
 Get 定义媒体播放器应在哪种类型的窗口中创建。请参考从 fsdk.MediaSettingsE_PlayerWindowTypeDockedPage 开始的值,这应该是这些值中的一个。 更多...
 
def Set (auto_play, base_url, bg_color, bg_opacity, duration, page, repeat, show_ui, is_visible, volume, window_type, floating_wnd_info)
 设置值。 更多...
 
def SetAuto_play (value)
 Set 指定媒体片段是否应在播放器打开后自动开始播放。 更多...
 
def SetBase_url (value)
 Set 用于解析媒体片段中使用的任何相对URL的基础URL。 更多...
 
def SetBg_color (value)
 Set 媒体播放器窗口的背景颜色。格式:0xRRGGBB 更多...
 
def SetBg_opacity (value)
 Set 媒体播放器窗口的背景不透明度。 更多...
 
def SetDuration (value)
 Set 播放将花费的时间(以秒为单位)。 更多...
 
def SetFloating_wnd_info (value)
 Set 包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。 更多...
 
def SetIs_visible (value)
 Set 布尔值,指定播放器是否应该可见。 更多...
 
def SetPage (value)
 Set 对于停靠的媒体播放器,此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器,此属性被忽略。 更多...
 
def SetRepeat (value)
 Set 媒体播放应自动重复的次数。 更多...
 
def SetShow_ui (value)
 Set 布尔值,指定媒体播放器的控件是否应该可见。 更多...
 
def SetVolume (value)
 Set 指定播放音量。值0表示静音,值100表示正常(全音量)。 更多...
 
def SetWindow_type (value)
 Set 定义媒体播放器应在哪种类型的窗口中创建。请参考从 fsdk.MediaSettingsE_PlayerWindowTypeDockedPage 开始的值,这应该是这些值中的一个。 更多...
 

详细描述

此类表示媒体设置。

成员函数说明

◆ GetAuto_play()

fsdk.MediaSettings.GetAuto_play ( )

Get 指定媒体片段是否应在播放器打开后自动开始播放。

true 表示自动播放,false 表示不自动播放。

返回
指定媒体片段是否应在播放器打开后自动开始播放。

◆ GetBase_url()

fsdk.MediaSettings.GetBase_url ( )

Get 用于解析媒体片段中使用的任何相对URL的基础URL。

例如,如果媒体打开一个网页。没有默认值;如果未指定, 相对URL的解释将根据媒体播放器而变化,但在大多数情况下不会工作。

返回
用于解析媒体片段中使用的任何相对URL的基础URL。

◆ GetBg_color()

fsdk.MediaSettings.GetBg_color ( )

Get 媒体播放器窗口的背景颜色。格式:0xRRGGBB

返回
媒体播放器窗口的背景颜色。格式:0xRRGGBB

◆ GetBg_opacity()

fsdk.MediaSettings.GetBg_opacity ( )

Get 媒体播放器窗口的背景不透明度。

返回
媒体播放器窗口的背景不透明度。

◆ GetDuration()

fsdk.MediaSettings.GetDuration ( )

Get 播放将花费的时间(以秒为单位)。

返回
播放将花费的时间(以秒为单位)。

◆ GetFloating_wnd_info()

fsdk.MediaSettings.GetFloating_wnd_info ( )

Get 包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。

返回
包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。

◆ GetIs_visible()

fsdk.MediaSettings.GetIs_visible ( )

Get 布尔值,指定播放器是否应该可见。

返回
布尔值,指定播放器是否应该可见。

◆ GetPage()

fsdk.MediaSettings.GetPage ( )

Get 对于停靠的媒体播放器,此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器,此属性被忽略。

返回
对于停靠的媒体播放器,此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器,此属性被忽略。

◆ GetRepeat()

fsdk.MediaSettings.GetRepeat ( )

Get 媒体播放应自动重复的次数。

默认值1导致媒体播放一次。

返回
媒体播放应自动重复的次数。

◆ GetShow_ui()

fsdk.MediaSettings.GetShow_ui ( )

Get 布尔值,指定媒体播放器的控件是否应该可见。

返回
布尔值,指定媒体播放器的控件是否应该可见。

◆ GetVolume()

fsdk.MediaSettings.GetVolume ( )

Get 指定播放音量。值0表示静音,值100表示正常(全音量)。

返回
指定播放音量。值0表示静音,值100表示正常(全音量)。

◆ GetWindow_type()

fsdk.MediaSettings.GetWindow_type ( )

Get 定义媒体播放器应在哪种类型的窗口中创建。请参考从 fsdk.MediaSettingsE_PlayerWindowTypeDockedPage 开始的值,这应该是这些值中的一个。

返回
定义媒体播放器应在哪种类型的窗口中创建。请参考从 fsdk.MediaSettingsE_PlayerWindowTypeDockedPage 开始的值,这应该是这些值中的一个。

◆ 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 
)

设置值。

参数
[in]auto_play指定媒体片段是否应在播放器打开后自动开始播放。
[in]base_url用于解析媒体片段中使用的任何相对URL的基础URL。
[in]bg_color媒体播放器窗口的背景颜色。
[in]bg_opacity媒体播放器窗口的背景不透明度。
[in]duration播放将花费的时间(以秒为单位)。
[in]page播放器应停靠的页面编号。
[in]repeat媒体播放应自动重复的次数。
[in]show_ui布尔值,指定媒体播放器的控件是否应该可见。
[in]is_visible布尔值,指定播放器是否应该可见。
[in]volume指定播放音量。值0表示静音,值100表示正常(全音量)。
[in]window_type定义媒体播放器应在哪种类型的窗口中创建。
[in]floating_wnd_info包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。
返回
None.

◆ SetAuto_play()

fsdk.MediaSettings.SetAuto_play (   value)

Set 指定媒体片段是否应在播放器打开后自动开始播放。

true 表示自动播放,false 表示不自动播放。

参数
[in]value指定媒体片段是否应在播放器打开后自动开始播放。
返回
None.

◆ SetBase_url()

fsdk.MediaSettings.SetBase_url (   value)

Set 用于解析媒体片段中使用的任何相对URL的基础URL。

例如,如果媒体打开一个网页。没有默认值;如果未指定, 相对URL的解释将根据媒体播放器而变化,但在大多数情况下不会工作。

参数
[in]value用于解析媒体片段中使用的任何相对URL的基础URL。
返回
None.

◆ SetBg_color()

fsdk.MediaSettings.SetBg_color (   value)

Set 媒体播放器窗口的背景颜色。格式:0xRRGGBB

参数
[in]value媒体播放器窗口的背景颜色。格式:0xRRGGBB
返回
None.

◆ SetBg_opacity()

fsdk.MediaSettings.SetBg_opacity (   value)

Set 媒体播放器窗口的背景不透明度。

参数
[in]value媒体播放器窗口的背景不透明度。
返回
None.

◆ SetDuration()

fsdk.MediaSettings.SetDuration (   value)

Set 播放将花费的时间(以秒为单位)。

参数
[in]value播放将花费的时间(以秒为单位)。
返回
None.

◆ SetFloating_wnd_info()

fsdk.MediaSettings.SetFloating_wnd_info (   value)

Set 包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。

参数
[in]value包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。
返回
None.

◆ SetIs_visible()

fsdk.MediaSettings.SetIs_visible (   value)

Set 布尔值,指定播放器是否应该可见。

参数
[in]value布尔值,指定播放器是否应该可见。
返回
None.

◆ SetPage()

fsdk.MediaSettings.SetPage (   value)

Set 对于停靠的媒体播放器,此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器,此属性被忽略。

参数
[in]value对于停靠的媒体播放器,此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器,此属性被忽略。
返回
None.

◆ SetRepeat()

fsdk.MediaSettings.SetRepeat (   value)

Set 媒体播放应自动重复的次数。

默认值1导致媒体播放一次。

参数
[in]value媒体播放应自动重复的次数。
返回
None.

◆ SetShow_ui()

fsdk.MediaSettings.SetShow_ui (   value)

Set 布尔值,指定媒体播放器的控件是否应该可见。

参数
[in]value布尔值,指定媒体播放器的控件是否应该可见。
返回
None.

◆ SetVolume()

fsdk.MediaSettings.SetVolume (   value)

Set 指定播放音量。值0表示静音,值100表示正常(全音量)。

参数
[in]value指定播放音量。值0表示静音,值100表示正常(全音量)。
返回
None.

◆ SetWindow_type()

fsdk.MediaSettings.SetWindow_type (   value)

Set 定义媒体播放器应在哪种类型的窗口中创建。请参考从 fsdk.MediaSettingsE_PlayerWindowTypeDockedPage 开始的值,这应该是这些值中的一个。

参数
[in]value定义媒体播放器应在哪种类型的窗口中创建。请参考从 fsdk.MediaSettingsE_PlayerWindowTypeDockedPage 开始的值,这应该是这些值中的一个。
返回
None.