CommonCallAdapter interface

套件:

@azure/communication-react

CallComposite Adapter 介面。

Extends

AdapterState<CallAdapterState>,Disposable,CallAdapterCallOperations,CallAdapterDeviceManagement,CallAdapterSubscribers

方法

joinCall(boolean)	使用麥克風一開始開啟/關閉來加入通話。
startCall(string[], StartCallOptions)	啟動呼叫。

繼承的方法

askDevicePermission(PermissionConstraints)	要求裝置的許可權。
createStreamView(string, VideoStreamOptions)	建立數據流的 HTML 檢視。
dispose()	處置複合
disposeStreamView(string, VideoStreamOptions)	處置數據流的 HTML 檢視。
getState()	取得目前狀態
leaveCall(boolean)	離開通話
mute()	在通話期間將目前的用戶靜音，或在本機停用麥克風
off("callEnded", CallEndedListener)	'callEnded' 事件的取消訂閱函式。
off("callIdChanged", CallIdChangedListener)	'callIdChanged' 事件的取消訂閱函式。
off("diagnosticChanged", DiagnosticChangedEventListner)	'diagnosticChanged' 事件的取消訂閱函式。
off("displayNameChanged", DisplayNameChangedListener)	'displayNameChanged' 事件的取消訂閱函式。
off("error", (e: AdapterError) => void)	取消訂閱 『error』 事件的函式。
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	'isLocalScreenSharingActiveChanged' 事件的取消訂閱函式。
off("isMutedChanged", IsMutedChangedListener)	'isMutedChanged' 事件的取消訂閱函式。
off("isSpeakingChanged", IsSpeakingChangedListener)	'isSpeakingChanged' 事件的取消訂閱函式。
off("participantsJoined", ParticipantsJoinedListener)	'participantsJoined' 事件的取消訂閱函式。
off("participantsLeft", ParticipantsLeftListener)	'participantsLeft' 事件的取消訂閱函式。
off("selectedMicrophoneChanged", PropertyChangedEvent)	取消訂閱 『selectedMicrophoneChanged』 事件的函式。
off("selectedSpeakerChanged", PropertyChangedEvent)	'selectedSpeakerChanged' 事件的取消訂閱函式。
offStateChange((state: CallAdapterState) => void)	將處理程式取消訂閱至 stateChanged 事件。
on("callEnded", CallEndedListener)	'callEnded' 事件的 Subscribe 函式。
on("callIdChanged", CallIdChangedListener)	'callIdChanged' 事件的 Subscribe 函式。
on("diagnosticChanged", DiagnosticChangedEventListner)	'diagnosticChanged' 事件的訂閱函式。 每當使用者面臨有關進行中呼叫的診斷變更時，就會引發此事件。
on("displayNameChanged", DisplayNameChangedListener)	'displayNameChanged' 事件的 Subscribe 函式。
on("error", (e: AdapterError) => void)	'error' 事件的訂閱函式。
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	'isLocalScreenSharingActiveChanged' 事件的訂閱函式。
on("isMutedChanged", IsMutedChangedListener)	'isMutedChanged' 事件的訂閱函式。
on("isSpeakingChanged", IsSpeakingChangedListener)	'isSpeakingChanged' 事件的 Subscribe 函式。
on("participantsJoined", ParticipantsJoinedListener)	'participantsJoined' 事件的訂閱函式。
on("participantsLeft", ParticipantsLeftListener)	'participantsLeft' 事件的訂閱函式。
on("selectedMicrophoneChanged", PropertyChangedEvent)	'selectedMicrophoneChanged' 事件的訂閱函式。 每當用戶選取新的麥克風裝置時，就會引發此事件。
on("selectedSpeakerChanged", PropertyChangedEvent)	'selectedSpeakerChanged' 事件的訂閱函式。 每當用戶選取新的喇叭裝置時，就會引發此事件。
onStateChange((state: CallAdapterState) => void)	訂閱處理程式至 stateChanged 事件。
queryCameras()	查詢可用的相機裝置。
queryMicrophones()	查詢可用的麥克風裝置。
querySpeakers()	查詢可用的麥克風裝置。
removeParticipant(string)	從通話中移除參與者。
setCamera(VideoDeviceInfo, VideoStreamOptions)	設定要用於呼叫中的相機。
setMicrophone(AudioDeviceInfo)	將麥克風設定為在通話中使用。
setSpeaker(AudioDeviceInfo)	將說話者設定為在通話中使用。
startCamera(VideoStreamOptions)	啟動相機 此方法會在呼叫未使用時開始轉譯本機相機檢視
startScreenShare()	開始在通話期間共享畫面。
stopCamera()	停止相機 此方法會在呼叫未使用時停止轉譯本機相機檢視
stopScreenShare()	停止共享畫面
unmute()	在通話期間取消靜音目前的使用者，或在本機啟用麥克風

