Class RestClient

A REST client to communicate with the companion servers REST API

Implements

GenericClient

Index

Constructors

constructor

new RestClient(settings): RestClient
Create a new RestClient
Parameters
- settings: Settings
  The settings to use
Returns RestClient
- Defined in shared/rest-client.ts:15

Accessors

settings

get settings(): Settings
Get the settings

Returns Settings
Implementation of GenericClient.settings
- Defined in shared/rest-client.ts:28
set settings(value): void
Set the settings
Parameters
- value: Settings
  The settings to set
Returns void
Implementation of GenericClient.settings
- Defined in shared/rest-client.ts:36

Methods

changeVideo

changeVideo(data): Promise<void>
Immediately starts playing the specified video or playlist.

Important: Either videoId or playlistId or both have to be set. You can also set an url instead. Url is prioritized over videoId and playlistId

Caution: YouTube Music's UI will display a blank / broken player if both videoId and playlistId are provided but the video is not in the playlist or the playlist does not exist (anymore).
Parameters
- data: ChangeVideoInput
  The data to change the video
Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:303

getAuthCode

getAuthCode(): Promise<RequestCodeOutput>
Requests a code to exchange for a valid token.

Returns Promise<RequestCodeOutput>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:96

getAuthToken

getAuthToken(code): Promise<RequestOutput>
Get the authentication token that is required to access the API.

You should save this token safely and set it either:
1. in the settings
2. use the setAuthToken method in this class
3. use the setAuthToken method in the CompanionConnector class (recommended)
to set the token for further requests.
Parameters
- code: string
  The code you got from the getAuthCode method
Returns Promise<RequestOutput>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:132

getMetadata

getMetadata(): Promise<MetadataOutput>
Get the metadata from the API

Returns Promise<MetadataOutput>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:59

getPlaylists

getPlaylists(): Promise<PlaylistOutput[]>
Get the playlists from the API

Returns Promise<PlaylistOutput[]>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:77

getState

getState(): Promise<StateOutput>
Get the state from the API

Returns Promise<StateOutput>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:68

mute

mute(): Promise<void>
Mute the volume

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:199

next(): Promise<void>
Play the next song

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:227

pause

pause(): Promise<void>
Pause the current song

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:159

play

play(): Promise<void>
Play the current song

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:150

playPause

playPause(): Promise<void>
Play or pause the current song

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:141

playQueueIndex

playQueueIndex(data): Promise<void>
Play a song from the queue
Parameters
- data: number
  The index of the song to play
Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:268

previous(): Promise<void>
Play the previous song

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:236

repeatMode

repeatMode(data): Promise<void>
Set the repeat mode
Parameters
- data: RepeatMode
  The repeat mode to set
Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:246

request

request(code): Promise<RequestOutput>
The authentication token that is required to access the API. You should save this token safely. This method will also set the token in the settings itself.
Parameters
- code: string
  The code you got from the requestCode method
Returns Promise<RequestOutput>
Throws
ErrorOutput If something went wrong

Deprecated
Please use getAuthToken instead. This method will be removed in the next major version due to the confusing name and the side effect of automatically setting the token in the settings.
- Defined in shared/rest-client.ts:111

requestCode

requestCode(): Promise<RequestCodeOutput>
Requests a code to exchange for a valid token.

Returns Promise<RequestCodeOutput>
Throws
ErrorOutput If something went wrong

Deprecated
This is now an alias for getAuthCode. Use that instead because it's more descriptive. This method will be removed in the next major version.
- Defined in shared/rest-client.ts:87

seekTo

seekTo(data): Promise<void>
Seek to a specific time
Parameters
- data: number
  The time to seek to
Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:218

setAuthToken

setAuthToken(token): void
Set the authentication token, so it can be used for further requests.

We recommend to use the setAuthToken method in the CompanionConnector class instead of this method because it sets the token for both clients and reconnects the socket client if the token changed.
Parameters
- token: string
  The token to set
Returns void
Implementation of GenericClient.setAuthToken
- Defined in shared/rest-client.ts:47

setVolume

setVolume(data): Promise<void>
Set the volume
Parameters
- data: number
  The volume to set the player to
Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:187

shuffle

shuffle(): Promise<void>
Shuffle the queue

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:258

toggleDislike

toggleDislike(): Promise<void>
Toggle dislike

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:289

toggleLike

toggleLike(): Promise<void>
Toggle like

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:280

unmute

unmute(): Promise<void>
Unmute the volume

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:208

volumeDown

volumeDown(): Promise<void>
Decrease the volume

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:177

volumeUp

volumeUp(): Promise<void>
Increase the volume

Returns Promise<void>
Throws
ErrorOutput If something went wrong
- Defined in shared/rest-client.ts:168

Class RestClient

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns RestClient

Accessors

settings

Returns Settings

Parameters

Returns void

Methods

changeVideo

Parameters

Returns Promise<void>

Throws

getAuthCode

Returns Promise<RequestCodeOutput>

Throws

getAuthToken

Parameters

Returns Promise<RequestOutput>

Throws

getMetadata

Returns Promise<MetadataOutput>

Throws

getPlaylists

Returns Promise<PlaylistOutput[]>

Throws

getState

Returns Promise<StateOutput>

Throws

mute

Returns Promise<void>

Throws

next

Returns Promise<void>

Throws

pause

Returns Promise<void>

Throws

play

Returns Promise<void>

Throws

playPause

Returns Promise<void>

Throws

playQueueIndex

Parameters

Returns Promise<void>

Throws

previous

Returns Promise<void>

Throws

repeatMode

Parameters

Returns Promise<void>

Throws

request

Parameters

Returns Promise<RequestOutput>

Throws

Deprecated

requestCode

Returns Promise<RequestCodeOutput>

Throws

Deprecated

seekTo

Parameters

Returns Promise<void>

Throws

setAuthToken

Parameters

Returns void

setVolume

Parameters