CallWithChatAdapter interface
CallWithChatComposite Antarmuka adaptor.
- Memperluas
Properti yang Diwariskan
| 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 yang Diwarisi
Detail Properti yang Diwariskan
forbidAudio
Melarang audio untuk ID pengguna yang ditentukan.
forbidAudio: (userIds: string[]) => Promise<void>
Nilai Properti
(userIds: string[]) => Promise<void>
Diwarisi dariCallWithChatAdapterManagement.forbidAudio
forbidOthersAudio
melarang audio untuk peserta rapat Teams kecuali pengguna lokal.
forbidOthersAudio: () => Promise<void>
Nilai Properti
() => Promise<void>
Diwarisi dariCallWithChatAdapterManagement.forbidOthersAudio
forbidOthersVideo
melarang video untuk peserta rapat Teams kecuali pengguna lokal.
forbidOthersVideo: () => Promise<void>
Nilai Properti
() => Promise<void>
Diwarisi dariCallWithChatAdapterManagement.forbidOthersVideo
forbidVideo
Melarang video untuk ID pengguna yang ditentukan.
forbidVideo: (userIds: string[]) => Promise<void>
Nilai Properti
(userIds: string[]) => Promise<void>
Diwarisi dariCallWithChatAdapterManagement.forbidVideo
permitAudio
Mengizinkan audio untuk ID pengguna yang ditentukan.
permitAudio: (userIds: string[]) => Promise<void>
Nilai Properti
(userIds: string[]) => Promise<void>
Diwarisi dariCallWithChatAdapterManagement.permitAudio
permitOthersAudio
mengizinkan audio untuk peserta rapat Teams kecuali pengguna lokal.
permitOthersAudio: () => Promise<void>
Nilai Properti
() => Promise<void>
Diwarisi dariCallWithChatAdapterManagement.permitOthersAudio
permitOthersVideo
mengizinkan video untuk peserta rapat Teams kecuali pengguna lokal.
permitOthersVideo: () => Promise<void>
Nilai Properti
() => Promise<void>
Diwarisi dariCallWithChatAdapterManagement.permitOthersVideo
permitVideo
Mengizinkan video untuk ID pengguna yang ditentukan.
permitVideo: (userIds: string[]) => Promise<void>
Nilai Properti
(userIds: string[]) => Promise<void>
Diwarisi dariCallWithChatAdapterManagement.permitVideo
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>
Diwarisi dariCallWithChatAdapterManagement.sendDtmfTone
sendRealTimeText
Kirim teks waktu nyata
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>
Nilai Properti
(text: string, isFinalized: boolean) => Promise<void>
Diwarisi dariCallWithChatAdapterManagement.sendRealTimeText
Detail Metode yang Diwarisi
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Parameter
- participant
- CommunicationUserIdentifier
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.addParticipant
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Menambahkan Peserta baru ke panggilan.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Parameter
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.createStreamView
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
Diwarisi dariCallWithChatAdapterManagement.createTogetherModeStreamView
deleteMessage(string)
Hapus pesan di utas.
function deleteMessage(messageId: string): Promise<void>
Parameter
- messageId
-
string
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.deleteMessage
dispose()
disposeLocalVideoStreamView()
Membuang tampilan html untuk streaming video lokal
function disposeLocalVideoStreamView(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.disposeScreenShareStreamView
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.
Diwarisi dariCallWithChatAdapterManagement.disposeStreamView
disposeTogetherModeStreamView()
Buang tampilan html untuk aliran mode bersama.
function disposeTogetherModeStreamView(): Promise<void>
Mengembalikan
Promise<void>
Keterangan
Metode ini diimplementasikan untuk komposit
Diwarisi dariCallWithChatAdapterManagement.disposeTogetherModeStreamView
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Parameter
- resourceDetails
- ResourceDetails
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.downloadResourceToCache
fetchInitialData()
Ambil status awal untuk adaptor Obrolan.
Melakukan pengambilan minimal yang diperlukan untuk metode ChatComposite dan API.
function fetchInitialData(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.fetchInitialData
getState()
Dapatkan Status saat ini
function getState(): CallWithChatAdapterState
Mengembalikan
Diwarisi dariAdapterState.getState
holdCall()
Menempatkan panggilan di Localhold.
function holdCall(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.holdCall
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
Diwarisi dariCallWithChatAdapterManagement.joinCall
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
Diwarisi dariCallWithChatAdapterManagement.joinCall
leaveCall(boolean)
Tinggalkan panggilan.
function leaveCall(forEveryone?: boolean): Promise<void>
Parameter
- forEveryone
-
boolean
Apakah akan menghapus semua peserta saat keluar
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.leaveCall
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.
Diwarisi dariCallWithChatAdapterManagement.loadPreviousChatMessages
lowerHand()
Turun tangan untuk pengguna lokal.
function lowerHand(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.lowerHand
mute()
Matikan suara pengguna saat ini selama panggilan atau nonaktifkan mikrofon secara lokal.
function mute(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.mute
muteAllRemoteParticipants()
Menonaktifkan peserta
function muteAllRemoteParticipants(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.muteAllRemoteParticipants
muteParticipant(string)
Menonaktifkan peserta
function muteParticipant(userId: string): Promise<void>
Parameter
- userId
-
string
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.muteParticipant
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parameter
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)
Parameter
- event
-
"callEnded"
- listener
- CallEndedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)
Parameter
- event
-
"callError"
- listener
-
(e: AdapterError) => void
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parameter
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parameter
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parameter
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("capabilitiesChanged", CapabilitiesChangedListener)
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parameter
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("captionsReceived", CaptionsReceivedListener)
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
Parameter
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)
Parameter
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("chatInitialized", ChatInitializedListener)
function off(event: "chatInitialized", listener: ChatInitializedListener)
Parameter
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parameter
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parameter
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parameter
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parameter
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parameter
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parameter
- event
-
"isLocalScreenSharingActiveChanged"
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Parameter
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parameter
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parameter
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("messageDeleted", MessageReceivedListener)
function off(event: "messageDeleted", listener: MessageReceivedListener)
Parameter
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("messageEdited", MessageReceivedListener)
function off(event: "messageEdited", listener: MessageReceivedListener)
Parameter
- event
-
"messageEdited"
- listener
- MessageReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)
Parameter
- event
-
"messageRead"
- listener
- MessageReadListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)
Parameter
- event
-
"messageReceived"
- listener
- MessageReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)
Parameter
- event
-
"messageSent"
- listener
- MessageReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("realTimeTextReceived", RealTimeTextReceivedListener)
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parameter
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Diwarisi dariCallWithChatAdapterSubscriptions.off
off("spotlightChanged", SpotlightChangedListener)
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
Parameter
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
Berhenti berlangganan handler ke stateChanged events.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)
Parameter
- handler
-
(state: CallWithChatAdapterState) => void
Diwarisi dariAdapterState.offStateChange
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parameter
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)
Parameter
- event
-
"callEnded"
- listener
- CallEndedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)
Parameter
- event
-
"callError"
- listener
-
(e: AdapterError) => void
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)
Parameter
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parameter
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parameter
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("capabilitiesChanged", CapabilitiesChangedListener)
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parameter
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("captionsReceived", CaptionsReceivedListener)
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
Parameter
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)
Parameter
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("chatInitialized", ChatInitializedListener)
function on(event: "chatInitialized", listener: ChatInitializedListener)
Parameter
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parameter
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parameter
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parameter
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parameter
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parameter
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parameter
- event
-
"isLocalScreenSharingActiveChanged"
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
Parameter
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parameter
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parameter
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("messageDeleted", MessageReceivedListener)
function on(event: "messageDeleted", listener: MessageReceivedListener)
Parameter
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("messageEdited", MessageReceivedListener)
function on(event: "messageEdited", listener: MessageReceivedListener)
Parameter
- event
-
"messageEdited"
- listener
- MessageReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)
Parameter
- event
-
"messageRead"
- listener
- MessageReadListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)
Parameter
- event
-
"messageReceived"
- listener
- MessageReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)
Parameter
- event
-
"messageSent"
- listener
- MessageReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("realTimeTextReceived", RealTimeTextReceivedListener)
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parameter
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parameter
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
Diwarisi dariCallWithChatAdapterSubscriptions.on
on("spotlightChanged", SpotlightChangedListener)
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
Parameter
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
Diwarisi dariCallWithChatAdapterSubscriptions.on
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>
Diwarisi dariCallWithChatAdapterManagement.onReactionClick
onStateChange((state: CallWithChatAdapterState) => void)
Berlangganan handler ke peristiwa stateChanged.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)
Parameter
- handler
-
(state: CallWithChatAdapterState) => 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 dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.querySpeakers
raiseHand()
Angkat tangan untuk pengguna lokal.
function raiseHand(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.removeParticipant
removeParticipant(string)
Menghapus peserta dari Panggilan.
function removeParticipant(userId: string): Promise<void>
Parameter
- userId
-
string
UserId peserta yang akan dihapus.
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.removeParticipant
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
Parameter
- resourceDetails
- ResourceDetails
Diwarisi dariCallWithChatAdapterManagement.removeResourceFromCache
resumeCall()
Melanjutkan panggilan dari status LocalHold.
function resumeCall(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.resumeCall
returnFromBreakoutRoom()
Kembali ke panggilan asal ruang kerja kelompok
function returnFromBreakoutRoom(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.returnFromBreakoutRoom
sendMessage(string, SendMessageOptions)
Kirim pesan di utas.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parameter
- content
-
string
- options
- SendMessageOptions
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.sendMessage
sendReadReceipt(string)
Kirim tanda terima baca untuk pesan.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parameter
- chatMessageId
-
string
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.sendReadReceipt
sendTypingIndicator()
Kirim indikator pengetikan di utas.
function sendTypingIndicator(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.sendTypingIndicator
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 dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.setSpeaker
setSpokenLanguage(string)
Fungsi untuk mengatur bahasa lisan
function setSpokenLanguage(language: string): Promise<void>
Parameter
- language
-
string
Bahasa lisan
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.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 dariCallWithChatAdapterManagement.setTogetherModeSceneSize
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
Diwarisi dariCallWithChatAdapterManagement.startCall
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
Diwarisi dariCallWithChatAdapterManagement.startCall
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>
Diwarisi dariCallWithChatAdapterManagement.startCamera
startCaptions(StartCaptionsAdapterOptions)
Fungsi untuk Memulai teks
function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>
Parameter
- options
- StartCaptionsAdapterOptions
Opsi untuk Mulai Teks
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.startCaptions
startNoiseSuppressionEffect()
Mulai efek peredam kebisingan.
function startNoiseSuppressionEffect(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.startNoiseSuppressionEffect
startScreenShare()
Mulai berbagi layar selama panggilan.
function startScreenShare(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.startScreenShare
startSpotlight(string[])
Mulai sorotan
function startSpotlight(userIds?: string[]): Promise<void>
Parameter
- userIds
-
string[]
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.startSpotlight
startTogetherMode()
Mulai mode bersama.
function startTogetherMode(): Promise<void>
Mengembalikan
Promise<void>
Keterangan
Metode ini diimplementasikan untuk komposit
Diwarisi dariCallWithChatAdapterManagement.startTogetherMode
startVideoBackgroundEffect(VideoBackgroundEffect)
Mulai efek latar belakang video.
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>
Parameter
- videoBackgroundEffect
- VideoBackgroundEffect
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.startVideoBackgroundEffect
stopAllSpotlight()
Hentikan semua lampu sorot
function stopAllSpotlight(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.stopAllSpotlight
stopCamera()
Hentikan kameranya.
Metode ini akan berhenti merender tampilan kamera lokal ketika panggilan tidak aktif.
function stopCamera(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.stopCamera
stopCaptions(StopCaptionsAdapterOptions)
Fungsi untuk menghentikan teks
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Parameter
- options
- StopCaptionsAdapterOptions
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.stopCaptions
stopNoiseSuppressionEffect()
Mulai efek peredam kebisingan.
function stopNoiseSuppressionEffect(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.stopNoiseSuppressionEffect
stopScreenShare()
Berhenti berbagi layar.
function stopScreenShare(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.stopScreenShare
stopSpotlight(string[])
Hentikan sorotan
function stopSpotlight(userIds?: string[]): Promise<void>
Parameter
- userIds
-
string[]
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.stopSpotlight
stopVideoBackgroundEffects()
Hentikan efek latar belakang video.
function stopVideoBackgroundEffects(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.stopVideoBackgroundEffects
submitSurvey(CallSurvey)
Kirim hasil survei akhir panggilan
function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>
Parameter
- survey
- CallSurvey
Mengembalikan
Promise<undefined | CallSurveyResponse>
Diwarisi dariCallWithChatAdapterManagement.submitSurvey
unmute()
Nyalakan suara pengguna saat ini selama panggilan atau aktifkan mikrofon secara lokal.
function unmute(): Promise<void>
Mengembalikan
Promise<void>
Diwarisi dariCallWithChatAdapterManagement.unmute
updateBackgroundPickerImages(VideoBackgroundImage[])
Ganti gambar pemilih latar belakang untuk efek penggantian latar belakang.
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])
Parameter
- backgroundImages
Array gambar latar belakang khusus.
Diwarisi dariCallWithChatAdapterManagement.updateBackgroundPickerImages
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>
Diwarisi dariCallWithChatAdapterManagement.updateMessage
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Perbarui efek latar belakang video yang dipilih
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parameter
- selectedVideoBackground
- VideoBackgroundEffect
Diwarisi dariCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect