TeamsCall interface

Pakiet:

@azure/communication-calling

Reprezentuje wywołanie usługi Teams.

Rozszerzenie

CallCommon

Właściwości

info	Uzyskaj informacje o tym wywołaniu usługi Teams.

Właściwości dziedziczone

callEndReason	Zawierające kod/podkodowanie wskazujące, jak zakończyło się to wywołanie.
callerInfo	Informacje o obiekcie wywołującym, jeśli to wywołanie jest przychodzące.
direction	Uzyskaj kierunek wywołania niezależnie od tego, czy jest to przychodzący, czy wychodzący.
id	Pobierz unikatowy identyfikator dla tego wywołania.
isIncomingAudioMuted	Określa, czy użytkownik lokalny wyciszy przychodzący dźwięk.
isLocalVideoStarted	Czy lokalne wideo jest włączone.
isMuted	Niezależnie od tego, czy użytkownik lokalny jest wyciszony, lokalnie czy zdalnie.
isScreenSharingOn	Czy udostępnianie ekranu jest włączone.
kind	Pobierz rodzaj obiektu wywołania.
lobby	Uzyskaj lobby spotkań usługi Teams.
localAudioStreams	Kolekcja lokalnych strumieni audio wysyłanych do innych uczestników połączenia.
localVideoStreams	Kolekcja lokalnych strumieni wideo wysyłanych do innych uczestników połączenia.
remoteAudioStreams	Kolekcja zdalnych strumieni audio odbieranych z wywołania.
remoteParticipants	Kolekcja uczestników zdalnych w tym wywołaniu. W przypadku połączeń z uczestnikami setek lub więcej, w tej kolekcji znajdują się tylko aktywni uczestnicy multimediów.
role	Pobierz rolę użytkownika lokalnego w wywołaniu.
state	Uzyskaj stan tego połączenia.
totalParticipantCount	Łączna liczba uczestników tego połączenia.

Metody

addParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, AddTeamsParticipantOptions)	Dodaj uczestnika.
removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)	Usuń uczestnika z tego połączenia.

Metody dziedziczone

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	Pobiera zainicjowany i zapamiętany obiekt funkcji z rozszerzonym interfejsem API. Sprawdź funkcje obiektu.* dla wszystkich dostępnych funkcji wywołań rozszerzonych w tym pakiecie, na przykład: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Rozłącz połączenie.
hold()	Wstrzymaj to połączenie.
mute()	Wycisz mikrofon lokalny.
muteAllRemoteParticipants()	Wycisz wszystkich uczestników zdalnych.
muteIncomingAudio()	Wycisz przychodzący dźwięk.
off("idChanged", PropertyChangedEvent)	Anuluj subskrypcję funkcji dla zdarzenia idChanged.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funkcja subskrybuj dla zdarzenia isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Funkcja anuluj subskrypcję dla zdarzenia isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)	Funkcja subskrybuj dla zdarzenia isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Funkcja anulowania subskrypcji dla zdarzenia isScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Funkcja anuluj subskrypcję dla zdarzenia localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Funkcja anuluj subskrypcję dla zdarzenia localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	Anuluj subskrypcję funkcji dla zdarzenia mutedByOthers.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funkcja anuluj subskrypcję zdarzenia remoteAudioStreamsUpdated.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Anuluj subskrypcję funkcji remoteParticipantsUpdated zdarzenia.
off("roleChanged", PropertyChangedEvent)	Anuluj subskrypcję funkcji dla zdarzenia roleChanged.
off("stateChanged", PropertyChangedEvent)	Funkcja anulowania subskrypcji dla zdarzenia stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)	funkcja anulowania subskrypcji dla zdarzenia totalParticipantCountChanged.
on("idChanged", PropertyChangedEvent)	Subskrybuj funkcję dla zdarzenia idChanged.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funkcja subskrybuj dla zdarzenia isIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Funkcja subskrybuj dla zdarzenia isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	Funkcja subskrybuj dla zdarzenia isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Funkcja subskrybuj dla zdarzenia isScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Funkcja subskrybuj dla zdarzenia localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Subskrybuj funkcję dla zdarzenia localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	Subskrybuj funkcję dla zdarzenia mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funkcja subskrybuj zdarzenie remoteAudioStreamsUpdated.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funkcja subskrybuj zdarzenia remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)	Subskrybuj funkcję dla zdarzenia roleChanged.
on("stateChanged", PropertyChangedEvent)	Subskrybuj funkcję dla zdarzenia stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)	Funkcja subskrybuj dla zdarzenia totalParticipantCountChanged.
resume()	Wznów to wywołanie, jeśli jest w stanie "LocalHold".
sendDtmf(DtmfTone)	Wyślij ton DTMF.
setConstraints(CallConstraints)	Ustawianie ograniczeń wywołań. Ta metoda ustawia maksymalne ograniczenia na podstawie podanych wartości. Ostateczne zastosowane ograniczenia będą mniejsze lub równe wartościom podanym tutaj w tej metodzie. Jeśli zostanie podana wartość 0, dla tego ograniczenia nie zostanie zastosowane żadne ograniczenie. Jeśli podano niezdefiniowaną wartość, zostanie użyta poprzednia wartość dla tego ograniczenia.
startAudio(LocalAudioStream)	Uruchom dźwięk w wywołaniu za pomocą niestandardowego dźwięku. Źródło LocalAudioStream powinno być elementem MediaStream.
startScreenSharing()	Rozpocznij wysyłanie strumienia udostępniania ekranu w wywołaniu. Przeglądarka wyświetli monit o wybranie ekranu, aplikacji lub karty przeglądarki. Wysyłanie strumienia udostępniania ekranu nie jest obsługiwane w systemach iOS ani Android. Strumień udostępniania ekranu przychodzącego jest obsługiwany w systemach iOS i Android.
startScreenSharing(LocalVideoStream)	Rozpocznij wysyłanie nieprzetworzonego strumienia udostępniania ekranu w wywołaniu. Wysyłanie nieprzetworzonego udostępniania ekranu nie jest obsługiwane w systemach iOS ani Android. Przychodzące udostępnianie nieprzetworzonych ekranów jest obsługiwane w systemach iOS i Android.
startVideo(LocalVideoStream)	Rozpocznij wysyłanie strumienia wideo w wywołaniu. Zdalni uczestnicy wywołania otrzymają strumień wideo, aby mogli go renderować w swoich interfejsach użytkownika.
stopAudio()	Zatrzymaj niestandardowy dźwięk w wywołaniu i przełącz się do domyślnego urządzenia audio menedżera urządzeń.
stopScreenSharing()	Zatrzymaj udostępnianie ekranu lokalnego.
stopScreenSharing(LocalVideoStream)	Zatrzymaj udostępnianie ekranu lokalnego.
stopVideo(LocalVideoStream)	Zatrzymaj wysyłanie strumienia wideo w wywołaniu. Musi przekazać ten sam obiekt LocalVideoStream, który został użyty do uruchomienia wideo w interfejsie API CallAgent.startCall(), CallAgent.join() API, IncomingCall.accept() API lub Call.startVideo().
unmute()	Anuluj wyciszanie mikrofonu lokalnego.
unmuteIncomingAudio()	Anuluj wyciszanie przychodzącego dźwięku.

Szczegóły właściwości

info

Uzyskaj informacje o tym wywołaniu usługi Teams.

info: TeamsCallInfo

Wartość właściwości

TeamsCallInfo

Szczegóły właściwości dziedziczonej

callEndReason

Zawierające kod/podkodowanie wskazujące, jak zakończyło się to wywołanie.

callEndReason?: CallEndReason

Wartość właściwości

CallEndReason

dziedziczone zCallCommon.callEndReason

callerInfo

Informacje o obiekcie wywołującym, jeśli to wywołanie jest przychodzące.

callerInfo: CallerInfo

Wartość właściwości

CallerInfo

dziedziczone zCallCommon.callerInfo

direction

Uzyskaj kierunek wywołania niezależnie od tego, czy jest to przychodzący, czy wychodzący.

