Bagikan melalui


TeamsCallAdapter interface

Antarmuka Adaptor khusus untuk identitas Teams yang memperluas CommonCallAdapter.

Memperluas

Properti yang Diwariskan

sendRealTimeText

Kirim teks waktu nyata

Metode

joinCall(boolean)

Gabungkan panggilan dengan mikrofon awalnya aktif/mati.

joinCall(JoinCallOptions)

Bergabung dengan panggilan dengan tas opsi untuk mengatur status awal mikrofon/kamera saat bergabung dengan panggilan true = nyalakan perangkat saat bergabung dengan panggilan false = matikan perangkat saat bergabung dengan panggilan 'keep'/undefined = pertahankan perangkat' status prapanggilan

startCall(CommunicationIdentifier[], StartCallOptions)

Mulai panggilan.

startCall(string[], StartCallOptions)

Mulai panggilan.

Metode yang Diwarisi

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Tambahkan peserta ke panggilan.

askDevicePermission(PermissionConstraints)

Minta izin perangkat.

createStreamView(string, VideoStreamOptions)

Buat tampilan html untuk aliran.

createTogetherModeStreamView(TogetherModeStreamOptions)

Buat tampilan html untuk aliran.

dispose()

Buang Komposit

disposeLocalVideoStreamView()

Membuang tampilan html untuk streaming video lokal

disposeRemoteVideoStreamView(string)

Buang tampilan html untuk streaming video jarak jauh

disposeScreenShareStreamView(string)

Membuang tampilan html untuk aliran berbagi layar

disposeStreamView(string, VideoStreamOptions)

Buang tampilan html untuk aliran.

disposeTogetherModeStreamView()

Buang tampilan html untuk aliran.

forbidAudio(string[])

Melarang audio peserta rapat Teams dengan id pengguna mereka.

forbidOthersAudio()

Melarang audio rapat Teams.

forbidOthersVideo()

Melarang video rapat Teams.

forbidVideo(string[])

Melarang video peserta rapat Teams dengan id pengguna mereka.

getState()

Dapatkan Status saat ini

holdCall()

Menahan panggilan.

leaveCall(boolean)

Tinggalkan panggilan

lowerHand()

Lebih rendah tangan untuk pengguna saat ini

mute()

Mematikan suara pengguna saat ini selama panggilan atau menonaktifkan mikrofon secara lokal

muteAllRemoteParticipants()

Bisukan Semua peserta

muteParticipant(string)

Menonaktifkan peserta

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Fungsi berhenti berlangganan untuk acara 'breakoutRoomsUpdated'.

off("callEnded", CallEndedListener)

Berhenti berlangganan fungsi untuk peristiwa 'callEnded'.

