Audio.GetVolume

number Audio.GetVolume (

Описание

Возвращает текущий уровень громкости аудио канала. Уровень громкости представлен числом от 0 до 255.

Параметры

Channel

(число) Аудио канал, где нужно получить уровень громкости. Выбор из:

КОНСТАНТА CONSTANT	ЗНАЧЕНИЕ VALUE	ОПИСАНИЕ DESCRIPTION
CHANNEL_BACKGROUND	5	Фоновый аудио канал.
CHANNEL_EFFECTS	0	Канал эффектов (используется для звуков мышки - наезд на объект, сход с объекта и клик).
CHANNEL_NARRATION	6	Канал звукового сопровождения (дикторский) (используется для наложения голоса).
CHANNEL_USER1	1	1 пользовательский канал.
CHANNEL_USER2	2	2 пользовательский канал.
CHANNEL_USER3	3	3 пользовательский канал.
CHANNEL_USER4	4	4 пользовательский канал.

Возврат

ResultVariable

(число) Текущий уровень громкости канала. Возвращаемое значение - число от 0 до 255. Если происходит ошибка, будет возвращена -1. Можно использовать Application.GetLastError для определения случился ли отказ в работе этого действия и почему.

При добавлении действия из редактора скрипта, можно использовать это поле для определения переменной, которая возвращает значение, сохраняющееся в ней.

Смотрите также: Связанные действия

Примеры

Пример 1

volume = Audio.GetVolume(CHANNEL_USER3);

Получаем значение уровня громкости в пользовательском канале 3 и сохраняем его в переменной по имени "volume".

Пример 2

ch3vol = Audio.GetVolume(3);

Сохраняем текущий уровень громкости канала 3 в переменной ch3vol.

Пример 3

background_music_volume = Audio.GetVolume(CHANNEL_BACKGROUND);

Получаем уровень громкости в фоновом аудио канале и сохраняем его в переменной background_music_volume.

Смотрите также: Связанные действия