Documentação do Steamworks
Interface ISteamMusic
Funções para o controle da reprodução de música no cliente Steam.

Isso permite que jogos façam coisas como pausar a música ou abaixar o volume durante uma cena importante, e voltar a reproduzi-la depois.

Consulte features/music_player para mais informações.

Funções de membro

Funções de membro de ISteamMusic são chamadas por meio da função de acesso global SteamMusic().

BIsEnabled

bool BIsEnabled();
Verifica se o reprodutor de músicas do Steam está ativado.

Retorna: bool
true se estiver ativado; false caso contrário.

BIsPlaying

bool BIsPlaying();
Verifica se o reprodutor de músicas do Steam está ativo. Isso não significa que há uma música em reprodução; pode estar em pausa.

Para uma resposta mais detalhada, use a função GetPlaybackStatus.

Retorna: bool
true se uma música estiver em reprodução, pausada ou na fila para reprodução; false caso contrário.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();
Recupera o estado atual do reprodutor de músicas do Steam.

Retorna: AudioPlayback_Status

GetVolume

float GetVolume();
Recupera o volume atual do reprodutor de músicas do Steam.

Retorna: float
O volume é retornado como uma porcentagem entre 0.0 e 1.0.

Pause

void Pause();
Pausa o reprodutor de músicas do Steam.

Play

void Play();
Retoma a reprodução no reprodutor de músicas do Steam.

PlayNext

void PlayNext();
Avança para a próxima música no reprodutor de músicas do Steam.

PlayPrevious

void PlayPrevious();
Volta para a música anterior no reprodutor de músicas do Steam.

SetVolume

void SetVolume( float flVolume );
NomeTipoDescrição
flVolumefloatA porcentagem do volume a definir, entre 0.0 e 1.0.

Define o volume do reprodutor de músicas do Steam.

Retornos de chamada

Estes são os retornos de chamada (callbacks) que podem ser disparados ao chamar SteamAPI_RunCallbacks. Muitos podem ser disparados diretamente em resposta às funções de membro de ISteamMusic.

PlaybackStatusHasChanged_t


Este retorno de chamada não possui campos.

VolumeHasChanged_t



NomeTipoDescrição
m_flNewVolumefloat

Enumerações

Estas são as enumerações definidas para uso com ISteamMusic.

AudioPlayback_Status

Especifica o estado de reprodutor atual.

NomeValorDescrição
AudioPlayback_Undefined0A interface de músicas do Steam provavelmente não está ativada.
AudioPlayback_Playing1O reprodutor de músicas do Steam está reproduzindo uma música.
AudioPlayback_Paused2O reprodutor de músicas do Steam está com uma música pausada.
AudioPlayback_Idle3O reprodutor de músicas do Steam interrompeu a reprodução de músicas.

Constantes

Estas são as constantes definidas para uso com ISteamMusic.

NomeTipoValorDescrição
STEAMMUSIC_INTERFACE_VERSIONconst char *"STEAMMUSIC_INTERFACE_VERSION001"