direction: CallDirection

Wartość właściwości

CallDirection

dziedziczone zCallCommon.direction

id

Pobierz unikatowy identyfikator dla tego wywołania.

id: string

Wartość właściwości

string

dziedziczone zCallCommon.id

isIncomingAudioMuted

Określa, czy użytkownik lokalny wyciszy przychodzący dźwięk.

isIncomingAudioMuted: boolean

Wartość właściwości

boolean

dziedziczone zCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Czy lokalne wideo jest włączone.

isLocalVideoStarted: boolean

Wartość właściwości

boolean

dziedziczone zCallCommon.isLocalVideoStarted

isMuted

Niezależnie od tego, czy użytkownik lokalny jest wyciszony, lokalnie czy zdalnie.

isMuted: boolean

Wartość właściwości

boolean

dziedziczone zCallCommon.isMuted

isScreenSharingOn

Czy udostępnianie ekranu jest włączone.

isScreenSharingOn: boolean

Wartość właściwości

boolean

dziedziczone zCallCommon.isScreenSharingOn

kind

Pobierz rodzaj obiektu wywołania.

kind: CallKind

Wartość właściwości

CallKind

dziedziczone zCallCommon.kind

lobby

Uzyskaj lobby spotkań usługi Teams.

lobby: Lobby

Wartość właściwości

Lobby

dziedziczone zCallCommon.lobby

localAudioStreams

Kolekcja lokalnych strumieni audio wysyłanych do innych uczestników połączenia.

localAudioStreams: readonly LocalAudioStream[]

Wartość właściwości

readonly LocalAudioStream[]

dziedziczone zCallCommon.localAudioStreams

localVideoStreams

Kolekcja lokalnych strumieni wideo wysyłanych do innych uczestników połączenia.

localVideoStreams: readonly LocalVideoStream[]

Wartość właściwości

readonly LocalVideoStream[]

dziedziczone zCallCommon.localVideoStreams

remoteAudioStreams

Kolekcja zdalnych strumieni audio odbieranych z wywołania.

remoteAudioStreams: readonly RemoteAudioStream[]

Wartość właściwości

readonly RemoteAudioStream[]

dziedziczone zCallCommon.remoteAudioStreams

remoteParticipants

Kolekcja uczestników zdalnych w tym wywołaniu. W przypadku połączeń z uczestnikami setek lub więcej, w tej kolekcji znajdują się tylko aktywni uczestnicy multimediów.

remoteParticipants: readonly RemoteParticipant[]

Wartość właściwości

readonly RemoteParticipant[]

dziedziczone zCallCommon.remoteParticipants

role

Pobierz rolę użytkownika lokalnego w wywołaniu.

role: ParticipantRole

Wartość właściwości

ParticipantRole

dziedziczone zCallCommon.role

state

Uzyskaj stan tego połączenia.

state: CallState

Wartość właściwości

CallState

dziedziczone zCallCommon.state

totalParticipantCount

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

Łączna liczba uczestników tego połączenia.

totalParticipantCount: number

Wartość właściwości

number

dziedziczone zCallCommon.totalParticipantCount

Szczegóły metody

addParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, AddTeamsParticipantOptions)

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

Dodaj uczestnika.

function addParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, options?: AddTeamsParticipantOptions): RemoteParticipant

Parametry

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

Uczestnik do dodania

options

AddTeamsParticipantOptions

AddTeamsParticipantOptions

Zwraca

RemoteParticipant

removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)

Usuń uczestnika z tego połączenia.

function removeParticipant(participant: PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier): Promise<void>

Parametry

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier

uczestnik, który ma zostać usunięty.

Zwraca

Promise<void>

Szczegóły metody dziedziczonej

dispose()

function dispose()

dziedziczone zCallCommon.dispose

feature<TFeature>(CallFeatureFactory<TFeature>)

Pobiera zainicjowany i zapamiętany obiekt funkcji z rozszerzonym interfejsem API. Sprawdź funkcje obiektu.* dla wszystkich dostępnych funkcji wywołań rozszerzonych w tym pakiecie, na przykład:

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

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

