Function TrickplayApiAxiosParamCreator

TrickplayApi - axios parameter creator

Export

  • TrickplayApiAxiosParamCreator(configuration?): {
        getTrickplayHlsPlaylist: ((itemId: string, width: number, mediaSourceId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getTrickplayTileImage: ((itemId: string, width: number, index: number, mediaSourceId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        getTrickplayHlsPlaylist: ((itemId: string, width: number, mediaSourceId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getTrickplayTileImage: ((itemId: string, width: number, index: number, mediaSourceId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

    • getTrickplayHlsPlaylist: ((itemId: string, width: number, mediaSourceId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets an image tiles playlist for trickplay.

      Throws

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

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

    • getTrickplayTileImage: ((itemId: string, width: number, index: number, mediaSourceId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a trickplay tile image.

      Throws

        • (itemId, width, index, mediaSourceId?, options?): Promise<RequestArgs>

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

Settings

Member Visibility