方法詳細資料

joinCall(boolean)

使用麥克風一開始開啟/關閉來加入通話。

function joinCall(microphoneOn?: boolean)

參數

microphoneOn

boolean

是否一開始啟用麥克風

startCall(string[], StartCallOptions)

啟動呼叫。

function startCall(participants: string[], options?: StartCallOptions)

參數

participants

string[]

要加入的參與者標識碼陣列

options

StartCallOptions

繼承的方法的詳細資料

askDevicePermission(PermissionConstraints)

要求裝置的許可權。

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

參數

constrain

PermissionConstraints

定義存取本機裝置的條件約束 <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

傳回

Promise<void>

備註

如果尚未授與許可權，瀏覽器許可權視窗將會快顯

繼承自CallAdapterDeviceManagement.askDevicePermission

createStreamView(string, VideoStreamOptions)

建立數據流的 HTML 檢視。

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

參數

remoteUserId

string

要轉譯的參與者標識碼，讓它保持未定義以建立本機相機檢視

options

VideoStreamOptions

控制影片串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

傳回

Promise<void | CreateVideoStreamViewResult>

備註

這個方法已針對複合實作

繼承自CallAdapterCallOperations.createStreamView

dispose()

處置複合

function dispose()

繼承自Dispos.dispose

disposeStreamView(string, VideoStreamOptions)

處置數據流的 HTML 檢視。

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

參數

remoteUserId

string

要轉譯的參與者標識碼，讓它保持未定義以處置本機相機檢視

options

VideoStreamOptions

控制影片串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

傳回

Promise<void>

備註

這個方法已針對複合實作

繼承自CallAdapterCallOperations.disposeStreamView

getState()

取得目前狀態

function getState(): CallAdapterState

傳回

CallAdapterState

繼承自AdapterState.getState

leaveCall(boolean)

離開通話

function leaveCall(forEveryone?: boolean): Promise<void>

參數

forEveryone

boolean

是否要在離開時移除所有參與者

傳回

Promise<void>

繼承自CallAdapterCallOperations.leaveCall

mute()

在通話期間將目前的用戶靜音，或在本機停用麥克風

function mute(): Promise<void>

傳回

Promise<void>

繼承自CallAdapterCallOperations.mute

off("callEnded", CallEndedListener)

'callEnded' 事件的取消訂閱函式。

function off(event: "callEnded", listener: CallEndedListener)

參數

event

"callEnded"

listener

CallEndedListener

繼承自CallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

'callIdChanged' 事件的取消訂閱函式。

function off(event: "callIdChanged", listener: CallIdChangedListener)

參數

event

"callIdChanged"

listener

CallIdChangedListener

繼承自CallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

'diagnosticChanged' 事件的取消訂閱函式。

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

參數

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

繼承自CallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

'displayNameChanged' 事件的取消訂閱函式。

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

參數

event

"displayNameChanged"

listener

DisplayNameChangedListener

繼承自CallAdapterSubscribers.off

off("error", (e: AdapterError) => void)

取消訂閱 『error』 事件的函式。

function off(event: "error", listener: (e: AdapterError) => void)

參數

event

"error"

listener

(e: AdapterError) => void

繼承自CallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

'isLocalScreenSharingActiveChanged' 事件的取消訂閱函式。

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

參數

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

繼承自CallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

'isMutedChanged' 事件的取消訂閱函式。

function off(event: "isMutedChanged", listener: IsMutedChangedListener)

參數

event

"isMutedChanged"

listener

IsMutedChangedListener

繼承自CallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

'isSpeakingChanged' 事件的取消訂閱函式。

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

參數

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

繼承自CallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

'participantsJoined' 事件的取消訂閱函式。

function off(event: "participantsJoined", listener: ParticipantsJoinedListener)

參數

event

"participantsJoined"

listener

ParticipantsJoinedListener

繼承自CallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

'participantsLeft' 事件的取消訂閱函式。

function off(event: "participantsLeft", listener: ParticipantsLeftListener)

參數

event

"participantsLeft"

listener

ParticipantsLeftListener

繼承自CallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

取消訂閱 『selectedMicrophoneChanged』 事件的函式。

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

參數

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

繼承自CallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

'selectedSpeakerChanged' 事件的取消訂閱函式。

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

參數

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

繼承自CallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

將處理程式取消訂閱至 stateChanged 事件。

function offStateChange(handler: (state: CallAdapterState) => void)

參數

handler

(state: CallAdapterState) => void

繼承自AdapterState.offStateChange

on("callEnded", CallEndedListener)

'callEnded' 事件的 Subscribe 函式。

function on(event: "callEnded", listener: CallEndedListener)

參數

event

"callEnded"

listener

CallEndedListener

繼承自CallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

'callIdChanged' 事件的 Subscribe 函式。

function on(event: "callIdChanged", listener: CallIdChangedListener)

參數

event

"callIdChanged"

listener

CallIdChangedListener

備註

當目前使用者的 callId 變更時，將會觸發事件。

繼承自CallAdapterSubscribers.on

on("diagnosticChanged", DiagnosticChangedEventListner)

'diagnosticChanged' 事件的訂閱函式。

每當使用者面臨有關進行中呼叫的診斷變更時，就會引發此事件。

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

參數

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

繼承自CallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

'displayNameChanged' 事件的 Subscribe 函式。

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

參數

event

"displayNameChanged"

listener

DisplayNameChangedListener

繼承自CallAdapterSubscribers.on

on("error", (e: AdapterError) => void)

'error' 事件的訂閱函式。

function on(event: "error", listener: (e: AdapterError) => void)

參數

event

"error"

listener

(e: AdapterError) => void

繼承自CallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

'isLocalScreenSharingActiveChanged' 事件的訂閱函式。

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

參數

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

繼承自CallAdapterSubscribers.on

on("isMutedChanged", IsMutedChangedListener)

'isMutedChanged' 事件的訂閱函式。

function on(event: "isMutedChanged", listener: IsMutedChangedListener)

參數

event

"isMutedChanged"

listener

IsMutedChangedListener

備註

每當目前的使用者或遠端使用者靜音狀態變更時，就會觸發事件

繼承自CallAdapterSubscribers.on

on("isSpeakingChanged", IsSpeakingChangedListener)

'isSpeakingChanged' 事件的 Subscribe 函式。

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

參數

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

繼承自CallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

'participantsJoined' 事件的訂閱函式。

function on(event: "participantsJoined", listener: ParticipantsJoinedListener)

參數

event

"participantsJoined"

listener

ParticipantsJoinedListener

繼承自CallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

'participantsLeft' 事件的訂閱函式。

function on(event: "participantsLeft", listener: ParticipantsLeftListener)

參數

event

"participantsLeft"

listener

ParticipantsLeftListener

繼承自CallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

'selectedMicrophoneChanged' 事件的訂閱函式。