Parametry

factory

CallFeatureFactory<TFeature>

Fabryka konstruktora funkcji wywołania, który udostępnia rozszerzony interfejs API.

Zwraca

TFeature

dziedziczone zCallCommon.feature

hangUp(HangUpOptions)

Rozłącz połączenie.

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

Parametry

options

HangUpOptions

Opcje HangUp.

Zwraca

Promise<void>

dziedziczone zCallCommon.hangUp

hold()

Wstrzymaj to połączenie.

function hold(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallCommon.hold

mute()

Wycisz mikrofon lokalny.

function mute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallCommon.mute

muteAllRemoteParticipants()

Wycisz wszystkich uczestników zdalnych.

function muteAllRemoteParticipants(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Wycisz przychodzący dźwięk.

function muteIncomingAudio(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallCommon.muteIncomingAudio

off("idChanged", PropertyChangedEvent)

Anuluj subskrypcję funkcji dla zdarzenia idChanged.

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

Parametry

event

"idChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

dziedziczone zCallCommon.off

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Funkcja subskrybuj dla zdarzenia isIncomingAudioMutedChanged.

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

Parametry

event

"isIncomingAudioMutedChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Funkcja anuluj subskrypcję dla zdarzenia isLocalVideoStartedChanged.

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

Parametry

event

"isLocalVideoStartedChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.off

off("isMutedChanged", PropertyChangedEvent)

Funkcja subskrybuj dla zdarzenia isMutedChanged.

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

Parametry

event

"isMutedChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.off

off("isScreenSharingOnChanged", PropertyChangedEvent)

Funkcja anulowania subskrypcji dla zdarzenia isScreenSharingChanged.

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

Parametry

event

"isScreenSharingOnChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

dziedziczone zCallCommon.off

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Funkcja anuluj subskrypcję dla zdarzenia localAudioStreamsUpdated.

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

Parametry

event

"localAudioStreamsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<LocalAudioStream>

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

dziedziczone zCallCommon.off

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Funkcja anuluj subskrypcję dla zdarzenia localVideoStreamsUpdated.

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

Parametry

event

"localVideoStreamsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<LocalVideoStream>

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

dziedziczone zCallCommon.off

off("mutedByOthers", PropertyChangedEvent)

Anuluj subskrypcję funkcji dla zdarzenia mutedByOthers.

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

Parametry

event

"mutedByOthers"

nazwa zdarzenia.

listener

PropertyChangedEvent

fn wywołania zwrotnego, który został użyty do anulowania subskrypcji tego zdarzenia.

dziedziczone zCallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Funkcja anuluj subskrypcję zdarzenia remoteAudioStreamsUpdated.

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

Parametry

event

"remoteAudioStreamsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<RemoteAudioStream>

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

dziedziczone zCallCommon.off

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Anuluj subskrypcję funkcji remoteParticipantsUpdated zdarzenia.

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

Parametry

event

"remoteParticipantsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<RemoteParticipant>

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

dziedziczone zCallCommon.off

off("roleChanged", PropertyChangedEvent)

Anuluj subskrypcję funkcji dla zdarzenia roleChanged.

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

Parametry

event

"roleChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

dziedziczone zCallCommon.off

off("stateChanged", PropertyChangedEvent)

Funkcja anulowania subskrypcji dla zdarzenia stateChanged.

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

Parametry

event

"stateChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

dziedziczone zCallCommon.off

off("totalParticipantCountChanged", PropertyChangedEvent)

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

funkcja anulowania subskrypcji dla zdarzenia totalParticipantCountChanged.

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

Parametry

event

"totalParticipantCountChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

fn wywołania zwrotnego, które będą wywoływane, gdy liczba uczestników ulegnie zmianie.

dziedziczone zCallCommon.off

on("idChanged", PropertyChangedEvent)

Subskrybuj funkcję dla zdarzenia idChanged.

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

Parametry

event

"idChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Funkcja subskrybuj dla zdarzenia isIncomingAudioMutedChanged.

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

Parametry

event

"isIncomingAudioMutedChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.on

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Funkcja subskrybuj dla zdarzenia isLocalVideoStartedChanged.

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

Parametry

event

"isLocalVideoStartedChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.on

on("isMutedChanged", PropertyChangedEvent)

Funkcja subskrybuj dla zdarzenia isMutedChanged.

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

Parametry

event

"isMutedChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.on

on("isScreenSharingOnChanged", PropertyChangedEvent)

Funkcja subskrybuj dla zdarzenia isScreenSharingChanged.

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

Parametry

event

"isScreenSharingOnChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.on

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Funkcja subskrybuj dla zdarzenia localAudioStreamsUpdated.

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

Parametry

event

"localAudioStreamsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<LocalAudioStream>

wywołanie zwrotne, które będzie wywoływane po zmianie tej kolekcji, przekaże tablice dodanych i usuniętych elementów.

dziedziczone zCallCommon.on

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Subskrybuj funkcję dla zdarzenia localVideoStreamsUpdated.

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

Parametry

event

"localVideoStreamsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<LocalVideoStream>

wywołanie zwrotne, które będzie wywoływane po zmianie tej kolekcji, przekaże tablice dodanych i usuniętych elementów.

dziedziczone zCallCommon.on

on("mutedByOthers", PropertyChangedEvent)

Subskrybuj funkcję dla zdarzenia mutedByOthers.

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

Parametry

event

"mutedByOthers"

nazwa zdarzenia.

listener

PropertyChangedEvent

fn wywołania zwrotnego, który został użyty do subskrybowania tego zdarzenia.

dziedziczone zCallCommon.on

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Funkcja subskrybuj zdarzenie remoteAudioStreamsUpdated.

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

Parametry

event

"remoteAudioStreamsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<RemoteAudioStream>

wywołanie zwrotne, które będzie wywoływane po zmianie tej kolekcji, przekaże tablice dodanych i usuniętych elementów.

dziedziczone zCallCommon.on

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Funkcja subskrybuj zdarzenia remoteParticipantsUpdated.

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

Parametry

event

"remoteParticipantsUpdated"

nazwa zdarzenia.

listener

CollectionUpdatedEvent<RemoteParticipant>

wywołanie zwrotne, które będzie wywoływane po zmianie tej kolekcji, przekaże tablice dodanych i usuniętych elementów.

dziedziczone zCallCommon.on

on("roleChanged", PropertyChangedEvent)

Subskrybuj funkcję dla zdarzenia roleChanged.

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

Parametry

event

"roleChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.on

on("stateChanged", PropertyChangedEvent)

Subskrybuj funkcję dla zdarzenia stateChanged.

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

Parametry

event

"stateChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

wywołanie zwrotne fn, które będzie wywoływane, gdy wartość tej właściwości ulegnie zmianie.

dziedziczone zCallCommon.on

on("totalParticipantCountChanged", PropertyChangedEvent)

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

Funkcja subskrybuj dla zdarzenia totalParticipantCountChanged.

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

Parametry

event

"totalParticipantCountChanged"

nazwa zdarzenia.

listener

PropertyChangedEvent

fn wywołania zwrotnego, które będą wywoływane, gdy liczba uczestników ulegnie zmianie.

dziedziczone zCallCommon.on

resume()

Wznów to wywołanie, jeśli jest w stanie "LocalHold".

function resume(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallCommon.resume

sendDtmf(DtmfTone)

Wyślij ton DTMF.

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

Parametry

dtmfTone

DtmfTone

Zwraca

Promise<void>

dziedziczone zCallCommon.sendDtmf

setConstraints(CallConstraints)

Ustawianie ograniczeń wywołań. Ta metoda ustawia maksymalne ograniczenia na podstawie podanych wartości. Ostateczne zastosowane ograniczenia będą mniejsze lub równe wartościom podanym tutaj w tej metodzie. Jeśli zostanie podana wartość 0, dla tego ograniczenia nie zostanie zastosowane żadne ograniczenie. Jeśli podano niezdefiniowaną wartość, zostanie użyta poprzednia wartość dla tego ograniczenia.

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

Parametry

constraints

CallConstraints

Obiekt reprezentujący ograniczenia wywołań do ustawienia

Zwraca

Promise<void>

dziedziczone zCallCommon.setConstraints

startAudio(LocalAudioStream)

Uruchom dźwięk w wywołaniu za pomocą niestandardowego dźwięku. Źródło LocalAudioStream powinno być elementem MediaStream.

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

Parametry

localAudioStream

LocalAudioStream

Zwraca

Promise<void>

dziedziczone zCallCommon.startAudio

startScreenSharing()

• Rozpocznij wysyłanie strumienia udostępniania ekranu w wywołaniu. Przeglądarka wyświetli monit o wybranie ekranu, aplikacji lub karty przeglądarki.
• Wysyłanie strumienia udostępniania ekranu nie jest obsługiwane w systemach iOS ani Android.
• Strumień udostępniania ekranu przychodzącego jest obsługiwany w systemach iOS i Android.

function startScreenSharing(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallCommon.startScreenSharing

startScreenSharing(LocalVideoStream)

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

• Rozpocznij wysyłanie nieprzetworzonego strumienia udostępniania ekranu w wywołaniu.
• Wysyłanie nieprzetworzonego udostępniania ekranu nie jest obsługiwane w systemach iOS ani Android.
• Przychodzące udostępnianie nieprzetworzonych ekranów jest obsługiwane w systemach iOS i Android.

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

Parametry

localVideoStream

LocalVideoStream

Reprezentuje lokalny strumień udostępniania nieprzetworzonego ekranu, który pobiera element MediaStream w konstruktorze.

Zwraca

Promise<void>

dziedziczone zCallCommon.startScreenSharing

startVideo(LocalVideoStream)

Rozpocznij wysyłanie strumienia wideo w wywołaniu. Zdalni uczestnicy wywołania otrzymają strumień wideo, aby mogli go renderować w swoich interfejsach użytkownika.

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

Parametry

localVideoStream

LocalVideoStream

Reprezentuje lokalny strumień wideo, który pobiera źródło aparatu w konstruktorze.

Zwraca

Promise<void>

dziedziczone zCallCommon.startVideo

stopAudio()

Zatrzymaj niestandardowy dźwięk w wywołaniu i przełącz się do domyślnego urządzenia audio menedżera urządzeń.

function stopAudio()

dziedziczone zCallCommon.stopAudio

stopScreenSharing()

Zatrzymaj udostępnianie ekranu lokalnego.

function stopScreenSharing(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallCommon.stopScreenSharing

stopScreenSharing(LocalVideoStream)

Uwaga

Ten typ interfejs API jest udostępniany w wersji beta jako wersja zapoznawcza dla deweloperów i może zostać zmieniony na podstawie otrzymanych opinii. Nie należy używać tego interfejsu API w środowisku produkcyjnym.

Zatrzymaj udostępnianie ekranu lokalnego.

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

Parametry

localVideoStream

LocalVideoStream

Strumień udostępniania ekranu lokalnego w celu zatrzymania przesyłania strumieniowego.

Zwraca

Promise<void>

dziedziczone zCallCommon.stopScreenSharing

stopVideo(LocalVideoStream)

Zatrzymaj wysyłanie strumienia wideo w wywołaniu. Musi przekazać ten sam obiekt LocalVideoStream, który został użyty do uruchomienia wideo w interfejsie API CallAgent.startCall(), CallAgent.join() API, IncomingCall.accept() API lub Call.startVideo().

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

Parametry

localVideoStream

LocalVideoStream

Lokalny strumień wideo, aby zatrzymać przesyłanie strumieniowe.

Zwraca

Promise<void>

dziedziczone zCallCommon.stopVideo

unmute()

Anuluj wyciszanie mikrofonu lokalnego.

function unmute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallCommon.unmute

unmuteIncomingAudio()

Anuluj wyciszanie przychodzącego dźwięku.

function unmuteIncomingAudio(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallCommon.unmuteIncomingAudio