Function SubtitleApiAxiosParamCreator

SubtitleApi - axios parameter creator

Export

  • SubtitleApiAxiosParamCreator(configuration?): {
        deleteSubtitle: ((itemId: string, index: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        downloadRemoteSubtitles: ((itemId: string, subtitleId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getFallbackFont: ((name: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getFallbackFontList: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getRemoteSubtitles: ((subtitleId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getSubtitle: ((routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getSubtitlePlaylist: ((itemId: string, index: number, mediaSourceId: string, segmentLength: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getSubtitleWithTicks: ((routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        searchRemoteSubtitles: ((itemId: string, language: string, isPerfectMatch?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        uploadSubtitle: ((itemId: string, uploadSubtitleDto: UploadSubtitleDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

  • Parameters

    Returns {
        deleteSubtitle: ((itemId: string, index: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        downloadRemoteSubtitles: ((itemId: string, subtitleId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getFallbackFont: ((name: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getFallbackFontList: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getRemoteSubtitles: ((subtitleId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getSubtitle: ((routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getSubtitlePlaylist: ((itemId: string, index: number, mediaSourceId: string, segmentLength: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        getSubtitleWithTicks: ((routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        searchRemoteSubtitles: ((itemId: string, language: string, isPerfectMatch?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
        uploadSubtitle: ((itemId: string, uploadSubtitleDto: UploadSubtitleDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>);
    }

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

      Summary

      Deletes an external subtitle file.

      Throws

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

        • Parameters

          • itemId: string

            The item id.

          • index: number

            The index of the subtitle file.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • downloadRemoteSubtitles: ((itemId: string, subtitleId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Downloads a remote subtitle.

      Throws

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

        • Parameters

          • itemId: string

            The item id.

          • subtitleId: string

            The subtitle id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getFallbackFont: ((name: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a fallback font file.

      Throws

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

        • Parameters

          • name: string

            The name of the fallback font file to get.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getFallbackFontList: ((options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets a list of available fallback font files.

      Throws

        • (options?): Promise<RequestArgs>

        • Parameters

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getRemoteSubtitles: ((subtitleId: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets the remote subtitles.

      Throws

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

        • Parameters

          • subtitleId: string

            The item id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getSubtitle: ((routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, startPositionTicks?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets subtitles in a specified format.

      Throws

        • (routeItemId, routeMediaSourceId, routeIndex, routeFormat, itemId?, mediaSourceId?, index?, format?, endPositionTicks?, copyTimestamps?, addVttTimeMap?, startPositionTicks?, options?): Promise<RequestArgs>

        • Parameters

          • routeItemId: string

            The (route) item id.

          • routeMediaSourceId: string

            The (route) media source id.

          • routeIndex: number

            The (route) subtitle stream index.

          • routeFormat: string

            The (route) format of the returned subtitle.

          • OptionalitemId: string

            The item id.

          • OptionalmediaSourceId: string

            The media source id.

          • Optionalindex: number

            The subtitle stream index.

          • Optionalformat: string

            The format of the returned subtitle.

          • OptionalendPositionTicks: number

            Optional. The end position of the subtitle in ticks.

          • OptionalcopyTimestamps: boolean

            Optional. Whether to copy the timestamps.

          • OptionaladdVttTimeMap: boolean

            Optional. Whether to add a VTT time map.

          • OptionalstartPositionTicks: number

            The start position of the subtitle in ticks.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

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

      Summary

      Gets an HLS subtitle playlist.

      Throws

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

        • Parameters

          • itemId: string

            The item id.

          • index: number

            The subtitle stream index.

          • mediaSourceId: string

            The media source id.

          • segmentLength: number

            The subtitle segment length.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getSubtitleWithTicks: ((routeItemId: string, routeMediaSourceId: string, routeIndex: number, routeStartPositionTicks: number, routeFormat: string, itemId?: string, mediaSourceId?: string, index?: number, startPositionTicks?: number, format?: string, endPositionTicks?: number, copyTimestamps?: boolean, addVttTimeMap?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets subtitles in a specified format.

      Throws

        • (routeItemId, routeMediaSourceId, routeIndex, routeStartPositionTicks, routeFormat, itemId?, mediaSourceId?, index?, startPositionTicks?, format?, endPositionTicks?, copyTimestamps?, addVttTimeMap?, options?): Promise<RequestArgs>

        • Parameters

          • routeItemId: string

            The (route) item id.

          • routeMediaSourceId: string

            The (route) media source id.

          • routeIndex: number

            The (route) subtitle stream index.

          • routeStartPositionTicks: number

            The (route) start position of the subtitle in ticks.

          • routeFormat: string

            The (route) format of the returned subtitle.

          • OptionalitemId: string

            The item id.

          • OptionalmediaSourceId: string

            The media source id.

          • Optionalindex: number

            The subtitle stream index.

          • OptionalstartPositionTicks: number

            The start position of the subtitle in ticks.

          • Optionalformat: string

            The format of the returned subtitle.

          • OptionalendPositionTicks: number

            Optional. The end position of the subtitle in ticks.

          • OptionalcopyTimestamps: boolean

            Optional. Whether to copy the timestamps.

          • OptionaladdVttTimeMap: boolean

            Optional. Whether to add a VTT time map.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • searchRemoteSubtitles: ((itemId: string, language: string, isPerfectMatch?: boolean, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Search remote subtitles.

      Throws

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

        • Parameters

          • itemId: string

            The item id.

          • language: string

            The language of the subtitles.

          • OptionalisPerfectMatch: boolean

            Optional. Only show subtitles which are a perfect match.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • uploadSubtitle: ((itemId: string, uploadSubtitleDto: UploadSubtitleDto, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Upload an external subtitle file.

      Throws

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

        • Parameters

          • itemId: string

            The item the subtitle belongs to.

          • uploadSubtitleDto: UploadSubtitleDto

            The request body.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility