Gränssnitt – ISteamMusic (Steamworksdokumentation)

Steamworks-dokumentation

Gränssnitt – ISteamMusic

Steamworksdokumentation > Referensdokumentation för Steamworks-API:et > Gränssnitt – ISteamMusic

Funktioner för att styra musikuppspelning i Steam-klienten.

Detta ger spel möjlighet att göra saker som att pausa musiken eller sänka volymen när en viktig mellanscen visas, för att sedan starta den igen efteråt.

Läs features/music_player för mer information.

Medlemsfunktioner

Medlemsfunktioner för ISteamMusic anropas via den globala accessorfunktionen SteamMusic().

BIsEnabled

bool BIsEnabled();

Kontrollerar om Steam Music är aktiverat.

Returnerar: bool
true om det är aktiverat; annars false.

BIsPlaying

bool BIsPlaying();

Kontrollerar om Steam Music är aktiverat. Detta betyder inte nödvändigtvis att en låt spelas, den kan vara pausad.

Använd GetPlaybackStatus för en mer detaljerad kontroll.

Returnerar: bool
true om en låt för närvarande spelas, är pausad eller står i kö för att spelas upp; annars false.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();

Hämtar aktuell status för Steam-musikspelaren.

Returnerar: AudioPlayback_Status

GetVolume

float GetVolume();

Hämtar aktuell volym för Steam-musikspelaren.

Returnerar: float
Volymen returneras som en procentsats mellan 0,0 och 1,0.

Pause

void Pause();

Pausa Steam-musikspelaren.

Play

void Play();

Få Steam-musikspelaren återuppta uppspelningen.

PlayNext

void PlayNext();

Få Steams musikspelare att hoppa till nästa låt.

PlayPrevious

void PlayPrevious();

Få Steam-musikspelaren att spela föregående låt.

SetVolume

void SetVolume( float flVolume );

Namn	Typ	Beskrivning
flVolume	float	Volymprocent att ange från 0,0 till 1,0.

Ställer in volymen för Steam-musikspelaren.

Återanrop

Återanrop som kan aktiveras genom att anropa SteamAPI_RunCallbacks. Många av dem kommer att utlösas direkt som svar på medlemsfunktionerna i ISteamMusic.

PlaybackStatusHasChanged_t

Detta återanrop har inga fält.

VolumeHasChanged_t

Namn	Typ	Beskrivning
m_flNewVolume	float

Uppräknare

Uppräknare som definieras för användning med ISteamMusic.

AudioPlayback_Status

Anger aktuell uppspelningsstatus.

Namn	Värde	Beskrivning
AudioPlayback_Undefined	0	Steam Music-gränssnittet är förmodligen inte aktiverat.
AudioPlayback_Playing	1	Steam Music spelar för tillfället.
AudioPlayback_Paused	2	Steam Music är pausat för tillfället.
AudioPlayback_Idle	3	Steam Music är stoppat för tillfället.

Konstanter

Konstanter som definieras för användning med ISteamMusic.

Namn	Typ	Värde	Beskrivning
STEAMMUSIC_INTERFACE_VERSION	const char *	"STEAMMUSIC_INTERFACE_VERSION001"