Documentation Steamworks
Interface ISteamMusic
Fonctions de contrôle de la lecture de musique dans le client Steam.

Cette fonction donne aux jeux l'opportunité d'accomplir des actions telles que mettre en pause la musique ou en baisser le volume lors de l'affichage d'une scène cinématique importante, et de reprendre la lecture normale ensuite.

Pour plus d'informations, consultez la section features/music_player.

Fonctions membres

Les fonctions membres de ISteamMusic sont appelées par le biais de la fonction d'accesseur global SteamMusic().

BIsEnabled

bool BIsEnabled();
Vérifie si Steam Music est activé.

Éléments renvoyés : bool
true si Steam Music est activé. Autrement, renvoie false.

BIsPlaying

bool BIsPlaying();
Vérifie si Steam Music est actif. Il n'est pas nécessaire qu'un morceau soit en cours de lecture pour que Steam Music soit considéré comme actif ; la musique peut aussi être en pause.

Pour un contrôle du grain plus précis, utilisez GetPlaybackStatus.

Éléments renvoyés : bool
true si un morceau est en cours de lecture, en pause ou dans la file d'attente. Autrement, renvoie false.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();
Obtient l'état actuel du lecteur de musique Steam.

Éléments renvoyés : AudioPlayback_Status

GetVolume

float GetVolume();
Obtient le volume actuel du lecteur de musique Steam.

Éléments renvoyés : float
Le volume correspond à un pourcentage entre 0,0 et 1,0.

Pause

void Pause();
Met le lecteur de musique Steam en pause.

Play

void Play();
Permet au lecteur de musique Steam de reprendre la lecture.

PlayNext

void PlayNext();
Permet au lecteur de musique Steam de passer au morceau suivant.

PlayPrevious

void PlayPrevious();
Permet au lecteur de musique Steam de lire le morceau précédent.

SetVolume

void SetVolume( float flVolume );
NomTypeDescription
flVolumefloatLe pourcentage de volume compris entre 0,0 et 1,0.

Règle le volume du lecteur de musique Steam.

Rappels

Voici les rappels qui peuvent être activés en appelant SteamAPI_RunCallbacks. La plupart seront activés directement en réponse aux fonctions membres de ISteamMusic.

PlaybackStatusHasChanged_t


Ce rappel n'a pas de champ.

VolumeHasChanged_t



NomTypeDescription
m_flNewVolumefloat

Énumérations

Voici les énumérations destinées à être utilisées avec ISteamMusic.

AudioPlayback_Status

Renvoie l'état actuel de lecture.

NomValeurDescription
AudioPlayback_Undefined0L'interface Steam Music n'est probablement pas activée.
AudioPlayback_Playing1Steam Music est actuellement en cours de lecture.
AudioPlayback_Paused2Steam Music est actuellement en pause.
AudioPlayback_Idle3Steam Music est actuellement arrêté.

Constantes

Voici les constantes destinées à être utilisées avec ISteamMusic.

NomTypeValeurDescription
STEAMMUSIC_INTERFACE_VERSIONconst char *"STEAMMUSIC_INTERFACE_VERSION001"