Class HlsSegmentApi

HlsSegmentApi - object-oriented interface

Export

HlsSegmentApi

Hierarchy

BaseAPI
- HlsSegmentApi

Index

Constructors

constructor

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

getHlsAudioSegmentLegacyAac

getHlsAudioSegmentLegacyAac(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: HlsSegmentApiGetHlsAudioSegmentLegacyAacRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets the specified audio segment for an audio item.

Throws
Memberof
HlsSegmentApi
- Defined in generated-client/api/hls-segment-api.ts:520

getHlsAudioSegmentLegacyMp3

getHlsAudioSegmentLegacyMp3(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: HlsSegmentApiGetHlsAudioSegmentLegacyMp3Request
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets the specified audio segment for an audio item.

Throws
Memberof
HlsSegmentApi
- Defined in generated-client/api/hls-segment-api.ts:532

getHlsPlaylistLegacy

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

Throws
Memberof
HlsSegmentApi
- Defined in generated-client/api/hls-segment-api.ts:544

getHlsVideoSegmentLegacy

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

Throws
Memberof
HlsSegmentApi
- Defined in generated-client/api/hls-segment-api.ts:556

stopEncodingProcess

stopEncodingProcess(requestParameters, options?): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: HlsSegmentApiStopEncodingProcessRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Stops an active encoding.

Throws
Memberof
HlsSegmentApi
- Defined in generated-client/api/hls-segment-api.ts:568

Class HlsSegmentApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns HlsSegmentApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

getHlsAudioSegmentLegacyAac

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getHlsAudioSegmentLegacyMp3

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getHlsPlaylistLegacy

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

getHlsVideoSegmentLegacy

Parameters

Returns Promise<AxiosResponse<File, any>>

Summary

Throws

Memberof

stopEncodingProcess

Parameters

Returns Promise<AxiosResponse<void, any>>

Summary

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration