Class VideoApi

VideoApi - object-oriented interface

Hierarchy

BaseAPI
- VideoApi

Index

Constructors

Properties

axios basePath configuration

Methods

deleteAlternateSources getAdditionalPart getAttachment getVideoStream getVideoStreamByContainer headVideoStream headVideoStreamByContainer mergeVersions

Constructors

constructor

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

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: Configuration | undefined

Methods

deleteAlternateSources

deleteAlternateSources(
requestParameters: VideoApiDeleteAlternateSourcesRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: VideoApiDeleteAlternateSourcesRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/video-api.ts:2845

getAdditionalPart

getAdditionalPart(
requestParameters: VideoApiGetAdditionalPartRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>
Parameters
- requestParameters: VideoApiGetAdditionalPartRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<BaseItemDtoQueryResult, any, {}>>

Throws
- Defined in generated-client/api/video-api.ts:2856

getAttachment

getAttachment(
requestParameters: VideoApiGetAttachmentRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: VideoApiGetAttachmentRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/video-api.ts:2867

getVideoStream

getVideoStream(
requestParameters: VideoApiGetVideoStreamRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: VideoApiGetVideoStreamRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/video-api.ts:2878

getVideoStreamByContainer

getVideoStreamByContainer(
requestParameters: VideoApiGetVideoStreamByContainerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: VideoApiGetVideoStreamByContainerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/video-api.ts:2889

headVideoStream

headVideoStream(
requestParameters: VideoApiHeadVideoStreamRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: VideoApiHeadVideoStreamRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/video-api.ts:2900

headVideoStreamByContainer

headVideoStreamByContainer(
requestParameters: VideoApiHeadVideoStreamByContainerRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<File, any, {}>>
Parameters
- requestParameters: VideoApiHeadVideoStreamByContainerRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any, {}>>

Throws
- Defined in generated-client/api/video-api.ts:2911

mergeVersions

mergeVersions(
requestParameters: VideoApiMergeVersionsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any, {}>>
Parameters
- requestParameters: VideoApiMergeVersionsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any, {}>>

Throws
- Defined in generated-client/api/video-api.ts:2922