Call interface

Paket:

@azure/communication-calling

Mewakili Panggilan.

Memperluas

CallCommon

Properti

info	Dapatkan informasi tentang Panggilan ini.

Properti yang Diwariskan

callEndReason	Berisi kode/subCode yang menunjukkan bagaimana panggilan ini berakhir.
callerInfo	Informasi Penelepon jika panggilan ini masuk.
direction	Dapatkan arah panggilan, apakah itu Masuk atau Keluar.
id	Dapatkan Id unik untuk Panggilan ini.
isIncomingAudioMuted	Apakah pengguna lokal mematikan audio masuk.
isLocalVideoStarted	Apakah video lokal aktif.
isMuted	Apakah pengguna lokal dibisukan, secara lokal atau jarak jauh.
isScreenSharingOn	Apakah berbagi layar aktif.
kind	Dapatkan jenis objek panggilan.
lobby	Dapatkan lobi rapat Teams.
localAudioStreams	Kumpulan aliran audio lokal yang dikirim ke peserta lain dalam panggilan.
localVideoStreams	Kumpulan aliran video lokal yang dikirim ke peserta lain dalam panggilan.
remoteAudioStreams	Kumpulan aliran audio jarak jauh yang diterima dari panggilan.
remoteParticipants	Kumpulan peserta jarak jauh dalam panggilan ini. Dalam kasus panggilan dengan peserta ratusan atau lebih, hanya peserta aktif media yang hadir dalam koleksi ini.
role	Dapatkan peran pengguna lokal dalam Panggilan.
state	Dapatkan status Panggilan ini.
totalParticipantCount	Jumlah total peserta dalam panggilan ini.

Metode

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)	Tambahkan peserta ke Panggilan ini.
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)	Tambahkan peserta ke Panggilan ini.
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)	Tambahkan Aplikasi Teams ke Panggilan ini.
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)	Tambahkan peserta ke Panggilan ini.
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Tambahkan peserta ke Panggilan ini.
removeParticipant(CommunicationIdentifier)	Hapus peserta dari Panggilan ini.

Metode yang Diwarisi

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	Mengambil objek Fitur yang diinisialisasi dan memoisasi dengan API yang diperluas. Periksa fitur objek.* untuk semua fitur panggilan yang diperluas yang tersedia dalam paket ini, misalnya: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Tutup teleponnya.
hold()	Tunggu panggilan ini.
mute()	Matikan suara mikrofon lokal.
muteAllRemoteParticipants()	Matikan suara semua peserta jarak jauh.
muteIncomingAudio()	Matikan suara audio masuk.
off("idChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa idChanged.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa isScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Berhenti berlangganan fungsi untuk peristiwa localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Berhenti berlangganan fungsi untuk kejadian localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa mutedByOthers.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Berhenti berlangganan fungsi untuk peristiwa remoteAudioStreamsUpdated.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Berhenti berlangganan fungsi untuk peristiwa remoteParticipantsUpdated.
off("roleChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa roleChanged.
off("stateChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)	berhenti berlangganan fungsi untuk peristiwa totalParticipantCountChanged.
on("idChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa idChanged.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa isIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa isScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Berlangganan fungsi untuk peristiwa localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Berlangganan fungsi untuk kejadian localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Berlangganan fungsi untuk peristiwa remoteAudioStreamsUpdated.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Berlangganan fungsi untuk peristiwa remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa roleChanged.
on("stateChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa totalParticipantCountChanged.
resume()	Lanjutkan Panggilan ini jika berada di status 'LocalHold'.
sendDtmf(DtmfTone)	Kirim nada DTMF.
setConstraints(CallConstraints)	Atur batasan panggilan. Metode ini menetapkan batasan maksimum berdasarkan nilai yang disediakan. Batasan akhir yang diterapkan akan kurang dari atau sama dengan nilai yang disediakan di sini untuk metode ini. Jika nilai 0 disediakan, maka tidak ada batasan yang akan diterapkan untuk batasan tersebut. Jika nilai yang tidak ditentukan disediakan, maka nilai sebelumnya yang digunakan akan digunakan untuk batasan tersebut.
startAudio(LocalAudioStream)	Mulai audio dalam panggilan dengan audio kustom. Sumber LocalAudioStream harus berupa MediaStream.
startScreenSharing()	Mulai mengirim aliran berbagi layar dalam panggilan. Browser akan meminta untuk memilih tab layar, aplikasi, atau browser. Mengirim aliran berbagi layar tidak didukung di iOS atau Android. Aliran berbagi layar masuk didukung di iOS dan Android.
startScreenSharing(LocalVideoStream)	Mulai mengirim aliran berbagi layar mentah dalam panggilan. Mengirim berbagi layar mentah tidak didukung di iOS atau Android. Berbagi layar mentah masuk didukung di iOS dan Android.
startVideo(LocalVideoStream)	Mulai kirim aliran video dalam panggilan. Peserta jarak jauh dalam panggilan akan menerima streaming video Anda sehingga mereka dapat merendernya di UI mereka.
stopAudio()	Hentikan audio kustom dalam panggilan dan beralih ke perangkat audio default manajer perangkat.
stopScreenSharing()	Hentikan berbagi layar lokal.
stopScreenSharing(LocalVideoStream)	Hentikan berbagi layar lokal.
stopVideo(LocalVideoStream)	Berhenti mengirim streaming video dalam panggilan. Harus melewati objek LocalVideoStream yang sama yang digunakan untuk memulai video di API CallAgent.startCall(), Api CallAgent.join(), API IncomingCall.accept(), atau API Call.startVideo().
unmute()	Nyalakan suara mikrofon lokal.
unmuteIncomingAudio()	Menyalakan suara audio masuk.

Detail Properti

info

Dapatkan informasi tentang Panggilan ini.

info: CallInfo

Nilai Properti

CallInfo

Detail Properti yang Diwariskan

callEndReason

Berisi kode/subCode yang menunjukkan bagaimana panggilan ini berakhir.

callEndReason?: CallEndReason

Nilai Properti

CallEndReason

Diwariskan DariCallCommon.callEndReason

callerInfo

Informasi Penelepon jika panggilan ini masuk.

callerInfo: CallerInfo

Nilai Properti

CallerInfo

Diwariskan DariCallCommon.callerInfo

direction

Dapatkan arah panggilan, apakah itu Masuk atau Keluar.

direction: CallDirection

Nilai Properti

CallDirection

Diwariskan Dari CallCommon.direction

id

Dapatkan Id unik untuk Panggilan ini.

id: string

Nilai Properti

string

Diwariskan DariCallCommon.id

isIncomingAudioMuted

Apakah pengguna lokal mematikan audio masuk.

isIncomingAudioMuted: boolean

Nilai Properti

boolean

Diwariskan DariCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Apakah video lokal aktif.

isLocalVideoStarted: boolean

Nilai Properti

boolean

Diwariskan DariCallCommon.isLocalVideoStarted

isMuted

Apakah pengguna lokal dibisukan, secara lokal atau jarak jauh.

isMuted: boolean

Nilai Properti

boolean

Diwariskan DariCallCommon.isMuted

isScreenSharingOn

Apakah berbagi layar aktif.

isScreenSharingOn: boolean

Nilai Properti

boolean

Diwarisi DariCallCommon.isScreenSharingOn

kind

Dapatkan jenis objek panggilan.

kind: CallKind

Nilai Properti

CallKind

Diwariskan DariCallCommon.kind

lobby

Dapatkan lobi rapat Teams.

lobby: Lobby

Nilai Properti

Lobby

Diwariskan DariCallCommon.lobby

localAudioStreams

Kumpulan aliran audio lokal yang dikirim ke peserta lain dalam panggilan.

localAudioStreams: readonly LocalAudioStream[]

Nilai Properti

readonly LocalAudioStream[]

Diwarisi DariCallCommon.localAudioStreams

localVideoStreams

Kumpulan aliran video lokal yang dikirim ke peserta lain dalam panggilan.

localVideoStreams: readonly LocalVideoStream[]

Nilai Properti

readonly LocalVideoStream[]

Diwariskan DariCallCommon.localVideoStreams

remoteAudioStreams

Kumpulan aliran audio jarak jauh yang diterima dari panggilan.

remoteAudioStreams: readonly RemoteAudioStream[]

Nilai Properti

readonly RemoteAudioStream[]

Diwarisi DariCallCommon.remoteAudioStreams

remoteParticipants

Kumpulan peserta jarak jauh dalam panggilan ini. Dalam kasus panggilan dengan peserta ratusan atau lebih, hanya peserta aktif media yang hadir dalam koleksi ini.

remoteParticipants: readonly RemoteParticipant[]

Nilai Properti

readonly RemoteParticipant[]

Diwarisi DariCallCommon.remoteParticipants

role

Dapatkan peran pengguna lokal dalam Panggilan.

role: ParticipantRole

Nilai Properti

ParticipantRole

Diwariskan DariCallCommon.role

state

Dapatkan status Panggilan ini.

state: CallState

Nilai Properti

CallState

Diwariskan Dari CallCommon.state

totalParticipantCount

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Jumlah total peserta dalam panggilan ini.

totalParticipantCount: number

Nilai Properti

number

Diwarisi DariCallCommon.totalParticipantCount

Detail Metode

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)

Tambahkan peserta ke Panggilan ini.

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

Parameter

identifier

CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier

Pengidentifikasi peserta yang akan ditambahkan.

Mengembalikan

RemoteParticipant

Objek RemoteParticipant yang terkait dengan peserta yang berhasil ditambahkan.

addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Tambahkan peserta ke Panggilan ini.

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

Parameter

identifier

CommunicationUserIdentifier

Pengidentifikasi peserta yang akan ditambahkan.

options

AddCommunicationUserOptions

Opsi tambahan untuk mengelola panggilan.

Mengembalikan

RemoteParticipant

Objek RemoteParticipant yang terkait dengan peserta yang berhasil ditambahkan.

addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Tambahkan Aplikasi Teams ke Panggilan ini.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

Parameter

identifier

MicrosoftTeamsAppIdentifier | UnknownIdentifier

Pengidentifikasi Aplikasi Teams yang akan ditambahkan.

Mengembalikan

RemoteParticipant

Objek RemoteParticipant yang terkait dengan Aplikasi Teams yang berhasil ditambahkan.

addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Tambahkan peserta ke Panggilan ini.

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

Parameter

identifier

MicrosoftTeamsUserIdentifier

Pengidentifikasi peserta yang akan ditambahkan.

options

AddMicrosoftTeamsUserOptions

Opsi tambahan untuk mengelola panggilan.

Mengembalikan

RemoteParticipant

Objek RemoteParticipant yang terkait dengan peserta yang berhasil ditambahkan.

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Tambahkan peserta ke Panggilan ini.

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

Parameter

identifier

PhoneNumberIdentifier

Pengidentifikasi peserta yang akan ditambahkan.

options

AddPhoneNumberOptions

Opsi tambahan untuk mengelola panggilan PSTN. Misalnya, mengatur nomor telepon Id Penelepon dalam panggilan PSTN.

Mengembalikan

RemoteParticipant

Objek RemoteParticipant yang terkait dengan peserta yang berhasil ditambahkan.

removeParticipant(CommunicationIdentifier)

Hapus peserta dari Panggilan ini.

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

Parameter

identifier

CommunicationIdentifier

Pengidentifikasi peserta yang akan dihapus.

Mengembalikan

Promise<void>

Detail Metode yang Diwarisi

dispose()

function dispose()

Diwariskan DariCallCommon.dispose

feature<TFeature>(CallFeatureFactory<TFeature>)

Mengambil objek Fitur yang diinisialisasi dan memoisasi dengan API yang diperluas. Periksa fitur objek.* untuk semua fitur panggilan yang diperluas yang tersedia dalam paket ini, misalnya:

const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')

function feature<TFeature>(factory: CallFeatureFactory<TFeature>): TFeature

Parameter

factory

CallFeatureFactory<TFeature>

Pabrik untuk konstruktor fitur panggilan yang menyediakan API yang diperluas.

Mengembalikan

TFeature

Diwariskan Dari fitur CallCommon.

hangUp(HangUpOptions)

Tutup teleponnya.

function hangUp(options?: HangUpOptions): Promise<void>

Parameter

options

HangUpOptions

Opsi HangUp.

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.hangUp

hold()

Tunggu panggilan ini.

function hold(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan Dari callCommon.hold

mute()

Matikan suara mikrofon lokal.

function mute(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan Dari CallCommon.mute

muteAllRemoteParticipants()

Matikan suara semua peserta jarak jauh.

function muteAllRemoteParticipants(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Matikan suara audio masuk.

function muteIncomingAudio(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi DariCallCommon.muteIncomingAudio

off("idChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa idChanged.

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

Parameter

event

"idChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

Diwariskan DariCallCommon.off

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa isIncomingAudioMutedChanged.

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

Parameter

event

"isIncomingAudioMutedChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwariskan DariCallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa isLocalVideoStartedChanged.

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

Parameter

event

"isLocalVideoStartedChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwariskan DariCallCommon.off

off("isMutedChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa isMutedChanged.

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

Parameter

event

"isMutedChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwariskan DariCallCommon.off

off("isScreenSharingOnChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa isScreenSharingChanged.

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

Parameter

event

"isScreenSharingOnChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

Diwariskan DariCallCommon.off

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Berhenti berlangganan fungsi untuk peristiwa localAudioStreamsUpdated.

function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Parameter

event

"localAudioStreamsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn yang digunakan untuk berlangganan kejadian ini.

Diwariskan DariCallCommon.off

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Berhenti berlangganan fungsi untuk kejadian localVideoStreamsUpdated.

function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Parameter

event

"localVideoStreamsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn yang digunakan untuk berlangganan kejadian ini.

Diwariskan DariCallCommon.off

off("mutedByOthers", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa mutedByOthers.

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

Parameter

event

"mutedByOthers"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang digunakan untuk berhenti berlangganan kejadian ini.

Diwariskan DariCallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Berhenti berlangganan fungsi untuk peristiwa remoteAudioStreamsUpdated.

function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Parameter

event

"remoteAudioStreamsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn yang digunakan untuk berlangganan kejadian ini.

Diwariskan DariCallCommon.off

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Berhenti berlangganan fungsi untuk peristiwa remoteParticipantsUpdated.

function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parameter

event

"remoteParticipantsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn yang digunakan untuk berlangganan kejadian ini.

Diwariskan DariCallCommon.off

off("roleChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa roleChanged.

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

Parameter

event

"roleChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

Diwariskan DariCallCommon.off

off("stateChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa stateChanged.

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

Parameter

event

"stateChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

Diwariskan DariCallCommon.off

off("totalParticipantCountChanged", PropertyChangedEvent)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

berhenti berlangganan fungsi untuk peristiwa totalParticipantCountChanged.

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

Parameter

event

"totalParticipantCountChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika jumlah peserta berubah.

Diwariskan DariCallCommon.off

on("idChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa idChanged.

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

Parameter

event

"idChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwarisi DariCallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa isIncomingAudioMutedChanged.

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

Parameter

event

"isIncomingAudioMutedChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwarisi DariCallCommon.on

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa isLocalVideoStartedChanged.

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

Parameter

event

"isLocalVideoStartedChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwarisi DariCallCommon.on

on("isMutedChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa isMutedChanged.

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

Parameter

event

"isMutedChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwarisi DariCallCommon.on

on("isScreenSharingOnChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa isScreenSharingChanged.

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

Parameter

event

"isScreenSharingOnChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwarisi DariCallCommon.on

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Berlangganan fungsi untuk peristiwa localAudioStreamsUpdated.

function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

Parameter

event

"localAudioStreamsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn yang akan dipanggil ketika koleksi ini akan berubah, itu akan melewati array elemen yang ditambahkan dan dihapus.

Diwarisi DariCallCommon.on

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Berlangganan fungsi untuk kejadian localVideoStreamsUpdated.

function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

Parameter

event

"localVideoStreamsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn yang akan dipanggil ketika koleksi ini akan berubah, itu akan melewati array elemen yang ditambahkan dan dihapus.

Diwarisi DariCallCommon.on

on("mutedByOthers", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa mutedByOthers.

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

Parameter

event

"mutedByOthers"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

Diwarisi DariCallCommon.on

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Berlangganan fungsi untuk peristiwa remoteAudioStreamsUpdated.

function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

Parameter

event

"remoteAudioStreamsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn yang akan dipanggil ketika koleksi ini akan berubah, itu akan melewati array elemen yang ditambahkan dan dihapus.

Diwarisi DariCallCommon.on

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Berlangganan fungsi untuk peristiwa remoteParticipantsUpdated.

function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

Parameter

event

"remoteParticipantsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn yang akan dipanggil ketika koleksi ini akan berubah, itu akan melewati array elemen yang ditambahkan dan dihapus.

Diwarisi DariCallCommon.on

on("roleChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa roleChanged.

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

Parameter

event

"roleChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwarisi DariCallCommon.on

on("stateChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa stateChanged.

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

Parameter

event

"stateChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika nilai properti ini akan berubah.

Diwarisi DariCallCommon.on

on("totalParticipantCountChanged", PropertyChangedEvent)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Berlangganan fungsi untuk peristiwa totalParticipantCountChanged.

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

Parameter

event

"totalParticipantCountChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang akan dipanggil ketika jumlah peserta berubah.

Diwarisi DariCallCommon.on

resume()

Lanjutkan Panggilan ini jika berada di status 'LocalHold'.

function resume(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.resume

sendDtmf(DtmfTone)

Kirim nada DTMF.

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

Parameter

dtmfTone

DtmfTone

Mengembalikan

Promise<void>

Diwariskan Dari CallCommon.sendDtmf

setConstraints(CallConstraints)

Atur batasan panggilan. Metode ini menetapkan batasan maksimum berdasarkan nilai yang disediakan. Batasan akhir yang diterapkan akan kurang dari atau sama dengan nilai yang disediakan di sini untuk metode ini. Jika nilai 0 disediakan, maka tidak ada batasan yang akan diterapkan untuk batasan tersebut. Jika nilai yang tidak ditentukan disediakan, maka nilai sebelumnya yang digunakan akan digunakan untuk batasan tersebut.

function setConstraints(constraints: CallConstraints): Promise<void>

Parameter

constraints

CallConstraints

Objek yang mewakili batasan panggilan yang akan diatur

Mengembalikan

Promise<void>

Diwariskan Dari CallCommon.setConstraints

startAudio(LocalAudioStream)

Mulai audio dalam panggilan dengan audio kustom. Sumber LocalAudioStream harus berupa MediaStream.

function startAudio(localAudioStream: LocalAudioStream): Promise<void>

Parameter

localAudioStream

LocalAudioStream

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.startAudio

startScreenSharing()

• Mulai mengirim aliran berbagi layar dalam panggilan. Browser akan meminta untuk memilih tab layar, aplikasi, atau browser.
• Mengirim aliran berbagi layar tidak didukung di iOS atau Android.
• Aliran berbagi layar masuk didukung di iOS dan Android.

function startScreenSharing(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.startScreenSharing

startScreenSharing(LocalVideoStream)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

• Mulai mengirim aliran berbagi layar mentah dalam panggilan.
• Mengirim berbagi layar mentah tidak didukung di iOS atau Android.
• Berbagi layar mentah masuk didukung di iOS dan Android.

function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Parameter

localVideoStream

LocalVideoStream

Mewakili aliran berbagi layar mentah lokal yang mengambil MediaStream di konstruktor.

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.startScreenSharing

startVideo(LocalVideoStream)

Mulai kirim aliran video dalam panggilan. Peserta jarak jauh dalam panggilan akan menerima streaming video Anda sehingga mereka dapat merendernya di UI mereka.

function startVideo(localVideoStream: LocalVideoStream): Promise<void>

Parameter

localVideoStream

LocalVideoStream

Mewakili aliran video lokal yang mengambil sumber kamera di konstruktor.

Mengembalikan

Promise<void>

Diwarisi DariCallCommon.startVideo

stopAudio()

Hentikan audio kustom dalam panggilan dan beralih ke perangkat audio default manajer perangkat.

function stopAudio()

Diwarisi DariCallCommon.stopAudio

stopScreenSharing()

Hentikan berbagi layar lokal.

function stopScreenSharing(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.stopScreenSharing

stopScreenSharing(LocalVideoStream)

Catatan

API ini berada dalam mode Beta dan disediakan sebagai pratinjau untuk pengembang dan dapat berubah berdasarkan umpan balik yang kami terima. Jangan gunakan API ini dalam lingkungan produksi.

Hentikan berbagi layar lokal.

function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

Parameter

localVideoStream

LocalVideoStream

Aliran berbagi layar lokal untuk menghentikan streaming.

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.stopScreenSharing

stopVideo(LocalVideoStream)

Berhenti mengirim streaming video dalam panggilan. Harus melewati objek LocalVideoStream yang sama yang digunakan untuk memulai video di API CallAgent.startCall(), Api CallAgent.join(), API IncomingCall.accept(), atau API Call.startVideo().

function stopVideo(localVideoStream: LocalVideoStream): Promise<void>

Parameter

localVideoStream

LocalVideoStream

Streaming video lokal untuk menghentikan streaming.

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.stopVideo

unmute()

Nyalakan suara mikrofon lokal.

function unmute(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.unmute

unmuteIncomingAudio()

Menyalakan suara audio masuk.

function unmuteIncomingAudio(): Promise<void>

Mengembalikan

Promise<void>

Diwariskan DariCallCommon.unmuteIncomingAudio