CallRecording class

الحزمة:

@azure/communication-call-automation

تمثل فئة CallRecording واجهات برمجة التطبيقات ذات الصلة بتسجيل المكالمات.

المنشئون

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

تحتوي خيارات الطلب الإضافية على خيارات deleteRecording api.

المرتجعات

Promise<void>

downloadStreaming(string, DownloadRecordingOptions)

إرجاع دفق مع تسجيل مكالمة.

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

المعلمات

sourceLocationUrl

string

عنوان URL لموقع المصدر. مطلوب.

options

DownloadRecordingOptions

تحتوي خيارات الطلب الإضافية على خيارات downloadRecording api.

المرتجعات

Promise<ReadableStream>

downloadToPath(string, string, DownloadRecordingOptions)

تنزيل ملف تسجيل مكالمة إلى المسار المحدد.

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

المعلمات

sourceLocationUrl

string

عنوان URL لموقع المصدر. مطلوب.

destinationPath

string

مسار الوجهة. مطلوب.

options

DownloadRecordingOptions

تحتوي خيارات الطلب الإضافية على خيارات downloadRecording api.

المرتجعات

Promise<void>

downloadToStream(string, WritableStream, DownloadRecordingOptions)

تنزيل ملف تسجيل مكالمة إلى الدفق المحدد.

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

المعلمات

sourceLocationUrl

string

عنوان URL لموقع المصدر. مطلوب.

destinationStream

WritableStream

دفق الوجهة. مطلوب.

options

DownloadRecordingOptions

تحتوي خيارات الطلب الإضافية على خيارات downloadRecording api.

المرتجعات

Promise<void>

getState(string, OperationOptions)

إرجاع خصائص تسجيل المكالمات.

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

المعلمات

recordingId

string

معرف التسجيل المقترن بالتسجيل.

options

OperationOptions

تحتوي خيارات الطلب الإضافية على خيارات واجهة برمجة تطبيقات getRecordingProperties.

المرتجعات

Promise<RecordingStateResult>

pause(string, OperationOptions)

إيقاف تسجيل مكالمة مؤقتا.

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

المعلمات

recordingId

string

معرف التسجيل المقترن بالتسجيل.

options

OperationOptions

تحتوي خيارات الطلب الإضافية على pauseRecording api options.

المرتجعات

Promise<void>

resume(string, OperationOptions)

استئناف تسجيل مكالمة.

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

المعلمات

recordingId

string

معرف التسجيل المقترن بالتسجيل.

options

OperationOptions

تحتوي خيارات الطلب الإضافية على خيارات واجهة برمجة تطبيقات resumeRecording.

المرتجعات

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

تحتوي خيارات الطلب الإضافية على خيارات واجهة برمجة التطبيقات stopRecording.

المرتجعات

Promise<void>