CallRecording class

Pakiet:

@azure/communication-call-automation

CallRecording, klasa reprezentuje interfejsy API powiązane z rejestrowaniem wywołań.

Konstruktory

CallRecording(string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

Metody

delete(string, OperationOptions)	Usuwa nagranie.
downloadStreaming(string, DownloadRecordingOptions)	Zwraca strumień z nagraniem wywołania.
downloadToPath(string, string, DownloadRecordingOptions)	Pobiera plik nagrywania wywołań do określonej ścieżki.
downloadToStream(string, WritableStream, DownloadRecordingOptions)	Pobiera plik nagrywania wywołań do określonego strumienia.
getState(string, OperationOptions)	Zwraca właściwości rejestrowania wywołań.
pause(string, OperationOptions)	Wstrzymuje nagrywanie połączeń.
resume(string, OperationOptions)	Wznawia nagrywanie połączeń.
start(StartRecordingOptions)	Uruchamia nagrywanie wywołań z określonymi opcjami.
stop(string, OperationOptions)	Zatrzymuje nagrywanie połączeń.

Szczegóły konstruktora

CallRecording(string, TokenCredential | KeyCredential, CallAutomationApiClientOptionalParams)

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

Parametry

endpoint

string

credential

TokenCredential | KeyCredential

options

CallAutomationApiClientOptionalParams

Szczegóły metody

delete(string, OperationOptions)

Usuwa nagranie.

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

Parametry

recordingLocationUrl

string

Adres URL lokalizacji nagrywania. Wymagane.

options

OperationOptions

Dodatkowe opcje żądania zawierają opcje interfejsu API deleteRecording.

Zwraca

Promise<void>

downloadStreaming(string, DownloadRecordingOptions)

Zwraca strumień z nagraniem wywołania.

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

Parametry

sourceLocationUrl

string

Adres URL lokalizacji źródłowej. Wymagane.

options

DownloadRecordingOptions

Dodatkowe opcje żądania zawierają opcje interfejsu API pobieraniaRekordowanie.

Zwraca

Promise<ReadableStream>

downloadToPath(string, string, DownloadRecordingOptions)

Pobiera plik nagrywania wywołań do określonej ścieżki.

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

Parametry

sourceLocationUrl

string

Adres URL lokalizacji źródłowej. Wymagane.

destinationPath

string

Ścieżka docelowa. Wymagane.

options

DownloadRecordingOptions

Dodatkowe opcje żądania zawierają opcje interfejsu API pobieraniaRekordowanie.

Zwraca

Promise<void>

downloadToStream(string, WritableStream, DownloadRecordingOptions)

Pobiera plik nagrywania wywołań do określonego strumienia.

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

Parametry

sourceLocationUrl

string

Adres URL lokalizacji źródłowej. Wymagane.

destinationStream

WritableStream

Strumień docelowy. Wymagane.

options

DownloadRecordingOptions

Dodatkowe opcje żądania zawierają opcje interfejsu API pobieraniaRekordowanie.

Zwraca

Promise<void>

getState(string, OperationOptions)

Zwraca właściwości rejestrowania wywołań.

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

Parametry

recordingId

string

Identyfikator nagrywania skojarzony z nagraniem.

options

OperationOptions

Dodatkowe opcje żądania zawierają opcje interfejsu API getRecordingProperties.

Zwraca

Promise<RecordingStateResult>

pause(string, OperationOptions)

Wstrzymuje nagrywanie połączeń.

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

Parametry

recordingId

string

Identyfikator nagrywania skojarzony z nagraniem.

options

OperationOptions

Dodatkowe opcje żądania zawierają opcje interfejsu API pauseRecording.

Zwraca

Promise<void>

resume(string, OperationOptions)

Wznawia nagrywanie połączeń.

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

Parametry

recordingId

string

Identyfikator nagrywania skojarzony z nagraniem.

options

OperationOptions

Dodatkowe opcje żądania zawierają opcje interfejsu API resumeRecording.

Zwraca

Promise<void>

start(StartRecordingOptions)

Uruchamia nagrywanie wywołań z określonymi opcjami.

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

Parametry

options

StartRecordingOptions

Opcje operacji.

Zwraca

Promise<RecordingStateResult>

stop(string, OperationOptions)

Zatrzymuje nagrywanie połączeń.

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

Parametry

recordingId

string

Identyfikator nagrywania skojarzony z nagraniem.

options

OperationOptions

Dodatkowe opcje żądania zawierają opcje interfejsu API stopRecording.

Zwraca

Promise<void>