@jellyfin/sdk
    Preparing search index...

    Function SyncPlayApiFp

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

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

      • syncPlayGetGroups: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayJoinGroup: function
        • Parameters

          • joinGroupRequestDto: JoinGroupRequestDto

            The group to join.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayLeaveGroup: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

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

      • syncPlayNextItem: function
        • Parameters

          • nextItemRequestDto: NextItemRequestDto

            The current item information.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayPause: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayPing: function
        • Parameters

          • pingRequestDto: PingRequestDto

            The new ping.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayPreviousItem: function
        • Parameters

          • previousItemRequestDto: PreviousItemRequestDto

            The current item information.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayQueue: function
        • Parameters

          • queueRequestDto: QueueRequestDto

            The items to add.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayReady: function
        • Parameters

          • readyRequestDto: ReadyRequestDto

            The player status.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayRemoveFromPlaylist: function
        • Parameters

          • removeFromPlaylistRequestDto: RemoveFromPlaylistRequestDto

            The items to remove.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlaySeek: function
        • Parameters

          • seekRequestDto: SeekRequestDto

            The new playback position.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlaySetIgnoreWait: function
        • Parameters

          • ignoreWaitRequestDto: IgnoreWaitRequestDto

            The settings to set.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

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

      • syncPlaySetPlaylistItem: function
        • Parameters

          • setPlaylistItemRequestDto: SetPlaylistItemRequestDto

            The new item to play.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlaySetRepeatMode: function
        • Parameters

          • setRepeatModeRequestDto: SetRepeatModeRequestDto

            The new repeat mode.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlaySetShuffleMode: function
        • Parameters

          • setShuffleModeRequestDto: SetShuffleModeRequestDto

            The new shuffle mode.

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayStop: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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

      • syncPlayUnpause: function
        • Parameters

          • Optionaloptions: RawAxiosRequestConfig

            Override http request option.

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