CallWithChatAdapter interface
CallWithChatComposite Antarmuka adapter.
- Extends
Metode yang Diwarisi
Detail Metode yang Diwarisi
askDevicePermission(PermissionConstraints)
Minta izin perangkat.
function askDevicePermission(constrain: PermissionConstraints): Promise<void>Parameter
- constrain
- PermissionConstraints
Menentukan batasan untuk mengakses perangkat lokal <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Mengembalikan
Promise<void>
Keterangan
Jendela izin browser akan muncul jika izin belum diberikan.
Diwarisi DariCallWithChatAdapterManagement.askDevicePermission
createStreamView(string, VideoStreamOptions)
Membuat tampilan html untuk aliran.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>Parameter
- remoteUserId
-
string
Id peserta yang akan dirender, biarkan tidak terdefinis untuk membuat tampilan kamera lokal
- options
- VideoStreamOptions
Opsi untuk mengontrol cara streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Mengembalikan
Promise<void | CreateVideoStreamViewResult>
Keterangan
Metode ini diimplementasikan untuk komposit.
Diwarisi DariCallWithChatAdapterManagement.createStreamView
deleteMessage(string)
Menghapus pesan di utas.
function deleteMessage(messageId: string): Promise<void>Parameter
- messageId
-
string
Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.deleteMessage
dispose()
disposeStreamView(string, VideoStreamOptions)
Buang tampilan html untuk aliran.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>Parameter
- remoteUserId
-
string
Id peserta yang akan dirender, biarkan tidak terdefinisi untuk membuang tampilan kamera lokal
- options
- VideoStreamOptions
Opsi untuk mengontrol cara streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Mengembalikan
Promise<void>
Keterangan
Metode ini diimplementasikan untuk komposit.
Diwarisi DariCallWithChatAdapterManagement.disposeStreamView
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(): CallWithChatAdapterStateMengembalikan
Diwarisi DariAdapterState.getState
joinCall(boolean)
Gabungkan panggilan dengan mikrofon yang awalnya aktif/nonaktif.
function joinCall(microphoneOn?: boolean): undefined | CallParameter
- microphoneOn
-
boolean
Apakah mikrofon awalnya diaktifkan
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 di 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
mute()
Matikan suara pengguna saat ini selama panggilan atau nonaktifkan mikrofon secara lokal.
function mute(): Promise<void>Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.mute
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("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)Parameter
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
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("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("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("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
offStateChange((state: CallWithChatAdapterState) => void)
Berhenti berlangganan handler ke peristiwa stateChanged.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)Parameter
- handler
-
(state: CallWithChatAdapterState) => void
Diwarisi DariAdapterState.offStateChange
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("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)Parameter
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
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("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("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("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
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
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
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 untuk digunakan dalam panggilan.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>Parameter
- sourceInfo
- VideoDeviceInfo
Perangkat kamera yang akan dipilih, pilih perangkat yang dikembalikan oleh queryCameras
- options
- VideoStreamOptions
Opsi untuk mengontrol bagaimana aliran kamera dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.setCamera
setMicrophone(AudioDeviceInfo)
Atur mikrofon untuk digunakan dalam panggilan.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>Parameter
- sourceInfo
- AudioDeviceInfo
Perangkat mikrofon untuk dipilih, pilih satu yang dikembalikan oleh kueriMicrophones
Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.setMicrophone
setSpeaker(AudioDeviceInfo)
Atur speaker untuk digunakan dalam panggilan.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>Parameter
- sourceInfo
- AudioDeviceInfo
Perangkat speaker untuk dipilih, pilih satu yang dikembalikan oleh querySpeakers
Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.setSpeaker
startCall(string[], StartCallOptions)
Mulai panggilan.
function startCall(participants: string[], options?: StartCallOptions): undefined | CallParameter
- 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 cara streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.startCamera
startScreenShare()
Mulai berbagi layar selama panggilan.
function startScreenShare(): Promise<void>Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.startScreenShare
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
stopScreenShare()
Berhenti berbagi layar.
function stopScreenShare(): Promise<void>Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.stopScreenShare
unmute()
Nyalakan suara pengguna saat ini selama panggilan atau aktifkan mikrofon secara lokal.
function unmute(): Promise<void>Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.unmute
updateMessage(string, string, Record<string, string>)
Memperbarui konten pesan.
function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>Parameter
- messageId
-
string
- content
-
string
- metadata
-
Record<string, string>
Mengembalikan
Promise<void>
Diwarisi DariCallWithChatAdapterManagement.updateMessage