SteamWorks.SteamMusicRemote - theace0296/steamworks-node GitHub Wiki
Interface: SteamMusicRemote
SteamWorksNamespace.SteamMusicRemote
Table of contents
Properties
- BActivationSuccess
- BIsCurrentMusicRemote
- CurrentEntryDidChange
- CurrentEntryIsAvailable
- CurrentEntryWillChange
- DeregisterSteamMusicRemote
- EnableLooped
- EnablePlayNext
- EnablePlayPrevious
- EnablePlaylists
- EnableQueue
- EnableShuffled
- PlaylistDidChange
- PlaylistWillChange
- QueueDidChange
- QueueWillChange
- RegisterSteamMusicRemote
- ResetPlaylistEntries
- ResetQueueEntries
- SetCurrentPlaylistEntry
- SetCurrentQueueEntry
- SetDisplayName
- SetPNGIcon_64x64
- SetPlaylistEntry
- SetQueueEntry
- UpdateCurrentEntryCoverArt
- UpdateCurrentEntryElapsedSeconds
- UpdateCurrentEntryText
- UpdateLooped
- UpdatePlaybackStatus
- UpdateShuffled
- UpdateVolume
Properties
BActivationSuccess
• BActivationSuccess: (bValue: boolean) => boolean
Type declaration
▸ (bValue): boolean
Parameters
| Name | Type |
|---|---|
bValue |
boolean |
Returns
boolean
Defined in
BIsCurrentMusicRemote
• BIsCurrentMusicRemote: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
CurrentEntryDidChange
• CurrentEntryDidChange: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
CurrentEntryIsAvailable
• CurrentEntryIsAvailable: (bAvailable: boolean) => boolean
Type declaration
▸ (bAvailable): boolean
Parameters
| Name | Type |
|---|---|
bAvailable |
boolean |
Returns
boolean
Defined in
CurrentEntryWillChange
• CurrentEntryWillChange: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
DeregisterSteamMusicRemote
• DeregisterSteamMusicRemote: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
EnableLooped
• EnableLooped: (bValue: boolean) => boolean
Type declaration
▸ (bValue): boolean
Parameters
| Name | Type |
|---|---|
bValue |
boolean |
Returns
boolean
Defined in
EnablePlayNext
• EnablePlayNext: (bValue: boolean) => boolean
Type declaration
▸ (bValue): boolean
Parameters
| Name | Type |
|---|---|
bValue |
boolean |
Returns
boolean
Defined in
EnablePlayPrevious
• EnablePlayPrevious: (bValue: boolean) => boolean
Type declaration
▸ (bValue): boolean
Parameters
| Name | Type |
|---|---|
bValue |
boolean |
Returns
boolean
Defined in
EnablePlaylists
• EnablePlaylists: (bValue: boolean) => boolean
Type declaration
▸ (bValue): boolean
Parameters
| Name | Type |
|---|---|
bValue |
boolean |
Returns
boolean
Defined in
EnableQueue
• EnableQueue: (bValue: boolean) => boolean
Type declaration
▸ (bValue): boolean
Parameters
| Name | Type |
|---|---|
bValue |
boolean |
Returns
boolean
Defined in
EnableShuffled
• EnableShuffled: (bValue: boolean) => boolean
Type declaration
▸ (bValue): boolean
Parameters
| Name | Type |
|---|---|
bValue |
boolean |
Returns
boolean
Defined in
PlaylistDidChange
• PlaylistDidChange: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
PlaylistWillChange
• PlaylistWillChange: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
QueueDidChange
• QueueDidChange: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
QueueWillChange
• QueueWillChange: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
RegisterSteamMusicRemote
• RegisterSteamMusicRemote: (pchName: string) => boolean
Type declaration
▸ (pchName): boolean
Parameters
| Name | Type |
|---|---|
pchName |
string |
Returns
boolean
Defined in
ResetPlaylistEntries
• ResetPlaylistEntries: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
ResetQueueEntries
• ResetQueueEntries: () => boolean
Type declaration
▸ (): boolean
Returns
boolean
Defined in
SetCurrentPlaylistEntry
• SetCurrentPlaylistEntry: (nID: number) => boolean
Type declaration
▸ (nID): boolean
Parameters
| Name | Type |
|---|---|
nID |
number |
Returns
boolean
Defined in
SetCurrentQueueEntry
• SetCurrentQueueEntry: (nID: number) => boolean
Type declaration
▸ (nID): boolean
Parameters
| Name | Type |
|---|---|
nID |
number |
Returns
boolean
Defined in
SetDisplayName
• SetDisplayName: (pchDisplayName: string) => boolean
Type declaration
▸ (pchDisplayName): boolean
Parameters
| Name | Type |
|---|---|
pchDisplayName |
string |
Returns
boolean
Defined in
SetPNGIcon_64x64
• SetPNGIcon_64x64: (pvBuffer: unknown, cbBufferLength: number) => boolean
Type declaration
▸ (pvBuffer, cbBufferLength): boolean
Parameters
| Name | Type |
|---|---|
pvBuffer |
unknown |
cbBufferLength |
number |
Returns
boolean
Defined in
SetPlaylistEntry
• SetPlaylistEntry: (nID: number, nPosition: number, pchEntryText: string) => boolean
Type declaration
▸ (nID, nPosition, pchEntryText): boolean
Parameters
| Name | Type |
|---|---|
nID |
number |
nPosition |
number |
pchEntryText |
string |
Returns
boolean
Defined in
SetQueueEntry
• SetQueueEntry: (nID: number, nPosition: number, pchEntryText: string) => boolean
Type declaration
▸ (nID, nPosition, pchEntryText): boolean
Parameters
| Name | Type |
|---|---|
nID |
number |
nPosition |
number |
pchEntryText |
string |
Returns
boolean
Defined in
UpdateCurrentEntryCoverArt
• UpdateCurrentEntryCoverArt: (pvBuffer: unknown, cbBufferLength: number) => boolean
Type declaration
▸ (pvBuffer, cbBufferLength): boolean
Parameters
| Name | Type |
|---|---|
pvBuffer |
unknown |
cbBufferLength |
number |
Returns
boolean
Defined in
UpdateCurrentEntryElapsedSeconds
• UpdateCurrentEntryElapsedSeconds: (nValue: number) => boolean
Type declaration
▸ (nValue): boolean
Parameters
| Name | Type |
|---|---|
nValue |
number |
Returns
boolean
Defined in
UpdateCurrentEntryText
• UpdateCurrentEntryText: (pchText: string) => boolean
Type declaration
▸ (pchText): boolean
Parameters
| Name | Type |
|---|---|
pchText |
string |
Returns
boolean
Defined in
UpdateLooped
• UpdateLooped: (bValue: boolean) => boolean
Type declaration
▸ (bValue): boolean
Parameters
| Name | Type |
|---|---|
bValue |
boolean |
Returns
boolean
Defined in
UpdatePlaybackStatus
• UpdatePlaybackStatus: (nStatus: AudioPlayback_Status) => boolean
Type declaration
▸ (nStatus): boolean
Parameters
| Name | Type |
|---|---|
nStatus |
AudioPlayback_Status |
Returns
boolean
Defined in
UpdateShuffled
• UpdateShuffled: (bValue: boolean) => boolean
Type declaration
▸ (bValue): boolean
Parameters
| Name | Type |
|---|---|
bValue |
boolean |
Returns
boolean
Defined in
UpdateVolume
• UpdateVolume: (flValue: number) => boolean
Type declaration
▸ (flValue): boolean
Parameters
| Name | Type |
|---|---|
flValue |
number |
Returns
boolean