foxit::ofd::SoundAction类 参考

类 foxit::ofd::SoundAction 继承关系图:

Public 成员函数
	SoundAction ()
	构造函数。
	SoundAction (Action object)
	构造函数，从现有foxit::ofd::Action对象。 更多...
	SoundAction (const SoundAction &other)
	构造函数，通过另一个声音动作对象。 更多...
	~SoundAction ()
	析构函数。
void	EnableRepeat (bool repeat)
	设置是否重复播放。 更多...
void	EnableSynchronous (bool synchronous)
	设置是否同步播放。 更多...
foxit::uint32	GetResourceID ()
	获取资源ID。 更多...
int	GetVolume ()
	获取音量。 更多...
bool	IsEmpty () const
	检查当前对象是否为空。 更多...
bool	IsRepeat ()
	检查是否重复播放。 更多...
bool	IsSynchronous ()
	检查是否同步播放。 更多...
bool	operator != (const SoundAction &other) const
	不相等操作符。 更多...
SoundAction &	operator= (const SoundAction &other)
	赋值操作符。 更多...
bool	operator== (const SoundAction &other) const
	相等操作符。 更多...
void	SetResourceID (foxit::uint32 resource_id)
	设置资源ID。 更多...
void	SetVolume (int volume)
	设置音量。 更多...
Public 成员函数 继承自 foxit::ofd::Action
	Action (const Action &other)
	用另一个动作对象构造当前动作对象。 更多...
	~Action ()
	析构函数。
ActionEventTriggerType	GetEventTrigger ()
	获取事件触发器。 更多...
foxit::ofd::Action::ActionType	GetType ()
	获取动作类型。 更多...
bool	IsEmpty () const
	检查当前对象是否为空。 更多...
bool	operator != (const Action &other) const
	不等操作符。 更多...
Action &	operator= (const Action &other)
	赋值操作符。 更多...
bool	operator== (const Action &other) const
	相等操作符。 更多...
void	SetEventTrigger (ActionEventTriggerType event_trigger)
	设置事件触发器。 更多...
Public 成员函数 继承自 foxit::Base
FS_HANDLE	Handle () const
	获取当前对象的句柄。 更多...

额外继承的成员函数
Public 类型 继承自 foxit::ofd::Action
enum	ActionEventTriggerType { e_ActionEventTriggerTypeDocumentOpen = 0, e_ActionEventTriggerTypePageOpen = 1, e_ActionEventTriggerTypeClick = 2 }
	OFD动作触发事件枚举类型。 更多...
enum	ActionType {   e_ActionTypeUnknown = 0, e_ActionTypeGoto = 1, e_ActionTypeUri = 2, e_ActionTypeSound = 3,   e_ActionTypeMovie = 4, e_ActionTypeGotoA = 5 }
	OFD动作类型定义枚举类型。 更多...

详细描述

此类表示和OFD声音动作相关的操作。

构造及析构函数说明

SoundAction() [1/2]

foxit::ofd::SoundAction::SoundAction ( Action  object )

explicit

构造函数，从现有foxit::ofd::Action对象。

参数

[in]

object

Action对象。 此对象必须是一个有效的对象，并且其类型必须是foxit::ofd::Action::ActionType::e_ActionTypeSound，否则构造函数将抛出异常。

SoundAction() [2/2]

foxit::ofd::SoundAction::SoundAction

(

const SoundAction &

other

)

构造函数，通过另一个声音动作对象。

参数

[in]

other

另一个声音动作对象。

成员函数说明

EnableRepeat()

void foxit::ofd::SoundAction::EnableRepeat

(

bool

repeat

)

设置是否重复播放。

参数

[in]

repeat

指定是否重复播放。true表示重复播放，false表示不重复播放。

返回

无。

EnableSynchronous()

void foxit::ofd::SoundAction::EnableSynchronous

(

bool

synchronous

)

设置是否同步播放。

参数

[in]

synchronous

指定是否同步播放。true表示同步播放，false表示不同步播放。

返回

无。

GetResourceID()

foxit::uint32 foxit::ofd::SoundAction::GetResourceID

(

)

获取资源ID。

返回

资源ID。

GetVolume()

int foxit::ofd::SoundAction::GetVolume

(

)

获取音量。

返回

音量值。

IsEmpty()

bool foxit::ofd::SoundAction::IsEmpty

(

)

const

检查当前对象是否为空。

当前对象为空时，表示当前对象是无用的。

返回

true 表示当前对象为空，false 表示不为空。

IsRepeat()

bool foxit::ofd::SoundAction::IsRepeat

(

)

检查是否重复播放。

返回

true 表示重复播放，false 表示不重复播放。

IsSynchronous()

bool foxit::ofd::SoundAction::IsSynchronous

(

)

检查是否同步播放。

返回

true 表示同步播放，false 表示不同步播放。

operator !=()

bool foxit::ofd::SoundAction::operator !=

(

const SoundAction &

other

)

const

不相等操作符。

参数

[in]

other

另一个声音动作对象。此函数将检查当前对象是否不等于这个对象。

返回

true 表示不相等，false 表示相等。

operator=()

SoundAction& foxit::ofd::SoundAction::operator=

(

const SoundAction &

other

)

赋值操作符。

参数

[in]

other

另一个声音动作对象，其值将被赋给当前对象。

返回

当前对象自身的引用。

operator==()

bool foxit::ofd::SoundAction::operator==

(

const SoundAction &

other

)

const

相等操作符。

参数

[in]

other

另一个声音动作对象。此函数将检查当前对象是否等于这个对象。

返回

true 表示相等，false 表示不相等。

SetResourceID()

void foxit::ofd::SoundAction::SetResourceID

(

foxit::uint32

resource_id

)

设置资源ID。

参数

[in]

resource_id

资源ID值。

返回

无。

SetVolume()

void foxit::ofd::SoundAction::SetVolume

(

int

volume

)

设置音量。

参数

[in]

volume

音量值，取值范围为0-100。

返回

无。