CommonCallAdapter interface
CallComposite Antarmuka adapter.
- Extends
Metode
| join |
Gabungkan panggilan dengan mikrofon yang awalnya aktif/nonaktif. |
| start |
Mulai panggilan. |
Metode yang Diwarisi
| ask |
Minta izin perangkat. |
| create |
Membuat tampilan html untuk aliran. |
| dispose() | Buang Komposit |
| dispose |
Buang tampilan html untuk aliran. |
| get |
Dapatkan Status saat ini |
| leave |
Tinggalkan panggilan |
| mute() | Mematikan suara pengguna saat ini selama panggilan atau menonaktifkan mikrofon secara lokal |
| off("call |
Berhenti berlangganan fungsi untuk peristiwa 'callEnded'. |
| off("call |
Berhenti berlangganan fungsi untuk peristiwa 'callIdChanged'. |
| off("diagnostic |
Berhenti berlangganan fungsi untuk peristiwa 'diagnosticChanged'. |
| off("display |
Berhenti berlangganan fungsi untuk peristiwa 'displayNameChanged'. |
| off("error", (e: Adapter |
Berhenti berlangganan fungsi untuk peristiwa 'kesalahan'. |
| off("is |
Berhenti berlangganan fungsi untuk peristiwa 'isLocalScreenSharingActiveChanged'. |
| off("is |
Berhenti berlangganan fungsi untuk peristiwa 'isMutedChanged'. |
| off("is |
Berhenti berlangganan fungsi untuk peristiwa 'isSpeakingChanged'. |
| off("participants |
Berhenti berlangganan fungsi untuk acara 'participantsJoined'. |
| off("participants |
Berhenti berlangganan fungsi untuk peristiwa 'participantsLeft'. |
| off("selected |
Berhenti berlangganan fungsi untuk peristiwa 'selectedMicrophoneChanged'. |
| off("selected |
Berhenti berlangganan fungsi untuk peristiwa 'selectedSpeakerChanged'. |
| off |
Berhenti berlangganan handler ke peristiwa stateChanged. |
| on("call |
Berlangganan fungsi untuk peristiwa 'callEnded'. |
| on("call |
Berlangganan fungsi untuk peristiwa 'callIdChanged'. |
| on("diagnostic |
Berlangganan fungsi untuk peristiwa 'diagnosticChanged'. Peristiwa ini diaktifkan setiap kali ada perubahan dalam diagnostik yang dihadapi pengguna tentang panggilan yang sedang berlangsung. |
| on("display |
Berlangganan fungsi untuk peristiwa 'displayNameChanged'. |
| on("error", (e: Adapter |
Berlangganan fungsi untuk peristiwa 'kesalahan'. |
| on("is |
Berlangganan fungsi untuk peristiwa 'isLocalScreenSharingActiveChanged'. |
| on("is |
Berlangganan fungsi untuk peristiwa 'isMutedChanged'. |
| on("is |
Berlangganan fungsi untuk peristiwa 'isSpeakingChanged'. |
| on("participants |
Berlangganan fungsi untuk acara 'participantsJoined'. |
| on("participants |
Berlangganan fungsi untuk peristiwa 'participantsLeft'. |
| on("selected |
Berlangganan fungsi untuk peristiwa 'selectedMicrophoneChanged'. Kejadian ini diaktifkan setiap kali pengguna memilih perangkat mikrofon baru. |
| on("selected |
Berlangganan fungsi untuk peristiwa 'selectedSpeakerChanged'. Kejadian ini diaktifkan setiap kali pengguna memilih perangkat speaker baru. |
| on |
Berlangganan handler ke peristiwa stateChanged. |
| query |
Kueri untuk perangkat kamera yang tersedia. |
| query |
Kueri untuk perangkat mikrofon yang tersedia. |
| query |
Kueri untuk perangkat mikrofon yang tersedia. |
| remove |
Menghapus peserta dari panggilan. |
| set |
Atur kamera yang akan digunakan dalam panggilan. |
| set |
Atur mikrofon yang akan digunakan dalam panggilan. |
| set |
Atur speaker untuk digunakan dalam panggilan. |
| start |
Mulai kamera Metode ini akan mulai merender tampilan kamera lokal saat panggilan tidak aktif |
| start |
Mulai berbagi layar selama panggilan. |
| stop |
Hentikan kamera Metode ini akan berhenti merender tampilan kamera lokal saat panggilan tidak aktif |
| stop |
Berhenti berbagi layar |
| unmute() | Nyalakan suara pengguna saat ini selama panggilan atau aktifkan mikrofon secara lokal |
Detail Metode
joinCall(boolean)
Gabungkan panggilan dengan mikrofon yang awalnya aktif/nonaktif.
function joinCall(microphoneOn?: boolean)Parameter
- microphoneOn
-
boolean
Apakah mikrofon awalnya diaktifkan
startCall(string[], StartCallOptions)
Mulai panggilan.
function startCall(participants: string[], options?: StartCallOptions)Parameter
- participants
-
string[]
Array id peserta untuk bergabung
- options
- StartCallOptions
Detail Metode yang Diwarisi
askDevicePermission(PermissionConstraints)
Minta izin perangkat.
function askDevicePermission(constrain: PermissionConstraints): Promise<void>Parameter
- constrain
- PermissionConstraints
Menentukan batasan untuk mengakses perangkat lokal <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Mengembalikan
Promise<void>
Keterangan
Jendela izin browser akan muncul jika izin belum diberikan
Diwarisi DariCallAdapterDeviceManagement.askDevicePermission
createStreamView(string, VideoStreamOptions)
Membuat tampilan html untuk aliran.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>Parameter
- remoteUserId
-
string
Id peserta yang akan dirender, biarkan tidak terdefinis untuk membuat tampilan kamera lokal
- options
- VideoStreamOptions
Opsi untuk mengontrol cara streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Mengembalikan
Promise<void | CreateVideoStreamViewResult>
Keterangan
Metode ini diimplementasikan untuk komposit
Diwarisi DariCallAdapterCallOperations.createStreamView
dispose()
disposeStreamView(string, VideoStreamOptions)
Buang tampilan html untuk aliran.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>Parameter
- remoteUserId
-
string
Id peserta yang akan dirender, biarkan tidak terdefinisi untuk membuang tampilan kamera lokal
- options
- VideoStreamOptions
Opsi untuk mengontrol cara streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Mengembalikan
Promise<void>
Keterangan
Metode ini diimplementasikan untuk komposit
Diwarisi DariCallAdapterCallOperations.disposeStreamView
getState()
Dapatkan Status saat ini
function getState(): CallAdapterStateMengembalikan
Diwarisi DariAdapterState.getState
leaveCall(boolean)
Tinggalkan panggilan
function leaveCall(forEveryone?: boolean): Promise<void>Parameter
- forEveryone
-
boolean
Apakah akan menghapus semua peserta saat keluar
Mengembalikan
Promise<void>
Diwarisi DariCallAdapterCallOperations.leaveCall
mute()
Mematikan suara pengguna saat ini selama panggilan atau menonaktifkan mikrofon secara lokal
function mute(): Promise<void>Mengembalikan
Promise<void>
Diwarisi DariCallAdapterCallOperations.mute
off("callEnded", CallEndedListener)
Berhenti berlangganan fungsi untuk peristiwa 'callEnded'.
function off(event: "callEnded", listener: CallEndedListener)Parameter
- event
-
"callEnded"
- listener
- CallEndedListener
Diwarisi DariCallAdapterSubscribers.off
off("callIdChanged", CallIdChangedListener)
Berhenti berlangganan fungsi untuk peristiwa 'callIdChanged'.
function off(event: "callIdChanged", listener: CallIdChangedListener)Parameter
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Diwarisi DariCallAdapterSubscribers.off
off("diagnosticChanged", DiagnosticChangedEventListner)
Berhenti berlangganan fungsi untuk peristiwa 'diagnosticChanged'.
function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)Parameter
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
Diwarisi DariCallAdapterSubscribers.off
off("displayNameChanged", DisplayNameChangedListener)
Berhenti berlangganan fungsi untuk peristiwa 'displayNameChanged'.
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)Parameter
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Diwarisi DariCallAdapterSubscribers.off
off("error", (e: AdapterError) => void)
Berhenti berlangganan fungsi untuk peristiwa 'kesalahan'.
function off(event: "error", listener: (e: AdapterError) => void)Parameter
- event
-
"error"
- listener
-
(e: AdapterError) => void
Diwarisi DariCallAdapterSubscribers.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
Berhenti berlangganan fungsi untuk peristiwa 'isLocalScreenSharingActiveChanged'.
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)Parameter
- event
-
"isLocalScreenSharingActiveChanged"
Diwarisi DariCallAdapterSubscribers.off
off("isMutedChanged", IsMutedChangedListener)
Berhenti berlangganan fungsi untuk peristiwa 'isMutedChanged'.
function off(event: "isMutedChanged", listener: IsMutedChangedListener)Parameter
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Diwarisi DariCallAdapterSubscribers.off
off("isSpeakingChanged", IsSpeakingChangedListener)
Berhenti berlangganan fungsi untuk peristiwa 'isSpeakingChanged'.
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)Parameter
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Diwarisi DariCallAdapterSubscribers.off
off("participantsJoined", ParticipantsJoinedListener)
Berhenti berlangganan fungsi untuk acara 'participantsJoined'.
function off(event: "participantsJoined", listener: ParticipantsJoinedListener)Parameter
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
Diwarisi DariCallAdapterSubscribers.off
off("participantsLeft", ParticipantsLeftListener)
Berhenti berlangganan fungsi untuk peristiwa 'participantsLeft'.
function off(event: "participantsLeft", listener: ParticipantsLeftListener)Parameter
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
Diwarisi DariCallAdapterSubscribers.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
Berhenti berlangganan fungsi untuk peristiwa 'selectedMicrophoneChanged'.
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)Parameter
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Diwarisi DariCallAdapterSubscribers.off
off("selectedSpeakerChanged", PropertyChangedEvent)
Berhenti berlangganan fungsi untuk peristiwa 'selectedSpeakerChanged'.
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)Parameter
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Diwarisi DariCallAdapterSubscribers.off
offStateChange((state: CallAdapterState) => void)
Berhenti berlangganan handler ke peristiwa stateChanged.
function offStateChange(handler: (state: CallAdapterState) => void)Parameter
- handler
-
(state: CallAdapterState) => void
Diwarisi DariAdapterState.offStateChange
on("callEnded", CallEndedListener)
Berlangganan fungsi untuk peristiwa 'callEnded'.
function on(event: "callEnded", listener: CallEndedListener)Parameter
- event
-
"callEnded"
- listener
- CallEndedListener
Diwarisi DariCallAdapterSubscribers.on
on("callIdChanged", CallIdChangedListener)
Berlangganan fungsi untuk peristiwa 'callIdChanged'.
function on(event: "callIdChanged", listener: CallIdChangedListener)Parameter
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Keterangan
Peristiwa akan dipicu ketika callId pengguna saat ini berubah.
Diwarisi DariCallAdapterSubscribers.on
on("diagnosticChanged", DiagnosticChangedEventListner)
Berlangganan fungsi untuk peristiwa 'diagnosticChanged'.
Peristiwa ini diaktifkan setiap kali ada perubahan dalam diagnostik yang dihadapi pengguna tentang panggilan yang sedang berlangsung.
function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)Parameter
- event
-
"diagnosticChanged"
- listener
- DiagnosticChangedEventListner
Diwarisi DariCallAdapterSubscribers.on
on("displayNameChanged", DisplayNameChangedListener)
Berlangganan fungsi untuk peristiwa 'displayNameChanged'.
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)Parameter
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Diwarisi DariCallAdapterSubscribers.on
on("error", (e: AdapterError) => void)
Berlangganan fungsi untuk peristiwa 'kesalahan'.
function on(event: "error", listener: (e: AdapterError) => void)Parameter
- event
-
"error"
- listener
-
(e: AdapterError) => void
Diwarisi DariCallAdapterSubscribers.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
Berlangganan fungsi untuk peristiwa 'isLocalScreenSharingActiveChanged'.
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)Parameter
- event
-
"isLocalScreenSharingActiveChanged"
Diwarisi DariCallAdapterSubscribers.on
on("isMutedChanged", IsMutedChangedListener)
Berlangganan fungsi untuk peristiwa 'isMutedChanged'.
function on(event: "isMutedChanged", listener: IsMutedChangedListener)Parameter
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Keterangan
Peristiwa akan dipicu setiap kali status bisukan pengguna atau pengguna jarak jauh saat ini berubah
Diwarisi DariCallAdapterSubscribers.on
on("isSpeakingChanged", IsSpeakingChangedListener)
Berlangganan fungsi untuk peristiwa 'isSpeakingChanged'.
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)Parameter
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Diwarisi DariCallAdapterSubscribers.on
on("participantsJoined", ParticipantsJoinedListener)
Berlangganan fungsi untuk acara 'participantsJoined'.
function on(event: "participantsJoined", listener: ParticipantsJoinedListener)Parameter
- event
-
"participantsJoined"
- listener
- ParticipantsJoinedListener
Diwarisi DariCallAdapterSubscribers.on
on("participantsLeft", ParticipantsLeftListener)
Berlangganan fungsi untuk peristiwa 'participantsLeft'.
function on(event: "participantsLeft", listener: ParticipantsLeftListener)Parameter
- event
-
"participantsLeft"
- listener
- ParticipantsLeftListener
Diwarisi DariCallAdapterSubscribers.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
Berlangganan fungsi untuk peristiwa 'selectedMicrophoneChanged'.
Kejadian ini diaktifkan setiap kali pengguna memilih perangkat mikrofon baru.
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)Parameter
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Diwarisi DariCallAdapterSubscribers.on
on("selectedSpeakerChanged", PropertyChangedEvent)
Berlangganan fungsi untuk peristiwa 'selectedSpeakerChanged'.
Kejadian ini diaktifkan setiap kali pengguna memilih perangkat speaker baru.
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)Parameter
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Diwarisi DariCallAdapterSubscribers.on
onStateChange((state: CallAdapterState) => void)
Berlangganan handler ke peristiwa stateChanged.
function onStateChange(handler: (state: CallAdapterState) => void)Parameter
- handler
-
(state: CallAdapterState) => void
Diwarisi DariAdapterState.onStateChange
queryCameras()
Kueri untuk perangkat kamera yang tersedia.
function queryCameras(): Promise<VideoDeviceInfo[]>Mengembalikan
Promise<VideoDeviceInfo[]>
Array entitas informasi perangkat video <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Keterangan
Metode ini harus dipanggil setelah askDevicePermission()
Diwarisi DariCallAdapterDeviceManagement.queryCameras
queryMicrophones()
Kueri untuk perangkat mikrofon yang tersedia.
function queryMicrophones(): Promise<AudioDeviceInfo[]>Mengembalikan
Promise<AudioDeviceInfo[]>
Array entitas informasi perangkat audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Keterangan
Metode ini harus dipanggil setelah askDevicePermission()
Diwarisi DariCallAdapterDeviceManagement.queryMicrophones
querySpeakers()
Kueri untuk perangkat mikrofon yang tersedia.
function querySpeakers(): Promise<AudioDeviceInfo[]>Mengembalikan
Promise<AudioDeviceInfo[]>
Array entitas informasi perangkat audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Keterangan
Metode ini harus dipanggil setelah askDevicePermission()
Diwarisi DariCallAdapterDeviceManagement.querySpeakers
removeParticipant(string)
Menghapus peserta dari panggilan.
function removeParticipant(userId: string): Promise<void>Parameter
- userId
-
string
Id peserta yang akan dihapus
Mengembalikan
Promise<void>
Diwarisi DariCallAdapterCallOperations.removeParticipant
setCamera(VideoDeviceInfo, VideoStreamOptions)
Atur kamera yang akan digunakan dalam panggilan.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>Parameter
- sourceInfo
- VideoDeviceInfo
Perangkat kamera untuk dipilih, pilih satu yang dikembalikan oleh queryCameras
- options
- VideoStreamOptions
Opsi untuk mengontrol bagaimana aliran kamera dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Mengembalikan
Promise<void>
Diwarisi DariCallAdapterDeviceManagement.setCamera
setMicrophone(AudioDeviceInfo)
Atur mikrofon yang akan digunakan dalam panggilan.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>Parameter
- sourceInfo
- AudioDeviceInfo
Perangkat mikrofon untuk dipilih, pilih satu yang dikembalikan oleh kueriMicrophones
Mengembalikan
Promise<void>
Diwarisi DariCallAdapterDeviceManagement.setMicrophone
setSpeaker(AudioDeviceInfo)
Atur speaker untuk digunakan dalam panggilan.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>Parameter
- sourceInfo
- AudioDeviceInfo
Perangkat speaker untuk dipilih, pilih satu yang dikembalikan oleh querySpeakers
Mengembalikan
Promise<void>
Diwarisi DariCallAdapterDeviceManagement.setSpeaker
startCamera(VideoStreamOptions)
Mulai kamera Metode ini akan mulai merender tampilan kamera lokal saat panggilan tidak aktif
function startCamera(options?: VideoStreamOptions): Promise<void>Parameter
- options
- VideoStreamOptions
Opsi untuk mengontrol cara streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Mengembalikan
Promise<void>
Diwarisi DariCallAdapterCallOperations.startCamera
startScreenShare()
Mulai berbagi layar selama panggilan.
function startScreenShare(): Promise<void>Mengembalikan
Promise<void>
Diwarisi DariCallAdapterCallOperations.startScreenShare
stopCamera()
Hentikan kamera Metode ini akan berhenti merender tampilan kamera lokal saat panggilan tidak aktif
function stopCamera(): Promise<void>Mengembalikan
Promise<void>
Diwarisi DariCallAdapterCallOperations.stopCamera
stopScreenShare()
Berhenti berbagi layar
function stopScreenShare(): Promise<void>Mengembalikan
Promise<void>
Diwarisi DariCallAdapterCallOperations.stopScreenShare
unmute()
Nyalakan suara pengguna saat ini selama panggilan atau aktifkan mikrofon secara lokal
function unmute(): Promise<void>Mengembalikan
Promise<void>
Diwarisi DariCallAdapterCallOperations.unmute