hgl::AudioPlayer类参考

音频播放器基类 更多...

#include <AudioPlayer.H>

继承图，类hgl::AudioPlayer

所有成员的列表。

公有类型
enum	PlayState { psNone = 0, psPlay, psPause, psExit }
公有成员
const Vector3f &	GetPosition ()
const void	SetPosition (const Vector3f &pos)
const Vector3f &	GetVelocity ()
const void	SetVelocity (const Vector3f &vel)
const Vector3f &	GetDirection ()
const void	SetDirection (const Vector3f &dir)
const ReferenceValue &	GetDistance ()
const void	SetDistance (const ReferenceValue &rv)
const ConeAngle &	GetAngle ()
const void	SetAngle (const ConeAngle &ca)
	AudioPlayer ()
	AudioPlayer (Stream *, AFT)
	AudioPlayer (const wchar_t *, AFT=aftNone)
	AudioPlayer (HAC *, const wchar_t *, AFT=aftNone)
virtual	~AudioPlayer ()
virtual bool	Load (Stream *, AFT)
	从流中加载一个音频文件
virtual bool	Load (const wchar_t *, AFT=aftNone)
	加载一个音频文件
virtual bool	Load (HAC *, const wchar_t *, AFT=aftNone)
	从HAC包中加载一个音频文件
virtual void	Play (bool=true)
	播放音频
virtual void	Stop ()
	停止播放
virtual void	Pause ()
	暂停播放
virtual void	Resume ()
	继续播放
virtual void	Clear ()
	清除音频数据
virtual double	GetPlayTime ()
	取得已播放时间(单位秒)
virtual void	SetFadeTime (double, double)
	设置淡入淡出时间
virtual void	AutoGain (float, double)
	自动音量
公有属性
Property< uint >	Index
	音源索引
Property< double >	Time
	音频总时间
Property< PlayState >	State
	播放器状态
Property< int >	SourceState
	音源状态
Property< float >	MinGain
	最小增益
Property< float >	MaxGain
	最大增益
Property< bool >	Loop
	是否循环播放虚拟变量
Property< float >	Pitch
	播放频率
Property< float >	Gain
	音量增益幅度
Property< float >	ConeGain
Property< float >	RolloffFactor

---

详细描述

音频播放器基类

使用AudioPlayer创建的音频播放器类，一般用于背景音乐等独占的音频处理。 这个音频播放器将使用一个单独的线程，在播放器被删除时线程也会被关闭。

---

成员枚举类型文档

enum hgl::AudioPlayer::PlayState

枚举值:

psNone
psPlay
psPause
psExit

---

构造及析构函数文档

hgl::AudioPlayer::AudioPlayer

(

)

hgl::AudioPlayer::AudioPlayer	(	Stream *	stream,
		AFT	aft
	)

hgl::AudioPlayer::AudioPlayer	(	const wchar_t *	filename,
		AFT	aft = aftNone
	)

hgl::AudioPlayer::AudioPlayer	(	HAC *	hac,
		const wchar_t *	filename,
		AFT	aft = aftNone
	)

hgl::AudioPlayer::~AudioPlayer

(

)

[virtual]

---

成员函数文档

void hgl::AudioPlayer::AutoGain	(	float	target_gain,
		double	adjust_time
	)		[virtual]

自动音量

自动调整增益

void hgl::AudioPlayer::Clear

(

)

[virtual]

清除音频数据

const ConeAngle& hgl::AudioPlayer::GetAngle

(

)

[inline]

const Vector3f& hgl::AudioPlayer::GetDirection

(

)

[inline]

const ReferenceValue& hgl::AudioPlayer::GetDistance

(

)

[inline]

double hgl::AudioPlayer::GetPlayTime

(

)

[virtual]

取得已播放时间(单位秒)

const Vector3f& hgl::AudioPlayer::GetPosition

(

)

[inline]

const Vector3f& hgl::AudioPlayer::GetVelocity

(

)

[inline]

bool hgl::AudioPlayer::Load	(	Stream *	stream,
		AFT	aft
	)		[virtual]

从流中加载一个音频文件

从流中加载音频数据,仅支持OGG

参数:

stream	要加载数据的流
aft	音频文件类型

返回:

是否加载成功

bool hgl::AudioPlayer::Load	(	const wchar_t *	filename,
		AFT	aft = aftNone
	)		[virtual]

加载一个音频文件

从文件中加载一段音频数据

参数:

filename	音频文件名称
aft	音频文件类型

返回:

是否加载成功

bool hgl::AudioPlayer::Load	(	HAC *	hac,
		const wchar_t *	filename,
		AFT	aft = aftNone
	)		[virtual]

从HAC包中加载一个音频文件

从文件中加载一段音频数据

参数:

hac	HAC包指针
filename	音频文件名称
aft	音频文件类型

返回:

是否加载成功

void hgl::AudioPlayer::Pause

(

)

[virtual]

暂停播放

void hgl::AudioPlayer::Play

(

bool

_loop = true

)

[virtual]

播放音频

开始播放

参数:

_loop

是否循环播放

void hgl::AudioPlayer::Resume

(

)

[virtual]

继续播放

const void hgl::AudioPlayer::SetAngle

(

const ConeAngle &

ca

)

[inline]

const void hgl::AudioPlayer::SetDirection

(

const Vector3f &

dir

)

[inline]

const void hgl::AudioPlayer::SetDistance

(

const ReferenceValue &

rv

)

[inline]

void hgl::AudioPlayer::SetFadeTime	(	double	in,
		double	out
	)		[virtual]

设置淡入淡出时间

const void hgl::AudioPlayer::SetPosition

(

const Vector3f &

pos

)

[inline]

const void hgl::AudioPlayer::SetVelocity

(

const Vector3f &

vel

)

[inline]

void hgl::AudioPlayer::Stop

(

)

[virtual]

停止播放

---

成员数据文档

Property<float> hgl::AudioPlayer::ConeGain

Property<float> hgl::AudioPlayer::Gain

音量增益幅度

Property<uint> hgl::AudioPlayer::Index

音源索引

Property<bool> hgl::AudioPlayer::Loop

是否循环播放虚拟变量

Property<float> hgl::AudioPlayer::MaxGain

最大增益

Property<float> hgl::AudioPlayer::MinGain

最小增益

Property<float> hgl::AudioPlayer::Pitch

播放频率

Property<float> hgl::AudioPlayer::RolloffFactor

Property<int> hgl::AudioPlayer::SourceState

音源状态

Property<PlayState> hgl::AudioPlayer::State

播放器状态

Property<double> hgl::AudioPlayer::Time

音频总时间

---

该类的文档由以下文件生成：

• K:/CMGDKv18/SDK/Include/hgl/audio/AudioPlayer.H
• K:/CMGDKv18/SDK/Source/OpenALEE/AudioPlayer.CPP