Steamworks-Dokumentation
ISteamMusic-Schnittstelle
Funktionen zum Steuern der Musikwiedergabe im Steam-Client.

Dies ermöglicht Spielen bei Anzeige einer wichtigen Zwischensequenz die Musik zu pausieren, die Lautstärke zu reduzieren und Ähnliches und anschließend die Wiedergabe wieder aufzunehmen.

Weitere Informationen finden Sie hier: features/music_player.

Memberfunktionen

Memberfunktionen für ISteamMusic werden über die globale Accessorfunktion SteamMusic() aufgerufen.

BIsEnabled

bool BIsEnabled();
Überprüft, ob Steam-Musik aktiviert ist.

Rückgabewert: bool
true, wenn es aktiviert ist. Andernfalls false.

BIsPlaying

bool BIsPlaying();
Überprüft, ob Steam-Musik aktiv ist. Dies bedeutet nicht unbedingt, dass derzeit ein Musiktitel wiedergegeben wird. Die Musikwiedergabe könnte auch gerade pausiert sein.

Für die Feinabstimmung der Steuerung verwenden Sie bitte GetPlaybackStatus.

Rückgabewert: bool
true, wenn ein Musiktitel aktuell abgespielt wird, pausiert wird oder sich zum Abspielen in der Warteschlange befindet. Andernfalls false.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();
Ruft den aktuellen Status des Steam-Musikplayers ab.

Rückgabewert: AudioPlayback_Status

GetVolume

float GetVolume();
Ruft die aktuelle Lautstärke des Steam-Musikplayers ab.

Rückgabewert: float
Die Lautstärke wird als Prozentwert zwischen 0.0 und 1.0 zurückgegeben.

Pause

void Pause();
Schaltet den Steam-Musikplayer auf Pause.

Play

void Play();
Lässt den Steam-Musikplayer die Wiedergabe fortsetzen.

PlayNext

void PlayNext();
Lässt den Steam-Musikplayer zum nächsten Musiktitel springen.

PlayPrevious

void PlayPrevious();
Lässt den Steam-Musikplayer den vorherigen Musiktitel wiedergeben.

SetVolume

void SetVolume( float flVolume );
NameTypBeschreibung
flVolumefloatDie zu setzende Lautstärke in Prozent von 0.0 bis 1.0.

Stellt die Lautstärke des Steam-Musikplayers ein.

Rückrufe

Dies sind Rückrufe, die durch Aufrufen von SteamAPI_RunCallbacks ausgelöst werden können. Viele davon werden als Reaktion auf die Memberfunktionen von ISteamMusic aufgerufen.

PlaybackStatusHasChanged_t


Dieser Rückruf hat keine Variablen.

VolumeHasChanged_t



NameTypBeschreibung
m_flNewVolumefloat

Enums

Dies sind Aufzählungstypen, die zur Verwendung mit ISteamMusic definiert sind.

AudioPlayback_Status

Gibt den aktuellen Wiedergabestatus an.

NameWertBeschreibung
AudioPlayback_Undefined0Die Steam-Musik-Schnittstelle ist wahrscheinlich nicht aktiviert.
AudioPlayback_Playing1Steam-Musik ist derzeit auf Wiedergabe geschaltet.
AudioPlayback_Paused2Steam-Musik ist derzeit auf Pause geschaltet.
AudioPlayback_Idle3Steam-Musik ist derzeit angehalten.

Konstanten

Dies sind Konstanten, die zur Verwendung mit ISteamMusic definiert sind.

NameTypWertBeschreibung
STEAMMUSIC_INTERFACE_VERSIONconst char *"STEAMMUSIC_INTERFACE_VERSION001"