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

其他要求選項包含 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

與錄製相關聯的 recordingId。

options

OperationOptions

其他要求選項包含 getRecordingProperties api 選項。

傳回

Promise<RecordingStateResult>

pause(string, OperationOptions)

暫停通話錄製。

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

參數

recordingId

string

與錄製相關聯的 recordingId。

options

OperationOptions

其他要求選項包含 pauseRecording API 選項。

傳回

Promise<void>

resume(string, OperationOptions)

繼續通話錄製。

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

參數

recordingId

string

與錄製相關聯的 recordingId。

options

OperationOptions

其他要求選項包含 resumeRecording API 選項。

傳回

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

與錄製相關聯的 recordingId。

options

OperationOptions

其他要求選項包含 stopRecording API 選項。

傳回

Promise<void>