Class RecordingApi

RecordingApi - object-oriented interface

Export

RecordingApi

Hierarchy

BaseAPI
- RecordingApi

Index

Constructors

Properties

axios basePath configuration

Methods

deleteRecording getRecordingContent getRecordings

Constructors

constructor

new RecordingApi(configuration?, basePath?, axios?): RecordingApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns RecordingApi
Inherited from BaseAPI.constructor
- Defined in openapi/base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

deleteRecording

deleteRecording(recordingId, options?): Promise<AxiosResponse<void, any>>
Parameters
- recordingId: string
  Recording id
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Deletes the recording

Throws
Memberof
RecordingApi
- Defined in openapi/api.ts:1521

getRecordingContent

getRecordingContent(recordingId, filename, options?): Promise<AxiosResponse<string, any>>
Parameters
- recordingId: string
  Recording id
- filename: string
  Name of the file
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<string, any>>
Summary
Retrieve Recording (HLS) Content

Throws
Memberof
RecordingApi
- Defined in openapi/api.ts:1534

getRecordings

getRecordings(options?): Promise<AxiosResponse<RecordingListResponse, any>>
Parameters
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<RecordingListResponse, any>>
Summary
Lists all available recordings

Throws
Memberof
RecordingApi
- Defined in openapi/api.ts:1545