Steamworks 文獻庫
ISteamMusicRemote 介面
用來直接與 Steam 音樂播放器互動。

如需更多資訊,請參閱 features/music_player一文。

成員函式

ISteamMusicRemote 的成員函式可透過全域存取子函式 ISteamMusicRemote() 呼叫。

BActivationSuccess

bool BActivationSuccess( bool bValue );
名稱型別說明
bValuebool



傳回: bool

BIsCurrentMusicRemote

bool BIsCurrentMusicRemote();


傳回: bool

CurrentEntryDidChange

bool CurrentEntryDidChange();


傳回: bool

CurrentEntryIsAvailable

bool CurrentEntryIsAvailable( bool bAvailable );
名稱型別說明
bAvailablebool



傳回: bool

CurrentEntryWillChange

bool CurrentEntryWillChange();
目前的項目。

傳回: bool

DeregisterSteamMusicRemote

bool DeregisterSteamMusicRemote();


傳回: bool

EnableLooped

bool EnableLooped( bool bValue );
名稱型別說明
bValuebool



傳回: bool

EnablePlaylists

bool EnablePlaylists( bool bValue );
名稱型別說明
bValuebool



傳回: bool

EnablePlayNext

bool EnablePlayNext( bool bValue );
名稱型別說明
bValuebool



傳回: bool

EnablePlayPrevious

bool EnablePlayPrevious( bool bValue );
名稱型別說明
bValuebool

使用者介面的功能。

傳回: bool

EnableQueue

bool EnableQueue( bool bValue );
名稱型別說明
bValuebool



傳回: bool

EnableShuffled

bool EnableShuffled( bool bValue );
名稱型別說明
bValuebool



傳回: bool

PlaylistDidChange

bool PlaylistDidChange();


傳回: bool

PlaylistWillChange

bool PlaylistWillChange();
播放清單。

傳回: bool

QueueDidChange

bool QueueDidChange();


傳回: bool

QueueWillChange

bool QueueWillChange();
佇列。

傳回: bool

RegisterSteamMusicRemote

bool RegisterSteamMusicRemote( const char *pchName );
名稱型別說明
pchNameconst char *

服務定義。

傳回: bool

ResetPlaylistEntries

bool ResetPlaylistEntries();


傳回: bool

ResetQueueEntries

bool ResetQueueEntries();


傳回: bool

SetCurrentPlaylistEntry

bool SetCurrentPlaylistEntry( int nID );
名稱型別說明
nIDint



傳回: bool

SetCurrentQueueEntry

bool SetCurrentQueueEntry( int nID );
名稱型別說明
nIDint



傳回: bool

SetDisplayName

bool SetDisplayName( const char *pchDisplayName );
名稱型別說明
pchDisplayNameconst char *



傳回: bool

SetPlaylistEntry

bool SetPlaylistEntry( int nID, int nPosition, const char *pchEntryText );
名稱型別說明
nIDint
nPositionint
pchEntryTextconst char *



傳回: bool

SetPNGIcon_64x64

bool SetPNGIcon_64x64( void *pvBuffer, uint32 cbBufferLength );
名稱型別說明
pvBuffervoid *
cbBufferLengthuint32



傳回: bool

SetQueueEntry

bool SetQueueEntry( int nID, int nPosition, const char *pchEntryText );
名稱型別說明
nIDint
nPositionint
pchEntryTextconst char *



傳回: bool

UpdateCurrentEntryCoverArt

bool UpdateCurrentEntryCoverArt( void *pvBuffer, uint32 cbBufferLength );
名稱型別說明
pvBuffervoid *
cbBufferLengthuint32



傳回: bool

UpdateCurrentEntryElapsedSeconds

bool UpdateCurrentEntryElapsedSeconds( int nValue );
名稱型別說明
nValueint



傳回: bool

UpdateCurrentEntryText

bool UpdateCurrentEntryText( const char *pchText );
名稱型別說明
pchTextconst char *



傳回: bool

UpdateLooped

bool UpdateLooped( bool bValue );
名稱型別說明
bValuebool



傳回: bool

UpdatePlaybackStatus

bool UpdatePlaybackStatus( AudioPlayback_Status nStatus );
名稱型別說明
nStatusAudioPlayback_Status

狀態。

傳回: bool

UpdateShuffled

bool UpdateShuffled( bool bValue );
名稱型別說明
bValuebool



傳回: bool

UpdateVolume

bool UpdateVolume( float flValue );
名稱型別說明
flValuefloat



傳回: bool

回呼

以下為呼叫 SteamAPI_RunCallbacks 後可能會發出的回呼。 之中許多函式會應 ISteamMusicRemote 的成員函式直接執行。

MusicPlayerRemoteToFront_t



此回呼沒有欄位。

MusicPlayerRemoteWillActivate_t



此回呼沒有欄位。

MusicPlayerRemoteWillDeactivate_t



此回呼沒有欄位。

MusicPlayerSelectsPlaylistEntry_t



名稱型別說明
nIDint

MusicPlayerSelectsQueueEntry_t



名稱型別說明
nIDint

MusicPlayerWantsLooped_t



名稱型別說明
m_bLoopedbool

MusicPlayerWantsPause_t



此回呼沒有欄位。

MusicPlayerWantsPlayingRepeatStatus_t



名稱型別說明
m_nPlayingRepeatStatusint

MusicPlayerWantsPlayNext_t



此回呼沒有欄位。

MusicPlayerWantsPlayPrevious_t



此回呼沒有欄位。

MusicPlayerWantsPlay_t



此回呼沒有欄位。

MusicPlayerWantsShuffled_t



名稱型別說明
m_bShuffledbool

MusicPlayerWantsVolume_t



名稱型別說明
m_flNewVolumefloat

MusicPlayerWillQuit_t



此回呼沒有欄位。

常數

以下為定義來用於 ISteamMusicRemote 中的常數。

名稱型別說明
k_SteamMusicNameMaxLengthint255
k_SteamMusicPNGMaxLengthint65535
STEAMMUSICREMOTE_INTERFACE_VERSIONconst char *"STEAMMUSICREMOTE_INTERFACE_VERSION001"
  翻译: