CallRecording class

Пакет:

@azure/communication-call-automation

Класс CallRecording представляет связанные API-интерфейсы записи вызовов.

Конструкторы

CallRecording(string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

Методы

delete(string, OperationOptions)	Удаляет запись.
downloadStreaming(string, DownloadRecordingOptions)	Возвращает поток с записью вызова.
downloadToPath(string, string, DownloadRecordingOptions)	Скачивает файл записи вызова в указанный путь.
downloadToStream(string, WritableStream, DownloadRecordingOptions)	Загружает файл записи вызовов в указанный поток.
getState(string, OperationOptions)	Возвращает свойства записи вызова.
pause(string, OperationOptions)	Приостанавливает запись звонка.
resume(string, OperationOptions)	Возобновляет запись звонка.
start(StartRecordingOptions)	Запускает запись звонка с указанными параметрами.
stop(string, OperationOptions)	Останавливает запись звонка.

Сведения о конструкторе

CallRecording(string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

new CallRecording(endpoint: string, credential: TokenCredential | KeyCredential, options?: CallAutomationApiClientOptionalParams)

Параметры

endpoint

string

credential

TokenCredential | KeyCredential

options

CallAutomationApiClientOptionalParams

Сведения о методе

delete(string, OperationOptions)

Удаляет запись.

function delete(recordingLocationUrl: string, options?: OperationOptions): Promise<void>

Параметры

recordingLocationUrl

string

URL-адрес расположения записи. Обязательно.

options

OperationOptions

Дополнительные параметры запроса содержат параметры API deleteRecording.

Возвращаемое значение

Promise<void>

downloadStreaming(string, DownloadRecordingOptions)

Возвращает поток с записью вызова.

function downloadStreaming(sourceLocationUrl: string, options?: DownloadRecordingOptions): Promise<ReadableStream>

Параметры

sourceLocationUrl

string

URL-адрес исходного расположения. Обязательно.

options

DownloadRecordingOptions

Дополнительные параметры запроса содержат параметры api downloadRecording.

Возвращаемое значение

Promise<ReadableStream>

downloadToPath(string, string, DownloadRecordingOptions)

Скачивает файл записи вызова в указанный путь.

function downloadToPath(sourceLocationUrl: string, destinationPath: string, options?: DownloadRecordingOptions): Promise<void>

Параметры

sourceLocationUrl

string

URL-адрес исходного расположения. Обязательно.

destinationPath

string

Путь назначения. Обязательно.

options

DownloadRecordingOptions

Дополнительные параметры запроса содержат параметры api downloadRecording.

Возвращаемое значение

Promise<void>

downloadToStream(string, WritableStream, DownloadRecordingOptions)

Загружает файл записи вызовов в указанный поток.

function downloadToStream(sourceLocationUrl: string, destinationStream: WritableStream, options?: DownloadRecordingOptions): Promise<void>

Параметры

sourceLocationUrl

string

URL-адрес исходного расположения. Обязательно.

destinationStream

WritableStream

Целевой поток. Обязательно.

options

DownloadRecordingOptions

Дополнительные параметры запроса содержат параметры api downloadRecording.

Возвращаемое значение

Promise<void>

getState(string, OperationOptions)

Возвращает свойства записи вызова.

function getState(recordingId: string, options?: OperationOptions): Promise<RecordingStateResult>

Параметры

recordingId

string

Идентификатор записи, связанный с записью.

options

OperationOptions

Дополнительные параметры запроса содержат параметры API getRecordingProperties.

Возвращаемое значение

Promise<RecordingStateResult>

pause(string, OperationOptions)

Приостанавливает запись звонка.

function pause(recordingId: string, options?: OperationOptions): Promise<void>

Параметры

recordingId

string

Идентификатор записи, связанный с записью.

options

OperationOptions

Дополнительные параметры запроса содержат параметры api pauseRecording.

Возвращаемое значение

Promise<void>

resume(string, OperationOptions)

Возобновляет запись звонка.

function resume(recordingId: string, options?: OperationOptions): Promise<void>

Параметры

recordingId

string

Идентификатор записи, связанный с записью.

options

OperationOptions

Дополнительные параметры запроса содержат параметры api резюмеRecording.

Возвращаемое значение

Promise<void>

start(StartRecordingOptions)

Запускает запись звонка с указанными параметрами.

function start(options: StartRecordingOptions): Promise<RecordingStateResult>

Параметры

options

StartRecordingOptions

Параметры операции.

Возвращаемое значение

Promise<RecordingStateResult>

stop(string, OperationOptions)

Останавливает запись звонка.

function stop(recordingId: string, options?: OperationOptions): Promise<void>

Параметры

recordingId

string

Идентификатор записи, связанный с записью.

options

OperationOptions

Дополнительные параметры запроса содержат параметры api stopRecording.

Возвращаемое значение

Promise<void>