Function SyncPlayApiAxiosParamCreator

SyncPlayApi - axios parameter creator

Export

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

  • Parameters

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

    • syncPlayBuffering: ((bufferRequestDto: BufferRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Notify SyncPlay group that member is buffering.

      Throws

        • (bufferRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • bufferRequestDto: BufferRequestDto

            The player status.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayCreateGroup: ((newGroupRequestDto: NewGroupRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Create a new SyncPlay group.

      Throws

        • (newGroupRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • newGroupRequestDto: NewGroupRequestDto

            The settings of the new group.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayGetGroups: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets all SyncPlay groups.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayJoinGroup: ((joinGroupRequestDto: JoinGroupRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Join an existing SyncPlay group.

      Throws

        • (joinGroupRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • joinGroupRequestDto: JoinGroupRequestDto

            The group to join.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayLeaveGroup: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Leave the joined SyncPlay group.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayMovePlaylistItem: ((movePlaylistItemRequestDto: MovePlaylistItemRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

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

      Throws

        • (movePlaylistItemRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • movePlaylistItemRequestDto: MovePlaylistItemRequestDto

            The new position for the item.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayNextItem: ((nextItemRequestDto: NextItemRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request next item in SyncPlay group.

      Throws

        • (nextItemRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • nextItemRequestDto: NextItemRequestDto

            The current item information.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayPause: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request pause in SyncPlay group.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayPing: ((pingRequestDto: PingRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Update session ping.

      Throws

        • (pingRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • pingRequestDto: PingRequestDto

            The new ping.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayPreviousItem: ((previousItemRequestDto: PreviousItemRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request previous item in SyncPlay group.

      Throws

        • (previousItemRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • previousItemRequestDto: PreviousItemRequestDto

            The current item information.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayQueue: ((queueRequestDto: QueueRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

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

      Throws

        • (queueRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • queueRequestDto: QueueRequestDto

            The items to add.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayReady: ((readyRequestDto: ReadyRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Notify SyncPlay group that member is ready for playback.

      Throws

        • (readyRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • readyRequestDto: ReadyRequestDto

            The player status.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayRemoveFromPlaylist: ((removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request to remove items from the playlist in SyncPlay group.

      Throws

        • (removeFromPlaylistRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto

            The items to remove.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlaySeek: ((seekRequestDto: SeekRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request seek in SyncPlay group.

      Throws

        • (seekRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • seekRequestDto: SeekRequestDto

            The new playback position.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlaySetIgnoreWait: ((ignoreWaitRequestDto: IgnoreWaitRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request SyncPlay group to ignore member during group-wait.

      Throws

        • (ignoreWaitRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • ignoreWaitRequestDto: IgnoreWaitRequestDto

            The settings to set.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlaySetNewQueue: ((playRequestDto: PlayRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request to set new playlist in SyncPlay group.

      Throws

        • (playRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • playRequestDto: PlayRequestDto

            The new playlist to play in the group.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlaySetPlaylistItem: ((setPlaylistItemRequestDto: SetPlaylistItemRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request to change playlist item in SyncPlay group.

      Throws

        • (setPlaylistItemRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • setPlaylistItemRequestDto: SetPlaylistItemRequestDto

            The new item to play.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlaySetRepeatMode: ((setRepeatModeRequestDto: SetRepeatModeRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request to set repeat mode in SyncPlay group.

      Throws

        • (setRepeatModeRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • setRepeatModeRequestDto: SetRepeatModeRequestDto

            The new repeat mode.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlaySetShuffleMode: ((setShuffleModeRequestDto: SetShuffleModeRequestDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request to set shuffle mode in SyncPlay group.

      Throws

        • (setShuffleModeRequestDto, options?): Promise<RequestArgs>

        • Parameters

          • setShuffleModeRequestDto: SetShuffleModeRequestDto

            The new shuffle mode.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayStop: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request stop in SyncPlay group.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • syncPlayUnpause: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Request unpause in SyncPlay group.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility