Function VideosApiFactory

VideosApi - factory interface

Export

VideosApiFactory(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): {
    deleteAlternateSources(
        requestParameters: VideosApiDeleteAlternateSourcesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getAdditionalPart(
        requestParameters: VideosApiGetAdditionalPartRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getVideoStream(
        requestParameters: VideosApiGetVideoStreamRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    getVideoStreamByContainer(
        requestParameters: VideosApiGetVideoStreamByContainerRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    headVideoStream(
        requestParameters: VideosApiHeadVideoStreamRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    headVideoStreamByContainer(
        requestParameters: VideosApiHeadVideoStreamByContainerRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    mergeVersions(
        requestParameters: VideosApiMergeVersionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}
Parameters
- Optionalconfiguration: Configuration
- OptionalbasePath: string
- Optionalaxios: AxiosInstance
Returns {
    deleteAlternateSources(
        requestParameters: VideosApiDeleteAlternateSourcesRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
    getAdditionalPart(
        requestParameters: VideosApiGetAdditionalPartRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>;
    getVideoStream(
        requestParameters: VideosApiGetVideoStreamRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    getVideoStreamByContainer(
        requestParameters: VideosApiGetVideoStreamByContainerRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    headVideoStream(
        requestParameters: VideosApiHeadVideoStreamRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    headVideoStreamByContainer(
        requestParameters: VideosApiHeadVideoStreamByContainerRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>;
    mergeVersions(
        requestParameters: VideosApiMergeVersionsRequest,
        options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>;
}
- deleteAlternateSources:function
  - deleteAlternateSources(
    requestParameters: VideosApiDeleteAlternateSourcesRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: VideosApiDeleteAlternateSourcesRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/videos-api.ts:1641
- getAdditionalPart:function
  - getAdditionalPart(
    requestParameters: VideosApiGetAdditionalPartRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<BaseItemDtoQueryResult>
  - Parameters
    - requestParameters: VideosApiGetAdditionalPartRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<BaseItemDtoQueryResult>
    Throws
    - Defined in generated-client/api/videos-api.ts:1651
- getVideoStream:function
  - getVideoStream(
    requestParameters: VideosApiGetVideoStreamRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>
  - Parameters
    - requestParameters: VideosApiGetVideoStreamRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<File>
    Throws
    - Defined in generated-client/api/videos-api.ts:1661
- getVideoStreamByContainer:function
  - getVideoStreamByContainer(
    requestParameters: VideosApiGetVideoStreamByContainerRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>
  - Parameters
    - requestParameters: VideosApiGetVideoStreamByContainerRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<File>
    Throws
    - Defined in generated-client/api/videos-api.ts:1671
- headVideoStream:function
  - headVideoStream(
    requestParameters: VideosApiHeadVideoStreamRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>
  - Parameters
    - requestParameters: VideosApiHeadVideoStreamRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<File>
    Throws
    - Defined in generated-client/api/videos-api.ts:1681
- headVideoStreamByContainer:function
  - headVideoStreamByContainer(
    requestParameters: VideosApiHeadVideoStreamByContainerRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<File>
  - Parameters
    - requestParameters: VideosApiHeadVideoStreamByContainerRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<File>
    Throws
    - Defined in generated-client/api/videos-api.ts:1691
- mergeVersions:function
  - mergeVersions(
    requestParameters: VideosApiMergeVersionsRequest,
    options?: RawAxiosRequestConfig,
    ): AxiosPromise<void>
  - Parameters
    - requestParameters: VideosApiMergeVersionsRequest
      Request parameters.
    - Optionaloptions: RawAxiosRequestConfig
      Override http request option.
    Returns AxiosPromise<void>
    Throws
    - Defined in generated-client/api/videos-api.ts:1701
- Defined in generated-client/api/videos-api.ts:1631

Function VideosApiFactory

Export

Parameters

deleteAlternateSources:function

Parameters

Returns AxiosPromise<void>

Throws

getAdditionalPart:function

Parameters

Returns AxiosPromise<BaseItemDtoQueryResult>

Throws

getVideoStream:function

Parameters

Returns AxiosPromise<File>

Throws

getVideoStreamByContainer:function

Parameters

Returns AxiosPromise<File>

Throws

headVideoStream:function

Parameters

Returns AxiosPromise<File>

Throws

headVideoStreamByContainer:function

Parameters

Returns AxiosPromise<File>

Throws

mergeVersions:function

Parameters

Returns AxiosPromise<void>

Throws

Settings