CommonCallAdapter interface

Pakiet:

@azure/communication-react

CallComposite interfejs adaptera.

Rozszerzenie

AdapterState<CallAdapterState>,Disposable,CallAdapterCallOperations,CallAdapterDeviceManagement,CallAdapterSubscribers

Metody

joinCall(boolean)	Dołącz połączenie z mikrofonem początkowo włączony/wyłączony.
startCall(string[], StartCallOptions)	Uruchom wywołanie.

Metody dziedziczone

askDevicePermission(PermissionConstraints)	Poproś o uprawnienia urządzeń.
createStreamView(string, VideoStreamOptions)	Utwórz widok HTML dla strumienia.
dispose()	Usuwanie złożonego
disposeStreamView(string, VideoStreamOptions)	Usuwanie widoku HTML dla strumienia.
getState()	Pobieranie bieżącego stanu
leaveCall(boolean)	Opuść połączenie
mute()	Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie
off("callEnded", CallEndedListener)	Anuluj subskrypcję funkcji dla zdarzenia "callEnded".
off("callIdChanged", CallIdChangedListener)	Anuluj subskrypcję funkcji dla zdarzenia "callIdChanged".
off("diagnosticChanged", DiagnosticChangedEventListner)	Anuluj subskrypcję funkcji dla zdarzenia "diagnosticChanged".
off("displayNameChanged", DisplayNameChangedListener)	Anuluj subskrypcję funkcji dla zdarzenia "displayNameChanged".
off("error", (e: AdapterError) => void)	Anuluj subskrypcję funkcji dla zdarzenia "error".
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Funkcja anuluj subskrypcję zdarzenia "isLocalScreenSharingActiveChanged".
off("isMutedChanged", IsMutedChangedListener)	Funkcja anulowania subskrypcji zdarzenia "isMutedChanged".
off("isSpeakingChanged", IsSpeakingChangedListener)	Funkcja anuluj subskrypcję zdarzenia "isSpeakingChanged".
off("participantsJoined", ParticipantsJoinedListener)	Anuluj subskrypcję funkcji dla zdarzenia "participantsJoined".
off("participantsLeft", ParticipantsLeftListener)	Anuluj subskrypcję funkcji dla zdarzenia "participantsLeft".
off("selectedMicrophoneChanged", PropertyChangedEvent)	Anuluj subskrypcję funkcji dla zdarzenia "selectedMicrophoneChanged".
off("selectedSpeakerChanged", PropertyChangedEvent)	Funkcja anuluj subskrypcję zdarzenia "selectedSpeakerChanged".
offStateChange((state: CallAdapterState) => void)	Anuluje subskrypcję programu obsługi w celu stanuZmienianie zdarzeń.
on("callEnded", CallEndedListener)	Subskrybuj funkcję zdarzenia "callEnded".
on("callIdChanged", CallIdChangedListener)	Funkcja subskrybuj zdarzenie "callIdChanged".
on("diagnosticChanged", DiagnosticChangedEventListner)	Subskrybuj funkcję zdarzenia "diagnosticChanged". To zdarzenie jest uruchamiane za każdym razem, gdy wystąpi zmiana diagnostyki użytkownika na temat trwającego połączenia.
on("displayNameChanged", DisplayNameChangedListener)	Subskrybuj funkcję zdarzenia "displayNameChanged".
on("error", (e: AdapterError) => void)	Subskrybuj funkcję zdarzenia "error".
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Funkcja subskrybuj zdarzenie "isLocalScreenSharingActiveChanged".
on("isMutedChanged", IsMutedChangedListener)	Funkcja subskrybuj zdarzenie "isMutedChanged".
on("isSpeakingChanged", IsSpeakingChangedListener)	Funkcja subskrybuj zdarzenie "isSpeakingChanged".
on("participantsJoined", ParticipantsJoinedListener)	Subskrybuj funkcję zdarzenia "participantsJoined".
on("participantsLeft", ParticipantsLeftListener)	Subskrybuj funkcję zdarzenia "participantsLeft".
on("selectedMicrophoneChanged", PropertyChangedEvent)	Funkcja subskrybuj zdarzenie "selectedMicrophoneChanged". To zdarzenie jest uruchamiane za każdym razem, gdy użytkownik wybierze nowe urządzenie mikrofonu.
on("selectedSpeakerChanged", PropertyChangedEvent)	Funkcja subskrybuj zdarzenie "selectedSpeakerChanged". To zdarzenie jest uruchamiane za każdym razem, gdy użytkownik wybierze nowe urządzenie mówiące.
onStateChange((state: CallAdapterState) => void)	Subskrybuje program obsługi do zdarzeń stateChanged.
queryCameras()	Wykonywanie zapytań dotyczących dostępnych urządzeń z aparatami fotograficznymi.
queryMicrophones()	Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.
querySpeakers()	Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.
removeParticipant(string)	Usuń uczestnika z połączenia.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Ustaw aparat do użycia w wywołaniu.
setMicrophone(AudioDeviceInfo)	Ustaw mikrofon do użycia w wywołaniu.
setSpeaker(AudioDeviceInfo)	Ustaw głośnik do użycia w wywołaniu.
startCamera(VideoStreamOptions)	Uruchom aparat. Ta metoda rozpocznie renderowanie widoku aparatu lokalnego, gdy wywołanie nie jest aktywne
startScreenShare()	Rozpocznij udostępnianie ekranu podczas połączenia.
stopCamera()	Zatrzymaj kamerę Ta metoda przestanie renderować widok aparatu lokalnego, gdy wywołanie nie jest aktywne
stopScreenShare()	Zatrzymaj udostępnianie ekranu
unmute()	Wyciszanie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie

