@jellyfin/sdk
Version:
A TypeScript SDK for Jellyfin.
938 lines (937 loc) • 40.3 kB
TypeScript
/**
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* Do not edit the class manually.
*
* Jellyfin API
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
import type { Configuration } from '../configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import { type RequestArgs, BaseAPI } from '../base';
import type { BufferRequestDto } from '../models';
import type { GroupInfoDto } from '../models';
import type { IgnoreWaitRequestDto } from '../models';
import type { JoinGroupRequestDto } from '../models';
import type { MovePlaylistItemRequestDto } from '../models';
import type { NewGroupRequestDto } from '../models';
import type { NextItemRequestDto } from '../models';
import type { PingRequestDto } from '../models';
import type { PlayRequestDto } from '../models';
import type { PreviousItemRequestDto } from '../models';
import type { QueueRequestDto } from '../models';
import type { ReadyRequestDto } from '../models';
import type { RemoveFromPlaylistRequestDto } from '../models';
import type { SeekRequestDto } from '../models';
import type { SetPlaylistItemRequestDto } from '../models';
import type { SetRepeatModeRequestDto } from '../models';
import type { SetShuffleModeRequestDto } from '../models';
/**
* SyncPlayApi - axios parameter creator
* @export
*/
export declare const SyncPlayApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Notify SyncPlay group that member is buffering.
* @param {BufferRequestDto} bufferRequestDto The player status.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayBuffering: (bufferRequestDto: BufferRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Create a new SyncPlay group.
* @param {NewGroupRequestDto} newGroupRequestDto The settings of the new group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayCreateGroup: (newGroupRequestDto: NewGroupRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Gets all SyncPlay groups.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayGetGroups: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Join an existing SyncPlay group.
* @param {JoinGroupRequestDto} joinGroupRequestDto The group to join.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayJoinGroup: (joinGroupRequestDto: JoinGroupRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Leave the joined SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayLeaveGroup: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request to move an item in the playlist in SyncPlay group.
* @param {MovePlaylistItemRequestDto} movePlaylistItemRequestDto The new position for the item.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayMovePlaylistItem: (movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request next item in SyncPlay group.
* @param {NextItemRequestDto} nextItemRequestDto The current item information.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayNextItem: (nextItemRequestDto: NextItemRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request pause in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayPause: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Update session ping.
* @param {PingRequestDto} pingRequestDto The new ping.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayPing: (pingRequestDto: PingRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request previous item in SyncPlay group.
* @param {PreviousItemRequestDto} previousItemRequestDto The current item information.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayPreviousItem: (previousItemRequestDto: PreviousItemRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request to queue items to the playlist of a SyncPlay group.
* @param {QueueRequestDto} queueRequestDto The items to add.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayQueue: (queueRequestDto: QueueRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Notify SyncPlay group that member is ready for playback.
* @param {ReadyRequestDto} readyRequestDto The player status.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayReady: (readyRequestDto: ReadyRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request to remove items from the playlist in SyncPlay group.
* @param {RemoveFromPlaylistRequestDto} removeFromPlaylistRequestDto The items to remove.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayRemoveFromPlaylist: (removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request seek in SyncPlay group.
* @param {SeekRequestDto} seekRequestDto The new playback position.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySeek: (seekRequestDto: SeekRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request SyncPlay group to ignore member during group-wait.
* @param {IgnoreWaitRequestDto} ignoreWaitRequestDto The settings to set.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetIgnoreWait: (ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request to set new playlist in SyncPlay group.
* @param {PlayRequestDto} playRequestDto The new playlist to play in the group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetNewQueue: (playRequestDto: PlayRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request to change playlist item in SyncPlay group.
* @param {SetPlaylistItemRequestDto} setPlaylistItemRequestDto The new item to play.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetPlaylistItem: (setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request to set repeat mode in SyncPlay group.
* @param {SetRepeatModeRequestDto} setRepeatModeRequestDto The new repeat mode.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetRepeatMode: (setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request to set shuffle mode in SyncPlay group.
* @param {SetShuffleModeRequestDto} setShuffleModeRequestDto The new shuffle mode.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetShuffleMode: (setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request stop in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayStop: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
*
* @summary Request unpause in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayUnpause: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* SyncPlayApi - functional programming interface
* @export
*/
export declare const SyncPlayApiFp: (configuration?: Configuration) => {
/**
*
* @summary Notify SyncPlay group that member is buffering.
* @param {BufferRequestDto} bufferRequestDto The player status.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayBuffering(bufferRequestDto: BufferRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Create a new SyncPlay group.
* @param {NewGroupRequestDto} newGroupRequestDto The settings of the new group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayCreateGroup(newGroupRequestDto: NewGroupRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Gets all SyncPlay groups.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayGetGroups(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupInfoDto>>>;
/**
*
* @summary Join an existing SyncPlay group.
* @param {JoinGroupRequestDto} joinGroupRequestDto The group to join.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayJoinGroup(joinGroupRequestDto: JoinGroupRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Leave the joined SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayLeaveGroup(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request to move an item in the playlist in SyncPlay group.
* @param {MovePlaylistItemRequestDto} movePlaylistItemRequestDto The new position for the item.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayMovePlaylistItem(movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request next item in SyncPlay group.
* @param {NextItemRequestDto} nextItemRequestDto The current item information.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayNextItem(nextItemRequestDto: NextItemRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request pause in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayPause(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Update session ping.
* @param {PingRequestDto} pingRequestDto The new ping.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayPing(pingRequestDto: PingRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request previous item in SyncPlay group.
* @param {PreviousItemRequestDto} previousItemRequestDto The current item information.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayPreviousItem(previousItemRequestDto: PreviousItemRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request to queue items to the playlist of a SyncPlay group.
* @param {QueueRequestDto} queueRequestDto The items to add.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayQueue(queueRequestDto: QueueRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Notify SyncPlay group that member is ready for playback.
* @param {ReadyRequestDto} readyRequestDto The player status.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayReady(readyRequestDto: ReadyRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request to remove items from the playlist in SyncPlay group.
* @param {RemoveFromPlaylistRequestDto} removeFromPlaylistRequestDto The items to remove.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayRemoveFromPlaylist(removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request seek in SyncPlay group.
* @param {SeekRequestDto} seekRequestDto The new playback position.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySeek(seekRequestDto: SeekRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request SyncPlay group to ignore member during group-wait.
* @param {IgnoreWaitRequestDto} ignoreWaitRequestDto The settings to set.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetIgnoreWait(ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request to set new playlist in SyncPlay group.
* @param {PlayRequestDto} playRequestDto The new playlist to play in the group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetNewQueue(playRequestDto: PlayRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request to change playlist item in SyncPlay group.
* @param {SetPlaylistItemRequestDto} setPlaylistItemRequestDto The new item to play.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetPlaylistItem(setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request to set repeat mode in SyncPlay group.
* @param {SetRepeatModeRequestDto} setRepeatModeRequestDto The new repeat mode.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetRepeatMode(setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request to set shuffle mode in SyncPlay group.
* @param {SetShuffleModeRequestDto} setShuffleModeRequestDto The new shuffle mode.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetShuffleMode(setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request stop in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayStop(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
*
* @summary Request unpause in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayUnpause(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
* SyncPlayApi - factory interface
* @export
*/
export declare const SyncPlayApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Notify SyncPlay group that member is buffering.
* @param {SyncPlayApiSyncPlayBufferingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayBuffering(requestParameters: SyncPlayApiSyncPlayBufferingRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Create a new SyncPlay group.
* @param {SyncPlayApiSyncPlayCreateGroupRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayCreateGroup(requestParameters: SyncPlayApiSyncPlayCreateGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Gets all SyncPlay groups.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayGetGroups(options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupInfoDto>>;
/**
*
* @summary Join an existing SyncPlay group.
* @param {SyncPlayApiSyncPlayJoinGroupRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayJoinGroup(requestParameters: SyncPlayApiSyncPlayJoinGroupRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Leave the joined SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayLeaveGroup(options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request to move an item in the playlist in SyncPlay group.
* @param {SyncPlayApiSyncPlayMovePlaylistItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayMovePlaylistItem(requestParameters: SyncPlayApiSyncPlayMovePlaylistItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request next item in SyncPlay group.
* @param {SyncPlayApiSyncPlayNextItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayNextItem(requestParameters: SyncPlayApiSyncPlayNextItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request pause in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayPause(options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Update session ping.
* @param {SyncPlayApiSyncPlayPingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayPing(requestParameters: SyncPlayApiSyncPlayPingRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request previous item in SyncPlay group.
* @param {SyncPlayApiSyncPlayPreviousItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayPreviousItem(requestParameters: SyncPlayApiSyncPlayPreviousItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request to queue items to the playlist of a SyncPlay group.
* @param {SyncPlayApiSyncPlayQueueRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayQueue(requestParameters: SyncPlayApiSyncPlayQueueRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Notify SyncPlay group that member is ready for playback.
* @param {SyncPlayApiSyncPlayReadyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayReady(requestParameters: SyncPlayApiSyncPlayReadyRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request to remove items from the playlist in SyncPlay group.
* @param {SyncPlayApiSyncPlayRemoveFromPlaylistRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayRemoveFromPlaylist(requestParameters: SyncPlayApiSyncPlayRemoveFromPlaylistRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request seek in SyncPlay group.
* @param {SyncPlayApiSyncPlaySeekRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySeek(requestParameters: SyncPlayApiSyncPlaySeekRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request SyncPlay group to ignore member during group-wait.
* @param {SyncPlayApiSyncPlaySetIgnoreWaitRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetIgnoreWait(requestParameters: SyncPlayApiSyncPlaySetIgnoreWaitRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request to set new playlist in SyncPlay group.
* @param {SyncPlayApiSyncPlaySetNewQueueRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetNewQueue(requestParameters: SyncPlayApiSyncPlaySetNewQueueRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request to change playlist item in SyncPlay group.
* @param {SyncPlayApiSyncPlaySetPlaylistItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetPlaylistItem(requestParameters: SyncPlayApiSyncPlaySetPlaylistItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request to set repeat mode in SyncPlay group.
* @param {SyncPlayApiSyncPlaySetRepeatModeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetRepeatMode(requestParameters: SyncPlayApiSyncPlaySetRepeatModeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request to set shuffle mode in SyncPlay group.
* @param {SyncPlayApiSyncPlaySetShuffleModeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlaySetShuffleMode(requestParameters: SyncPlayApiSyncPlaySetShuffleModeRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request stop in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayStop(options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @summary Request unpause in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
syncPlayUnpause(options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
* Request parameters for syncPlayBuffering operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayBufferingRequest
*/
export interface SyncPlayApiSyncPlayBufferingRequest {
/**
* The player status.
* @type {BufferRequestDto}
* @memberof SyncPlayApiSyncPlayBuffering
*/
readonly bufferRequestDto: BufferRequestDto;
}
/**
* Request parameters for syncPlayCreateGroup operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayCreateGroupRequest
*/
export interface SyncPlayApiSyncPlayCreateGroupRequest {
/**
* The settings of the new group.
* @type {NewGroupRequestDto}
* @memberof SyncPlayApiSyncPlayCreateGroup
*/
readonly newGroupRequestDto: NewGroupRequestDto;
}
/**
* Request parameters for syncPlayJoinGroup operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayJoinGroupRequest
*/
export interface SyncPlayApiSyncPlayJoinGroupRequest {
/**
* The group to join.
* @type {JoinGroupRequestDto}
* @memberof SyncPlayApiSyncPlayJoinGroup
*/
readonly joinGroupRequestDto: JoinGroupRequestDto;
}
/**
* Request parameters for syncPlayMovePlaylistItem operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayMovePlaylistItemRequest
*/
export interface SyncPlayApiSyncPlayMovePlaylistItemRequest {
/**
* The new position for the item.
* @type {MovePlaylistItemRequestDto}
* @memberof SyncPlayApiSyncPlayMovePlaylistItem
*/
readonly movePlaylistItemRequestDto: MovePlaylistItemRequestDto;
}
/**
* Request parameters for syncPlayNextItem operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayNextItemRequest
*/
export interface SyncPlayApiSyncPlayNextItemRequest {
/**
* The current item information.
* @type {NextItemRequestDto}
* @memberof SyncPlayApiSyncPlayNextItem
*/
readonly nextItemRequestDto: NextItemRequestDto;
}
/**
* Request parameters for syncPlayPing operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayPingRequest
*/
export interface SyncPlayApiSyncPlayPingRequest {
/**
* The new ping.
* @type {PingRequestDto}
* @memberof SyncPlayApiSyncPlayPing
*/
readonly pingRequestDto: PingRequestDto;
}
/**
* Request parameters for syncPlayPreviousItem operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayPreviousItemRequest
*/
export interface SyncPlayApiSyncPlayPreviousItemRequest {
/**
* The current item information.
* @type {PreviousItemRequestDto}
* @memberof SyncPlayApiSyncPlayPreviousItem
*/
readonly previousItemRequestDto: PreviousItemRequestDto;
}
/**
* Request parameters for syncPlayQueue operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayQueueRequest
*/
export interface SyncPlayApiSyncPlayQueueRequest {
/**
* The items to add.
* @type {QueueRequestDto}
* @memberof SyncPlayApiSyncPlayQueue
*/
readonly queueRequestDto: QueueRequestDto;
}
/**
* Request parameters for syncPlayReady operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayReadyRequest
*/
export interface SyncPlayApiSyncPlayReadyRequest {
/**
* The player status.
* @type {ReadyRequestDto}
* @memberof SyncPlayApiSyncPlayReady
*/
readonly readyRequestDto: ReadyRequestDto;
}
/**
* Request parameters for syncPlayRemoveFromPlaylist operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlayRemoveFromPlaylistRequest
*/
export interface SyncPlayApiSyncPlayRemoveFromPlaylistRequest {
/**
* The items to remove.
* @type {RemoveFromPlaylistRequestDto}
* @memberof SyncPlayApiSyncPlayRemoveFromPlaylist
*/
readonly removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto;
}
/**
* Request parameters for syncPlaySeek operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlaySeekRequest
*/
export interface SyncPlayApiSyncPlaySeekRequest {
/**
* The new playback position.
* @type {SeekRequestDto}
* @memberof SyncPlayApiSyncPlaySeek
*/
readonly seekRequestDto: SeekRequestDto;
}
/**
* Request parameters for syncPlaySetIgnoreWait operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlaySetIgnoreWaitRequest
*/
export interface SyncPlayApiSyncPlaySetIgnoreWaitRequest {
/**
* The settings to set.
* @type {IgnoreWaitRequestDto}
* @memberof SyncPlayApiSyncPlaySetIgnoreWait
*/
readonly ignoreWaitRequestDto: IgnoreWaitRequestDto;
}
/**
* Request parameters for syncPlaySetNewQueue operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlaySetNewQueueRequest
*/
export interface SyncPlayApiSyncPlaySetNewQueueRequest {
/**
* The new playlist to play in the group.
* @type {PlayRequestDto}
* @memberof SyncPlayApiSyncPlaySetNewQueue
*/
readonly playRequestDto: PlayRequestDto;
}
/**
* Request parameters for syncPlaySetPlaylistItem operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlaySetPlaylistItemRequest
*/
export interface SyncPlayApiSyncPlaySetPlaylistItemRequest {
/**
* The new item to play.
* @type {SetPlaylistItemRequestDto}
* @memberof SyncPlayApiSyncPlaySetPlaylistItem
*/
readonly setPlaylistItemRequestDto: SetPlaylistItemRequestDto;
}
/**
* Request parameters for syncPlaySetRepeatMode operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlaySetRepeatModeRequest
*/
export interface SyncPlayApiSyncPlaySetRepeatModeRequest {
/**
* The new repeat mode.
* @type {SetRepeatModeRequestDto}
* @memberof SyncPlayApiSyncPlaySetRepeatMode
*/
readonly setRepeatModeRequestDto: SetRepeatModeRequestDto;
}
/**
* Request parameters for syncPlaySetShuffleMode operation in SyncPlayApi.
* @export
* @interface SyncPlayApiSyncPlaySetShuffleModeRequest
*/
export interface SyncPlayApiSyncPlaySetShuffleModeRequest {
/**
* The new shuffle mode.
* @type {SetShuffleModeRequestDto}
* @memberof SyncPlayApiSyncPlaySetShuffleMode
*/
readonly setShuffleModeRequestDto: SetShuffleModeRequestDto;
}
/**
* SyncPlayApi - object-oriented interface
* @export
* @class SyncPlayApi
* @extends {BaseAPI}
*/
export declare class SyncPlayApi extends BaseAPI {
/**
*
* @summary Notify SyncPlay group that member is buffering.
* @param {SyncPlayApiSyncPlayBufferingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayBuffering(requestParameters: SyncPlayApiSyncPlayBufferingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Create a new SyncPlay group.
* @param {SyncPlayApiSyncPlayCreateGroupRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayCreateGroup(requestParameters: SyncPlayApiSyncPlayCreateGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Gets all SyncPlay groups.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayGetGroups(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupInfoDto[], any>>;
/**
*
* @summary Join an existing SyncPlay group.
* @param {SyncPlayApiSyncPlayJoinGroupRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayJoinGroup(requestParameters: SyncPlayApiSyncPlayJoinGroupRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Leave the joined SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayLeaveGroup(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request to move an item in the playlist in SyncPlay group.
* @param {SyncPlayApiSyncPlayMovePlaylistItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayMovePlaylistItem(requestParameters: SyncPlayApiSyncPlayMovePlaylistItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request next item in SyncPlay group.
* @param {SyncPlayApiSyncPlayNextItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayNextItem(requestParameters: SyncPlayApiSyncPlayNextItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request pause in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayPause(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Update session ping.
* @param {SyncPlayApiSyncPlayPingRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayPing(requestParameters: SyncPlayApiSyncPlayPingRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request previous item in SyncPlay group.
* @param {SyncPlayApiSyncPlayPreviousItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayPreviousItem(requestParameters: SyncPlayApiSyncPlayPreviousItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request to queue items to the playlist of a SyncPlay group.
* @param {SyncPlayApiSyncPlayQueueRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayQueue(requestParameters: SyncPlayApiSyncPlayQueueRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Notify SyncPlay group that member is ready for playback.
* @param {SyncPlayApiSyncPlayReadyRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayReady(requestParameters: SyncPlayApiSyncPlayReadyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request to remove items from the playlist in SyncPlay group.
* @param {SyncPlayApiSyncPlayRemoveFromPlaylistRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayRemoveFromPlaylist(requestParameters: SyncPlayApiSyncPlayRemoveFromPlaylistRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request seek in SyncPlay group.
* @param {SyncPlayApiSyncPlaySeekRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlaySeek(requestParameters: SyncPlayApiSyncPlaySeekRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request SyncPlay group to ignore member during group-wait.
* @param {SyncPlayApiSyncPlaySetIgnoreWaitRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlaySetIgnoreWait(requestParameters: SyncPlayApiSyncPlaySetIgnoreWaitRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request to set new playlist in SyncPlay group.
* @param {SyncPlayApiSyncPlaySetNewQueueRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlaySetNewQueue(requestParameters: SyncPlayApiSyncPlaySetNewQueueRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request to change playlist item in SyncPlay group.
* @param {SyncPlayApiSyncPlaySetPlaylistItemRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlaySetPlaylistItem(requestParameters: SyncPlayApiSyncPlaySetPlaylistItemRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request to set repeat mode in SyncPlay group.
* @param {SyncPlayApiSyncPlaySetRepeatModeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlaySetRepeatMode(requestParameters: SyncPlayApiSyncPlaySetRepeatModeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request to set shuffle mode in SyncPlay group.
* @param {SyncPlayApiSyncPlaySetShuffleModeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlaySetShuffleMode(requestParameters: SyncPlayApiSyncPlaySetShuffleModeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request stop in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayStop(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
*
* @summary Request unpause in SyncPlay group.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof SyncPlayApi
*/
syncPlayUnpause(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}