SpotifyRemoteApi | react-native-spotify-remote

The Spotify Remote Api allows remote control of Spotify Application

See the example shown for SpotifyAuth

export
interface: SpotifyRemoteApi

Hierarchy

TypedEventEmitter<SpotifyRemoteEvents>
SpotifyRemoteApiExtensions
- SpotifyRemoteApi

Methods

addListener

addListener<K>(event: K, listener: (v: SpotifyRemoteEvents[K]) => void): EmitterSubscription

- Defined in TypedEventEmitter.ts:12
Type parameters
- K: "playerStateChanged" | "playerContextChanged" | "remoteDisconnected" | "remoteConnected"
Parameters
- event: K
- listener: (v: SpotifyRemoteEvents[K]) => void
  - - (v: SpotifyRemoteEvents[K]): void
    - Parameters
      - v: SpotifyRemoteEvents[K]
      Returns void
Returns EmitterSubscription

connect

connect(accessToken: string): Promise<void>

- Defined in SpotifyRemote.ts:94
Connect to Spotify Application via the access token

memberof

SpotifyRemoteApi

Parameters
- accessToken: string
Returns Promise<void>

disconnect

disconnect(): Promise<void>

- Defined in SpotifyRemote.ts:102
Disconnects the App Remote

memberof

SpotifyRemoteApi

Returns Promise<void>

emit

emit<K>(event: K, args: SpotifyRemoteEvents[K]): void

- Defined in TypedEventEmitter.ts:18
Type parameters
- K: "playerStateChanged" | "playerContextChanged" | "remoteDisconnected" | "remoteConnected"
Parameters
- event: K
- args: SpotifyRemoteEvents[K]
Returns void

eventNames

eventNames(): ("playerStateChanged" | "playerContextChanged" | "remoteDisconnected" | "remoteConnected")[]

- Defined in TypedEventEmitter.ts:19
Returns ("playerStateChanged" | "playerContextChanged" | "remoteDisconnected" | "remoteConnected")[]

getChildrenOfItem

getChildrenOfItem(item: Pick<ContentItem, "uri" | "id">, options?: GetChildrenItemsOptions): Promise<ContentItem[]>

- Defined in SpotifyRemote.ts:234
Gets the children of a given item

memberof

SpotifyRemoteApi

Parameters
- item: Pick<ContentItem, "uri" | "id">
- Optional options: GetChildrenItemsOptions
Returns Promise<ContentItem[]>

getContentItemForUri

getContentItemForUri(uri: string): Promise<undefined | ContentItem>

- Defined in SpotifyRemote.ts:244
Gets a ContentItem from a uri (iOS only)

memberof

SpotifyRemoteApi

Parameters
- uri: string
Returns Promise<undefined | ContentItem>

getCrossfadeState

getCrossfadeState(): Promise<CrossfadeState>

- Defined in SpotifyRemote.ts:252
Retrieves the current crossfade state of the player.

memberof

SpotifyRemoteApi

Returns Promise<CrossfadeState>

getPlayerState

getPlayerState(): Promise<PlayerState>

- Defined in SpotifyRemote.ts:206
Gets the current state of the player

memberof

SpotifyRemoteApi

Returns Promise<PlayerState>

getRecommendedContentItems

getRecommendedContentItems(options: RecommendedContentOptions): Promise<ContentItem[]>

- Defined in SpotifyRemote.ts:224
Gets the recommended content items for type

memberof

SpotifyRemoteApi

Parameters
- options: RecommendedContentOptions
Returns Promise<ContentItem[]>

getRootContentItems

getRootContentItems(type?: "default" | "fitness" | "navigation"): Promise<ContentItem[]>

- Defined in SpotifyRemote.ts:215
Retrieves the root content items for a given type. (iOS only)

memberof

SpotifyRemoteApi

Parameters
- Optional type: "default" | "fitness" | "navigation"
Returns Promise<ContentItem[]>

isConnectedAsync

isConnectedAsync(): Promise<boolean>

- Defined in SpotifyRemote.ts:85
Asynchronous call to get whether or not the Spotify Remote is connected

memberof

SpotifyNativeApi

Returns Promise<boolean>

listenerCount

listenerCount<K>(type: K): number

- Defined in TypedEventEmitter.ts:20
Type parameters
- K: "playerStateChanged" | "playerContextChanged" | "remoteDisconnected" | "remoteConnected"
Parameters
- type: K
Returns number

off

off<K>(event: K, listener: (v: SpotifyRemoteEvents[K]) => void): void

- Defined in TypedEventEmitter.ts:28
deprecated

Use remove on the EventSubscription from addListener.

Type parameters
- K: "playerStateChanged" | "playerContextChanged" | "remoteDisconnected" | "remoteConnected"
Parameters
- event: K
- listener: (v: SpotifyRemoteEvents[K]) => void
  - - (v: SpotifyRemoteEvents[K]): void
    - Parameters
      - v: SpotifyRemoteEvents[K]
      Returns void
Returns void

on

on<K>(name: K, listener: (v: SpotifyRemoteEvents[K]) => void): EmitterSubscription

- Defined in TypedEventEmitter.ts:24
deprecated

Use addListener instead.

Type parameters
- K: "playerStateChanged" | "playerContextChanged" | "remoteDisconnected" | "remoteConnected"
Parameters
- name: K
- listener: (v: SpotifyRemoteEvents[K]) => void
  - - (v: SpotifyRemoteEvents[K]): void
    - Parameters
      - v: SpotifyRemoteEvents[K]
      Returns void
Returns EmitterSubscription

pause

pause(): Promise<void>

- Defined in SpotifyRemote.ts:164
Pauses Playback

memberof

SpotifyRemoteApi

Returns Promise<void>

playItem

playItem(item: ContentItem): Promise<void>

- Defined in SpotifyRemote.ts:120
Plays a content item

memberof

SpotifyRemoteApi

Parameters
- item: ContentItem
Returns Promise<void>

playItemWithIndex

playItemWithIndex(item: ContentItem, skipToTrackIndex: number): Promise<void>

- Defined in SpotifyRemote.ts:130
Plays an item (like a playlist), skipping to a particular track inside

memberof

SpotifyRemoteApi

Parameters
- item: ContentItem
  
  item to play (usually a playlist)
- skipToTrackIndex: number
  
  track in playlist to skip to
Returns Promise<void>

playUri

playUri(spotifyUri: string): Promise<void>

- Defined in SpotifyRemote.ts:111
Play a track, album, playlist or artist via spotifyUri Example: spotify:track:, spotify:album:, spotify:playlist:, spotify:artist:

memberof

SpotifyNativeApi

Parameters
- spotifyUri: string
Returns Promise<void>

queueUri

queueUri(spotifyUri: string): Promise<void>

- Defined in SpotifyRemote.ts:139
Queues the track given by spotifyUri in Spotify example: spotify:track:

memberof

SpotifyNativeApi

Parameters
- spotifyUri: string
Returns Promise<void>

removeAllListeners

removeAllListeners<K>(event?: K): void

- Defined in TypedEventEmitter.ts:17
Type parameters
- K: "playerStateChanged" | "playerContextChanged" | "remoteDisconnected" | "remoteConnected"
Parameters
- Optional event: K
Returns void

removeListener

removeListener<K>(event: K, listener: (v: SpotifyRemoteEvents[K]) => void): void

- Defined in TypedEventEmitter.ts:16
deprecated

Use remove on the EventSubscription from addListener.

Type parameters
- K: "playerStateChanged" | "playerContextChanged" | "remoteDisconnected" | "remoteConnected"
Parameters
- event: K
- listener: (v: SpotifyRemoteEvents[K]) => void
  - - (v: SpotifyRemoteEvents[K]): void
    - Parameters
      - v: SpotifyRemoteEvents[K]
      Returns void
Returns void

resume

resume(): Promise<void>

- Defined in SpotifyRemote.ts:156
Resumes playing

memberof

SpotifyRemoteApi

Returns Promise<void>

seek

seek(positionMs: number): Promise<void>

- Defined in SpotifyRemote.ts:148
Seeks to a position within a song

memberof

SpotifyRemoteApi

Parameters
- positionMs: number
  
  Position in milliseconds
Returns Promise<void>

setPlaying

setPlaying(playing: boolean): Promise<void>

- Defined in SpotifyRemote.ts:67
deprecated

Please use resume and pause instead

memberof

SpotifyJSApi

Parameters
- playing: boolean
Returns Promise<void>

setRepeatMode

setRepeatMode(mode: RepeatMode): Promise<void>

- Defined in SpotifyRemote.ts:198
Sets repeat mode of player

memberof

SpotifyRemoteApi

Parameters
- mode: RepeatMode
Returns Promise<void>

setShuffling

setShuffling(shuffling: boolean): Promise<void>

- Defined in SpotifyRemote.ts:189
Sets shuffling

memberof

SpotifyRemoteApi

Parameters
- shuffling: boolean
Returns Promise<void>

skipToNext

skipToNext(): Promise<void>

- Defined in SpotifyRemote.ts:172
Skips to next item in context

memberof

SpotifyRemoteApi

Returns Promise<void>

skipToPrevious

skipToPrevious(): Promise<void>

- Defined in SpotifyRemote.ts:180
Skips to previous item in context

memberof

SpotifyRemoteApi

Returns Promise<void>

Generated using TypeDoc