Szczegóły metody

joinCall(boolean)

Dołącz połączenie z mikrofonem początkowo włączony/wyłączony.

function joinCall(microphoneOn?: boolean)

Parametry

microphoneOn

boolean

Czy mikrofon jest początkowo włączony

startCall(string[], StartCallOptions)

Uruchom wywołanie.

function startCall(participants: string[], options?: StartCallOptions)

Parametry

participants

string[]

Tablica identyfikatorów uczestników do przyłączenia

options

StartCallOptions

Szczegóły metody dziedziczonej

askDevicePermission(PermissionConstraints)

Poproś o uprawnienia urządzeń.

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

Parametry

constrain

PermissionConstraints

Definiowanie ograniczeń dotyczących uzyskiwania dostępu do urządzeń lokalnych <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Zwraca

Promise<void>

Uwagi

Zostanie wyświetlone okno uprawnień przeglądarki, jeśli uprawnienia nie zostały jeszcze przyznane

dziedziczone zCallAdapterDeviceManagement.askDevicePermission

createStreamView(string, VideoStreamOptions)

Utwórz widok HTML dla strumienia.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parametry

remoteUserId

string

Identyfikator uczestnika do renderowania, pozostaw go niezdefiniowany, aby utworzyć lokalny widok aparatu

options

VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void | CreateVideoStreamViewResult>

Uwagi

Ta metoda jest implementowana dla złożonego

dziedziczone zCallAdapterCallOperations.createStreamView

dispose()

Usuwanie złożonego

function dispose()

dziedziczone z Jednorazowe.dispose

disposeStreamView(string, VideoStreamOptions)

Usuwanie widoku HTML dla strumienia.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parametry

remoteUserId

string

Identyfikator uczestnika do renderowania, pozostaw niezdefiniowany, aby usunąć widok aparatu lokalnego

options

VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla złożonego

dziedziczone zCallAdapterCallOperations.disposeStreamView

getState()

Pobieranie bieżącego stanu

function getState(): CallAdapterState

Zwraca

CallAdapterState

dziedziczone zAdapterState.getState

leaveCall(boolean)

Opuść połączenie

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

Parametry

forEveryone

boolean

Czy usunąć wszystkich uczestników podczas opuszczania

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.leaveCall

mute()

Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie

function mute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.mute

off("callEnded", CallEndedListener)

Anuluj subskrypcję funkcji dla zdarzenia "callEnded".

function off(event: "callEnded", listener: CallEndedListener)

Parametry

event

"callEnded"

listener

CallEndedListener

dziedziczone zCallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

Anuluj subskrypcję funkcji dla zdarzenia "callIdChanged".

function off(event: "callIdChanged", listener: CallIdChangedListener)

Parametry

event

"callIdChanged"

listener

CallIdChangedListener

dziedziczone zCallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Anuluj subskrypcję funkcji dla zdarzenia "diagnosticChanged".

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parametry

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

dziedziczone zCallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

Anuluj subskrypcję funkcji dla zdarzenia "displayNameChanged".

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

Parametry

event

"displayNameChanged"

listener

DisplayNameChangedListener

dziedziczone zCallAdapterSubscribers.off

off("error", (e: AdapterError) => void)

Anuluj subskrypcję funkcji dla zdarzenia "error".

function off(event: "error", listener: (e: AdapterError) => void)

Parametry

event

"error"

listener

(e: AdapterError) => void

dziedziczone zCallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Funkcja anuluj subskrypcję zdarzenia "isLocalScreenSharingActiveChanged".

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parametry

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

dziedziczone zCallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

Funkcja anulowania subskrypcji zdarzenia "isMutedChanged".

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

Parametry

event

"isMutedChanged"

listener

IsMutedChangedListener

dziedziczone zCallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Funkcja anuluj subskrypcję zdarzenia "isSpeakingChanged".

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

Parametry

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

dziedziczone zCallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

Anuluj subskrypcję funkcji dla zdarzenia "participantsJoined".

function off(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parametry

event

"participantsJoined"

listener

ParticipantsJoinedListener

dziedziczone zCallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

Anuluj subskrypcję funkcji dla zdarzenia "participantsLeft".

function off(event: "participantsLeft", listener: ParticipantsLeftListener)

Parametry

event

"participantsLeft"

listener

ParticipantsLeftListener

dziedziczone zCallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Anuluj subskrypcję funkcji dla zdarzenia "selectedMicrophoneChanged".

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

Parametry

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

dziedziczone zCallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Funkcja anuluj subskrypcję zdarzenia "selectedSpeakerChanged".

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

Parametry

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

dziedziczone zCallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

Anuluje subskrypcję programu obsługi w celu stanuZmienianie zdarzeń.

function offStateChange(handler: (state: CallAdapterState) => void)

Parametry

handler

(state: CallAdapterState) => void

dziedziczone zAdapterState.offStateChange

on("callEnded", CallEndedListener)

Subskrybuj funkcję zdarzenia "callEnded".

function on(event: "callEnded", listener: CallEndedListener)

Parametry

event

"callEnded"

listener

CallEndedListener

dziedziczone zCallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

Funkcja subskrybuj zdarzenie "callIdChanged".

function on(event: "callIdChanged", listener: CallIdChangedListener)

Parametry

event

"callIdChanged"

listener

CallIdChangedListener

Uwagi

Zdarzenie zostanie wyzwolone po zmianie identyfikatora callId bieżącego użytkownika.

dziedziczone zCallAdapterSubscribers.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Subskrybuj funkcję zdarzenia "diagnosticChanged".

To zdarzenie jest uruchamiane za każdym razem, gdy wystąpi zmiana diagnostyki użytkownika na temat trwającego połączenia.

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parametry

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

dziedziczone zCallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

Subskrybuj funkcję zdarzenia "displayNameChanged".

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

Parametry

event

"displayNameChanged"

listener

DisplayNameChangedListener

dziedziczone zCallAdapterSubscribers.on

on("error", (e: AdapterError) => void)

Subskrybuj funkcję zdarzenia "error".

function on(event: "error", listener: (e: AdapterError) => void)

Parametry

event

"error"

listener

(e: AdapterError) => void

dziedziczone zCallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Funkcja subskrybuj zdarzenie "isLocalScreenSharingActiveChanged".

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parametry

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

dziedziczone zCallAdapterSubscribers.on

on("isMutedChanged", IsMutedChangedListener)

Funkcja subskrybuj zdarzenie "isMutedChanged".

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

Parametry

event

"isMutedChanged"

listener

IsMutedChangedListener

Uwagi

Zdarzenie zostanie wyzwolone za każdym razem, gdy bieżący użytkownik lub stan wyciszenia użytkownika zdalnego uległ zmianie

dziedziczone zCallAdapterSubscribers.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Funkcja subskrybuj zdarzenie "isSpeakingChanged".

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

Parametry

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

dziedziczone zCallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

Subskrybuj funkcję zdarzenia "participantsJoined".

function on(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parametry

event

"participantsJoined"

listener

ParticipantsJoinedListener

dziedziczone zCallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

Subskrybuj funkcję zdarzenia "participantsLeft".

function on(event: "participantsLeft", listener: ParticipantsLeftListener)

Parametry

event

"participantsLeft"

listener

ParticipantsLeftListener

dziedziczone zCallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Funkcja subskrybuj zdarzenie "selectedMicrophoneChanged".

To zdarzenie jest uruchamiane za każdym razem, gdy użytkownik wybierze nowe urządzenie mikrofonu.

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

Parametry

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

dziedziczone zCallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Funkcja subskrybuj zdarzenie "selectedSpeakerChanged".

To zdarzenie jest uruchamiane za każdym razem, gdy użytkownik wybierze nowe urządzenie mówiące.

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

Parametry

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

dziedziczone zCallAdapterSubscribers.on

onStateChange((state: CallAdapterState) => void)

Subskrybuje program obsługi do zdarzeń stateChanged.

function onStateChange(handler: (state: CallAdapterState) => void)

Parametry

handler

(state: CallAdapterState) => void

dziedziczone zAdapterState.onStateChange

queryCameras()

Wykonywanie zapytań dotyczących dostępnych urządzeń z aparatami fotograficznymi.

function queryCameras(): Promise<VideoDeviceInfo[]>

Zwraca

Promise<VideoDeviceInfo[]>

Tablica jednostek informacji o urządzeniu wideo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Uwagi

Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()

dziedziczone zCallAdapterDeviceManagement.queryCameras

queryMicrophones()

Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Zwraca

Promise<AudioDeviceInfo[]>

Tablica jednostek informacji o urządzeniu audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Uwagi

Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()

dziedziczone zCallAdapterDeviceManagement.queryMicrophones

querySpeakers()

Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Zwraca

Promise<AudioDeviceInfo[]>

Tablica jednostek informacji o urządzeniu audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Uwagi

Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()

dziedziczone zCallAdapterDeviceManagement.querySpeakers

removeParticipant(string)

Usuń uczestnika z połączenia.

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

Parametry

userId

string

Identyfikator uczestnika do usunięcia

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.removeParticipant

setCamera(VideoDeviceInfo, VideoStreamOptions)

Ustaw aparat do użycia w wywołaniu.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parametry

sourceInfo

VideoDeviceInfo

Urządzenie aparatu do wyboru, wybierz jedno zwrócone przez queryCameras

options

VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumienia aparatu <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void>

dziedziczone zCallAdapterDeviceManagement.setCamera

setMicrophone(AudioDeviceInfo)

Ustaw mikrofon do użycia w wywołaniu.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parametry

sourceInfo

AudioDeviceInfo

Urządzenie mikrofonu do wyboru, wybierz jedno zwrócone przez zapytanieMicrophones

Zwraca

Promise<void>

dziedziczone zCallAdapterDeviceManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Ustaw głośnik do użycia w wywołaniu.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parametry

sourceInfo

AudioDeviceInfo

Urządzenie mówiące do wyboru, wybierz jedno zwrócone przez querySpeakers

Zwraca

Promise<void>

dziedziczone zCallAdapterDeviceManagement.setSpeaker

startCamera(VideoStreamOptions)

Uruchom aparat. Ta metoda rozpocznie renderowanie widoku aparatu lokalnego, gdy wywołanie nie jest aktywne

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

Parametry

options

VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.startCamera

startScreenShare()

Rozpocznij udostępnianie ekranu podczas połączenia.

function startScreenShare(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.startScreenShare

stopCamera()

Zatrzymaj kamerę Ta metoda przestanie renderować widok aparatu lokalnego, gdy wywołanie nie jest aktywne

function stopCamera(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.stopCamera

stopScreenShare()

Zatrzymaj udostępnianie ekranu

function stopScreenShare(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.stopScreenShare

unmute()

Wyciszanie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie

function unmute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.unmute