CallWithChatAdapterManagement interface
Fungsionalitas untuk mengelola panggilan saat ini dengan obrolan.
Properti
| forbid |
Melarang audio untuk ID pengguna yang ditentukan. |
| forbid |
melarang audio untuk peserta rapat Teams kecuali pengguna lokal. |
| forbid |
melarang video untuk peserta rapat Teams kecuali pengguna lokal. |
| forbid |
Melarang video untuk ID pengguna yang ditentukan. |
| permit |
Mengizinkan audio untuk ID pengguna yang ditentukan. |
| permit |
mengizinkan audio untuk peserta rapat Teams kecuali pengguna lokal. |
| permit |
mengizinkan video untuk peserta rapat Teams kecuali pengguna lokal. |
| permit |
Mengizinkan video untuk ID pengguna yang ditentukan. |
| send |
Kirim nada DTMF ke peserta lain dalam panggilan dalam panggilan 1:1 |
| send |
Kirim teks waktu nyata |
Metode
| add |
|
| add |
Menambahkan Peserta baru ke panggilan. |
| ask |
Minta izin perangkat. |
| create |
Buat tampilan html untuk aliran. |
| create |
Buat tampilan html untuk aliran mode bersama. |
| delete |
Hapus pesan di utas. |
| dispose |
Membuang tampilan html untuk streaming video lokal |
| dispose |
Buang tampilan html untuk streaming video jarak jauh |
| dispose |
Membuang tampilan html untuk aliran berbagi layar |
| dispose |
Buang tampilan html untuk aliran. |
| dispose |
Buang tampilan html untuk aliran mode bersama. |
| download |
|
| fetch |
Ambil status awal untuk adaptor Obrolan. Melakukan pengambilan minimal yang diperlukan untuk metode ChatComposite dan API. |
| hold |
Menempatkan panggilan di Localhold. |
| join |
Gabungkan panggilan dengan mikrofon awalnya aktif/mati. |
| join |
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 |
| leave |
Tinggalkan panggilan. |
| load |
Muat lebih banyak pesan sebelumnya dalam riwayat utas obrolan. |
| lower |
Turun tangan untuk pengguna lokal. |
| mute() | Matikan suara pengguna saat ini selama panggilan atau nonaktifkan mikrofon secara lokal. |
| mute |
Menonaktifkan peserta |
| mute |
Menonaktifkan peserta |
| on |
Kirim Reaksi ke rapat yang sedang berlangsung. |
| query |
Kueri untuk perangkat kamera yang tersedia. |
| query |
Kueri untuk perangkat mikrofon yang tersedia. |
| query |
Kueri untuk perangkat mikrofon yang tersedia. |
| raise |
Angkat tangan untuk pengguna lokal. |
| remove |
Hapus peserta dari panggilan. |
| remove |
Menghapus peserta dari Panggilan. |
| remove |
|
| resume |
Melanjutkan panggilan dari status LocalHold. |
| return |
Kembali ke panggilan asal ruang kerja kelompok |
| send |
Kirim pesan di utas. |
| send |
Kirim tanda terima baca untuk pesan. |
| send |
Kirim indikator pengetikan di utas. |
| set |
Atur kamera yang akan digunakan dalam panggilan. |
| set |
Fungsi untuk mengatur bahasa teks |
| set |
Atur mikrofon yang akan digunakan dalam panggilan. |
| set |
Atur speaker untuk digunakan dalam panggilan. |
| set |
Fungsi untuk mengatur bahasa lisan |
| set |
Hitung ulang posisi tempat duduk untuk mode bersama. |
| start |
Mulai panggilan. |
| start |
Mulai panggilan. |
| start |
Mulai kamera. Metode ini akan mulai merender tampilan kamera lokal ketika panggilan tidak aktif. |
| start |
Fungsi untuk Memulai teks |
| start |
Mulai efek peredam kebisingan. |
| start |
Mulai berbagi layar selama panggilan. |
| start |
Mulai sorotan |
| start |
Mulai mode bersama. |
| start |
Mulai efek latar belakang video. |
| stop |
Hentikan semua lampu sorot |
| stop |
Hentikan kameranya. Metode ini akan berhenti merender tampilan kamera lokal ketika panggilan tidak aktif. |
| stop |
Fungsi untuk menghentikan teks |
| stop |
Mulai efek peredam kebisingan. |
| stop |
Berhenti berbagi layar. |
| stop |
Hentikan sorotan |
| stop |
Hentikan efek latar belakang video. |
| submit |
Kirim hasil survei akhir panggilan |
| unmute() | Nyalakan suara pengguna saat ini selama panggilan atau aktifkan mikrofon secara lokal. |
| update |
Ganti gambar pemilih latar belakang untuk efek penggantian latar belakang. |
| update |
Memperbarui konten pesan. |
| update |
Perbarui efek latar belakang video yang dipilih |
Detail Properti
forbidAudio
Melarang audio untuk ID pengguna yang ditentukan.
forbidAudio: (userIds: string[]) => Promise<void>
Nilai Properti
(userIds: string[]) => Promise<void>
forbidOthersAudio
melarang audio untuk peserta rapat Teams kecuali pengguna lokal.
forbidOthersAudio: () => Promise<void>
Nilai Properti
() => Promise<void>
forbidOthersVideo
melarang video untuk peserta rapat Teams kecuali pengguna lokal.
forbidOthersVideo: () => Promise<void>
Nilai Properti
() => Promise<void>
forbidVideo
Melarang video untuk ID pengguna yang ditentukan.
forbidVideo: (userIds: string[]) => Promise<void>
Nilai Properti
(userIds: string[]) => Promise<void>
permitAudio
Mengizinkan audio untuk ID pengguna yang ditentukan.
permitAudio: (userIds: string[]) => Promise<void>
Nilai Properti
(userIds: string[]) => Promise<void>
permitOthersAudio
mengizinkan audio untuk peserta rapat Teams kecuali pengguna lokal.
permitOthersAudio: () => Promise<void>
Nilai Properti
() => Promise<void>
permitOthersVideo
mengizinkan video untuk peserta rapat Teams kecuali pengguna lokal.
permitOthersVideo: () => Promise<void>
Nilai Properti
() => Promise<void>
permitVideo
Mengizinkan video untuk ID pengguna yang ditentukan.
permitVideo: (userIds: string[]) => Promise<void>
Nilai Properti
(userIds: string[]) => Promise<void>
sendDtmfTone
Kirim nada DTMF ke peserta lain dalam panggilan dalam panggilan 1:1
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>
Nilai Properti
(dtmfTone: DtmfTone) => Promise<void>
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)
Menambahkan Peserta baru ke panggilan.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Parameter
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Mengembalikan
Promise<void>
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.
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 mode bersama.
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
deleteMessage(string)
Hapus pesan di utas.
function deleteMessage(messageId: string): Promise<void>
Parameter
- messageId
-
string
Mengembalikan
Promise<void>
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)
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 mode bersama.
function disposeTogetherModeStreamView(): Promise<void>
Mengembalikan
Promise<void>
Keterangan
Metode ini diimplementasikan untuk komposit
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Parameter
- resourceDetails
- ResourceDetails
Mengembalikan
Promise<void>
fetchInitialData()
Ambil status awal untuk adaptor Obrolan.
Melakukan pengambilan minimal yang diperlukan untuk metode ChatComposite dan API.
function fetchInitialData(): Promise<void>
Mengembalikan
Promise<void>
holdCall()
Menempatkan panggilan di Localhold.
function holdCall(): Promise<void>
Mengembalikan
Promise<void>
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 | Call
Parameter
- microphoneOn
-
boolean
Apakah mikrofon awalnya diaktifkan
Mengembalikan
undefined | Call
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 | Call
Parameter
- options
- JoinCallOptions
parameter untuk mengatur mikrofon/kamera awalnya aktif/mati/gunakan status precall.
Mengembalikan
undefined | Call
leaveCall(boolean)
Tinggalkan panggilan.
function leaveCall(forEveryone?: boolean): Promise<void>
Parameter
- forEveryone
-
boolean
Apakah akan menghapus semua peserta saat keluar
Mengembalikan
Promise<void>
loadPreviousChatMessages(number)
Muat lebih banyak pesan sebelumnya dalam riwayat utas obrolan.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
Parameter
- messagesToLoad
-
number
Mengembalikan
Promise<boolean>
Keterangan
Metode ini biasanya digunakan untuk mengontrol pengambilan inkremental/gulir tak terbatas.
lowerHand()
Turun tangan untuk pengguna lokal.
function lowerHand(): Promise<void>
Mengembalikan
Promise<void>
mute()
Matikan suara pengguna saat ini selama panggilan atau nonaktifkan mikrofon secara lokal.
function mute(): Promise<void>
Mengembalikan
Promise<void>
muteAllRemoteParticipants()
Menonaktifkan peserta
function muteAllRemoteParticipants(): Promise<void>
Mengembalikan
Promise<void>
muteParticipant(string)
Menonaktifkan peserta
function muteParticipant(userId: string): Promise<void>
Parameter
- userId
-
string
Mengembalikan
Promise<void>
onReactionClick(Reaction)
Kirim Reaksi ke rapat yang sedang berlangsung.
function onReactionClick(reaction: Reaction): Promise<void>
Parameter
- reaction
- Reaction
Nilai jenis <xref:%40azure%2Fcommunication-calling%23Reaction>
Mengembalikan
Promise<void>
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()
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()
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()
raiseHand()
Angkat tangan untuk pengguna lokal.
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)
Menghapus peserta dari Panggilan.
function removeParticipant(userId: string): Promise<void>
Parameter
- userId
-
string
UserId peserta yang akan dihapus.
Mengembalikan
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
Parameter
- resourceDetails
- ResourceDetails
resumeCall()
Melanjutkan panggilan dari status LocalHold.
function resumeCall(): Promise<void>
Mengembalikan
Promise<void>
returnFromBreakoutRoom()
Kembali ke panggilan asal ruang kerja kelompok
function returnFromBreakoutRoom(): Promise<void>
Mengembalikan
Promise<void>
sendMessage(string, SendMessageOptions)
Kirim pesan di utas.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parameter
- content
-
string
- options
- SendMessageOptions
Mengembalikan
Promise<void>
sendReadReceipt(string)
Kirim tanda terima baca untuk pesan.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parameter
- chatMessageId
-
string
Mengembalikan
Promise<void>
sendTypingIndicator()
Kirim indikator pengetikan di utas.
function sendTypingIndicator(): Promise<void>
Mengembalikan
Promise<void>
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>
setCaptionLanguage(string)
Fungsi untuk mengatur bahasa teks
function setCaptionLanguage(language: string): Promise<void>
Parameter
- language
-
string
Bahasa yang ditetapkan untuk teks
Mengembalikan
Promise<void>
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>
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>
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
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
Mulai panggilan.
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call
Parameter
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
Array yang <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> akan dipanggil
- options
- StartCallOptions
Mengembalikan
undefined | Call
startCall(string[], StartCallOptions)
Mulai panggilan.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
Parameter
- participants
-
string[]
Array id peserta untuk bergabung
- options
- StartCallOptions
Mengembalikan
undefined | Call
startCamera(VideoStreamOptions)
Mulai kamera.
Metode ini akan mulai merender tampilan kamera lokal ketika 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
function startSpotlight(userIds?: string[]): Promise<void>
Parameter
- userIds
-
string[]
Mengembalikan
Promise<void>
startTogetherMode()
Mulai mode bersama.
function startTogetherMode(): Promise<void>
Mengembalikan
Promise<void>
Keterangan
Metode ini diimplementasikan untuk komposit
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 kameranya.
Metode ini akan berhenti merender tampilan kamera lokal ketika 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()
Mulai 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
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
Array gambar latar belakang khusus.
updateMessage(string, string, Record<string, string>)
Memperbarui konten pesan.
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>
Parameter
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
Mengembalikan
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Perbarui efek latar belakang video yang dipilih
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parameter
- selectedVideoBackground
- VideoBackgroundEffect