Class VideosApi

VideosApi - object-oriented interface

Export

VideosApi

Hierarchy

BaseAPI
- VideosApi

Index

Constructors

constructor

new VideosApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): 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: VideosApiDeleteAlternateSourcesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: VideosApiDeleteAlternateSourcesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3255

getAdditionalPart

getAdditionalPart(
requestParameters: VideosApiGetAdditionalPartRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult>>
Parameters
- requestParameters: VideosApiGetAdditionalPartRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>
Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3267

getVideoStream

getVideoStream(
requestParameters: VideosApiGetVideoStreamRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File>>
Parameters
- requestParameters: VideosApiGetVideoStreamRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File>>
Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3279

getVideoStreamByContainer

getVideoStreamByContainer(
requestParameters: VideosApiGetVideoStreamByContainerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File>>
Parameters
- requestParameters: VideosApiGetVideoStreamByContainerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File>>
Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3291

headVideoStream

headVideoStream(
requestParameters: VideosApiHeadVideoStreamRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File>>
Parameters
- requestParameters: VideosApiHeadVideoStreamRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File>>
Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3303

headVideoStreamByContainer

headVideoStreamByContainer(
requestParameters: VideosApiHeadVideoStreamByContainerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File>>
Parameters
- requestParameters: VideosApiHeadVideoStreamByContainerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File>>
Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3315

mergeVersions

mergeVersions(
requestParameters: VideosApiMergeVersionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void>>
Parameters
- requestParameters: VideosApiMergeVersionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void>>
Throws
Memberof
VideosApi
- Defined in generated-client/api/videos-api.ts:3327

Class VideosApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns VideosApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

deleteAlternateSources

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

getAdditionalPart

Parameters

Returns Promise<AxiosResponse<BaseItemDtoQueryResult>>

Throws

Memberof

getVideoStream

Parameters

Returns Promise<AxiosResponse<File>>

Throws

Memberof

getVideoStreamByContainer

Parameters

Returns Promise<AxiosResponse<File>>

Throws

Memberof

headVideoStream

Parameters

Returns Promise<AxiosResponse<File>>

Throws

Memberof

headVideoStreamByContainer

Parameters

Returns Promise<AxiosResponse<File>>

Throws

Memberof

mergeVersions

Parameters

Returns Promise<AxiosResponse<void>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration