ISteamMusic interfész (Steamworks dokumentáció)

Steamworks dokumentáció

ISteamMusic interfész

Steamworks dokumentáció > Steamworks API referencia > ISteamMusic interfész

Függvények a Steam kliensben levő zenelejátszó vezérlésére.

Ez lehetőséget ad a játékoknak olyan dolgokra, mint a zene szüneteltetése vagy a hangerő csökkentése, amikor fontos átvezető videó jelenik meg, és utána elkezdhetik annak lejátszását.

További információkért nézd meg a features/music_player dokumentációt.

Tagfüggvények

Az ISteamMusic tagfüggvényei a SteamMusic() globális accessor függvényen keresztül vannak meghívva.

BIsEnabled

bool BIsEnabled();

Ellenőrzi, hogy a Steam Zene be van-e kapcsolva.

Visszatérési érték: bool
true ha be van kapcsolva; ellenkező esetben false.

BIsPlaying

bool BIsPlaying();

Ellenőrzi, hogy a Steam Zene aktív-e. Ez nem feltétlenül jelenti azt, hogy épp lejátszik valamit, lehet szüneteltetve is.

Finomabb vezérléshez használd az GetPlaybackStatus-t.

Visszatérési érték: bool
true ha épp lejátszik valamit, szüneteltetve van, vagy van valami a lejátszási sorban; ellenkező esetben false.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();

Lekéri a Steam zenelejátszó jelenlegi állapotát.

Visszatérési érték: AudioPlayback_Status

GetVolume

float GetVolume();

Lekéri a Steam zenelejátszó jelenlegi hangerejét.

Visszatérési érték: float
A hangerő 0.0 és 1.0 érték közötti százalékként van visszaadva.

Pause

void Pause();

Szünetelteti a Steam zenelejátszót.

Play

void Play();

A lejátszás folytatására utasítja a Steam zenelejátszót.

PlayNext

void PlayNext();

A következő dalhoz ugrásra utasítja a Steam zenelejátszót.

PlayPrevious

void PlayPrevious();

Az előző dal lejátszására utasítja a Steam zenelejátszót.

SetVolume

void SetVolume( float flVolume );

Név	Típus	Leírás
flVolume	float	A beállítandó hangerőszázalék 0.0 és 1.0 között.

Beállítja a Steam zenelejátszó hangerejét.

Callbackek

Ezek olyan callbackek, amelyek a SteamAPI_RunCallbacks hívásával indíthatók. Ezek közül sok közvetlenül kiváltódik az ISteamMusic tagfüggvényeire reagálva.

PlaybackStatusHasChanged_t

E callbacknek nincsenek mezői.

VolumeHasChanged_t

Név	Típus	Leírás
m_flNewVolume	float

Enumok

Ezek az ISteamMusic-kal való használathoz definiált enumok.

AudioPlayback_Status

Megadja a jelenlegi lejátszási állapotot.

Név	Érték	Leírás
AudioPlayback_Undefined	0	Valószínűleg nincs engedélyezve a Steam zenelejátszó kezelőfelület.
AudioPlayback_Playing	1	Az Steam Zene jelenleg lejátszik.
AudioPlayback_Paused	2	Az Steam Zene jelenleg szüneteltetve van.
AudioPlayback_Idle	3	A Steam Zene jelenleg meg van állítva.

Konstansok

Ezek az ISteamMusic-kal való használathoz definiált konstansok.

Név	Típus	Érték	Leírás
STEAMMUSIC_INTERFACE_VERSION	const char *	"STEAMMUSIC_INTERFACE_VERSION001"