Class SpotifyPlayer

Hierarchy

GenericPlayer
- SpotifyPlayer

Index

Constructors

Properties

_isInitialized _positionHolder _volume device_id eventEmitter off on playerInstance tokenHandler

Accessors

Methods

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

Constructors

constructor

new SpotifyPlayer(config, playerConstructMethod?): SpotifyPlayer
Parameters
- config: ConstructorConfig
- playerConstructMethod: "create_player" | "create_player_spirc" = "create_player"
Returns SpotifyPlayer
Inherited from GenericPlayer.constructor
- Defined in genericPlayer.ts:106

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

close

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

Returns Promise<void>
Overrides GenericPlayer.close
- Defined in player.ts:38

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 player.ts:159

getCurrentPosition

getCurrentPosition(): number
Get current position of player

Returns number
current position in milliseconds
Overrides GenericPlayer.getCurrentPosition
- Defined in player.ts:49

getDeviceId

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

getLyrics

getLyrics(track): Promise<any>
Get lyrics for spotify track
Parameters
- track: string
  
  Spotify track URI or URL
Returns Promise<any>
Overrides GenericPlayer.getLyrics
- Defined in player.ts:178

getToken

getToken(...scopes): Promise<any>
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<any>
token
Overrides GenericPlayer.getToken
- Defined in player.ts:130

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 player.ts:73

load

load(trackURIs, autoPlay?, startPosition?): Promise<void>
Loads a track by Spotify URI or URL
Parameters
- trackURIs: string | string[]
- autoPlay: boolean = false
- startPosition: number = 0
Returns Promise<void>
Overrides GenericPlayer.load
- Defined in player.ts:86

`Protected` onPlayerInitialized

onPlayerInitialized(): void
Returns void
Overrides GenericPlayer.onPlayerInitialized
- Defined in player.ts:6

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 player.ts:21

play

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

Returns Promise<void>
- Defined in player.ts:13

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 player.ts:30

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 player.ts:58

`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