Function RecordingApiFactory

  • RecordingApiFactory(configuration?, basePath?, axios?): {
        deleteRecording(recordingId, options?): AxiosPromise<void>;
        getRecordingContent(recordingId, filename, options?): AxiosPromise<string>;
        getRecordings(options?): AxiosPromise<RecordingListResponse>;
    }

  • RecordingApi - factory interface

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        deleteRecording(recordingId, options?): AxiosPromise<void>;
        getRecordingContent(recordingId, filename, options?): AxiosPromise<string>;
        getRecordings(options?): AxiosPromise<RecordingListResponse>;
    }

    • deleteRecording:function
      • deleteRecording(recordingId, options?): AxiosPromise<void>

      • Parameters

        • recordingId: string

          Recording id

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<void>

        Summary

        Deletes the recording

        Throws

    • getRecordingContent:function
      • getRecordingContent(recordingId, filename, options?): AxiosPromise<string>

      • Parameters

        • recordingId: string

          Recording id

        • filename: string

          Name of the file

        • Optional options: any

          Override http request option.

        Returns AxiosPromise<string>

        Summary

        Retrieve Recording (HLS) Content

        Throws

    • getRecordings:function

    Export

Settings

Member Visibility

Theme