Foxit PDF SDK

Public 类型 | Public 成员函数 | Public 属性 | 所有成员列表
foxit::MediaSettings类 参考

继承自 Object .

## Public 类型
enum | PlayerWindowType { e_PlayerWindowTypeDockedPage = 1, e_PlayerWindowTypeFloating = 2, e_PlayerWindowTypeFullScreen = 4 }
| 媒体播放窗口类型的枚举。 更多...

## Public 成员函数
| MediaSettings ()
| 构造函数。
| MediaSettings (bool auto_play, const wchar_t *base_url, foxit::RGB bg_color, float bg_opacity, int duration, int page, int repeat, bool show_ui, bool is_visible, int volume, PlayerWindowType window_type, const FloatingInfo &floating_wnd_info)
| 构造函数，带参数。 更多...
| MediaSettings (const MediaSettings &media_settings)
| 构造函数，使用另一个媒体设置对象。 更多...
MediaSettings & | operator= (const MediaSettings &media_settings)
| 赋值操作符。 更多...
void | Set (bool auto_play, const wchar_t *base_url, foxit::RGB bg_color, float bg_opacity, int duration, int page, int repeat, bool show_ui, bool is_visible, int volume, PlayerWindowType window_type, const FloatingInfo &floating_wnd_info)
| 设置值。 更多...

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

## 详细描述

此类表示媒体设置。

## 成员枚举类型说明

## ◆ PlayerWindowType

enum foxit::MediaSettings::PlayerWindowType

媒体播放窗口类型的枚举。

此枚举的值应单独使用。

枚举值
e_PlayerWindowTypeDockedPage | 窗口类型：停靠的页面窗口。
e_PlayerWindowTypeFloating | 窗口类型：浮动窗口。
e_PlayerWindowTypeFullScreen | 窗口类型：遮蔽所有其他窗口的全屏窗口。

## 构造及析构函数说明

## ◆ MediaSettings() [1/2]

foxit::MediaSettings::MediaSettings | ( | bool | auto_play,
|  | const wchar_t * | base_url,
|  | foxit::RGB | bg_color,
|  | float | bg_opacity,
|  | int | duration,
|  | int | page,
|  | int | repeat,
|  | bool | show_ui,
|  | bool | is_visible,
|  | int | volume,
|  | PlayerWindowType | window_type,
|  | const FloatingInfo & | floating_wnd_info
| ) |  |
| inline

构造函数，带参数。

参数

  [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 对象。

## ◆ MediaSettings() [2/2]

foxit::MediaSettings::MediaSettings | ( | const MediaSettings & | media_settings | ) |
| inline

构造函数，使用另一个媒体设置对象。

参数

  [in] | media_settings | 另一个媒体设置对象。

## 成员函数说明

## ◆ operator=()

MediaSettings& foxit::MediaSettings::operator= | ( | const MediaSettings & | media_settings | ) |
| inline

赋值操作符。

参数

  [in] | media_settings | 另一个媒体设置对象。

返回
  当前对象自身的引用。

## ◆ Set()

void foxit::MediaSettings::Set | ( | bool | auto_play,
|  | const wchar_t * | base_url,
|  | foxit::RGB | bg_color,
|  | float | bg_opacity,
|  | int | duration,
|  | int | page,
|  | int | repeat,
|  | bool | show_ui,
|  | bool | is_visible,
|  | int | volume,
|  | PlayerWindowType | window_type,
|  | const FloatingInfo & | floating_wnd_info
| ) |  |
| inline

设置值。

参数

  [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.

## 类成员变量说明

## ◆ auto_play

bool foxit::MediaSettings::auto_play

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

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

## ◆ base_url

WString foxit::MediaSettings::base_url

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

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

## ◆ repeat

int foxit::MediaSettings::repeat

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

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