Steamworks-dokumentation
ISteamMusic-grænseflade
Funktioner til at kontrollere musikafspilning i Steam-klienten.

Dette gør det muligt for spil at sætte musik på pause, sænke lydstyrken, når der vises en vigtig cut-scene, og starte afspilningen bagefter.

Se features/music_player for flere oplysninger.

Medlemsfunktioner

Medlemsfunktioner for ISteamMusic kaldes gennem den globale accessor-funktion SteamMusic().

BIsEnabled

bool BIsEnabled();
Tjekker, om Steam-musik er slået til.

Returværdier: bool
true, hvis det er slået til, ellers false.

BIsPlaying

bool BIsPlaying();
Tjekker, om Steam-musik er aktivt. Dette betyder ikke nødvendigvis, at der afspilles en sang i øjeblikket. Sangen kan være sat på pause.

Brug GetPlaybackStatus, hvis du vil have mere nøjagtig styring.

Returværdier: bool
true, hvis der afspilles en sang i øjeblikket, den er sat på pause eller står i kø til at blive afspillet, ellers false.

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();
Henter den aktuelle status for Steam-musikafspilleren.

Returværdier: AudioPlayback_Status

GetVolume

float GetVolume();
Henter den aktuelle lydstyrke for Steam-musikafspilleren.

Returværdier: float
Lydstyrken returneres som en procent mellem 0,0 og 1,0.

Pause

void Pause();
Sætter Steam-musikafspilleren på pause.

Play

void Play();
Får Steam-musikafspilleren til at genoptage afspilningen.

PlayNext

void PlayNext();
Får Steam-musikafspilleren til at springe til den næste sang.

PlayPrevious

void PlayPrevious();
Får Steam-musikafspilleren til at afspille den forrige sang.

SetVolume

void SetVolume( float flVolume );
NavnTypeBeskrivelse
flVolumefloatLydstyrkeprocenten, der skal sættes fra 0,0 til 1,0.

Indstiller lydstyrken for Steam-musikafspilleren.

Tilbagekald

Disse er tilbagekald, som kan aktiveres ved at kalde SteamAPI_RunCallbacks. Mange af disse vil blive udløst direkte som svar på medlemsfunktionerne i ISteamMusic.

PlaybackStatusHasChanged_t


Dette tilbagekald har ingen felter.

VolumeHasChanged_t



NavnTypeBeskrivelse
m_flNewVolumefloat

Enums

Disse er optællinger, som defineres til brug med ISteamMusic.

AudioPlayback_Status

Angiver den aktuelle afspilningsstatus.

NavnVærdiBeskrivelse
AudioPlayback_Undefined0Grænsefladen for Steam-musik er nok ikke slået til.
AudioPlayback_Playing1Steam-musik afspiller i øjeblikket.
AudioPlayback_Paused2Steam-musik er sat på pause i øjeblikket.
AudioPlayback_Idle3Steam-musik er stoppet i øjeblikket.

Konstanter

Det følgende er konstanter, som defineres til brug med ISteamMusic.

NavnTypeVærdiBeskrivelse
STEAMMUSIC_INTERFACE_VERSIONconst char *"STEAMMUSIC_INTERFACE_VERSION001"