CallAdapterCallManagement interface

Paket:

@azure/communication-react

Peringatan

API ini sudah tidak digunakan lagi.

CallAdapter interface will be flatten, consider using CallAdapter directly

Fungsionalitas untuk mengelola panggilan saat ini atau memulai panggilan baru

Extends

CallAdapterCallOperations

Metode

joinCall(boolean)	Gabungkan panggilan dengan mikrofon yang awalnya aktif/nonaktif.
startCall(string[], StartCallOptions)	Mulai panggilan.

Metode yang Diwarisi

createStreamView(string, VideoStreamOptions)	Membuat tampilan html untuk aliran.
disposeStreamView(string, VideoStreamOptions)	Buang tampilan html untuk aliran.
leaveCall(boolean)	Tinggalkan panggilan
mute()	Mematikan suara pengguna saat ini selama panggilan atau menonaktifkan mikrofon secara lokal
removeParticipant(string)	Menghapus peserta dari panggilan.
startCamera(VideoStreamOptions)	Mulai kamera Metode ini akan mulai merender tampilan kamera lokal saat panggilan tidak aktif
startScreenShare()	Mulai berbagi layar selama panggilan.
stopCamera()	Hentikan kamera Metode ini akan berhenti merender tampilan kamera lokal saat panggilan tidak aktif
stopScreenShare()	Berhenti berbagi layar
unmute()	Nyalakan suara pengguna saat ini selama panggilan atau aktifkan mikrofon secara lokal

Detail Metode

joinCall(boolean)

Gabungkan panggilan dengan mikrofon yang awalnya aktif/nonaktif.

function joinCall(microphoneOn?: boolean): undefined | Call

Parameter

microphoneOn

boolean

Apakah mikrofon awalnya diaktifkan

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

Detail Metode yang Diwarisi

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 DariCallAdapterCallOperations.createStreamView

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 DariCallAdapterCallOperations.disposeStreamView

leaveCall(boolean)

Tinggalkan panggilan

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

Parameter

forEveryone

boolean

Apakah akan menghapus semua peserta saat keluar

Mengembalikan

Promise<void>

Diwarisi DariCallAdapterCallOperations.leaveCall

mute()

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

function mute(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi DariCallAdapterCallOperations.mute

removeParticipant(string)

Menghapus peserta dari panggilan.

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

Parameter

userId

string

Id peserta yang akan dihapus

Mengembalikan

Promise<void>

Diwarisi DariCallAdapterCallOperations.removeParticipant

startCamera(VideoStreamOptions)

Mulai kamera Metode ini akan mulai merender tampilan kamera lokal saat panggilan tidak aktif

function startCamera(options?: VideoStreamOptions): Promise<void>

Parameter

options

VideoStreamOptions

Opsi untuk mengontrol cara streaming video dirender <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Mengembalikan

Promise<void>

Diwarisi DariCallAdapterCallOperations.startCamera

startScreenShare()

Mulai berbagi layar selama panggilan.

function startScreenShare(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi DariCallAdapterCallOperations.startScreenShare

stopCamera()

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

function stopCamera(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi DariCallAdapterCallOperations.stopCamera

stopScreenShare()

Berhenti berbagi layar

function stopScreenShare(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi DariCallAdapterCallOperations.stopScreenShare

unmute()

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

function unmute(): Promise<void>

Mengembalikan

Promise<void>

Diwarisi DariCallAdapterCallOperations.unmute