Function PlaystateApiFactory

Returns {
    markPlayedItem(requestParameters: PlaystateApiMarkPlayedItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserItemDataDto>;
    markUnplayedItem(requestParameters: PlaystateApiMarkUnplayedItemRequest, options?: RawAxiosRequestConfig): AxiosPromise<UserItemDataDto>;
    onPlaybackProgress(requestParameters: PlaystateApiOnPlaybackProgressRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    onPlaybackStart(requestParameters: PlaystateApiOnPlaybackStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    onPlaybackStopped(requestParameters: PlaystateApiOnPlaybackStoppedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    pingPlaybackSession(requestParameters: PlaystateApiPingPlaybackSessionRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    reportPlaybackProgress(requestParameters?: PlaystateApiReportPlaybackProgressRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    reportPlaybackStart(requestParameters?: PlaystateApiReportPlaybackStartRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    reportPlaybackStopped(requestParameters?: PlaystateApiReportPlaybackStoppedRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
}

• markPlayedItem:function

  • markPlayedItem(requestParameters, options?): AxiosPromise<UserItemDataDto>

  • Parameters

    • requestParameters: PlaystateApiMarkPlayedItemRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserItemDataDto>

    Summary

    Marks an item as played for user.

    Throws

• markUnplayedItem:function

  • markUnplayedItem(requestParameters, options?): AxiosPromise<UserItemDataDto>

  • Parameters

    • requestParameters: PlaystateApiMarkUnplayedItemRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<UserItemDataDto>

    Summary

    Marks an item as unplayed for user.

    Throws

• onPlaybackProgress:function

  • onPlaybackProgress(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaystateApiOnPlaybackProgressRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports a session's playback progress.

    Throws

• onPlaybackStart:function

  • onPlaybackStart(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaystateApiOnPlaybackStartRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports that a session has begun playing an item.

    Throws

• onPlaybackStopped:function

  • onPlaybackStopped(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaystateApiOnPlaybackStoppedRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports that a session has stopped playing an item.

    Throws

• pingPlaybackSession:function

  • pingPlaybackSession(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaystateApiPingPlaybackSessionRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Pings a playback session.

    Throws

• reportPlaybackProgress:function

  • reportPlaybackProgress(requestParameters?, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaystateApiReportPlaybackProgressRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports playback progress within a session.

    Throws

• reportPlaybackStart:function

  • reportPlaybackStart(requestParameters?, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaystateApiReportPlaybackStartRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports playback has started within a session.

    Throws

• reportPlaybackStopped:function

  • reportPlaybackStopped(requestParameters?, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: PlaystateApiReportPlaybackStoppedRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Reports playback has stopped within a session.

    Throws