Class SyncPlayApi

SyncPlayApi - object-oriented interface

Hierarchy

BaseAPI
- SyncPlayApi

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

syncPlayBuffering

syncPlayBuffering(
requestParameters: SyncPlayApiSyncPlayBufferingRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayBufferingRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1572

syncPlayCreateGroup

syncPlayCreateGroup(
requestParameters: SyncPlayApiSyncPlayCreateGroupRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GroupInfoDto, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayCreateGroupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GroupInfoDto, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1583

syncPlayGetGroup

syncPlayGetGroup(
requestParameters: SyncPlayApiSyncPlayGetGroupRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GroupInfoDto, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayGetGroupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GroupInfoDto, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1594

syncPlayGetGroups

syncPlayGetGroups(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GroupInfoDto[], any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GroupInfoDto[], any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1604

syncPlayJoinGroup

syncPlayJoinGroup(
requestParameters: SyncPlayApiSyncPlayJoinGroupRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayJoinGroupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1615

syncPlayLeaveGroup

syncPlayLeaveGroup(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1625

syncPlayMovePlaylistItem

syncPlayMovePlaylistItem(
requestParameters: SyncPlayApiSyncPlayMovePlaylistItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayMovePlaylistItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1636

syncPlayNextItem

syncPlayNextItem(
requestParameters: SyncPlayApiSyncPlayNextItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayNextItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1647

syncPlayPause

syncPlayPause(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

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

syncPlayPing

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

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

syncPlayPreviousItem

syncPlayPreviousItem(
requestParameters: SyncPlayApiSyncPlayPreviousItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayPreviousItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1679

syncPlayQueue

syncPlayQueue(
requestParameters: SyncPlayApiSyncPlayQueueRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayQueueRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1690

syncPlayReady

syncPlayReady(
requestParameters: SyncPlayApiSyncPlayReadyRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayReadyRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1701

syncPlayRemoveFromPlaylist

syncPlayRemoveFromPlaylist(
requestParameters: SyncPlayApiSyncPlayRemoveFromPlaylistRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlayRemoveFromPlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1712

syncPlaySeek

syncPlaySeek(
requestParameters: SyncPlayApiSyncPlaySeekRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySeekRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1723

syncPlaySetIgnoreWait

syncPlaySetIgnoreWait(
requestParameters: SyncPlayApiSyncPlaySetIgnoreWaitRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetIgnoreWaitRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1734

syncPlaySetNewQueue

syncPlaySetNewQueue(
requestParameters: SyncPlayApiSyncPlaySetNewQueueRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetNewQueueRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1745

syncPlaySetPlaylistItem

syncPlaySetPlaylistItem(
requestParameters: SyncPlayApiSyncPlaySetPlaylistItemRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetPlaylistItemRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1756

syncPlaySetRepeatMode

syncPlaySetRepeatMode(
requestParameters: SyncPlayApiSyncPlaySetRepeatModeRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetRepeatModeRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1767

syncPlaySetShuffleMode

syncPlaySetShuffleMode(
requestParameters: SyncPlayApiSyncPlaySetShuffleModeRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: SyncPlayApiSyncPlaySetShuffleModeRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1778

syncPlayStop

syncPlayStop(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

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

syncPlayUnpause

syncPlayUnpause(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/sync-play-api.ts:1798

Class SyncPlayApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SyncPlayApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

syncPlayBuffering

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayCreateGroup

Parameters

Returns Promise<AxiosResponse<GroupInfoDto, any, {}>>

Throws

syncPlayGetGroup

Parameters

Returns Promise<AxiosResponse<GroupInfoDto, any, {}>>

Throws

syncPlayGetGroups

Parameters

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

Throws

syncPlayJoinGroup

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayLeaveGroup

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayMovePlaylistItem

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayNextItem

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayPause

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayPing

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayPreviousItem

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayQueue

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayReady

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlayRemoveFromPlaylist

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlaySeek

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlaySetIgnoreWait

Parameters

Returns Promise<AxiosResponse<void, any, {}>>

Throws

syncPlaySetNewQueue

`Protected`axios

`Protected`basePath

`Protected`configuration