Interfaz de ISteamMusic (documentación de Steamworks)

Documentación de Steamworks

Interfaz de ISteamMusic

Documentación de Steamworks > Referencia de la API de Steamworks > Interfaz de ISteamMusic

Funciones para controlar la reproducción de música en el cliente de Steam.

Esto proporciona a los juegos la posibilidad de hacer cosas como poner la música en pausa o bajar el volumen cuando comienza una secuencia importante y reiniciarla después.

Visita features/music_player para obtener más información.

Funciones de miembros

Las funciones miembro para ISteamMusic se llaman a través de la función de acceso global SteamMusic().

BIsEnabled

bool BIsEnabled();

Comprueba si Steam Music está habilitado.

Devuelve: bool
True si está habilitado; de lo contrario false.

BIsPlaying

bool BIsPlaying();

Comprueba si Steam Music está activo. No significa necesariamente que se esté reproduciendo una canción, puede estar en pausa.

Para un control más fino utiliza GetPlaybackStatus.

Devuelve: bool
true si una canción se está reproduciendo, está en pausa o en cola actualmente para reproducir; de lo contrario false.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();

Obtiene el estado actual del reproductor de música de Steam.

Devuelve: AudioPlayback_Status

GetVolume

float GetVolume();

Obtiene el volumen actual del reproductor de música de Steam.

Devuelve: float
El volumen se devuelve como un porcentaje entre 0.0 y 1.0.

Poner en pausa

void Pause();

Pone en pausa el reproductor de música de Steam.

Reproducir

void Play();

Reanuda la reproducción en el reproductor de música de Steam.

PlayNext

void PlayNext();

Hace que el reproductor de música de Steam pase a la canción siguiente.

PlayPrevious

void PlayPrevious();

Hace que el reproductor de música de Steam reproduzca la canción anterior.

SetVolume

void SetVolume( float flVolume );

Nombre	Tipo	Descripción
flVolume	float	El porcentaje de volumen que se debe configurar desde 0.0 a 1.0.

Establece el volumen actual del reproductor de música de Steam.

Devoluciones de llamada

Estas son funciones callback que pueden activarse llamando a SteamAPI_RunCallbacks. Muchas de estas se activarán directamente en respuesta a las funciones miembro de ISteamMusic.

PlaybackStatusHasChanged_t

Esta función callback no tiene campos.

VolumeHasChanged_t

Nombre	Tipo	Descripción
m_flNewVolume	float

Enums

Estas son las enumeraciones definidas para usarse con ISteamMusic.

AudioPlayback_Status

Especifica el estado actual de la reproducción.

Nombre	Valor	Descripción
AudioPlayback_Undefined	0	Probablemente, la interfaz de Steam Music no está habilitada.
AudioPlayback_Playing	1	Steam Music está reproduciendo algo.
AudioPlayback_Paused	2	Steam Music está en pausa.
AudioPlayback_Idle	3	Steam Music se ha detenido.

Constantes

Son constantes definidas para usarse con ISteamMusic.

Nombre	Tipo	Valor	Descripción
STEAMMUSIC_INTERFACE_VERSION	const char *	"STEAMMUSIC_INTERFACE_VERSION001"