Skip to content

Latest commit

 

History

History
393 lines (393 loc) · 20.4 KB

Music.md

File metadata and controls

393 lines (393 loc) · 20.4 KB

Список методов в категории Music:

StopMusic

Описание

Останавливает любое воспроизведение музыки, после чего музыка может быть перезапущена только вызовом PlayMusic.

Определение

void agk::StopMusic( )

Параметры

Пример кода


StopMusicOGG

Описание

Останавливает музыкальный файл и сбрасывает его положение в начало файла.

Определение

void agk::StopMusicOGG( UINT musicID )

Параметры

musicID - Идентификатор музыкального файла для остановки

Пример кода


SetMusicSystemVolumeOGG

Описание

Устанавливает основную громкость для всех музыкальных файлов OGG. Это умножается на объем файла, так что если системный том установлен на 100, а объем файла установлен на 0, то файл все равно будет иметь объем 0.

Определение

void agk::SetMusicSystemVolumeOGG( int vol )

Параметры

vol - Основной объем для использования, от 0 до 100

Пример кода


SetMusicVolumeOGG

Описание

Устанавливает объем для каждого файла. По умолчанию файлы воспроизводятся на томе 100. Уровень громкости должен быть между 0 и 100.

Определение

void agk::SetMusicVolumeOGG( UINT musicID, int vol )

Параметры

musicID - Идентификатор музыкального файла для изменения.
vol - Том, который будет использоваться для этого файла.

Пример кода


SetMusicSystemVolume

Описание

Устанавливает основную громкость музыкального проигрывателя в диапазоне от 0 до 100.

Определение

void agk::SetMusicSystemVolume( int iVol )

Параметры

iVol - Новое значение объема для использования.

Пример кода


SetMusicLoopTimesOGG

Описание

Устанавливает время начала и окончания музыкального цикла. Когда PlayMusicOGG используется с параметром loop, он по умолчанию останавливается в конце файла и возвращается к началу файла. Эта команда изменит его на цикл, начинающийся и заканчивающийся в определенное время в музыкальном файле. Использование времени начала -1 приведет к возврату в начало файла, использование и время окончания -1 остановится в конце файла, они соответствуют поведению по умолчанию. Если время начала больше текущего времени воспроизведения, то музыкальный файл будет продолжать воспроизводиться до тех пор, пока не достигнет конечного времени, а затем вернется к выбранному времени начала.

Определение

void agk::SetMusicLoopTimesOGG(UINT musicID, float startTime, float endTime)

Параметры

musicID - Идентификатор музыкального файла для изменения
startTime - Время в секундах для возврата в начало цикла
endTime - Время в секундах, чтобы закончить цикл и вернуться к началу

Пример кода


SetMusicLoopCountOGG

Описание

Изменяет количество циклов воспроизведения музыкального файла, может быть установлено во время его воспроизведения. Используйте значение 0 для воспроизведения до конца файла или текущего времени окончания цикла, а затем остановитесь. Значение цикла, равное 1, будет циклическим навсегда, значение, большее 1, будет циклическим для этого числа раз. Эта команда сбрасывает команду GetMusicLoopCountOGG и снова начинает отсчет с 0.

Определение

void agk::SetMusicLoopCountOGG(UINT musicID, int loop)

Параметры

musicID - Идентификатор музыкального файла для изменения
loop - Количество циклов, 0 для остановки цикла.

Пример кода


SetMusicFileVolume

Описание

Устанавливает громкость на основе каждого файла, этот уровень громкости объединяется с громкостью музыкальной системы для создания окончательной громкости. По умолчанию файлы воспроизводятся на томе 100. Уровень громкости должен быть между 0 и 100.

Определение

void agk::SetMusicFileVolume( UINT ID, int vol )

Параметры

ID - Музыкальный номер для установки.
vol - Том, который будет использоваться для этого файла.

Пример кода


SeekMusicOGG

Описание

Стремится к заданному значению времени, если файл воспроизводится в данный момент, то он немедленно продолжит воспроизведение оттуда. Если файл в данный момент не воспроизводится, то он вступит в силу после следующего вызова PlayMusicOGG. Параметр mode позволяет выбрать, следует ли искать на основе абсолютного или относительного значения времени. Абсолют будет стремиться к этой позиции в файле, в то время как относительный будет искать относительно текущей позиции.

