SyncPlayApi - functional programming interface

  • Parameters

    Returns {
        syncPlayBuffering(bufferRequestDto: BufferRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayCreateGroup(newGroupRequestDto: NewGroupRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayGetGroups(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupInfoDto[]>)>;
        syncPlayJoinGroup(joinGroupRequestDto: JoinGroupRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayLeaveGroup(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayMovePlaylistItem(movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayNextItem(nextItemRequestDto: NextItemRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayPause(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayPing(pingRequestDto: PingRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayPreviousItem(previousItemRequestDto: PreviousItemRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayQueue(queueRequestDto: QueueRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayReady(readyRequestDto: ReadyRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayRemoveFromPlaylist(removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlaySeek(seekRequestDto: SeekRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlaySetIgnoreWait(ignoreWaitRequestDto: IgnoreWaitRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlaySetNewQueue(playRequestDto: PlayRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlaySetPlaylistItem(setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlaySetRepeatMode(setRepeatModeRequestDto: SetRepeatModeRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlaySetShuffleMode(setShuffleModeRequestDto: SetShuffleModeRequestDto, options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayStop(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
        syncPlayUnpause(options?: RawAxiosRequestConfig): Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>;
    }

    • syncPlayBuffering:function
      • Parameters

        • bufferRequestDto: BufferRequestDto

          The player status.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Notify SyncPlay group that member is buffering.

    • syncPlayCreateGroup:function
      • Parameters

        • newGroupRequestDto: NewGroupRequestDto

          The settings of the new group.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Create a new SyncPlay group.

    • syncPlayGetGroups:function
      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupInfoDto[]>)>

        Gets all SyncPlay groups.

    • syncPlayJoinGroup:function
      • Parameters

        • joinGroupRequestDto: JoinGroupRequestDto

          The group to join.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Join an existing SyncPlay group.

    • syncPlayLeaveGroup:function
      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Leave the joined SyncPlay group.

    • syncPlayMovePlaylistItem:function
      • Parameters

        • movePlaylistItemRequestDto: MovePlaylistItemRequestDto

          The new position for the item.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request to move an item in the playlist in SyncPlay group.

    • syncPlayNextItem:function
      • Parameters

        • nextItemRequestDto: NextItemRequestDto

          The current item information.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request next item in SyncPlay group.

    • syncPlayPause:function
      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request pause in SyncPlay group.

    • syncPlayPing:function
      • Parameters

        • pingRequestDto: PingRequestDto

          The new ping.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Update session ping.

    • syncPlayPreviousItem:function
      • Parameters

        • previousItemRequestDto: PreviousItemRequestDto

          The current item information.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request previous item in SyncPlay group.

    • syncPlayQueue:function
      • Parameters

        • queueRequestDto: QueueRequestDto

          The items to add.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request to queue items to the playlist of a SyncPlay group.

    • syncPlayReady:function
      • Parameters

        • readyRequestDto: ReadyRequestDto

          The player status.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Notify SyncPlay group that member is ready for playback.

    • syncPlayRemoveFromPlaylist:function
      • Parameters

        • removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto

          The items to remove.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request to remove items from the playlist in SyncPlay group.

    • syncPlaySeek:function
      • Parameters

        • seekRequestDto: SeekRequestDto

          The new playback position.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request seek in SyncPlay group.

    • syncPlaySetIgnoreWait:function
      • Parameters

        • ignoreWaitRequestDto: IgnoreWaitRequestDto

          The settings to set.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request SyncPlay group to ignore member during group-wait.

    • syncPlaySetNewQueue:function
      • Parameters

        • playRequestDto: PlayRequestDto

          The new playlist to play in the group.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request to set new playlist in SyncPlay group.

    • syncPlaySetPlaylistItem:function
      • Parameters

        • setPlaylistItemRequestDto: SetPlaylistItemRequestDto

          The new item to play.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request to change playlist item in SyncPlay group.

    • syncPlaySetRepeatMode:function
      • Parameters

        • setRepeatModeRequestDto: SetRepeatModeRequestDto

          The new repeat mode.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request to set repeat mode in SyncPlay group.

    • syncPlaySetShuffleMode:function
      • Parameters

        • setShuffleModeRequestDto: SetShuffleModeRequestDto

          The new shuffle mode.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request to set shuffle mode in SyncPlay group.

    • syncPlayStop:function
      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request stop in SyncPlay group.

    • syncPlayUnpause:function
      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

        Returns Promise<((axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>)>

        Request unpause in SyncPlay group.