RemoteParticipant interface

Paket:

@azure/communication-calling

Mewakili peserta jarak jauh dalam panggilan.

Memperluas

ParticipantInfo

Properti

callEndReason	Alasan mengapa peserta meninggalkan panggilan, berisi kode/subKode/pesan.
isMuted	Apakah peserta jarak jauh ini dibisukan atau tidak.
isSpeaking	Apakah peserta jarak jauh ini berbicara atau tidak.
role	Dapatkan peran peserta jarak jauh ini.
state	Dapatkan status peserta jarak jauh ini.
videoStreams	Kumpulan aliran video yang dimiliki peserta ini.

Properti yang Diwariskan

displayName	Nama tampilan opsional, jika diatur oleh titik akhir peserta jarak jauh tersebut.
endpointDetails	Dapatkan detail semua titik akhir untuk peserta jarak jauh ini
identifier	Dapatkan pengidentifikasi untuk peserta jarak jauh ini.

Metode

mute()	Matikan suara mikrofon peserta jarak jauh ini.
off("displayNameChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa displayNameChanged.
off("isMutedChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa isMutedChanged.
off("isSpeakingChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa isSpeakingChanged.
off("roleChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa roleChanged.
off("stateChanged", PropertyChangedEvent)	Berhenti berlangganan fungsi untuk peristiwa stateChanged.
off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)	Berhenti berlangganan fungsi untuk peristiwa videoStreamsUpdated.
on("displayNameChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa displayNameChanged.
on("isMutedChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa isMutedChanged.
on("isSpeakingChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa isSpeakingChanged.
on("roleChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa roleChanged.
on("stateChanged", PropertyChangedEvent)	Berlangganan fungsi untuk peristiwa stateChanged.
on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)	Berlangganan fungsi untuk peristiwa videoStreamsUpdated.

Detail Properti

callEndReason

Alasan mengapa peserta meninggalkan panggilan, berisi kode/subKode/pesan.

callEndReason?: CallEndReason

Nilai Properti

CallEndReason

isMuted

Apakah peserta jarak jauh ini dibisukan atau tidak.

isMuted: boolean

Nilai Properti

boolean

isSpeaking

Apakah peserta jarak jauh ini berbicara atau tidak.

isSpeaking: boolean

Nilai Properti

boolean

role

Dapatkan peran peserta jarak jauh ini.

role: ParticipantRole

Nilai Properti

ParticipantRole

state

Dapatkan status peserta jarak jauh ini.

state: RemoteParticipantState

Nilai Properti

RemoteParticipantState

videoStreams

Kumpulan aliran video yang dimiliki peserta ini.

videoStreams: readonly RemoteVideoStream[]

Nilai Properti

readonly RemoteVideoStream[]

Detail Properti yang Diwariskan

displayName

Nama tampilan opsional, jika diatur oleh titik akhir peserta jarak jauh tersebut.

displayName?: string

Nilai Properti

string

Diwariskan DariParticipantInfo.displayName

endpointDetails

Dapatkan detail semua titik akhir untuk peserta jarak jauh ini

endpointDetails: EndpointDetails[]

Nilai Properti

EndpointDetails[]

Diwariskan DariParticipantInfo.endpointDetails

identifier

Dapatkan pengidentifikasi untuk peserta jarak jauh ini.

identifier: CommunicationIdentifierKind

Nilai Properti

CommunicationIdentifierKind

Diwariskan DariParticipantInfo.identifier

Detail Metode

mute()

Matikan suara mikrofon peserta jarak jauh ini.

function mute(): Promise<void>

Mengembalikan

Promise<void>

off("displayNameChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa displayNameChanged.

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

Parameter

event

"displayNameChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

off("isMutedChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa isMutedChanged.

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

Parameter

event

"isMutedChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

off("isSpeakingChanged", PropertyChangedEvent)

Berhenti berlangganan fungsi untuk peristiwa isSpeakingChanged.

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

Parameter

event

"isSpeakingChanged"

nama peristiwa.

listener

PropertyChangedEvent

callback fn yang digunakan untuk berlangganan kejadian ini.

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.

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.

off("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Berhenti berlangganan fungsi untuk peristiwa videoStreamsUpdated.

function off(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)

Parameter

event

"videoStreamsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<RemoteVideoStream>

callback fn yang digunakan untuk berlangganan kejadian ini.

on("displayNameChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa displayNameChanged.

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

Parameter

event

"displayNameChanged"

nama peristiwa.

listener

PropertyChangedEvent

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

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.

on("isSpeakingChanged", PropertyChangedEvent)

Berlangganan fungsi untuk peristiwa isSpeakingChanged.

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

Parameter

event

"isSpeakingChanged"

nama peristiwa.

listener

PropertyChangedEvent

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

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.

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.

on("videoStreamsUpdated", CollectionUpdatedEvent<RemoteVideoStream>)

Berlangganan fungsi untuk peristiwa videoStreamsUpdated.

function on(event: "videoStreamsUpdated", listener: CollectionUpdatedEvent<RemoteVideoStream>)

Parameter

event

"videoStreamsUpdated"

nama peristiwa.

listener

CollectionUpdatedEvent<RemoteVideoStream>

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