Foxit PDF SDK

Public 成员函数 | Public 属性 | 静态 Public 属性 | 所有成员列表
FSDK::MediaSettings类 参考

## Public 成员函数
| constructor ()
| 构造函数。
| constructor (auto_play, base_url, bg_color, bg_opacity, duration, page, repeat, show_ui, is_visible, volume, window_type, floating_wnd_info)
| 带参数的构造函数。 更多...
| Set (auto_play, base_url, bg_color, bg_opacity, duration, page, repeat, show_ui, is_visible, volume, window_type, floating_wnd_info)
| 设置值。 更多...

## Public 属性
| auto_play
| 指定播放器打开后媒体剪辑是否应自动开始播放。 更多...
| base_url
| 用于解析媒体剪辑中使用的任何相对 URL 的基础 URL。 更多...
| bg_color
| 媒体播放器窗口的背景颜色。格式：0xRRGGBB
| bg_opacity
| 媒体播放器窗口的背景不透明度。
| duration
| 播放将花费的时间量（以秒为单位）。
| floating_wnd_info
| 一个 FSDK.FloatingInfo 对象，包含定义浮动窗口的位置和样式的属性（如下所列）。
| is_visible
| 一个布尔值，指定播放器是否应可见。
| page
| 对于停靠的媒体播放器，此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器，此属性被忽略。
| repeat
| 媒体播放应自动重复的次数。 更多...
| show_ui
| 一个布尔值，指定媒体播放器的控件是否应可见。
| volume
| 指定播放音量。值 0 为静音，值 100 为正常（全）音量。
| window_type
| 定义应在其中创建媒体播放器的窗口类型。请参考从 FSDK.MediaSettings.e_PlayerWindowTypeDockedPage 开始的值，此值应为这些值之一。

## 静态 Public 属性
static | e_PlayerWindowTypeDockedPage
| 媒体应在其中播放的窗口类型的枚举。 更多...
static | e_PlayerWindowTypeFloating
| 窗口类型：浮动窗口。
static | e_PlayerWindowTypeFullScreen
| 窗口类型：遮挡所有其他窗口的全屏窗口。

## 详细描述

此类表示媒体设置。

## 成员函数说明

## ◆ constructor()

FSDK::MediaSettings::constructor | ( | 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 | 一个 FSDK.FloatingInfo 对象，包含定义浮动窗口的位置和样式的属性（如下所列）。

## ◆ Set()

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 | 一个 FSDK.FloatingInfo 对象，包含定义浮动窗口的位置和样式的属性（如下所列）。

返回
  无。

## 类成员变量说明

## ◆ auto_play

FSDK::MediaSettings::auto_play

指定播放器打开后媒体剪辑是否应自动开始播放。

true 表示自动播放，而 false 表示不自动播放。

## ◆ base_url

FSDK::MediaSettings::base_url

用于解析媒体剪辑中使用的任何相对 URL 的基础 URL。

例如，如果媒体打开网页。没有默认值；如果未指定此值， 相对 URL 的解释将根据媒体播放器而有所不同，但在大多数情况下将无法工作。

## ◆ e_PlayerWindowTypeDockedPage

FSDK::MediaSettings::e_PlayerWindowTypeDockedPage
| static

媒体应在其中播放的窗口类型的枚举。

此枚举的值应单独使用。窗口类型：停靠页面窗口。

## ◆ repeat

FSDK::MediaSettings::repeat

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

默认值 1 会使媒体播放一次。