Class VideosApi

VideosApi - object-oriented interface

Export

VideosApi

Hierarchy

BaseAPI
- VideosApi

Index

Constructors

Properties

axios basePath configuration

Methods

deleteAlternateSources getAdditionalPart getVideoStream getVideoStreamByContainer headVideoStream headVideoStreamByContainer mergeVersions

Constructors

constructor

new VideosApi(configuration?, basePath?, axios?): VideosApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns VideosApi
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

deleteAlternateSources

deleteAlternateSources(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: VideosApiDeleteAlternateSourcesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Removes alternate video sources.

Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3255

getAdditionalPart

getAdditionalPart(requestParameters, options?): Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Parameters
- requestParameters: VideosApiGetAdditionalPartRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any>>
Summary
Gets additional parts for a video.

Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3267

getVideoStream

getVideoStream(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: VideosApiGetVideoStreamRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a video stream.

Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3279

getVideoStreamByContainer

getVideoStreamByContainer(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: VideosApiGetVideoStreamByContainerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a video stream.

Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3291

headVideoStream

headVideoStream(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: VideosApiHeadVideoStreamRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a video stream.

Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3303

headVideoStreamByContainer

headVideoStreamByContainer(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: VideosApiHeadVideoStreamByContainerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a video stream.

Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3315

mergeVersions

mergeVersions(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: VideosApiMergeVersionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Merges videos into a single record.

Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3327