Определение

void agk::SeekMusicOGG( UINT musicID, float seconds, int mode )

Параметры

musicID - Идентификатор музыкального файла для поиска
seconds - Время в секундах, чтобы стремиться к
mode - 0 для абсолютного поиска, 1 для относительного поиска

Пример кода


SeekMusic

Описание

Ищет воспроизводимую в данный момент музыку в заданном количестве секунд, либо относительно текущей позиции, либо в абсолютном положении. Например, если музыкальная дорожка имеет длину 60 секунд и в настоящее время находится в положении 10 секунд (она воспроизводила 10 секунд музыки), поиск абсолютного значения 3 секунды вернет ее обратно к 3 секундам после начала музыкальной дорожки. Используя относительное значение 3, вы добавите 3 секунды к текущей позиции, взяв ее до 13.

Определение

void agk::SeekMusic( float seconds, int mode )

Параметры

seconds - Количество секунд для поиска.
mode - 0 для использования абсолютного положения, 1 для использования относительного положения

Пример кода


ResumeMusicOGG

Описание

Возобновляет воспроизведение музыкального файла, если он был приостановлен.

Определение

void agk::ResumeMusicOGG( UINT musicID )

Параметры

musicID - Идентификатор музыкального файла для приостановки

Пример кода


ResumeMusic

Описание

Возобновляет прерванную музыку с того места, где она остановилась.

Определение

void agk::ResumeMusic( )

Параметры

Пример кода


PlayMusicOGG

Описание

Воспроизведение музыкального файла. Несколько музыкальных файлов OGG могут воспроизводиться одновременно.

Определение

void agk::PlayMusicOGG( UINT musicID, int iLoop )
void agk::PlayMusicOGG( UINT musicID )

Параметры

musicID - Идентификатор музыкального файла для воспроизведения
iLoop - Количество раз, чтобы зациклиться, или 1, чтобы зациклиться навсегда

Пример кода


PlayMusic

Описание

Воспроизводит только данный музыкальный файл и при желании зацикливает его. Это изменение по сравнению с предыдущими версиями, где AGK продолжал бы воспроизводить следующий музыкальный трек после этого. Теперь вы должны использовать дополнительные параметры PlayMusic для воспроизведения треков один за другим. В любой момент времени может воспроизводиться только один музыкальный файл.

Определение

void agk::PlayMusic( UINT iID, int bLoop )
void agk::PlayMusic( UINT iID )
void agk::PlayMusic()
void agk::PlayMusic( UINT iID, int bLoop, UINT iStartID, UINT iEndID )

Параметры

iID - Начнем с музыкального файла.
bLoop - 1 - цикл навсегда, 0 - остановка после последнего идентификатора.
iStartID - Идентификатор, к которому нужно вернуться при циклическом переходе от конца к началу списка файлов.
iEndID - Идентификатор, после которого он должен вернуться к началу цикла.

Пример кода


PauseMusicOGG

Описание

Ставит музыкальный файл на паузу. GetMusicPlayingOGG будет продолжать возвращать 1.

Определение

void agk::PauseMusicOGG( UINT musicID )

Параметры

musicID - Идентификатор музыкального файла для приостановки

Пример кода


PauseMusic

Описание

Приостанавливает воспроизведение музыки в данный момент, какой бы идентификатор это ни был.

Определение

void agk::PauseMusic( )

Параметры

Пример кода


LoadMusic

Описание

Загружает музыкальный файл из папки мультимедиа приложения в указанный идентификатор. Пути к файлам должны быть относительными, а не абсолютными, вы не можете загружать музыкальные файлы из других мест на диске. Он возвращает идентификатор музыкального файла для последующей ссылки на него. Рекомендуемый формат для кросс-платформенной совместимости-MP3. Обратите внимание, что платформа Meego в настоящее время не поддерживает MP3, вместо этого она попытается загрузить файл OGG Vorbis. Например, если вы попытаетесь загрузить music.mp3, на Meego это будет интерпретировано как music.ogg. Идентификатор должен находиться в диапазоне от 1 до 50.

Определение

void agk::LoadMusic( UINT iID, const char *sFile )
UINT agk::LoadMusic( const char *sFile )

Параметры

iID - Музыкальный номер для хранения музыки.
sFile - Имя файла загружаемого музыкального файла.

Пример кода


LoadMusicOGG

Описание

Загружает музыкальный файл, сжатый с помощью OGG Vorbis. Это поддерживается на всех платформах, как и новый предпочтительный способ воспроизведения музыки, заменяющий команду LoadMusic. Одновременно можно воспроизводить несколько музыкальных файлов OGG. Идентификаторы музыкальных файлов OGG отделены от обычных идентификаторов музыкальных файлов и не ограничены определенным диапазоном чисел.

Определение

void agk::LoadMusicOGG( UINT musicID, const char* sFile )
UINT agk::LoadMusicOGG( const char* sFile )

Параметры

musicID - Идентификатор, используемый для ссылки на этот музыкальный файл.
sFile - Имя файла загружаемого музыкального файла.

Пример кода


GetMusicPositionOGG

Описание

Возвращает текущую позицию в музыкальном файле, между 0 для начала файла и GetMusicDurationOGG для конца файла.

Определение

float agk::GetMusicPositionOGG( UINT musicID )

Параметры

musicID - Идентификатор музыкального файла для проверки

Пример кода


GetMusicPosition

Описание

Возвращает количество секунд воспроизведения текущего музыкального файла. Если в данный момент музыка не воспроизводится, эта команда вернет 0.

Определение

float agk::GetMusicPosition()

Параметры

Пример кода


GetMusicPlayingOGG

Описание

Возвращает 1, если музыкальный файл воспроизводится в данный момент, и 0 в противном случае. Это будет продолжать возвращать 1, пока файл находится на паузе.

Определение

int agk::GetMusicPlayingOGG( UINT musicID )

Параметры

musicID - Идентификатор музыкального файла для проверки

Пример кода


GetMusicPlaying

Описание

Возвращает идентификатор воспроизводимого в данный момент музыкального файла. Если музыка не воспроизводится, она возвращает 0.

Определение

int agk::GetMusicPlaying()

Параметры

Пример кода


GetMusicLoopCountOGG

Описание

Возвращает количество раз, когда этот музыкальный файл был зациклен.

Определение

int agk::GetMusicLoopCountOGG( UINT musicID )

Параметры

musicID - Идентификатор музыкального файла для проверки

Пример кода


GetMusicExists

Описание

Возвращает 1, если музыкальный файл существует с текущим идентификатором, и 0, если нет.

Определение

UINT agk::GetMusicExists( UINT iID )

Параметры

iID - Удостоверение личности для проверки.

Пример кода


GetMusicExistsOGG

Описание

Возвращает 1, если музыкальный файл существует с указанным идентификатором, и 0 в противном случае.

Определение

int agk::GetMusicExistsOGG( UINT musicID )

Параметры

musicID - Удостоверение личности для проверки

Пример кода


GetMusicDurationOGG

Описание

Возвращает длительность музыкального файла в секундах в виде значения с плавающей запятой

Определение

float agk::GetMusicDurationOGG( UINT musicID )

Параметры

musicID - Идентификатор музыкального файла для проверки

Пример кода


GetMusicDuration

Описание

Возвращает количество секунд, которое потребуется для воспроизведения данного музыкального файла от начала до конца. Для работы этой команды не должно быть никаких звуков, или данный идентификатор должен быть дорожкой, воспроизводимой в данный момент. Например, если вы попытаетесь получить продолжительность ID 2 и ID 1 в данный момент воспроизводится, то это не удастся, но если ID 2 в данный момент воспроизводится, то это будет успешно. Для файлов с переменной скоростью передачи битов эта команда вернет аппроксимацию.

Определение

float agk::GetMusicDuration( UINT iID )

Параметры

iID - Идентификатор музыки для проверки.

Пример кода


DeleteMusicOGG

Описание

Удаляет музыкальный файл и освобождает идентификатор для повторного использования.

Определение

void agk::DeleteMusicOGG( UINT musicID )

Параметры

musicID - Идентификатор музыкального файла для удаления

Пример кода


DeleteMusic

Описание

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

Определение

void agk::DeleteMusic( UINT iID )

Параметры

iID - Идентификатор музыки, которую нужно удалить.

Пример кода