@jellyfin/sdk

    Function SubtitleApiAxiosParamCreator

    • SubtitleApi - axios parameter creator

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