Class TrickplayApi

TrickplayApi - object-oriented interface

Export

TrickplayApi

Hierarchy

BaseAPI
- TrickplayApi

Index

Constructors

Properties

axios basePath configuration

Methods

getTrickplayHlsPlaylist getTrickplayTileImage

Constructors

constructor

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

getTrickplayHlsPlaylist

getTrickplayHlsPlaylist(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: TrickplayApiGetTrickplayHlsPlaylistRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets an image tiles playlist for trickplay.

Throws
Memberof
TrickplayApi
- Defined in generated-client/api/trickplay-api.ts:279

getTrickplayTileImage

getTrickplayTileImage(requestParameters, options?): Promise<AxiosResponse<File, any>>
Parameters
- requestParameters: TrickplayApiGetTrickplayTileImageRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<File, any>>
Summary
Gets a trickplay tile image.

Throws
Memberof
TrickplayApi
- Defined in generated-client/api/trickplay-api.ts:291