Interface ISteamMusic (Documentação do Steamworks)

Documentação do Steamworks

Interface ISteamMusic

Documentação do Steamworks > Guia de referência da API do Steamworks > Interface ISteamMusic

Funções para o controlo da reprodução de música na aplicação Steam.

Permite que jogos realizem ações como pausar a música ou baixar o volume durante uma cena importante e voltar a reproduzi-la de seguida.

Consulte features/music_player para mais informações.

Funções de membro

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

BIsEnabled

bool BIsEnabled();

Verifica se o reprodutor de música do Steam está disponível.

Retorna: bool
true se está disponível. Caso contrario, irá retornar false.

BIsPlaying

bool BIsPlaying();

Verifica se o reprodutor de música do Steam está ativo. Não significa necessariamente de que uma música está a ser reproduzida, pode estar em pausa.

Para um controlo mais preciso, use a função GetPlaybackStatus.

Retorna: bool
true se uma música estiver a ser reproduzida, em pausa ou na fila de reprodução. Caso contrário, irá retornar false.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();

Obtém o estado atual do reprodutor de música do Steam.

Retorna: AudioPlayback_Status

GetVolume

float GetVolume();

Obtém o volume atual do reprodutor de música do Steam.

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

Pause

void Pause();

Pausa o reprodutor de música do Steam.

Play

void Play();

Retoma a reprodução do reprodutor de música do Steam.

PlayNext

void PlayNext();

Avança para a música seguinte no reprodutor de música do Steam.

PlayPrevious

void PlayPrevious();

Retrocede para a música anterior no reprodutor de música do Steam.

SetVolume

void SetVolume( float flVolume );

Nome	Tipo	Descrição
flVolume	float	A percentagem do volume a definir, de 0.0 a 1.0.

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

Callbacks

Estes são os callbacks que podem ocorrer ao chamar SteamAPI_RunCallbacks. Muitos destes callbacks irão ocorrer diretamente como resposta às funções de membro de ISteamMusic.

PlaybackStatusHasChanged_t

Este callback não tem campos.

VolumeHasChanged_t

Nome	Tipo	Descrição
m_flNewVolume	float

Enums

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

AudioPlayback_Status

Especifica o estado atual do reprodutor.

Nome	Valor	Descrição
AudioPlayback_Undefined	0	A interface de música do Steam provavelmente não está disponível.
AudioPlayback_Playing	1	O reprodutor de música do Steam está a reproduzir áudio.
AudioPlayback_Paused	2	O reprodutor de música do Steam está em pausa.
AudioPlayback_Idle	3	O reprodutor de música do Steam está parado.

Constantes

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

Nome	Tipo	Valor	Descrição
STEAMMUSIC_INTERFACE_VERSION	const char *	"STEAMMUSIC_INTERFACE_VERSION001"