Function MediaInfoApiAxiosParamCreator

MediaInfoApi - axios parameter creator

Export

  • MediaInfoApiAxiosParamCreator(configuration?): {
        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>);
    }

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

      Summary

      Closes a media source.

      Throws

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

        • Parameters

          • liveStreamId: string

            The livestream id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getBitrateTestBytes: ((size?: number, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Tests the network with a request with the size of the bitrate.

      Throws

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

        • Parameters

          • Optionalsize: number

            The bitrate. Defaults to 102400.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

    • getPlaybackInfo: ((itemId: string, userId?: string, options??: RawAxiosRequestConfig) => Promise<RequestArgs>)

      Summary

      Gets live playback media info for an item.

      Throws

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

        • Parameters

          • itemId: string

            The item id.

          • OptionaluserId: string

            The user id.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns 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.

      Summary

      Gets live playback media info for an item.

      Throws

        • (itemId, userId?, maxStreamingBitrate?, startTimeTicks?, audioStreamIndex?, subtitleStreamIndex?, maxAudioChannels?, mediaSourceId?, liveStreamId?, autoOpenLiveStream?, enableDirectPlay?, enableDirectStream?, enableTranscoding?, allowVideoStreamCopy?, allowAudioStreamCopy?, playbackInfoDto?, options?): Promise<RequestArgs>

        • Parameters

          • itemId: string

            The item id.

          • OptionaluserId: string

            The user id.

          • OptionalmaxStreamingBitrate: number

            The maximum streaming bitrate.

          • OptionalstartTimeTicks: number

            The start time in ticks.

          • OptionalaudioStreamIndex: number

            The audio stream index.

          • OptionalsubtitleStreamIndex: number

            The subtitle stream index.

          • OptionalmaxAudioChannels: number

            The maximum number of audio channels.

          • OptionalmediaSourceId: string

            The media source id.

          • OptionalliveStreamId: string

            The livestream id.

          • OptionalautoOpenLiveStream: boolean

            Whether to auto open the livestream.

          • OptionalenableDirectPlay: boolean

            Whether to enable direct play. Default: true.

          • OptionalenableDirectStream: boolean

            Whether to enable direct stream. Default: true.

          • OptionalenableTranscoding: boolean

            Whether to enable transcoding. Default: true.

          • OptionalallowVideoStreamCopy: boolean

            Whether to allow to copy the video stream. Default: true.

          • OptionalallowAudioStreamCopy: boolean

            Whether to allow to copy the audio stream. Default: true.

          • OptionalplaybackInfoDto: PlaybackInfoDto

            The playback info.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns 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>)

      Summary

      Opens a media source.

      Throws

        • (openToken?, userId?, playSessionId?, maxStreamingBitrate?, startTimeTicks?, audioStreamIndex?, subtitleStreamIndex?, maxAudioChannels?, itemId?, enableDirectPlay?, enableDirectStream?, alwaysBurnInSubtitleWhenTranscoding?, openLiveStreamDto?, options?): Promise<RequestArgs>

        • Parameters

          • OptionalopenToken: string

            The open token.

          • OptionaluserId: string

            The user id.

          • OptionalplaySessionId: string

            The play session id.

          • OptionalmaxStreamingBitrate: number

            The maximum streaming bitrate.

          • OptionalstartTimeTicks: number

            The start time in ticks.

          • OptionalaudioStreamIndex: number

            The audio stream index.

          • OptionalsubtitleStreamIndex: number

            The subtitle stream index.

          • OptionalmaxAudioChannels: number

            The maximum number of audio channels.

          • OptionalitemId: string

            The item id.

          • OptionalenableDirectPlay: boolean

            Whether to enable direct play. Default: true.

          • OptionalenableDirectStream: boolean

            Whether to enable direct stream. Default: true.

          • OptionalalwaysBurnInSubtitleWhenTranscoding: boolean

            Always burn-in subtitle when transcoding.

          • OptionalopenLiveStreamDto: OpenLiveStreamDto

            The open live stream dto.

          • Optionaloptions: RawAxiosRequestConfig = {}

            Override http request option.

          Returns Promise<RequestArgs>

Settings

Member Visibility