Class SyncPlayApi

SyncPlayApi - object-oriented interface

Export

SyncPlayApi

Hierarchy

BaseAPI
- SyncPlayApi

Constructors

constructor

new SyncPlayApi(configuration?, basePath?, axios?): SyncPlayApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SyncPlayApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

syncPlayBuffering

syncPlayBuffering(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayBufferingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Notify SyncPlay group that member is buffering.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1587

syncPlayCreateGroup

syncPlayCreateGroup(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayCreateGroupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Create a new SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1599

syncPlayGetGroups

syncPlayGetGroups(options?): Promise<AxiosResponse<GroupInfoDto[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GroupInfoDto[], any>>
Summary
Gets all SyncPlay groups.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1610

syncPlayJoinGroup

syncPlayJoinGroup(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayJoinGroupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Join an existing SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1622

syncPlayLeaveGroup

syncPlayLeaveGroup(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Leave the joined SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1633

syncPlayMovePlaylistItem

syncPlayMovePlaylistItem(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayMovePlaylistItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request to move an item in the playlist in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1645

syncPlayNextItem

syncPlayNextItem(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayNextItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request next item in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1657

syncPlayPause

syncPlayPause(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request pause in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1668

syncPlayPing

syncPlayPing(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayPingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Update session ping.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1680

syncPlayPreviousItem

syncPlayPreviousItem(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayPreviousItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request previous item in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1692

syncPlayQueue

syncPlayQueue(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayQueueRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request to queue items to the playlist of a SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1704

syncPlayReady

syncPlayReady(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayReadyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Notify SyncPlay group that member is ready for playback.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1716

syncPlayRemoveFromPlaylist

syncPlayRemoveFromPlaylist(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayRemoveFromPlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request to remove items from the playlist in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1728

syncPlaySeek

syncPlaySeek(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySeekRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request seek in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1740

syncPlaySetIgnoreWait

syncPlaySetIgnoreWait(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetIgnoreWaitRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request SyncPlay group to ignore member during group-wait.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1752

syncPlaySetNewQueue

syncPlaySetNewQueue(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetNewQueueRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request to set new playlist in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1764

syncPlaySetPlaylistItem

syncPlaySetPlaylistItem(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetPlaylistItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request to change playlist item in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1776

syncPlaySetRepeatMode

syncPlaySetRepeatMode(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetRepeatModeRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request to set repeat mode in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1788

syncPlaySetShuffleMode

syncPlaySetShuffleMode(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetShuffleModeRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request to set shuffle mode in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1800

syncPlayStop

syncPlayStop(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request stop in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1811

syncPlayUnpause

syncPlayUnpause(options?): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Request unpause in SyncPlay group.

Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1822

Class SyncPlayApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SyncPlayApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

syncPlayBuffering

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

syncPlayCreateGroup

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

syncPlayGetGroups

Parameters

Returns Promise<AxiosResponse<GroupInfoDto[], any>>

Summary

Throws

Memberof

syncPlayJoinGroup

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

syncPlayLeaveGroup

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

syncPlayMovePlaylistItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

syncPlayNextItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

syncPlayPause

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

syncPlayPing

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

syncPlayPreviousItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

syncPlayQueue

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

`Protected`axios

`Protected`basePath

`Protected`configuration