Документация Steamworks
Интерфейс ISteamMusicRemote
Предоставляет прямой доступ к проигрывателю Steam.

Подробно эти функции описаны в разделе features/music_player.

Функции-члены

Функции-члены ISteamMusicRemote вызываются с помощью глобальной функции доступа SteamMusicRemote().

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"
  翻译: