ScummVM API documentation
QDEngine::qdSound Class Reference

Звук. More...

#include <qd_sound.h>

Inheritance diagram for QDEngine::qdSound:
QDEngine::qdNamedObject QDEngine::qdResource QDEngine::qdNamedObjectBase

Public Member Functions

int named_object_type () const
 Возвращает тип объекта. More...
 
void load_script (const xml::tag *p)
 Загрузка данных из скрипта.
 
bool save_script (Common::WriteStream &fh, int indent=0) const
 Запись данных в скрипт.
 
bool load_resource ()
 Загружает в память данные ресурса. More...
 
bool free_resource ()
 Выгружает из памяти данные ресурса. More...
 
void set_resource_file (const Common::Path &file_name)
 Устанавливает имя файла, в котором хранятся данные ресурса. More...
 
const Common::Path resource_file () const
 Возвращает имя файла, в котором хранится анимация. More...
 
const Common::Path file_name () const
 Возвращает имя файла, в котором хранится звук.
 
void set_file_name (const Common::Path &fname)
 Устанавливает имя файла, в котором хранится звук.
 
bool play (const qdSoundHandle *handle=NULL, bool loop=false) const
 Запускает проигрывание звука. More...
 
bool stop (const qdSoundHandle *handle=NULL) const
 Останавливает проигрывание звука. More...
 
bool set_frequency (const qdSoundHandle *handle, float frequency_coeff) const
 Изменение частоты звука в frequency_coeff число раз.
 
float length () const
 Возвращает длительность звука в секундах.
 
bool is_stopped (const qdSoundHandle *handle=NULL) const
 Возвращает true, если звук не проигрывается.
 
int volume () const
 
void set_volume (int vol)
 
- Public Member Functions inherited from QDEngine::qdNamedObject
 qdNamedObject (const qdNamedObject &p)
 
qdNamedObject & operator= (const qdNamedObject &p)
 
qdNamedObject * owner () const
 Возвращает владельца объекта.
 
qdNamedObject * owner (qdNamedObjectType tp) const
 Возвращает владельца объекта, тип которого tp.
 
void set_owner (qdNamedObject *p)
 Устанавливает владельца объекта.
 
void set_flag (int fl)
 Устанавливает флаг.
 
void drop_flag (int fl)
 Скидывает флаг.
 
bool check_flag (int fl) const
 Возвращает true, если установлен флаг fl.
 
void clear_flags ()
 Очищает флаги.
 
int flags () const
 Возвращает значение флагов объекта.
 
virtual int named_object_type () const =0
 Возвращает тип объекта. More...
 
virtual bool load_data (Common::SeekableReadStream &fh, int save_version)
 Загрузка данных из сэйва. More...
 
virtual bool save_data (Common::WriteStream &fh) const
 Запись данных в сэйв. More...
 
void add_trigger_reference ()
 Добавляет ссылку из триггеров на объект.
 
void remove_trigger_reference ()
 Удаляет ссылку из триггеров на объект.
 
void clear_trigger_references ()
 Очищает счётчик ссылок из триггеров на объект.
 
bool is_in_triggers () const
 Возвращает true, если на объект есть ссылки из триггеров.
 
Common::String toString () const
 
- Public Member Functions inherited from QDEngine::qdNamedObjectBase
 qdNamedObjectBase (const qdNamedObjectBase &obj)
 
qdNamedObjectBase & operator= (const qdNamedObjectBase &obj)
 
const char * name () const
 Возвращает имя объекта.
 
void set_name (const char *p)
 Устанавливает имя объекта.
 
- Public Member Functions inherited from QDEngine::qdResource
 qdResource (const qdResource &res)
 
qdResource & operator= (const qdResource &res)
 
virtual bool load_resource ()=0
 Загружает в память данные ресурса. More...
 
virtual bool free_resource ()=0
 Выгружает из памяти данные ресурса. More...
 
virtual void set_resource_file (const Common::Path &file_name)=0
 Устанавливает имя файла, в котором хранятся данные ресурса. More...
 
virtual const Common::Path resource_file () const =0
 Возвращает имя файла, в котором хранятся данные ресурса. More...
 
bool is_resource_loaded () const
 Возвращает true, если данные ресурса загружены в память.
 

Additional Inherited Members

- Public Types inherited from QDEngine::qdResource
enum  file_format_t { RES_ANIMATION , RES_SPRITE , RES_SOUND , RES_UNKNOWN }
 Форматы файлов. More...
 
- Static Public Member Functions inherited from QDEngine::qdResource
static file_format_t file_format (const Common::Path &file_name)
 
- Protected Member Functions inherited from QDEngine::qdResource
void toggle_resource_status (bool st=true)
 Устанавливает или скидывает флаг, показывающий что данные ресурса загружены в память.
 

Detailed Description

Звук.

Member Function Documentation

◆ named_object_type()

int QDEngine::qdSound::named_object_type ( ) const
inlinevirtual

Возвращает тип объекта.

Implements QDEngine::qdNamedObject.

◆ load_resource()

bool QDEngine::qdSound::load_resource ( )
virtual

Загружает в память данные ресурса.

Implements QDEngine::qdResource.

◆ free_resource()

bool QDEngine::qdSound::free_resource ( )
virtual

Выгружает из памяти данные ресурса.

Implements QDEngine::qdResource.

◆ set_resource_file()

void QDEngine::qdSound::set_resource_file ( const Common::Path &  file_name)
inlinevirtual

Устанавливает имя файла, в котором хранятся данные ресурса.

Implements QDEngine::qdResource.

◆ resource_file()

const Common::Path QDEngine::qdSound::resource_file ( ) const
inlinevirtual

Возвращает имя файла, в котором хранится анимация.

Implements QDEngine::qdResource.

◆ play()

bool QDEngine::qdSound::play ( const qdSoundHandle *  handle = NULL,
bool  loop = false 
) const

Запускает проигрывание звука.

handle нужен для дальнейшего управления звуком и отслеживания его состояния, start_position - начальная позиция при запуске звука, значения - [0.0, 1.0]

◆ stop()

bool QDEngine::qdSound::stop ( const qdSoundHandle *  handle = NULL) const

Останавливает проигрывание звука.

Если handle нулевой - то выключится первый попавшийся активный звук с данными из sound_, если ненулевой - первый соответствующий этому хэндлу.


The documentation for this class was generated from the following file: