ISteamMusic-käyttöliittymä (Steamworks-dokumentaatio)

Steamworks-dokumentaatio

ISteamMusic-käyttöliittymä

Steamworks-dokumentaatio > Steamworks-ohjelmointirajapintojen dokumentaatio > ISteamMusic-käyttöliittymä

Funktioita, joilla voi kontrolloida musiikin toistamista Steam-asiakasohjelmassa.

Tämän ansiosta pelit voivat esimerkiksi keskeyttää musiikin tai laskea tärkeän kohtauksen ajaksi äänenvoimakkutta ja jatkaa sitten uudelleen.

Lisätietoja löytyy täältä: features/music_player.

Jäsenfunktiot

ISteamMusic-käyttöliittymän jäsenfunktioita kutsutaan globaalilla SteamMusic()-aksessorifunktiolla.

BIsEnabled

bool BIsEnabled();

Tarkistaa, onko Steam Music käytössä.

Paluuarvot: bool
true, jos käytössä, muuten false.

BIsPlaying

bool BIsPlaying();

Tarkistaa, onko Steam Music aktiivinen. Se ei välttämättä tarkoita, että kappaletta toistetaan parhaillaan, vaan se voi olla keskeytetty.

Yksityiskohtaisempaan hallintaan voidaan käyttää ohjelmointirajapintaa ISteamMusic::getPlaybackStatus .

Paluuarvot: bool
true, jos kappaletta toistetaan parhaillaan, se on keskeytetty tai asetettu soittojonoon. Muuten arvo on false.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();

Hakee Steam Musicin nykyisen tilan.

Paluuarvot: AudioPlayback_Status

GetVolume

float GetVolume();

Hakee Steam Musicin nykyisen äänenvoimakkuuden.

Paluuarvot: float
Äänenvoimakkuus palautetaan prosentteina välillä 0,0 ja 1,0.

Pause

void Pause();

Keskeyttää Steam Musicin.

Play

void Play();

Pyytää Steam Musicia jatkamaan toistoa.

PlayNext

void PlayNext();

Pyytää Steam Musicia siirtymään seuraavaan kappaleeseen.

PlayPrevious

void PlayPrevious();

Pyytää Steam Musicia siirtymään edelliseen kappaleeseen.

SetVolume

void SetVolume( float flVolume );

Nimi	Tyyppi	Kuvaus
flVolume	float	Äänenvoimakkuusprosentti, joka asetetaan välille 0,0 ja 1,0.

Asettaa Steam Musicin äänenvoimakkuuden.

Takaisinkutsut

Nämä ovat takaisinkutsuja, jotka voidaan käynnistää SteamAPI_RunCallbacks-kutsulla. Useat näistä aktivoituvat ISteamMusic-jäsenfunktioiden seurauksena.

PlaybackStatusHasChanged_t

Takaisinkutsussa ei ole kenttiä.

VolumeHasChanged_t

Nimi	Tyyppi	Kuvaus
m_flNewVolume	float

Luetellut tyypit

Nämä ovat lueteltuja tyyppejä, jotka on määritetty käytettäviksi ISteamMusic-käyttöliittymässä.

AudioPlayback_Status

Määrittää toiston nykyisen tilan.

Nimi	Arvo	Kuvaus
AudioPlayback_Undefined	0	Steam Music -käyttöliittymä ei todennäköisesti ole käytössä.
AudioPlayback_Playing	1	Steam Music soi parhaillaan.
AudioPlayback_Paused	2	Steam Music on keskeytetty.
AudioPlayback_Idle	3	Steam Music on pysäytetty.

Vakiot

Nämä ovat vakioita, jotka on määritetty käytettäviksi ISteamMusic-käyttöliittymässä.

Nimi	Tyyppi	Arvo	Kuvaus
STEAMMUSIC_INTERFACE_VERSION	const char *	"STEAMMUSIC_INTERFACE_VERSION001"