Function SyncPlayApiFp

SyncPlayApi - functional programming interface

Export

  • SyncPlayApiFp(
        configuration?: Configuration,
    ): {
        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>,
        >;
    }

  • 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
      • syncPlayBuffering(
            bufferRequestDto: BufferRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • bufferRequestDto: BufferRequestDto

          The player status.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayCreateGroup:function
      • syncPlayCreateGroup(
            newGroupRequestDto: NewGroupRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • newGroupRequestDto: NewGroupRequestDto

          The settings of the new group.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayGetGroups:function
      • syncPlayGetGroups(
            options?: RawAxiosRequestConfig,
        ): Promise<
            (
                axios?: AxiosInstance,
                basePath?: string,
            ) => AxiosPromise<GroupInfoDto[]>,
        >

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayJoinGroup:function
      • syncPlayJoinGroup(
            joinGroupRequestDto: JoinGroupRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • joinGroupRequestDto: JoinGroupRequestDto

          The group to join.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayLeaveGroup:function
      • syncPlayLeaveGroup(
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayMovePlaylistItem:function
      • syncPlayMovePlaylistItem(
            movePlaylistItemRequestDto: MovePlaylistItemRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • movePlaylistItemRequestDto: MovePlaylistItemRequestDto

          The new position for the item.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayNextItem:function
      • syncPlayNextItem(
            nextItemRequestDto: NextItemRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • nextItemRequestDto: NextItemRequestDto

          The current item information.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayPause:function
      • syncPlayPause(
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayPing:function
      • syncPlayPing(
            pingRequestDto: PingRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • pingRequestDto: PingRequestDto

          The new ping.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayPreviousItem:function
      • syncPlayPreviousItem(
            previousItemRequestDto: PreviousItemRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • previousItemRequestDto: PreviousItemRequestDto

          The current item information.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayQueue:function
      • syncPlayQueue(
            queueRequestDto: QueueRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • queueRequestDto: QueueRequestDto

          The items to add.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayReady:function
      • syncPlayReady(
            readyRequestDto: ReadyRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • readyRequestDto: ReadyRequestDto

          The player status.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayRemoveFromPlaylist:function
      • syncPlayRemoveFromPlaylist(
            removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto

          The items to remove.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlaySeek:function
      • syncPlaySeek(
            seekRequestDto: SeekRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • seekRequestDto: SeekRequestDto

          The new playback position.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlaySetIgnoreWait:function
      • syncPlaySetIgnoreWait(
            ignoreWaitRequestDto: IgnoreWaitRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • ignoreWaitRequestDto: IgnoreWaitRequestDto

          The settings to set.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlaySetNewQueue:function
      • syncPlaySetNewQueue(
            playRequestDto: PlayRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • 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>>

        Throws

    • syncPlaySetPlaylistItem:function
      • syncPlaySetPlaylistItem(
            setPlaylistItemRequestDto: SetPlaylistItemRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • setPlaylistItemRequestDto: SetPlaylistItemRequestDto

          The new item to play.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlaySetRepeatMode:function
      • syncPlaySetRepeatMode(
            setRepeatModeRequestDto: SetRepeatModeRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • setRepeatModeRequestDto: SetRepeatModeRequestDto

          The new repeat mode.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlaySetShuffleMode:function
      • syncPlaySetShuffleMode(
            setShuffleModeRequestDto: SetShuffleModeRequestDto,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • setShuffleModeRequestDto: SetShuffleModeRequestDto

          The new shuffle mode.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayStop:function
      • syncPlayStop(
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • syncPlayUnpause:function
      • syncPlayUnpause(
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>

      • Parameters

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility