Class MediaInfoApi

MediaInfoApi - object-oriented interface

Export

MediaInfoApi

Hierarchy

BaseAPI
- MediaInfoApi

Index

Constructors

constructor

new MediaInfoApi(configuration?, basePath?, axios?): MediaInfoApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns MediaInfoApi
Inherited from BaseAPI.constructor
- Defined in generated-client/base.ts:52

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

closeLiveStream

closeLiveStream(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: MediaInfoApiCloseLiveStreamRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Closes a media source.

Throws
Memberof
MediaInfoApi
- Defined in generated-client/api/media-info-api.ts:814

getBitrateTestBytes

getBitrateTestBytes(requestParameters?, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: MediaInfoApiGetBitrateTestBytesRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Tests the network with a request with the size of the bitrate.

Throws
Memberof
MediaInfoApi
- Defined in generated-client/api/media-info-api.ts:826

getPlaybackInfo

getPlaybackInfo(requestParameters, options?): Promise<AxiosResponse<PlaybackInfoResponse, any>>
Parameters
- requestParameters: MediaInfoApiGetPlaybackInfoRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PlaybackInfoResponse, any>>
Summary
Gets live playback media info for an item.

Throws
Memberof
MediaInfoApi
- Defined in generated-client/api/media-info-api.ts:838

getPostedPlaybackInfo

getPostedPlaybackInfo(requestParameters, options?): Promise<AxiosResponse<PlaybackInfoResponse, any>>
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 Promise<AxiosResponse<PlaybackInfoResponse, any>>
Summary
Gets live playback media info for an item.

Throws
Memberof
MediaInfoApi
- Defined in generated-client/api/media-info-api.ts:850

openLiveStream

openLiveStream(requestParameters?, options?): Promise<AxiosResponse<LiveStreamResponse, any>>
Parameters
- requestParameters: MediaInfoApiOpenLiveStreamRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<LiveStreamResponse, any>>
Summary
Opens a media source.

Throws
Memberof
MediaInfoApi
- Defined in generated-client/api/media-info-api.ts:862

Class MediaInfoApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns MediaInfoApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

closeLiveStream

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

getBitrateTestBytes

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getPlaybackInfo

Parameters

Returns Promise<AxiosResponse<PlaybackInfoResponse, any>>

Summary

Throws

Memberof

getPostedPlaybackInfo

Parameters

Returns Promise<AxiosResponse<PlaybackInfoResponse, any>>

Summary

Throws

Memberof

openLiveStream

Parameters

Returns Promise<AxiosResponse<LiveStreamResponse, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration