Function TrickplayApiFp

TrickplayApi - functional programming interface

Export

  • TrickplayApiFp(
        configuration?: Configuration,
    ): {
        getTrickplayHlsPlaylist(
            itemId: string,
            width: number,
            mediaSourceId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
        >;
        getTrickplayTileImage(
            itemId: string,
            width: number,
            index: number,
            mediaSourceId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
        >;
    }

  • Parameters

    Returns {
        getTrickplayHlsPlaylist(
            itemId: string,
            width: number,
            mediaSourceId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
        >;
        getTrickplayTileImage(
            itemId: string,
            width: number,
            index: number,
            mediaSourceId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<
            (axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>,
        >;
    }

    • getTrickplayHlsPlaylist:function
      • getTrickplayHlsPlaylist(
            itemId: string,
            width: number,
            mediaSourceId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

      • Parameters

        • itemId: string

          The item id.

        • width: number

          The width of a single tile.

        • OptionalmediaSourceId: string

          The media version id, if using an alternate version.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

    • getTrickplayTileImage:function
      • getTrickplayTileImage(
            itemId: string,
            width: number,
            index: number,
            mediaSourceId?: string,
            options?: RawAxiosRequestConfig,
        ): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>

      • Parameters

        • itemId: string

          The item id.

        • width: number

          The width of a single tile.

        • index: number

          The index of the desired tile.

        • OptionalmediaSourceId: string

          The media version id, if using an alternate version.

        • Optionaloptions: RawAxiosRequestConfig

          Override http request option.

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

        Throws

Settings

Member Visibility