Class SpotifyPlayerSpirc

Wrapper for librespot SPIRC player

Hierarchy

GenericPlayer
- SpotifyPlayerSpirc

Index

Constructors

Properties

_isInitialized _positionHolder _volume device_id eventEmitter off on playerInstance tokenHandler

Accessors

Methods

addListener addToQueue close getCanvas getCurrentPosition getDeviceId getLyrics getToken getVolume load onPlayerInitialized once pause play removeAllListeners removeListener seek setVolume validateUri

Constructors

constructor

new SpotifyPlayerSpirc(config): SpotifyPlayerSpirc
Parameters
- config: ConstructorConfig
Returns SpotifyPlayerSpirc
Overrides GenericPlayer.constructor
- Defined in spirc.ts:16

Properties

`Protected` _isInitialized

_isInitialized: boolean = false

`Protected` _positionHolder

_positionHolder: PositionHolder

`Protected` _volume

_volume: number = 0

`Protected` device_id

device_id: string

eventEmitter

eventEmitter: EventEmitter = ...

off

off: (<T>(event, callback) => EventEmitter) = ...

Type declaration

- <T>(event, callback): EventEmitter
- Type Parameters
  - T extends PlayerEventTypes
  Parameters
  - event: T
  - callback: ((event) => void)
    - (event): void
      
      Parameters
      
      event: PlayerEvent<T>
      
      Returns void
  Returns EventEmitter

on

on: (<T>(event, callback) => EventEmitter) = ...

Type declaration

- <T>(event, callback): EventEmitter
- Type Parameters
  - T extends PlayerEventTypes
  Parameters
  - event: T
  - callback: ((event) => void)
    - (event): void
      
      Parameters
      
      event: PlayerEvent<T>
      
      Returns void
  Returns EventEmitter

`Protected` playerInstance

playerInstance: undefined

`Protected` tokenHandler

tokenHandler: TokenHandler

Accessors

isInitialized

get isInitialized(): boolean
Returns boolean
Inherited from GenericPlayer.isInitialized
- Defined in genericPlayer.ts:46

Methods

addListener

addListener<T>(event, callback): EventEmitter
Type Parameters
- T extends PlayerEventTypes
Parameters
- event: T
- callback: ((event) => void)
  - - (event): void
    - Parameters
      
      event: PlayerEvent<T>
      
      Returns void
Returns EventEmitter
Inherited from GenericPlayer.addListener
- Defined in genericPlayer.ts:192

addToQueue

addToQueue(trackURI): Promise<void>
Adds track to queue
Parameters
- trackURI: string
  
  spotify URI or URL of track to be added to queue. (Eg. spotify:track:4PTG3Z6ehGkBFwjybzWkR8)
Returns Promise<void>
- Defined in spirc.ts:113

close

close(): Promise<void>
Clear all listeners and close player

Returns Promise<void>
Overrides GenericPlayer.close
- Defined in spirc.ts:48

getCanvas

getCanvas(track): Promise<undefined | CanvazResponse>
Returns spotify canvas URL for track
Parameters
- track: string
  
  track URI or URL to get canvas for
Returns Promise<undefined | CanvazResponse>
Spotify canvas public URL
Overrides GenericPlayer.getCanvas
- Defined in spirc.ts:176

getCurrentPosition

getCurrentPosition(): number
Get current position of player

Returns number
current position in milliseconds
Overrides GenericPlayer.getCurrentPosition
- Defined in spirc.ts:59

getDeviceId

getDeviceId(): string
Returns string
Inherited from GenericPlayer.getDeviceId
- Defined in genericPlayer.ts:218

getLyrics

getLyrics(track): Promise<undefined | LyricsResponse>
Get lyrics for spotify track
Parameters
- track: string
  
  Spotify track URI or URL
Returns Promise<undefined | LyricsResponse>
Overrides GenericPlayer.getLyrics
- Defined in spirc.ts:195

getToken

getToken(...scopes): Promise<Token>
Get spotify access token for logged in account
Parameters
- Rest ...scopes: TokenScope[]
  
  scopes to get token for. (https://developer.spotify.com/documentation/general/guides/authorization/scopes/)
Returns Promise<Token>
token
Overrides GenericPlayer.getToken
- Defined in spirc.ts:147

getVolume

getVolume(raw?): number
Returns volume in percentage or uint16
Parameters
- raw: boolean = false
  
  If true, returns volume in uint16. Otherwise percentage
Returns number
volume in percentage or uint16
Overrides GenericPlayer.getVolume
- Defined in spirc.ts:83

load

load(trackURI, autoplay?): Promise<void>
Loads a track by Spotify URI or URL
Parameters
- trackURI: string
  
  spotify URI or URL of track to be loaded. (Eg. spotify:track:4PTG3Z6ehGkBFwjybzWkR8)
- autoplay: boolean = false
  
  if true, track will start playing immediately after being loaded. (Default: false)
Returns Promise<void>
Overrides GenericPlayer.load
- Defined in spirc.ts:96

`Protected` onPlayerInitialized

onPlayerInitialized(): void
Returns void
Overrides GenericPlayer.onPlayerInitialized
- Defined in spirc.ts:10

once

once<T>(event, callback): EventEmitter
Type Parameters
- T extends PlayerEventTypes
Parameters
- event: T
- callback: ((event) => void)
  - - (event): void
    - Parameters
      
      event: PlayerEvent<T>
      
      Returns void
Returns EventEmitter
Inherited from GenericPlayer.once
- Defined in genericPlayer.ts:206

pause

pause(): Promise<void>
Set player state to paused

Returns Promise<void>
- Defined in spirc.ts:31

play

play(): Promise<void>
Set player state to play

Returns Promise<void>
- Defined in spirc.ts:23

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from GenericPlayer.removeAllListeners
- Defined in genericPlayer.ts:213

removeListener

removeListener<T>(event, callback): EventEmitter
Type Parameters
- T extends PlayerEventTypes
Parameters
- event: T
- callback: ((event) => void)
  - - (event): void
    - Parameters
      
      event: PlayerEvent<T>
      
      Returns void
Returns EventEmitter
Inherited from GenericPlayer.removeListener
- Defined in genericPlayer.ts:199

seek

seek(posMs): Promise<void>
Seek current song to position
Parameters
- posMs: number
  
  position in milliseconds
Returns Promise<void>
Overrides GenericPlayer.seek
- Defined in spirc.ts:40

setVolume

setVolume(volume, raw?): Promise<void>
Set volume in percentage or uint16
Parameters
- volume: number
- raw: boolean = false
  
  if true, volume is set in uint16. Otherwise percentage. (Default: false)
Returns Promise<void>
Overrides GenericPlayer.setVolume
- Defined in spirc.ts:68

`Protected` validateUri

validateUri(val): [undefined | string, undefined | string]
Parameters
- val: string
Returns [undefined | string, undefined | string]
Inherited from GenericPlayer.validateUri
- Defined in genericPlayer.ts:222

Generated using TypeDoc