Foxit PDF SDK
foxit::pdf::MediaPlayer类 参考
类 foxit::pdf::MediaPlayer 继承关系图:
foxit::Base

Public 成员函数

 MediaPlayer (objects::PDFDictionary *media_player_dict=0)
 带参数的构造函数。 更多...
 
 MediaPlayer (const MediaPlayer &other)
 使用另一个媒体播放器对象的构造函数。 更多...
 
 ~MediaPlayer ()
 析构函数。
 
objects::PDFDictionaryGetDict () const
 获取当前对象的PDF字典。 更多...
 
StringArray GetOSIdentifiers () const
 获取表示操作系统标识符的字符串数组。 更多...
 
String GetSoftwareURI () const
 获取标识软件的软件URI。 更多...
 
bool IsEmpty () const
 检查当前对象是否为空。 更多...
 
bool operator != (const MediaPlayer &other) const
 不等于操作符。 更多...
 
MediaPlayeroperator= (const MediaPlayer &other)
 赋值操作符。 更多...
 
bool operator== (const MediaPlayer &other) const
 等于操作符。 更多...
 
void SetOSIdentifiers (const StringArray &identifier_array)
 设置表示操作系统标识符的字符串数组。 更多...
 
void SetSoftwareURI (const String &uri)
 设置标识软件的软件URI。 更多...
 
- Public 成员函数 继承自 foxit::Base
FS_HANDLE Handle () const
 获取当前对象的句柄。 更多...
 

详细描述

MediaPlayer 提供访问特定媒体播放器信息的方法。

构造及析构函数说明

◆ MediaPlayer() [1/2]

foxit::pdf::MediaPlayer::MediaPlayer ( objects::PDFDictionary media_player_dict = 0)

带参数的构造函数。

通常,媒体播放器对象应该只添加到具有指定媒体播放器类型的演示对象中。 不建议用户将相同的媒体播放器对象添加到不同的演示或 一个演示的不同媒体播放器类型中;否则可能会发生意外问题(如崩溃)。 如果用户不想构造另一个媒体播放器并设置相同的值,用户可以克隆 原始媒体播放器对象的字典,并使用克隆的字典 直接构造另一个媒体播放器。

参数
[in]media_player_dict媒体播放器对象的PDF字典。如果这是 NULL,意味着 构造一个新的媒体播放器对象。默认值:NULL

◆ MediaPlayer() [2/2]

foxit::pdf::MediaPlayer::MediaPlayer ( const MediaPlayer other)

使用另一个媒体播放器对象的构造函数。

参数
[in]other另一个媒体播放器对象。

成员函数说明

◆ GetDict()

objects::PDFDictionary* foxit::pdf::MediaPlayer::GetDict ( ) const

获取当前对象的PDF字典。

返回
当前对象的PDF字典。如果有任何错误,此函数将返回 NULL

◆ GetOSIdentifiers()

StringArray foxit::pdf::MediaPlayer::GetOSIdentifiers ( ) const

获取表示操作系统标识符的字符串数组。

此数组中的操作系统标识符指示此对象适用于哪些操作系统。 定义的值与为 SMIL 2.0 的 systemOperatingSystem 属性定义的值相同。 数组中可能不存在同一标识符的多个副本。

返回
表示操作系统标识符的字符串数组。 空数组被认为代表所有操作系统。

◆ GetSoftwareURI()

String foxit::pdf::MediaPlayer::GetSoftwareURI ( ) const

获取标识软件的软件URI。

更多详细信息,请参考 <PDF reference 1.7> P780 "Software URIs"。

返回
软件URI。

◆ IsEmpty()

bool foxit::pdf::MediaPlayer::IsEmpty ( ) const

检查当前对象是否为空。

当前对象为空时,意味着当前对象无用。

返回
true 表示当前对象为空,false 表示不为空。

◆ operator !=()

bool foxit::pdf::MediaPlayer::operator != ( const MediaPlayer other) const

不等于操作符。

参数
[in]other另一个媒体播放器对象。此函数将检查当前对象是否不等于这个对象。
返回
true 表示不相等,false 表示相等。

◆ operator=()

MediaPlayer& foxit::pdf::MediaPlayer::operator= ( const MediaPlayer other)

赋值操作符。

参数
[in]other另一个媒体播放器对象,其值将被赋给当前对象。
返回
对当前对象自身的引用。

◆ operator==()

bool foxit::pdf::MediaPlayer::operator== ( const MediaPlayer other) const

等于操作符。

参数
[in]other另一个媒体播放器对象。此函数将检查当前对象是否等于这个对象。
返回
true 表示相等,false 表示不相等。

◆ SetOSIdentifiers()

void foxit::pdf::MediaPlayer::SetOSIdentifiers ( const StringArray identifier_array)

设置表示操作系统标识符的字符串数组。

此数组中的操作系统标识符指示此对象适用于哪些操作系统。 定义的值与为 SMIL 2.0 的 systemOperatingSystem 属性定义的值相同。 数组中可能不存在同一标识符的多个副本。

参数
[in]identifier_array表示操作系统标识符的字符串数组。 空数组被认为代表所有操作系统。
返回
无。

◆ SetSoftwareURI()

void foxit::pdf::MediaPlayer::SetSoftwareURI ( const String uri)

设置标识软件的软件URI。

此属性对媒体播放器对象是必需的。更多详细信息,请参考 <PDF reference 1.7> P780 "Software URIs"。

参数
[in]uri软件URI。它不应是空字符串。
返回
无。