CallAdapterCallOperations interface

Paket:

@azure/communication-react

Fungsionalitas untuk mengelola panggilan saat ini.

Properti

sendRealTimeText

Kirim teks waktu nyata

Metode

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Tambahkan peserta ke panggilan.
createStreamView(string, VideoStreamOptions)	Buat tampilan html untuk aliran.
createTogetherModeStreamView(TogetherModeStreamOptions)	Buat tampilan html untuk aliran.
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.
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
onReactionClick(Reaction)	Kirim emoji reaksi
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.
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
setCaptionLanguage(string)	Fungsi untuk mengatur bahasa teks
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

sendRealTimeText

Kirim teks waktu nyata

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

Nilai Properti

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

Detail Metode

addParticipant(CommunicationUserIdentifier)

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

Parameter

participant

CommunicationUserIdentifier

Mengembalikan

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Tambahkan peserta ke panggilan.

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

Parameter

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Mengembalikan

Promise<void>

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

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

Promise<void | TogetherModeStreamViewResult>

Keterangan

Metode ini diimplementasikan untuk komposit

disposeLocalVideoStreamView()

Membuang tampilan html untuk streaming video lokal

function disposeLocalVideoStreamView(): Promise<void>

Mengembalikan

Promise<void>

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>

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

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

disposeTogetherModeStreamView()

Buang tampilan html untuk aliran.

function disposeTogetherModeStreamView(): Promise<void>

Mengembalikan

Promise<void>

Keterangan

Metode ini diimplementasikan untuk komposit

forbidAudio(string[])

Melarang audio peserta rapat Teams dengan id pengguna mereka.

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

Parameter

userIds

string[]

Mengembalikan

Promise<void>

forbidOthersAudio()

Melarang audio rapat Teams.

function forbidOthersAudio(): Promise<void>

Mengembalikan

Promise<void>

forbidOthersVideo()

Melarang video rapat Teams.

function forbidOthersVideo(): Promise<void>

Mengembalikan

Promise<void>

forbidVideo(string[])

Melarang video peserta rapat Teams dengan id pengguna mereka.

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

Parameter

userIds

string[]

Mengembalikan

Promise<void>

holdCall()

Menahan panggilan.

function holdCall(): Promise<void>

Mengembalikan

Promise<void>

leaveCall(boolean)

Tinggalkan panggilan

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

Parameter

forEveryone

boolean

Apakah akan menghapus semua peserta saat keluar

Mengembalikan

Promise<void>

lowerHand()

Lebih rendah tangan untuk pengguna saat ini

function lowerHand(): Promise<void>

Mengembalikan

Promise<void>

mute()

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

function mute(): Promise<void>

Mengembalikan

Promise<void>

muteAllRemoteParticipants()

Bisukan Semua peserta

function muteAllRemoteParticipants(): Promise<void>

Mengembalikan

Promise<void>

muteParticipant(string)

Menonaktifkan peserta

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

Parameter

userId

string

ID peserta untuk membisukan

Mengembalikan

Promise<void>

onReactionClick(Reaction)

Kirim emoji reaksi

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

Parameter

reaction

Reaction

Mengembalikan

Promise<void>

permitAudio(string[])

Izinkan audio peserta rapat Teams dengan id pengguna mereka.

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

Parameter

userIds

string[]

Mengembalikan

Promise<void>

permitOthersAudio()

Izinkan audio rapat Teams.

function permitOthersAudio(): Promise<void>

Mengembalikan

Promise<void>

permitOthersVideo()

Izinkan video rapat Teams.

function permitOthersVideo(): Promise<void>

Mengembalikan

Promise<void>

permitVideo(string[])

Izinkan audio peserta rapat Teams dengan id pengguna mereka.

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

Parameter

userIds

string[]

Mengembalikan

Promise<void>

raiseHand()

Angkat tangan untuk pengguna saat ini

function raiseHand(): Promise<void>

Mengembalikan

Promise<void>

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>

removeParticipant(string)

Hapus peserta dari panggilan.

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

Parameter

userId

string

Id peserta yang akan dihapus

Mengembalikan

Promise<void>

resumeCall()

Melanjutkan panggilan dari negara LocalHold bagian.

function resumeCall(): Promise<void>

Mengembalikan

Promise<void>

returnFromBreakoutRoom()

Kembali ke panggilan asal ruang kerja kelompok

function returnFromBreakoutRoom(): Promise<void>

Mengembalikan

Promise<void>

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>

setCaptionLanguage(string)

Fungsi untuk mengatur bahasa teks

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

Parameter

language

string

Bahasa yang ditetapkan untuk teks

Mengembalikan

Promise<void>

setSpokenLanguage(string)

Fungsi untuk mengatur bahasa lisan

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

Parameter

language

string

Bahasa lisan

Mengembalikan

Promise<void>

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

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>

startCaptions(StartCaptionsAdapterOptions)

Fungsi untuk Memulai teks

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

Parameter

options

StartCaptionsAdapterOptions

Opsi untuk Mulai Teks

Mengembalikan

Promise<void>

startNoiseSuppressionEffect()

Mulai efek peredam kebisingan.

function startNoiseSuppressionEffect(): Promise<void>

Mengembalikan

Promise<void>

startScreenShare()

Mulai berbagi layar selama panggilan.

function startScreenShare(): Promise<void>

Mengembalikan

Promise<void>

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>

startTogetherMode()

Mulai mode Bersama.

function startTogetherMode(): Promise<void>

Mengembalikan

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

Mulai efek latar belakang video.

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

Parameter

videoBackgroundEffect

VideoBackgroundEffect

Mengembalikan

Promise<void>

stopAllSpotlight()

Hentikan semua lampu sorot

function stopAllSpotlight(): Promise<void>

Mengembalikan

Promise<void>

stopCamera()

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

function stopCamera(): Promise<void>

Mengembalikan

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Fungsi untuk menghentikan teks

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

Parameter

options

StopCaptionsAdapterOptions

Mengembalikan

Promise<void>

stopNoiseSuppressionEffect()

Hentikan efek peredam kebisingan.

function stopNoiseSuppressionEffect(): Promise<void>

Mengembalikan

Promise<void>

stopScreenShare()

Berhenti berbagi layar

function stopScreenShare(): Promise<void>

Mengembalikan

Promise<void>

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>

stopVideoBackgroundEffects()

Hentikan efek latar belakang video.

function stopVideoBackgroundEffects(): Promise<void>

Mengembalikan

Promise<void>

submitSurvey(CallSurvey)

Kirim hasil survei akhir panggilan

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

Parameter

survey

CallSurvey

Mengembalikan

Promise<undefined | CallSurveyResponse>

unmute()

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

function unmute(): Promise<void>

Mengembalikan

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

Ganti gambar pemilih latar belakang untuk efek penggantian latar belakang.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameter

backgroundImages

VideoBackgroundImage[]

Array gambar latar belakang khusus.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Perbarui efek latar belakang video yang dipilih.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameter

selectedVideoBackground

VideoBackgroundEffect