每當用戶選取新的麥克風裝置時，就會引發此事件。

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

參數

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

繼承自CallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

'selectedSpeakerChanged' 事件的訂閱函式。

每當用戶選取新的喇叭裝置時，就會引發此事件。

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

參數

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

繼承自CallAdapterSubscribers.on

onStateChange((state: CallAdapterState) => void)

訂閱處理程式至 stateChanged 事件。

function onStateChange(handler: (state: CallAdapterState) => void)

參數

handler

(state: CallAdapterState) => void

繼承自AdapterState.onStateChange

queryCameras()

查詢可用的相機裝置。

function queryCameras(): Promise<VideoDeviceInfo[]>

傳回

Promise<VideoDeviceInfo[]>

視訊裝置資訊實體陣列 <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

備註

這個方法應在 askDevicePermission（） 之後呼叫

繼承自CallAdapterDeviceManagement.queryCameras

queryMicrophones()

查詢可用的麥克風裝置。

function queryMicrophones(): Promise<AudioDeviceInfo[]>

傳回

Promise<AudioDeviceInfo[]>

音訊裝置資訊實體陣列 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

備註

這個方法應在 askDevicePermission（） 之後呼叫

繼承自CallAdapterDeviceManagement.queryMicrophones

querySpeakers()

查詢可用的麥克風裝置。

function querySpeakers(): Promise<AudioDeviceInfo[]>

傳回

Promise<AudioDeviceInfo[]>

音訊裝置資訊實體陣列 <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

備註

這個方法應在 askDevicePermission（） 之後呼叫

繼承自CallAdapterDeviceManagement.querySpeakers

removeParticipant(string)

從通話中移除參與者。

function removeParticipant(userId: string): Promise<void>

參數

userId

string

要移除之參與者的標識碼

傳回

Promise<void>

繼承自CallAdapterCallOperations.removeParticipant

setCamera(VideoDeviceInfo, VideoStreamOptions)

設定要用於呼叫中的相機。

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

參數

sourceInfo

VideoDeviceInfo

要選擇的相機裝置，挑選 查詢Cameras 傳回的相機裝置

options

VideoStreamOptions

控制相機串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

傳回

Promise<void>

繼承自CallAdapterDeviceManagement.setCamera

setMicrophone(AudioDeviceInfo)

將麥克風設定為在通話中使用。

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

參數

sourceInfo

AudioDeviceInfo

要選擇的麥克風裝置，挑選由 queryMicrophones 傳回的麥克風裝置

傳回

Promise<void>

繼承自CallAdapterDeviceManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

將說話者設定為在通話中使用。

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

參數

sourceInfo

AudioDeviceInfo

要選擇的喇叭裝置，挑選 querySpeakers 所傳回的裝置

傳回

Promise<void>

繼承自CallAdapterDeviceManagement.setSpeaker

startCamera(VideoStreamOptions)

啟動相機 此方法會在呼叫未使用時開始轉譯本機相機檢視

function startCamera(options?: VideoStreamOptions): Promise<void>

參數

options

VideoStreamOptions

控制影片串流轉譯方式的選項 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

傳回

Promise<void>

繼承自CallAdapterCallOperations.startCamera

startScreenShare()

開始在通話期間共享畫面。

function startScreenShare(): Promise<void>

傳回

Promise<void>

繼承自CallAdapterCallOperations.startScreenShare

stopCamera()

停止相機 此方法會在呼叫未使用時停止轉譯本機相機檢視

function stopCamera(): Promise<void>

傳回

Promise<void>

繼承自CallAdapterCallOperations.stopCamera

stopScreenShare()

停止共享畫面

function stopScreenShare(): Promise<void>

傳回

Promise<void>

繼承自CallAdapterCallOperations.stopScreenShare

unmute()

在通話期間取消靜音目前的使用者，或在本機啟用麥克風

function unmute(): Promise<void>

傳回

Promise<void>

繼承自CallAdapterCallOperations.unmute