Class SyncPlayApi

SyncPlayApi - object-oriented interface

Export

SyncPlayApi

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:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1587

syncPlayCreateGroup

syncPlayCreateGroup(
requestParameters: SyncPlayApiSyncPlayCreateGroupRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: SyncPlayApiSyncPlayCreateGroupRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1599

syncPlayGetGroups

syncPlayGetGroups(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<GroupInfoDto[], any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<GroupInfoDto[], any>>
Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1610

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1622

syncPlayLeaveGroup

syncPlayLeaveGroup(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1633

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1645

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1657

syncPlayPause

syncPlayPause(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1668

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1680

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1692

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1704

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1716

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1728

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1740

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1752

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1764

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1776

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1788

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
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1800

syncPlayStop

syncPlayStop(options?: RawAxiosRequestConfig): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
SyncPlayApi
- Defined in generated-client/api/sync-play-api.ts:1811

syncPlayUnpause

syncPlayUnpause(
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
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>>

Throws

Memberof

syncPlayCreateGroup

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayGetGroups

Parameters

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

Throws

Memberof

syncPlayJoinGroup

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayLeaveGroup

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayMovePlaylistItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayNextItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayPause

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayPing

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayPreviousItem

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayQueue

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayReady

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

syncPlayRemoveFromPlaylist

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

`Protected`axios

`Protected`basePath

`Protected`configuration