off("callIdChanged", CallIdChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'callIdChanged'.

off("capabilitiesChanged", CapabilitiesChangedListener)

Berhenti berlangganan untuk peristiwa 'capabilitiesChanged'.

off("captionsReceived", CaptionsReceivedListener)

Fungsi berhenti berlangganan untuk acara 'captionsReceived'.

off("diagnosticChanged", DiagnosticChangedEventListner)

Berhenti berlangganan fungsi untuk peristiwa 'diagnosticChanged'.

off("displayNameChanged", DisplayNameChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'displayNameChanged'.

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

Berhenti berlangganan fungsi untuk peristiwa 'kesalahan'.

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Berhenti berlangganan untuk peristiwa 'isCaptionLanguageChanged'.

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Berhenti berlangganan untuk peristiwa 'isCaptionsActiveChanged'.

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'isLocalScreenSharingActiveChanged'.

off("isMutedChanged", IsMutedChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'isMutedChanged'.

off("isSpeakingChanged", IsSpeakingChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'isSpeakingChanged'.

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Berhenti berlangganan untuk peristiwa 'isSpokenLanguageChanged'.

off("mutedByOthers", PropertyChangedEvent)

Berhenti berlangganan untuk peristiwa 'mutedByOthers'.

off("participantsJoined", ParticipantsJoinedListener)

Berhenti berlangganan fungsi untuk acara 'pesertaGabung'.

off("participantsLeft", ParticipantsLeftListener)

Berhenti berlangganan fungsi untuk peristiwa 'participantsLeft'.

off("realTimeTextReceived", RealTimeTextReceivedListener)

Berhenti berlangganan untuk peristiwa 'realTimeTextReceived'.

off("roleChanged", PropertyChangedEvent)

Fungsi berhenti berlangganan untuk peristiwa 'roleChanged'.

off("selectedMicrophoneChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa 'selectedMicrophoneChanged'.

off("selectedSpeakerChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa 'selectedSpeakerChanged'.

off("spotlightChanged", SpotlightChangedListener)

Fungsi berhenti berlangganan untuk peristiwa 'spotlightChanged'.

off("transferAccepted", TransferAcceptedListener)

Fungsi berhenti berlangganan untuk peristiwa 'transferRequested'.

offStateChange((state: CallAdapterState) => void)

Berhenti berlangganan handler ke stateChanged events.

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Fungsi berlangganan untuk acara 'breakoutRoomsUpdated'.

on("callEnded", CallEndedListener)

Berlangganan fungsi untuk peristiwa 'callEnded'.

on("callIdChanged", CallIdChangedListener)

Berlangganan fungsi untuk peristiwa 'callIdChanged'.

on("capabilitiesChanged", CapabilitiesChangedListener)

Berlangganan untuk peristiwa 'capabilitiesChanged'.

on("captionsReceived", CaptionsReceivedListener)

Fungsi berlangganan untuk acara 'captionsReceived'.

on("diagnosticChanged", DiagnosticChangedEventListner)

Berlangganan fungsi untuk peristiwa 'diagnosticChanged'.

Peristiwa ini diaktifkan setiap kali ada perubahan pada diagnostik yang dihadapi pengguna tentang panggilan yang sedang berlangsung.

on("displayNameChanged", DisplayNameChangedListener)

Berlangganan fungsi untuk peristiwa 'displayNameChanged'.

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

Berlangganan fungsi untuk peristiwa 'kesalahan'.

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Fungsi berlangganan untuk peristiwa 'isCaptionLanguageChanged'.

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Fungsi berlangganan untuk peristiwa 'isCaptionsActiveChanged'.

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Berlangganan fungsi untuk peristiwa 'isLocalScreenSharingActiveChanged'.

on("isMutedChanged", IsMutedChangedListener)

Berlangganan fungsi untuk peristiwa 'isMutedChanged'.

on("isSpeakingChanged", IsSpeakingChangedListener)

Berlangganan fungsi untuk peristiwa 'isSpeakingChanged'.

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Fungsi berlangganan untuk peristiwa 'isSpokenLanguageChanged'.

on("mutedByOthers", PropertyChangedEvent)

Fungsi berlangganan untuk peristiwa 'mutedByOthers'.

on("participantsJoined", ParticipantsJoinedListener)

Berlangganan fungsi untuk acara 'pesertaJoined'.

on("participantsLeft", ParticipantsLeftListener)

Berlangganan fungsi untuk peristiwa 'pesertaLeft'.

on("realTimeTextReceived", RealTimeTextReceivedListener)

Berlangganan untuk peristiwa 'realTimeTextReceived'.

on("roleChanged", PropertyChangedEvent)

Berlangganan untuk peristiwa 'roleChanged'.

on("selectedMicrophoneChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa 'selectedMicrophoneChanged'.

Kejadian ini diaktifkan setiap kali pengguna memilih perangkat mikrofon baru.

on("selectedSpeakerChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa 'selectedSpeakerChanged'.

Kejadian ini diaktifkan setiap kali pengguna memilih perangkat speaker baru.

on("spotlightChanged", SpotlightChangedListener)

Berlangganan untuk acara 'spotlightChanged'.

on("transferAccepted", TransferAcceptedListener)

Fungsi berlangganan untuk peristiwa 'transferRequested'.

onReactionClick(Reaction)

Kirim emoji reaksi

onStateChange((state: CallAdapterState) => void)

Berlangganan handler ke peristiwa stateChanged.

permitAudio(string[])

Izinkan audio peserta rapat Teams dengan id pengguna mereka.

permitOthersAudio()

Izinkan audio rapat Teams.

permitOthersVideo()

Izinkan video rapat Teams.

permitVideo(string[])

Izinkan audio peserta rapat Teams dengan id pengguna mereka.

queryCameras()

Kueri untuk perangkat kamera yang tersedia.

queryMicrophones()

Kueri untuk perangkat mikrofon yang tersedia.

querySpeakers()

Kueri untuk perangkat speaker yang tersedia.

raiseHand()

Angkat tangan untuk pengguna saat ini

removeParticipant(CommunicationIdentifier)

Hapus peserta dari panggilan.

removeParticipant(string)

Hapus peserta dari panggilan.

resumeCall()

Melanjutkan panggilan dari negara LocalHold bagian.

returnFromBreakoutRoom()

Kembali ke panggilan asal ruang kerja kelompok

sendDtmfTone(DtmfTone)

mengirim nada dtmf ke peserta lain dalam panggilan PSTN 1:1

setCamera(VideoDeviceInfo, VideoStreamOptions)

Atur kamera yang akan digunakan dalam panggilan.

setCaptionLanguage(string)

Fungsi untuk mengatur bahasa teks

setMicrophone(AudioDeviceInfo)

Atur mikrofon yang akan digunakan dalam panggilan.

setSpeaker(AudioDeviceInfo)

Atur speaker untuk digunakan dalam panggilan.

setSpokenLanguage(string)

Fungsi untuk mengatur bahasa lisan

setTogetherModeSceneSize(number, number)

Hitung ulang posisi tempat duduk untuk mode bersama.

startCamera(VideoStreamOptions)

Mulai kamera Metode ini akan mulai merender tampilan kamera lokal saat panggilan tidak aktif

startCaptions(StartCaptionsAdapterOptions)

Fungsi untuk Memulai teks

startNoiseSuppressionEffect()

Mulai efek peredam kebisingan.

startScreenShare()

Mulai berbagi layar selama panggilan.

startSpotlight(string[])

Mulai sorotan untuk peserta lokal dan jarak jauh dengan id pengguna mereka. Jika tidak ada array id pengguna yang diteruskan, tindakan dilakukan pada peserta lokal.

startTogetherMode()

Mulai mode Bersama.

startVideoBackgroundEffect(VideoBackgroundEffect)

Mulai efek latar belakang video.

stopAllSpotlight()

Hentikan semua lampu sorot

stopCamera()

Hentikan kamera Metode ini akan berhenti merender tampilan kamera lokal saat panggilan tidak aktif

stopCaptions(StopCaptionsAdapterOptions)

Fungsi untuk menghentikan teks

stopNoiseSuppressionEffect()

Hentikan efek peredam kebisingan.

stopScreenShare()

Berhenti berbagi layar

stopSpotlight(string[])

Hentikan sorotan untuk peserta lokal dan jarak jauh berdasarkan id pengguna mereka. Jika tidak ada array id pengguna yang diteruskan, tindakan dilakukan pada peserta lokal.

stopVideoBackgroundEffects()

Hentikan efek latar belakang video.

submitSurvey(CallSurvey)

Kirim hasil survei akhir panggilan

unmute()

Nyalakan suara pengguna saat ini selama panggilan atau aktifkan mikrofon secara lokal

updateBackgroundPickerImages(VideoBackgroundImage[])

Ganti gambar pemilih latar belakang untuk efek penggantian latar belakang.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Perbarui efek latar belakang video yang dipilih.

Detail Properti yang Diwariskan

sendRealTimeText

Kirim teks waktu nyata

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

Nilai Properti

(text: string, isFinalized: boolean) => Promise<void>

Diwarisi dariCommonCallAdapter.sendRealTimeText

Detail Metode

joinCall(boolean)

Peringatan

API ini sudah tidak digunakan lagi.

Use joinCall(options?:JoinCallOptions) instead.

Gabungkan panggilan dengan mikrofon awalnya aktif/mati.

function joinCall(microphoneOn?: boolean): undefined | TeamsCall

Parameter

microphoneOn

boolean

Apakah mikrofon awalnya diaktifkan

Mengembalikan

undefined | TeamsCall

joinCall(JoinCallOptions)

Bergabung dengan panggilan dengan tas opsi untuk mengatur status awal mikrofon/kamera saat bergabung dengan panggilan true = nyalakan perangkat saat bergabung dengan panggilan false = matikan perangkat saat bergabung dengan panggilan 'keep'/undefined = pertahankan perangkat' status prapanggilan

function joinCall(options?: JoinCallOptions): undefined | TeamsCall

Parameter

options
JoinCallOptions

parameter untuk mengatur mikrofon/kamera awalnya aktif/mati.

Mengembalikan

undefined | TeamsCall

startCall(CommunicationIdentifier[], StartCallOptions)

Mulai panggilan.

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): undefined | TeamsCall

Parameter

participants

CommunicationIdentifier[]

Array yang <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> akan dipanggil

Mengembalikan

undefined | TeamsCall

startCall(string[], StartCallOptions)

Mulai panggilan.

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

Parameter

participants

string[]

Array id peserta untuk bergabung

Mengembalikan

undefined | TeamsCall

Detail Metode yang Diwarisi

addParticipant(CommunicationUserIdentifier)

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

Parameter

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Tambahkan peserta ke panggilan.

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

Parameter

participant
PhoneNumberIdentifier

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.addParticipant

askDevicePermission(PermissionConstraints)

Minta izin perangkat.

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

Parameter

constrain
PermissionConstraints

Menentukan batasan untuk mengakses perangkat lokal <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Mengembalikan

Promise<DeviceAccess>

Keterangan

Jendela izin browser akan muncul jika izin belum diberikan

Diwarisi dariCommonCallAdapter.askDevicePermission

createStreamView(string, VideoStreamOptions)

Buat tampilan html untuk aliran.

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

Parameter

remoteUserId

string

Id peserta yang akan dirender, biarkan tidak ditentukan untuk membuat tampilan kamera lokal

options
VideoStreamOptions

Opsi untuk mengontrol bagaimana streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Mengembalikan

Promise<void | CreateVideoStreamViewResult>

Keterangan

Metode ini diimplementasikan untuk komposit

Diwarisi dariCommonCallAdapter.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Buat tampilan html untuk aliran.

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

Parameter

options
TogetherModeStreamOptions

Opsi untuk mengontrol bagaimana streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Mengembalikan

Keterangan

Metode ini diimplementasikan untuk komposit

Diwarisi dariCommonCallAdapter.createTogetherModeStreamView

dispose()

Buang Komposit

function dispose()

Diwarisi dariCommonCallAdapter.dispose

disposeLocalVideoStreamView()

Membuang tampilan html untuk streaming video lokal

function disposeLocalVideoStreamView(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Buang tampilan html untuk streaming video jarak jauh

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

Parameter

remoteUserId

string

ID peserta yang akan dibuang

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Membuang tampilan html untuk aliran berbagi layar

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

Parameter

remoteUserId

string

ID peserta untuk membuang tampilan streaming berbagi layar.

Mengembalikan

Promise<void>

Keterangan

Metode ini diterapkan untuk komposit

Diwarisi dariCommonCallAdapter.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Peringatan

API ini sudah tidak digunakan lagi.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

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 bagaimana streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Mengembalikan

Promise<void>

Keterangan

Metode ini diimplementasikan untuk komposit

Diwarisi dariCommonCallAdapter.disposeStreamView

disposeTogetherModeStreamView()

Buang tampilan html untuk aliran.

function disposeTogetherModeStreamView(): Promise<void>

Mengembalikan

Promise<void>

Keterangan

Metode ini diimplementasikan untuk komposit

Diwarisi dariCommonCallAdapter.disposeTogetherModeStreamView

forbidAudio(string[])

Melarang audio peserta rapat Teams dengan id pengguna mereka.

function forbidAudio(userIds: string[]): Promise<void>

Parameter

userIds

string[]

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.forbidAudio

forbidOthersAudio()

Melarang audio rapat Teams.

function forbidOthersAudio(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.forbidOthersAudio

forbidOthersVideo()

Melarang video rapat Teams.

function forbidOthersVideo(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.forbidOthersVideo

forbidVideo(string[])

Melarang video peserta rapat Teams dengan id pengguna mereka.

function forbidVideo(userIds: string[]): Promise<void>

Parameter

userIds

string[]

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.forbidVideo

getState()

Dapatkan Status saat ini

function getState(): CallAdapterState

Mengembalikan

Diwarisi dariCommonCallAdapter.getState

holdCall()

Menahan panggilan.

function holdCall(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.holdCall

leaveCall(boolean)

Tinggalkan panggilan

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

Parameter

forEveryone

boolean

Apakah akan menghapus semua peserta saat keluar

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.leaveCall

lowerHand()

Lebih rendah tangan untuk pengguna saat ini

function lowerHand(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.lowerHand

mute()

Mematikan suara pengguna saat ini selama panggilan atau menonaktifkan mikrofon secara lokal

function mute(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.mute

muteAllRemoteParticipants()

Bisukan Semua peserta

function muteAllRemoteParticipants(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.muteAllRemoteParticipants

muteParticipant(string)

Menonaktifkan peserta

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

Parameter

userId

string

ID peserta untuk membisukan

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Fungsi berhenti berlangganan untuk acara 'breakoutRoomsUpdated'.

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parameter

event

"breakoutRoomsUpdated"

Diwarisi dariCommonCallAdapter.off

off("callEnded", CallEndedListener)

Berhenti berlangganan fungsi untuk peristiwa 'callEnded'.

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

Parameter

event

"callEnded"

Diwarisi dariCommonCallAdapter.off

off("callIdChanged", CallIdChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'callIdChanged'.

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

Parameter

event

"callIdChanged"

Diwarisi dariCommonCallAdapter.off

off("capabilitiesChanged", CapabilitiesChangedListener)

Berhenti berlangganan untuk peristiwa 'capabilitiesChanged'.

function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parameter

event

"capabilitiesChanged"

Diwarisi dariCommonCallAdapter.off

off("captionsReceived", CaptionsReceivedListener)

Fungsi berhenti berlangganan untuk acara 'captionsReceived'.

function off(event: "captionsReceived", listener: CaptionsReceivedListener)

Parameter

event

"captionsReceived"

Diwarisi dariCommonCallAdapter.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Berhenti berlangganan fungsi untuk peristiwa 'diagnosticChanged'.

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

Parameter

event

"diagnosticChanged"

Diwarisi dariCommonCallAdapter.off

off("displayNameChanged", DisplayNameChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'displayNameChanged'.

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

Parameter

event

"displayNameChanged"

Diwarisi dariCommonCallAdapter.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 dariCommonCallAdapter.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Berhenti berlangganan untuk peristiwa 'isCaptionLanguageChanged'.

function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parameter

event

"isCaptionLanguageChanged"

Diwarisi dariCommonCallAdapter.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Berhenti berlangganan untuk peristiwa 'isCaptionsActiveChanged'.

function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parameter

event

"isCaptionsActiveChanged"

Diwarisi dariCommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'isLocalScreenSharingActiveChanged'.

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

Parameter

event

"isLocalScreenSharingActiveChanged"

Diwarisi dariCommonCallAdapter.off

off("isMutedChanged", IsMutedChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'isMutedChanged'.

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

Parameter

event

"isMutedChanged"

Diwarisi dariCommonCallAdapter.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Berhenti berlangganan fungsi untuk peristiwa 'isSpeakingChanged'.

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

Parameter

event

"isSpeakingChanged"

Diwarisi dariCommonCallAdapter.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Berhenti berlangganan untuk peristiwa 'isSpokenLanguageChanged'.

function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parameter

event

"isSpokenLanguageChanged"

Diwarisi dariCommonCallAdapter.off

off("mutedByOthers", PropertyChangedEvent)

Berhenti berlangganan untuk peristiwa 'mutedByOthers'.

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

Parameter

event

"mutedByOthers"

Diwarisi dariCommonCallAdapter.off

off("participantsJoined", ParticipantsJoinedListener)

Berhenti berlangganan fungsi untuk acara 'pesertaGabung'.

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

Parameter

event

"participantsJoined"

Diwarisi dariCommonCallAdapter.off

off("participantsLeft", ParticipantsLeftListener)

Berhenti berlangganan fungsi untuk peristiwa 'participantsLeft'.

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

Parameter

event

"participantsLeft"

Diwarisi dariCommonCallAdapter.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

Berhenti berlangganan untuk peristiwa 'realTimeTextReceived'.

function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parameter

event

"realTimeTextReceived"

Diwarisi dariCommonCallAdapter.off

off("roleChanged", PropertyChangedEvent)

Fungsi berhenti berlangganan untuk peristiwa 'roleChanged'.

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

Parameter

event

"roleChanged"

Diwarisi dariCommonCallAdapter.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa 'selectedMicrophoneChanged'.

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

Parameter

event

"selectedMicrophoneChanged"

Diwarisi dariCommonCallAdapter.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa 'selectedSpeakerChanged'.

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

Parameter

event

"selectedSpeakerChanged"

Diwarisi dariCommonCallAdapter.off

off("spotlightChanged", SpotlightChangedListener)

Fungsi berhenti berlangganan untuk peristiwa 'spotlightChanged'.

function off(event: "spotlightChanged", listener: SpotlightChangedListener)

Parameter

event

"spotlightChanged"

Diwarisi dariCommonCallAdapter.off

off("transferAccepted", TransferAcceptedListener)

Fungsi berhenti berlangganan untuk peristiwa 'transferRequested'.

function off(event: "transferAccepted", listener: TransferAcceptedListener)

Parameter

event

"transferAccepted"

Diwarisi dariCommonCallAdapter.off

offStateChange((state: CallAdapterState) => void)

Berhenti berlangganan handler ke stateChanged events.

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

Parameter

handler

(state: CallAdapterState) => void

Diwarisi dariCommonCallAdapter.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Fungsi berlangganan untuk acara 'breakoutRoomsUpdated'.

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parameter

event

"breakoutRoomsUpdated"

Diwarisi dariCommonCallAdapter.on

on("callEnded", CallEndedListener)

Berlangganan fungsi untuk peristiwa 'callEnded'.

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

Parameter

event

"callEnded"

Diwarisi dariCommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

Berlangganan fungsi untuk peristiwa 'callIdChanged'.

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

Parameter

event

"callIdChanged"

Keterangan

Peristiwa akan dipicu ketika callId pengguna saat ini berubah.

Diwarisi dariCommonCallAdapter.on

on("capabilitiesChanged", CapabilitiesChangedListener)

Berlangganan untuk peristiwa 'capabilitiesChanged'.

function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parameter

event

"capabilitiesChanged"

Diwarisi dariCommonCallAdapter.on

on("captionsReceived", CaptionsReceivedListener)

Fungsi berlangganan untuk acara 'captionsReceived'.

function on(event: "captionsReceived", listener: CaptionsReceivedListener)

Parameter

event

"captionsReceived"

Diwarisi dariCommonCallAdapter.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Berlangganan fungsi untuk peristiwa 'diagnosticChanged'.

Peristiwa ini diaktifkan setiap kali ada perubahan pada diagnostik yang dihadapi pengguna tentang panggilan yang sedang berlangsung.

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

Parameter

event

"diagnosticChanged"

Diwarisi dariCommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

Berlangganan fungsi untuk peristiwa 'displayNameChanged'.

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

Parameter

event

"displayNameChanged"

Diwarisi dariCommonCallAdapter.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 dariCommonCallAdapter.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Fungsi berlangganan untuk peristiwa 'isCaptionLanguageChanged'.

function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parameter

event

"isCaptionLanguageChanged"

Diwarisi dariCommonCallAdapter.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Fungsi berlangganan untuk peristiwa 'isCaptionsActiveChanged'.

function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parameter

event

"isCaptionsActiveChanged"

Diwarisi dariCommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Berlangganan fungsi untuk peristiwa 'isLocalScreenSharingActiveChanged'.

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

Parameter

event

"isLocalScreenSharingActiveChanged"

Diwarisi dariCommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

Berlangganan fungsi untuk peristiwa 'isMutedChanged'.

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

Parameter

event

"isMutedChanged"

Keterangan

Peristiwa akan dipicu setiap kali status bisukan pengguna atau pengguna jarak jauh saat ini berubah

Diwarisi dariCommonCallAdapter.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Berlangganan fungsi untuk peristiwa 'isSpeakingChanged'.

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

Parameter

event

"isSpeakingChanged"

Diwarisi dariCommonCallAdapter.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Fungsi berlangganan untuk peristiwa 'isSpokenLanguageChanged'.

function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parameter

event

"isSpokenLanguageChanged"

Diwarisi dariCommonCallAdapter.on

on("mutedByOthers", PropertyChangedEvent)

Fungsi berlangganan untuk peristiwa 'mutedByOthers'.

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

Parameter

event

"mutedByOthers"

Diwarisi dariCommonCallAdapter.on

on("participantsJoined", ParticipantsJoinedListener)

Berlangganan fungsi untuk acara 'pesertaJoined'.

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

Parameter

event

"participantsJoined"

Diwarisi dariCommonCallAdapter.on

on("participantsLeft", ParticipantsLeftListener)

Berlangganan fungsi untuk peristiwa 'pesertaLeft'.

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

Parameter

event

"participantsLeft"

Diwarisi dariCommonCallAdapter.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

Berlangganan untuk peristiwa 'realTimeTextReceived'.

function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parameter

event

"realTimeTextReceived"

Diwarisi dariCommonCallAdapter.on

on("roleChanged", PropertyChangedEvent)

Berlangganan untuk peristiwa 'roleChanged'.

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

Parameter

event

"roleChanged"

Diwarisi dariCommonCallAdapter.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"

Diwarisi dariCommonCallAdapter.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"

Diwarisi dariCommonCallAdapter.on

on("spotlightChanged", SpotlightChangedListener)

Berlangganan untuk acara 'spotlightChanged'.

function on(event: "spotlightChanged", listener: SpotlightChangedListener)

Parameter

event

"spotlightChanged"

Diwarisi dariCommonCallAdapter.on

on("transferAccepted", TransferAcceptedListener)

Fungsi berlangganan untuk peristiwa 'transferRequested'.

function on(event: "transferAccepted", listener: TransferAcceptedListener)

Parameter

event

"transferAccepted"

Diwarisi dariCommonCallAdapter.on

onReactionClick(Reaction)

Kirim emoji reaksi

function onReactionClick(reaction: Reaction): Promise<void>

Parameter

reaction
Reaction

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.onReactionClick

onStateChange((state: CallAdapterState) => void)

Berlangganan handler ke peristiwa stateChanged.

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

Parameter

handler

(state: CallAdapterState) => void

Diwarisi dariCommonCallAdapter.onStateChange

permitAudio(string[])

Izinkan audio peserta rapat Teams dengan id pengguna mereka.

function permitAudio(userIds: string[]): Promise<void>

Parameter

userIds

string[]

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.permitAudio

permitOthersAudio()

Izinkan audio rapat Teams.

function permitOthersAudio(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.permitOthersAudio

permitOthersVideo()

Izinkan video rapat Teams.

function permitOthersVideo(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.permitOthersVideo

permitVideo(string[])

Izinkan audio peserta rapat Teams dengan id pengguna mereka.

function permitVideo(userIds: string[]): Promise<void>

Parameter

userIds

string[]

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.permitVideo

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 dariCommonCallAdapter.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 dariCommonCallAdapter.queryMicrophones

querySpeakers()

Kueri untuk perangkat speaker 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 dariCommonCallAdapter.querySpeakers

raiseHand()

Angkat tangan untuk pengguna saat ini

function raiseHand(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.raiseHand

removeParticipant(CommunicationIdentifier)

Hapus peserta dari panggilan.

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

Parameter

participant
CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> peserta yang akan dihapus

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.removeParticipant

removeParticipant(string)

Hapus peserta dari panggilan.

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

Parameter

userId

string

Id peserta yang akan dihapus

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.removeParticipant

resumeCall()

Melanjutkan panggilan dari negara LocalHold bagian.

function resumeCall(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.resumeCall

returnFromBreakoutRoom()

Kembali ke panggilan asal ruang kerja kelompok

function returnFromBreakoutRoom(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

mengirim nada dtmf ke peserta lain dalam panggilan PSTN 1:1

function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>

Parameter

dtmfTone
DtmfTone

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.sendDtmfTone

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 salah satu yang dikembalikan oleh queryCameras

options
VideoStreamOptions

Opsi untuk mengontrol bagaimana aliran kamera dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.setCamera

setCaptionLanguage(string)

Fungsi untuk mengatur bahasa teks

function setCaptionLanguage(language: string): Promise<void>

Parameter

language

string

Bahasa yang ditetapkan untuk teks

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.setCaptionLanguage

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 kueri Microphones

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.setMicrophone

setSpeaker(AudioDeviceInfo)

Atur speaker untuk digunakan dalam panggilan.

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

Parameter

sourceInfo
AudioDeviceInfo

Perangkat speaker untuk dipilih, pilih salah satu yang dikembalikan oleh querySpeakers

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.setSpeaker

setSpokenLanguage(string)

Fungsi untuk mengatur bahasa lisan

function setSpokenLanguage(language: string): Promise<void>

Parameter

language

string

Bahasa lisan

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Hitung ulang posisi tempat duduk untuk mode bersama.

function setTogetherModeSceneSize(width: number, height: number)

Parameter

width

number

Lebar wadah

height

number

Tinggi wadah

Keterangan

Metode ini diimplementasikan untuk komposit

Diwarisi dariCommonCallAdapter.setTogetherModeSceneSize

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 bagaimana streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.startCamera

startCaptions(StartCaptionsAdapterOptions)

Fungsi untuk Memulai teks

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

Parameter

options
StartCaptionsAdapterOptions

Opsi untuk Mulai Teks

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.startCaptions

startNoiseSuppressionEffect()

Mulai efek peredam kebisingan.

function startNoiseSuppressionEffect(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.startNoiseSuppressionEffect

startScreenShare()

Mulai berbagi layar selama panggilan.

function startScreenShare(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.startScreenShare

startSpotlight(string[])

Mulai sorotan untuk peserta lokal dan jarak jauh dengan id pengguna mereka. Jika tidak ada array id pengguna yang diteruskan, tindakan dilakukan pada peserta lokal.

function startSpotlight(userIds?: string[]): Promise<void>

Parameter

userIds

string[]

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.startSpotlight

startTogetherMode()

Mulai mode Bersama.

function startTogetherMode(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Mulai efek latar belakang video.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

Parameter

videoBackgroundEffect
VideoBackgroundEffect

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.startVideoBackgroundEffect

stopAllSpotlight()

Hentikan semua lampu sorot

function stopAllSpotlight(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.stopAllSpotlight

stopCamera()

Hentikan kamera Metode ini akan berhenti merender tampilan kamera lokal saat panggilan tidak aktif

function stopCamera(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Fungsi untuk menghentikan teks

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

Parameter

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.stopCaptions

stopNoiseSuppressionEffect()

Hentikan efek peredam kebisingan.

function stopNoiseSuppressionEffect(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.stopNoiseSuppressionEffect

stopScreenShare()

Berhenti berbagi layar

function stopScreenShare(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.stopScreenShare

stopSpotlight(string[])

Hentikan sorotan untuk peserta lokal dan jarak jauh berdasarkan id pengguna mereka. Jika tidak ada array id pengguna yang diteruskan, tindakan dilakukan pada peserta lokal.

function stopSpotlight(userIds?: string[]): Promise<void>

Parameter

userIds

string[]

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.stopSpotlight

stopVideoBackgroundEffects()

Hentikan efek latar belakang video.

function stopVideoBackgroundEffects(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Kirim hasil survei akhir panggilan

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

Parameter

survey
CallSurvey

Mengembalikan

Promise<undefined | CallSurveyResponse>

Diwarisi dariCommonCallAdapter.submitSurvey

unmute()

Nyalakan suara pengguna saat ini selama panggilan atau aktifkan mikrofon secara lokal

function unmute(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi dariCommonCallAdapter.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Ganti gambar pemilih latar belakang untuk efek penggantian latar belakang.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameter

backgroundImages

VideoBackgroundImage[]

Array gambar latar belakang khusus.

Diwarisi dariCommonCallAdapter.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Perbarui efek latar belakang video yang dipilih.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameter

selectedVideoBackground
VideoBackgroundEffect

Diwarisi dariCommonCallAdapter.updateSelectedVideoBackgroundEffect