Документация Steamworks
Интерфейс ISteamMusic
Управляет проигрыванием музыки в клиенте Steam.

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

Подробно эти функции описаны в разделе features/music_player.

Функции-члены

Функции-члены ISteamMusic вызываются с помощью глобальной функции доступа SteamMusic().

BIsEnabled

bool BIsEnabled();
Проверяет, включён ли проигрыватель.

Возвращаемые значения: bool
true если включён, в противном случае false.

BIsPlaying

bool BIsPlaying();
Проверяет, активен ли проигрыватель. Это необязательно означает, что композиция проигрывается, она может стоять на паузе.

Более точные значения можно получить в GetPlaybackStatus.

Возвращаемые значения: bool
true если песня проигрывается, поставлена на паузу или в очереди, в противном случае false.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();
Получает текущее состояние проигрывателя Steam.

Возвращает: AudioPlayback_Status

GetVolume

float GetVolume();
Получает текущую громкость проигрывателя Steam.

Возвращаемые значения: float
Громкость возвращается как значение между 0.0 и 1.0.

Pause

void Pause();
Ставит проигрыватель на паузу.

Play

void Play();
Сообщает проигрывателю возобновить воспроизведение.

PlayNext

void PlayNext();
Сообщает проигрывателю пропустить следующую композицию.

PlayPrevious

void PlayPrevious();
Сообщает проигрывателю воспроизвести предыдущую композицию.

SetVolume

void SetVolume( float flVolume );
НазваниеТипОписание
flVolumefloatГромкость в диапазоне 0.0 и 1.0.

Задаёт текущую громкость проигрывателя Steam.

Обратные вызовы

Далее приведён список обратных вызовов, которые могут быть получены при вызове SteamAPI_RunCallbacks. Многие из них могут быть получены сразу в ответ на функции-члены ISteamMusic.

PlaybackStatusHasChanged_t


У данного обратного вызова отсутствуют поля.

VolumeHasChanged_t



НазваниеТипОписание
m_flNewVolumefloat

Перечисления

Далее приведён список перечислений, которые определены для использования с ISteamMusic.

AudioPlayback_Status

Указывает текущее состояние воспроизведения.

НазваниеЗначениеОписание
AudioPlayback_Undefined0Проигрыватель, вероятно, выключен.
AudioPlayback_Playing1Проигрыватель в данный момент воспроизводит музыку.
AudioPlayback_Paused2Проигрыватель в данный момент поставлен на паузу.
AudioPlayback_Idle3Проигрыватель в данный момент остановлен.

Константы

Далее приведён список констант, которые определены для использования с ISteamMusic.

НазваниеТипЗначениеОписание
STEAMMUSIC_INTERFACE_VERSIONconst char *"STEAMMUSIC_INTERFACE_VERSION001"
  翻译: