Function MediaInfoApiFactory

Returns {
    closeLiveStream(requestParameters: MediaInfoApiCloseLiveStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
    getBitrateTestBytes(requestParameters?: MediaInfoApiGetBitrateTestBytesRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
    getPlaybackInfo(requestParameters: MediaInfoApiGetPlaybackInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaybackInfoResponse>;
    getPostedPlaybackInfo(requestParameters: MediaInfoApiGetPostedPlaybackInfoRequest, options?: RawAxiosRequestConfig): AxiosPromise<PlaybackInfoResponse>;
    openLiveStream(requestParameters?: MediaInfoApiOpenLiveStreamRequest, options?: RawAxiosRequestConfig): AxiosPromise<LiveStreamResponse>;
}

• closeLiveStream:function

  • closeLiveStream(requestParameters, options?): AxiosPromise<void>

  • Parameters

    • requestParameters: MediaInfoApiCloseLiveStreamRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<void>

    Summary

    Closes a media source.

    Throws

• getBitrateTestBytes:function

  • getBitrateTestBytes(requestParameters?, options?): AxiosPromise<File>

  • Parameters

    • requestParameters: MediaInfoApiGetBitrateTestBytesRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<File>

    Summary

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

    Throws

• getPlaybackInfo:function

  • getPlaybackInfo(requestParameters, options?): AxiosPromise<PlaybackInfoResponse>

  • Parameters

    • requestParameters: MediaInfoApiGetPlaybackInfoRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlaybackInfoResponse>

    Summary

    Gets live playback media info for an item.

    Throws

• getPostedPlaybackInfo:function

  • getPostedPlaybackInfo(requestParameters, options?): AxiosPromise<PlaybackInfoResponse>

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

    Parameters

    • requestParameters: MediaInfoApiGetPostedPlaybackInfoRequest

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<PlaybackInfoResponse>

    Summary

    Gets live playback media info for an item.

    Throws

• openLiveStream:function

  • openLiveStream(requestParameters?, options?): AxiosPromise<LiveStreamResponse>

  • Parameters

    • requestParameters: MediaInfoApiOpenLiveStreamRequest = {}

      Request parameters.
    • Optionaloptions: RawAxiosRequestConfig

      Override http request option.

    Returns AxiosPromise<LiveStreamResponse>

    Summary

    Opens a media source.

    Throws