Function PlaystateApiAxiosParamCreator

Returns {
    markPlayedItem: ((itemId: string, userId?: string, datePlayed?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    markUnplayedItem: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    onPlaybackProgress: ((itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    onPlaybackStart: ((itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    onPlaybackStopped: ((itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    pingPlaybackSession: ((playSessionId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    reportPlaybackProgress: ((playbackProgressInfo?: PlaybackProgressInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    reportPlaybackStart: ((playbackStartInfo?: PlaybackStartInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    reportPlaybackStopped: ((playbackStopInfo?: PlaybackStopInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
}

• markPlayedItem: ((itemId: string, userId?: string, datePlayed?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Marks an item as played for user.

  Throws

  • • (itemId, userId?, datePlayed?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionaluserId: string

        User id.
      • OptionaldatePlayed: string

        Optional. The date the item was played.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• markUnplayedItem: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Marks an item as unplayed for user.

  Throws

  • • (itemId, userId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionaluserId: string

        User id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• onPlaybackProgress: ((itemId: string, mediaSourceId?: string, positionTicks?: number, audioStreamIndex?: number, subtitleStreamIndex?: number, volumeLevel?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, repeatMode?: RepeatMode, isPaused?: boolean, isMuted?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports a session's playback progress.

  Throws

  • • (itemId, mediaSourceId?, positionTicks?, audioStreamIndex?, subtitleStreamIndex?, volumeLevel?, playMethod?, liveStreamId?, playSessionId?, repeatMode?, isPaused?, isMuted?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionalmediaSourceId: string

        The id of the MediaSource.
      • OptionalpositionTicks: number

        Optional. The current position, in ticks. 1 tick = 10000 ms.
      • OptionalaudioStreamIndex: number

        The audio stream index.
      • OptionalsubtitleStreamIndex: number

        The subtitle stream index.
      • OptionalvolumeLevel: number

        Scale of 0-100.
      • OptionalplayMethod: PlayMethod

        The play method.
      • OptionalliveStreamId: string

        The live stream id.
      • OptionalplaySessionId: string

        The play session id.
      • OptionalrepeatMode: RepeatMode

        The repeat mode.
      • OptionalisPaused: boolean

        Indicates if the player is paused.
      • OptionalisMuted: boolean

        Indicates if the player is muted.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• onPlaybackStart: ((itemId: string, mediaSourceId?: string, audioStreamIndex?: number, subtitleStreamIndex?: number, playMethod?: PlayMethod, liveStreamId?: string, playSessionId?: string, canSeek?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports that a session has begun playing an item.

  Throws

  • • (itemId, mediaSourceId?, audioStreamIndex?, subtitleStreamIndex?, playMethod?, liveStreamId?, playSessionId?, canSeek?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionalmediaSourceId: string

        The id of the MediaSource.
      • OptionalaudioStreamIndex: number

        The audio stream index.
      • OptionalsubtitleStreamIndex: number

        The subtitle stream index.
      • OptionalplayMethod: PlayMethod

        The play method.
      • OptionalliveStreamId: string

        The live stream id.
      • OptionalplaySessionId: string

        The play session id.
      • OptionalcanSeek: boolean

        Indicates if the client can seek.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• onPlaybackStopped: ((itemId: string, mediaSourceId?: string, nextMediaType?: string, positionTicks?: number, liveStreamId?: string, playSessionId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports that a session has stopped playing an item.

  Throws

  • • (itemId, mediaSourceId?, nextMediaType?, positionTicks?, liveStreamId?, playSessionId?, options?): Promise<RequestArgs>

    • Parameters

      • itemId: string

        Item id.
      • OptionalmediaSourceId: string

        The id of the MediaSource.
      • OptionalnextMediaType: string

        The next media type that will play.
      • OptionalpositionTicks: number

        Optional. The position, in ticks, where playback stopped. 1 tick = 10000 ms.
      • OptionalliveStreamId: string

        The live stream id.
      • OptionalplaySessionId: string

        The play session id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• pingPlaybackSession: ((playSessionId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Pings a playback session.

  Throws

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

    • Parameters

      • playSessionId: string

        Playback session id.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• reportPlaybackProgress: ((playbackProgressInfo?: PlaybackProgressInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports playback progress within a session.

  Throws

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

    • Parameters

      • OptionalplaybackProgressInfo: PlaybackProgressInfo

        The playback progress info.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• reportPlaybackStart: ((playbackStartInfo?: PlaybackStartInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports playback has started within a session.

  Throws

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

    • Parameters

      • OptionalplaybackStartInfo: PlaybackStartInfo

        The playback start info.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>

• reportPlaybackStopped: ((playbackStopInfo?: PlaybackStopInfo, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

  Summary

  Reports playback has stopped within a session.

  Throws

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

    • Parameters

      • OptionalplaybackStopInfo: PlaybackStopInfo

        The playback stop info.
      • Optionaloptions: RawAxiosRequestConfig = {}

        Override http request option.

      Returns Promise<RequestArgs>