MediaInfoApi - axios parameter creator

  • Parameters

    Returns {
        closeLiveStream: (
            liveStreamId: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getBitrateTestBytes: (
            size?: number,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getPlaybackInfo: (
            itemId: string,
            userId?: string,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        getPostedPlaybackInfo: (
            itemId: string,
            userId?: string,
            maxStreamingBitrate?: number,
            startTimeTicks?: number,
            audioStreamIndex?: number,
            subtitleStreamIndex?: number,
            maxAudioChannels?: number,
            mediaSourceId?: string,
            liveStreamId?: string,
            autoOpenLiveStream?: boolean,
            enableDirectPlay?: boolean,
            enableDirectStream?: boolean,
            enableTranscoding?: boolean,
            allowVideoStreamCopy?: boolean,
            allowAudioStreamCopy?: boolean,
            playbackInfoDto?: PlaybackInfoDto,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
        openLiveStream: (
            openToken?: string,
            userId?: string,
            playSessionId?: string,
            maxStreamingBitrate?: number,
            startTimeTicks?: number,
            audioStreamIndex?: number,
            subtitleStreamIndex?: number,
            maxAudioChannels?: number,
            itemId?: string,
            enableDirectPlay?: boolean,
            enableDirectStream?: boolean,
            alwaysBurnInSubtitleWhenTranscoding?: boolean,
            openLiveStreamDto?: OpenLiveStreamDto,
            options?: RawAxiosRequestConfig,
        ) => Promise<RequestArgs>;
    }

    • closeLiveStream: (liveStreamId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>
    • getBitrateTestBytes: (size?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>
    • getPlaybackInfo: (
          itemId: string,
          userId?: string,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>
    • getPostedPlaybackInfo: (
          itemId: string,
          userId?: string,
          maxStreamingBitrate?: number,
          startTimeTicks?: number,
          audioStreamIndex?: number,
          subtitleStreamIndex?: number,
          maxAudioChannels?: number,
          mediaSourceId?: string,
          liveStreamId?: string,
          autoOpenLiveStream?: boolean,
          enableDirectPlay?: boolean,
          enableDirectStream?: boolean,
          enableTranscoding?: boolean,
          allowVideoStreamCopy?: boolean,
          allowAudioStreamCopy?: boolean,
          playbackInfoDto?: PlaybackInfoDto,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>

      For backwards compatibility parameters can be sent via Query or Body, with Query having higher precedence. Query parameters are obsolete.

    • openLiveStream: (
          openToken?: string,
          userId?: string,
          playSessionId?: string,
          maxStreamingBitrate?: number,
          startTimeTicks?: number,
          audioStreamIndex?: number,
          subtitleStreamIndex?: number,
          maxAudioChannels?: number,
          itemId?: string,
          enableDirectPlay?: boolean,
          enableDirectStream?: boolean,
          alwaysBurnInSubtitleWhenTranscoding?: boolean,
          openLiveStreamDto?: OpenLiveStreamDto,
          options?: RawAxiosRequestConfig,
      ) => Promise<RequestArgs>