Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
com.foxit.sdk.MediaSettings类 参考

## Public 成员函数
| MediaSettings ()
| 构造函数。
| MediaSettings (boolean auto_play, String base_url, long bg_color, float bg_opacity, int duration, int page, int repeat, boolean show_ui, boolean is_visible, int volume, int window_type, FloatingInfo floating_wnd_info)
| 构造函数，带参数。 更多...
| MediaSettings (MediaSettings media_settings)
| 构造函数，使用另一个媒体设置对象。 更多...
synchronized void | delete ()
| 直接清除C++相关资源。 更多...
boolean | getAuto_play ()
| Get 指定媒体片段是否应在播放器打开后自动开始播放。 更多...
String | getBase_url ()
| Get 用于解析媒体片段中使用的任何相对URL的基础URL。 更多...
long | getBg_color ()
| Get 媒体播放器窗口的背景颜色。格式：0xRRGGBB 更多...
float | getBg_opacity ()
| Get 媒体播放器窗口的背景不透明度。 更多...
int | getDuration ()
| Get 播放将花费的时间（以秒为单位）。 更多...
FloatingInfo | getFloating_wnd_info ()
| Get 包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。 更多...
boolean | getIs_visible ()
| Get 布尔值，指定播放器是否应该可见。 更多...
int | getPage ()
| Get 对于停靠的媒体播放器，此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器，此属性被忽略。 更多...
int | getRepeat ()
| Get 媒体播放应自动重复的次数。 更多...
boolean | getShow_ui ()
| Get 布尔值，指定媒体播放器的控件是否应该可见。 更多...
int | getVolume ()
| Get 指定播放音量。值0表示静音，值100表示正常（全音量）。 更多...
int | getWindow_type ()
| Get 定义媒体播放器应在哪种类型的窗口中创建。请参考从 com.foxit.sdk.MediaSettings.e_PlayerWindowTypeDockedPage 开始的值，这应该是这些值中的一个。 更多...
void | set (boolean auto_play, String base_url, long bg_color, float bg_opacity, int duration, int page, int repeat, boolean show_ui, boolean is_visible, int volume, int window_type, FloatingInfo floating_wnd_info)
| 设置值。 更多...
void | setAuto_play (boolean value)
| Set 指定媒体片段是否应在播放器打开后自动开始播放。 更多...
void | setBase_url (String value)
| Set 用于解析媒体片段中使用的任何相对URL的基础URL。 更多...
void | setBg_color (long value)
| Set 媒体播放器窗口的背景颜色。格式：0xRRGGBB 更多...
void | setBg_opacity (float value)
| Set 媒体播放器窗口的背景不透明度。 更多...
void | setDuration (int value)
| Set 播放将花费的时间（以秒为单位）。 更多...
void | setFloating_wnd_info (FloatingInfo value)
| Set 包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。 更多...
void | setIs_visible (boolean value)
| Set 布尔值，指定播放器是否应该可见。 更多...
void | setPage (int value)
| Set 对于停靠的媒体播放器，此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器，此属性被忽略。 更多...
void | setRepeat (int value)
| Set 媒体播放应自动重复的次数。 更多...
void | setShow_ui (boolean value)
| Set 布尔值，指定媒体播放器的控件是否应该可见。 更多...
void | setVolume (int value)
| Set 指定播放音量。值0表示静音，值100表示正常（全音量）。 更多...
void | setWindow_type (int value)
| Set 定义媒体播放器应在哪种类型的窗口中创建。请参考从 com.foxit.sdk.MediaSettings.e_PlayerWindowTypeDockedPage 开始的值，这应该是这些值中的一个。 更多...

## 静态 Public 属性
static final int | e_PlayerWindowTypeDockedPage = 1
| 窗口类型：停靠的页面窗口。
static final int | e_PlayerWindowTypeFloating = 2
| 窗口类型：浮动窗口。
static final int | e_PlayerWindowTypeFullScreen = 4
| 窗口类型：遮蔽所有其他窗口的全屏窗口。

## 详细描述

此类表示媒体设置。

## 构造及析构函数说明

## ◆ MediaSettings() [1/2]

com.foxit.sdk.MediaSettings.MediaSettings | ( | boolean | auto_play,
|  | String | base_url,
|  | long | bg_color,
|  | float | bg_opacity,
|  | int | duration,
|  | int | page,
|  | int | repeat,
|  | boolean | show_ui,
|  | boolean | is_visible,
|  | int | volume,
|  | int | window_type,
|  | FloatingInfo | 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 对象。

## ◆ MediaSettings() [2/2]

com.foxit.sdk.MediaSettings.MediaSettings | ( | MediaSettings | media_settings | ) |

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

参数

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

## 成员函数说明

## ◆ delete()

synchronized void com.foxit.sdk.MediaSettings.delete | ( |  | ) |

直接清除C++相关资源。

返回
  无。

注解
  一旦这个接口被调用，这个对象将不能再被使用。

## ◆ getAuto_play()

com.foxit.sdk.MediaSettings.getAuto_play | ( |  | ) |

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

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

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

## ◆ getBase_url()

com.foxit.sdk.MediaSettings.getBase_url | ( |  | ) |

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

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

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

## ◆ getBg_color()

com.foxit.sdk.MediaSettings.getBg_color | ( |  | ) |

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

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

## ◆ getBg_opacity()

com.foxit.sdk.MediaSettings.getBg_opacity | ( |  | ) |

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

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

## ◆ getDuration()

com.foxit.sdk.MediaSettings.getDuration | ( |  | ) |

Get 播放将花费的时间（以秒为单位）。

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

## ◆ getFloating_wnd_info()

com.foxit.sdk.MediaSettings.getFloating_wnd_info | ( |  | ) |

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

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

## ◆ getIs_visible()

com.foxit.sdk.MediaSettings.getIs_visible | ( |  | ) |

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

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

## ◆ getPage()

com.foxit.sdk.MediaSettings.getPage | ( |  | ) |

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

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

## ◆ getRepeat()

com.foxit.sdk.MediaSettings.getRepeat | ( |  | ) |

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

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

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

## ◆ getShow_ui()

com.foxit.sdk.MediaSettings.getShow_ui | ( |  | ) |

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

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

## ◆ getVolume()

com.foxit.sdk.MediaSettings.getVolume | ( |  | ) |

Get 指定播放音量。值0表示静音，值100表示正常（全音量）。

返回
  指定播放音量。值0表示静音，值100表示正常（全音量）。

## ◆ getWindow_type()

com.foxit.sdk.MediaSettings.getWindow_type | ( |  | ) |

Get 定义媒体播放器应在哪种类型的窗口中创建。请参考从 com.foxit.sdk.MediaSettings.e_PlayerWindowTypeDockedPage 开始的值，这应该是这些值中的一个。

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

## ◆ set()

void com.foxit.sdk.MediaSettings.set | ( | boolean | auto_play,
|  | String | base_url,
|  | long | bg_color,
|  | float | bg_opacity,
|  | int | duration,
|  | int | page,
|  | int | repeat,
|  | boolean | show_ui,
|  | boolean | is_visible,
|  | int | volume,
|  | int | window_type,
|  | FloatingInfo | 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()

com.foxit.sdk.MediaSettings.setAuto_play | ( | boolean | value | ) |

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

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

参数

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

返回
  None.

## ◆ setBase_url()

com.foxit.sdk.MediaSettings.setBase_url | ( | String | value | ) |

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

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

参数

  [in] | value | 用于解析媒体片段中使用的任何相对URL的基础URL。

返回
  None.

## ◆ setBg_color()

com.foxit.sdk.MediaSettings.setBg_color | ( | long | value | ) |

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

参数

  [in] | value | 媒体播放器窗口的背景颜色。格式：0xRRGGBB

返回
  None.

## ◆ setBg_opacity()

com.foxit.sdk.MediaSettings.setBg_opacity | ( | float | value | ) |

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

参数

  [in] | value | 媒体播放器窗口的背景不透明度。

返回
  None.

## ◆ setDuration()

com.foxit.sdk.MediaSettings.setDuration | ( | int | value | ) |

Set 播放将花费的时间（以秒为单位）。

参数

  [in] | value | 播放将花费的时间（以秒为单位）。

返回
  None.

## ◆ setFloating_wnd_info()

com.foxit.sdk.MediaSettings.setFloating_wnd_info | ( | FloatingInfo | value | ) |

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

参数

  [in] | value | 包含定义浮动窗口位置和样式属性的 FloatingInfo 对象。

返回
  None.

## ◆ setIs_visible()

com.foxit.sdk.MediaSettings.setIs_visible | ( | boolean | value | ) |

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

参数

  [in] | value | 布尔值，指定播放器是否应该可见。

返回
  None.

## ◆ setPage()

com.foxit.sdk.MediaSettings.setPage | ( | int | value | ) |

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

参数

  [in] | value | 对于停靠的媒体播放器，此属性是播放器应停靠的页面编号。 对于其他类型的媒体播放器，此属性被忽略。

返回
  None.

## ◆ setRepeat()

com.foxit.sdk.MediaSettings.setRepeat | ( | int | value | ) |

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

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

参数

  [in] | value | 媒体播放应自动重复的次数。

返回
  None.

## ◆ setShow_ui()

com.foxit.sdk.MediaSettings.setShow_ui | ( | boolean | value | ) |

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

参数

  [in] | value | 布尔值，指定媒体播放器的控件是否应该可见。

返回
  None.

## ◆ setVolume()

com.foxit.sdk.MediaSettings.setVolume | ( | int | value | ) |

Set 指定播放音量。值0表示静音，值100表示正常（全音量）。

参数

  [in] | value | 指定播放音量。值0表示静音，值100表示正常（全音量）。

返回
  None.

## ◆ setWindow_type()

com.foxit.sdk.MediaSettings.setWindow_type | ( | int | value | ) |

Set 定义媒体播放器应在哪种类型的窗口中创建。请参考从 com.foxit.sdk.MediaSettings.e_PlayerWindowTypeDockedPage 开始的值，这应该是这些值中的一个。

参数

  [in] | value | 定义媒体播放器应在哪种类型的窗口中创建。请参考从 com.foxit.sdk.MediaSettings.e_PlayerWindowTypeDockedPage 开始的值，这应该是这些值中的一个。

返回
  None.