CallCommon interface
Společné rozhraní volání.
- Extends
Vlastnosti
call |
Obsahuje kód nebo podkód označující, jak toto volání skončilo. |
caller |
Informace o volajícím, pokud je tento hovor příchozí. |
direction | Směr volání získáte bez ohledu na to, jestli je příchozí nebo odchozí. |
id | Získejte jedinečné ID pro toto volání. |
is |
Určuje, jestli místní uživatel ztlumil příchozí zvuk. |
is |
Jestli je místní video zapnuté. |
is |
Ať už je místní uživatel ztlumený, místně nebo vzdáleně. |
is |
Určuje, jestli je zapnuté sdílení obrazovky. |
kind | Získejte typ objektu volání. |
lobby | Získejte předsálí schůzky Teams. |
local |
Kolekce místních zvukových proudů, které se odesílají ostatním účastníkům hovoru. |
local |
Kolekce místních streamů videa, které se odesílají ostatním účastníkům hovoru. |
remote |
Kolekce vzdálených zvukových proudů přijatých z volání |
remote |
Kolekce vzdálených účastníků v tomto volání V případě hovorů s účastníky se stovkami nebo více účastníky jsou v této kolekci přítomni jenom aktivní účastníci médií. |
role | Získejte roli místního uživatele v hovoru. |
state | Získejte stav tohoto volání. |
total |
Počet celkového počtu účastníků tohoto hovoru |
Metody
feature<TFeature>(Call |
Načte inicializovaný a memoizovaný objekt feature s rozšířeným rozhraním API. Zkontrolujte vlastnosti objektu.* Pro všechny dostupné rozšířené funkce volání v tomto balíčku, například:
|
hang |
Zavěste hovor. |
hold() | Přidržte tento hovor. |
mute() | Ztlumit místní mikrofon. |
mute |
Ztlumit všechny vzdálené účastníky. |
mute |
Ztlumit příchozí zvuk. |
off("id |
Funkce odhlášení odběru události idChanged |
off("is |
Funkce Subscribe pro isIncomingAudioMutedChanged událost. |
off("is |
Funkce Odhlášení odběru události isLocalVideoStartedChanged |
off("is |
Funkce Subscribe pro událost isMutedChanged |
off("is |
Funkce Odhlášení odběru události isScreenSharingChanged |
off("local |
Funkce odhlášení odběru události localAudioStreamsUpdated |
off("local |
Funkce odhlášení odběru události localVideoStreamsUpdated |
off("muted |
Funkce Odhlášení odběru pro ztlumenou událostByOthers |
off("remote |
Funkce Odhlášení odběru události remoteAudioStreamsUpdated |
off("remote |
Funkce Odhlášení odběru události remoteParticipantsUpdated |
off("role |
Funkce odhlášení odběru pro událost roleChanged |
off("state |
Funkce odhlášení odběru pro událost stateChanged |
off("total |
funkce odběru pro totalParticipantCountChanged událost. |
on("id |
Přihlášení funkce k odběru události idChanged |
on("is |
Funkce Subscribe pro isIncomingAudioMutedChanged událost. |
on("is |
Funkce Subscribe pro událost isLocalVideoStartedChanged |
on("is |
Funkce Subscribe pro událost isMutedChanged |
on("is |
Funkce Subscribe pro událost isScreenSharingChanged |
on("local |
Funkce Subscribe pro localAudioStreamsUpdated událost. |
on("local |
Funkce Subscribe pro událost localVideoStreamsUpdated |
on("muted |
Funkce Subscribe pro ztlumenou událostByOthers |
on("remote |
Funkce Subscribe pro událost remoteAudioStreamsUpdated |
on("remote |
Funkce Subscribe pro událost remoteParticipantsUpdated |
on("role |
Přihlásit se k odběru funkce pro událost roleChanged |
on("state |
Funkce Přihlásit se k odběru události stateChanged |
on("total |
Funkce Subscribe pro totalParticipantCountChanged událost. |
resume() | Pokračujte v tomto volání, pokud je ve stavu LocalHold. |
send |
Odeslat tón DTMF. |
set |
Nastavte omezení volání. Tato metoda nastaví maximální omezení na základě zadaných hodnot. Konečná použitá omezení budou menší nebo rovna hodnotám zadaným v této metodě. Pokud je zadána hodnota 0, nebude pro toto omezení použito žádné omezení. Pokud je zadaná nedefinovaná hodnota, použije se pro toto omezení předchozí použitá hodnota. |
start |
V hovoru můžete zahájit zvuk s vlastním zvukem. Zdroj LocalAudioStream by měl být MediaStream. |
start |
|
start |
|
start |
Začněte posílat video stream v hovoru. Vzdálení účastníci hovoru dostanou váš video stream, aby ho mohli vykreslit ve svých uživatelských rozhraních. |
stop |
Zastavte vlastní zvuk v hovoru a přepněte do výchozího zvukového zařízení Správce zařízení. |
stop |
Zastavte sdílení místní obrazovky. |
stop |
Zastavte sdílení místní obrazovky. |
stop |
Ukončení odesílání streamu videa v hovoru Musí předat stejný LocalVideoStream objekt, který byl použit ke spuštění videa v CallAgent.startCall() API, CallAgent.join() API , IncomingCall.accept() API nebo Call.startVideo() API. |
unmute() | Zrušit ztlumení místního mikrofonu. |
unmute |
Zrušit ztlumení příchozího zvuku |
Zděděné metody
dispose() |
Podrobnosti vlastnosti
callEndReason
Obsahuje kód nebo podkód označující, jak toto volání skončilo.
callEndReason?: CallEndReason
Hodnota vlastnosti
callerInfo
Informace o volajícím, pokud je tento hovor příchozí.
callerInfo: CallerInfo
Hodnota vlastnosti
direction
Směr volání získáte bez ohledu na to, jestli je příchozí nebo odchozí.
direction: CallDirection
Hodnota vlastnosti
id
Získejte jedinečné ID pro toto volání.
id: string
Hodnota vlastnosti
string
isIncomingAudioMuted
Určuje, jestli místní uživatel ztlumil příchozí zvuk.
isIncomingAudioMuted: boolean
Hodnota vlastnosti
boolean
isLocalVideoStarted
Jestli je místní video zapnuté.
isLocalVideoStarted: boolean
Hodnota vlastnosti
boolean
isMuted
Ať už je místní uživatel ztlumený, místně nebo vzdáleně.
isMuted: boolean
Hodnota vlastnosti
boolean
isScreenSharingOn
Určuje, jestli je zapnuté sdílení obrazovky.
isScreenSharingOn: boolean
Hodnota vlastnosti
boolean
kind
lobby
localAudioStreams
Kolekce místních zvukových proudů, které se odesílají ostatním účastníkům hovoru.
localAudioStreams: readonly LocalAudioStream[]
Hodnota vlastnosti
readonly LocalAudioStream[]
localVideoStreams
Kolekce místních streamů videa, které se odesílají ostatním účastníkům hovoru.
localVideoStreams: readonly LocalVideoStream[]
Hodnota vlastnosti
readonly LocalVideoStream[]
remoteAudioStreams
Kolekce vzdálených zvukových proudů přijatých z volání
remoteAudioStreams: readonly RemoteAudioStream[]
Hodnota vlastnosti
readonly RemoteAudioStream[]
remoteParticipants
Kolekce vzdálených účastníků v tomto volání V případě hovorů s účastníky se stovkami nebo více účastníky jsou v této kolekci přítomni jenom aktivní účastníci médií.
remoteParticipants: readonly RemoteParticipant[]
Hodnota vlastnosti
readonly RemoteParticipant[]
role
state
totalParticipantCount
Poznámka
Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.
Počet celkového počtu účastníků tohoto hovoru
totalParticipantCount: number
Hodnota vlastnosti
number
Podrobnosti metody
feature<TFeature>(CallFeatureFactory<TFeature>)
Načte inicializovaný a memoizovaný objekt feature s rozšířeným rozhraním API. Zkontrolujte vlastnosti objektu.* Pro všechny dostupné rozšířené funkce volání v tomto balíčku, například:
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>
Objekt pro vytváření konstruktoru funkce volání, který poskytuje rozšířené rozhraní API.
Návraty
TFeature
hangUp(HangUpOptions)
Zavěste hovor.
function hangUp(options?: HangUpOptions): Promise<void>
Parametry
- options
- HangUpOptions
Možnosti hangupu.
Návraty
Promise<void>
hold()
Přidržte tento hovor.
function hold(): Promise<void>
Návraty
Promise<void>
mute()
Ztlumit místní mikrofon.
function mute(): Promise<void>
Návraty
Promise<void>
muteAllRemoteParticipants()
Ztlumit všechny vzdálené účastníky.
function muteAllRemoteParticipants(): Promise<void>
Návraty
Promise<void>
muteIncomingAudio()
Ztlumit příchozí zvuk.
function muteIncomingAudio(): Promise<void>
Návraty
Promise<void>
off("idChanged", PropertyChangedEvent)
Funkce odhlášení odběru události idChanged
function off(event: "idChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"idChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který byl použit k přihlášení k odběru této události.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)
Funkce Subscribe pro isIncomingAudioMutedChanged událost.
function off(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"isIncomingAudioMutedChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
off("isLocalVideoStartedChanged", PropertyChangedEvent)
Funkce Odhlášení odběru události isLocalVideoStartedChanged
function off(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"isLocalVideoStartedChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
off("isMutedChanged", PropertyChangedEvent)
Funkce Subscribe pro událost isMutedChanged
function off(event: "isMutedChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"isMutedChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
off("isScreenSharingOnChanged", PropertyChangedEvent)
Funkce Odhlášení odběru události isScreenSharingChanged
function off(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"isScreenSharingOnChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který byl použit k přihlášení k odběru této události.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)
Funkce odhlášení odběru události localAudioStreamsUpdated
function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)
Parametry
- event
-
"localAudioStreamsUpdated"
název události.
- listener
callback fn, který byl použit k přihlášení k odběru této události.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)
Funkce odhlášení odběru události localVideoStreamsUpdated
function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)
Parametry
- event
-
"localVideoStreamsUpdated"
název události.
- listener
callback fn, který byl použit k přihlášení k odběru této události.
off("mutedByOthers", PropertyChangedEvent)
Funkce Odhlášení odběru pro ztlumenou událostByOthers
function off(event: "mutedByOthers", listener: PropertyChangedEvent)
Parametry
- event
-
"mutedByOthers"
název události.
- listener
- PropertyChangedEvent
callback fn, který byl použit k odhlášení odběru této události.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)
Funkce Odhlášení odběru události remoteAudioStreamsUpdated
function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)
Parametry
- event
-
"remoteAudioStreamsUpdated"
název události.
- listener
callback fn, který byl použit k přihlášení k odběru této události.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
Funkce Odhlášení odběru události remoteParticipantsUpdated
function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)
Parametry
- event
-
"remoteParticipantsUpdated"
název události.
- listener
callback fn, který byl použit k přihlášení k odběru této události.
off("roleChanged", PropertyChangedEvent)
Funkce odhlášení odběru pro událost roleChanged
function off(event: "roleChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"roleChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který byl použit k přihlášení k odběru této události.
off("stateChanged", PropertyChangedEvent)
Funkce odhlášení odběru pro událost stateChanged
function off(event: "stateChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"stateChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který byl použit k přihlášení k odběru této události.
off("totalParticipantCountChanged", PropertyChangedEvent)
Poznámka
Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.
funkce odběru pro totalParticipantCountChanged událost.
function off(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"totalParticipantCountChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně počtu účastníků.
on("idChanged", PropertyChangedEvent)
Přihlášení funkce k odběru události idChanged
function on(event: "idChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"idChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)
Funkce Subscribe pro isIncomingAudioMutedChanged událost.
function on(event: "isIncomingAudioMutedChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"isIncomingAudioMutedChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
on("isLocalVideoStartedChanged", PropertyChangedEvent)
Funkce Subscribe pro událost isLocalVideoStartedChanged
function on(event: "isLocalVideoStartedChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"isLocalVideoStartedChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
on("isMutedChanged", PropertyChangedEvent)
Funkce Subscribe pro událost isMutedChanged
function on(event: "isMutedChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"isMutedChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
on("isScreenSharingOnChanged", PropertyChangedEvent)
Funkce Subscribe pro událost isScreenSharingChanged
function on(event: "isScreenSharingOnChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"isScreenSharingOnChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)
Funkce Subscribe pro localAudioStreamsUpdated událost.
function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)
Parametry
- event
-
"localAudioStreamsUpdated"
název události.
- listener
callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)
Funkce Subscribe pro událost localVideoStreamsUpdated
function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)
Parametry
- event
-
"localVideoStreamsUpdated"
název události.
- listener
callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.
on("mutedByOthers", PropertyChangedEvent)
Funkce Subscribe pro ztlumenou událostByOthers
function on(event: "mutedByOthers", listener: PropertyChangedEvent)
Parametry
- event
-
"mutedByOthers"
název události.
- listener
- PropertyChangedEvent
callback fn, který byl použit k přihlášení k odběru této události.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)
Funkce Subscribe pro událost remoteAudioStreamsUpdated
function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)
Parametry
- event
-
"remoteAudioStreamsUpdated"
název události.
- listener
callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
Funkce Subscribe pro událost remoteParticipantsUpdated
function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)
Parametry
- event
-
"remoteParticipantsUpdated"
název události.
- listener
callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.
on("roleChanged", PropertyChangedEvent)
Přihlásit se k odběru funkce pro událost roleChanged
function on(event: "roleChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"roleChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
on("stateChanged", PropertyChangedEvent)
Funkce Přihlásit se k odběru události stateChanged
function on(event: "stateChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"stateChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně hodnoty této vlastnosti.
on("totalParticipantCountChanged", PropertyChangedEvent)
Poznámka
Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.
Funkce Subscribe pro totalParticipantCountChanged událost.
function on(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"totalParticipantCountChanged"
název události.
- listener
- PropertyChangedEvent
callback fn, který bude volán při změně počtu účastníků.
resume()
Pokračujte v tomto volání, pokud je ve stavu LocalHold.
function resume(): Promise<void>
Návraty
Promise<void>
sendDtmf(DtmfTone)
Odeslat tón DTMF.
function sendDtmf(dtmfTone: DtmfTone): Promise<void>
Parametry
- dtmfTone
- DtmfTone
Návraty
Promise<void>
setConstraints(CallConstraints)
Nastavte omezení volání. Tato metoda nastaví maximální omezení na základě zadaných hodnot. Konečná použitá omezení budou menší nebo rovna hodnotám zadaným v této metodě. Pokud je zadána hodnota 0, nebude pro toto omezení použito žádné omezení. Pokud je zadaná nedefinovaná hodnota, použije se pro toto omezení předchozí použitá hodnota.
function setConstraints(constraints: CallConstraints): Promise<void>
Parametry
- constraints
- CallConstraints
Objekt představující omezení volání, která se mají nastavit
Návraty
Promise<void>
startAudio(LocalAudioStream)
V hovoru můžete zahájit zvuk s vlastním zvukem. Zdroj LocalAudioStream by měl být MediaStream.
function startAudio(localAudioStream: LocalAudioStream): Promise<void>
Parametry
- localAudioStream
- LocalAudioStream
Návraty
Promise<void>
startScreenSharing()
- Začněte posílat stream sdílení obrazovky v hovoru. Prohlížeč zobrazí výzvu k výběru obrazovky, aplikace nebo karty prohlížeče.
- Odesílání streamu sdílení obrazovky není podporováno v iOSu ani Androidu.
- Příchozí stream sdílení obrazovky je podporovaný v iOSu a Androidu.
function startScreenSharing(): Promise<void>
Návraty
Promise<void>
startScreenSharing(LocalVideoStream)
Poznámka
Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.
- Začněte posílat stream sdílení nezpracované obrazovky v hovoru.
- Odesílání nezpracovaných sdílení obrazovky se v iOSu ani Androidu nepodporuje.
- Příchozí nezpracované sdílení obrazovky je podporováno v iOSu a Androidu.
function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>
Parametry
- localVideoStream
- LocalVideoStream
Představuje místní nezpracovaný stream sdílení obrazovky, který přebírá MediaStream v konstruktoru.
Návraty
Promise<void>
startVideo(LocalVideoStream)
Začněte posílat video stream v hovoru. Vzdálení účastníci hovoru dostanou váš video stream, aby ho mohli vykreslit ve svých uživatelských rozhraních.
function startVideo(localVideoStream: LocalVideoStream): Promise<void>
Parametry
- localVideoStream
- LocalVideoStream
Představuje místní datový proud videa, který přebírá zdroj fotoaparátu v konstruktoru.
Návraty
Promise<void>
stopAudio()
Zastavte vlastní zvuk v hovoru a přepněte do výchozího zvukového zařízení Správce zařízení.
function stopAudio()
stopScreenSharing()
Zastavte sdílení místní obrazovky.
function stopScreenSharing(): Promise<void>
Návraty
Promise<void>
stopScreenSharing(LocalVideoStream)
Poznámka
Tento rozhraní API je v beta verzi. Poskytuje se jako verze Preview pro vývojáře a může se změnit na základě zpětné vazby, kterou dostaneme. Nepoužívejte toto rozhraní API v produkčním prostředí.
Zastavte sdílení místní obrazovky.
function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>
Parametry
- localVideoStream
- LocalVideoStream
Stream sdílení místní obrazovky pro zastavení streamování.
Návraty
Promise<void>
stopVideo(LocalVideoStream)
Ukončení odesílání streamu videa v hovoru Musí předat stejný LocalVideoStream objekt, který byl použit ke spuštění videa v CallAgent.startCall() API, CallAgent.join() API , IncomingCall.accept() API nebo Call.startVideo() API.
function stopVideo(localVideoStream: LocalVideoStream): Promise<void>
Parametry
- localVideoStream
- LocalVideoStream
Místní stream videa pro zastavení streamování.
Návraty
Promise<void>
unmute()
Zrušit ztlumení místního mikrofonu.
function unmute(): Promise<void>
Návraty
Promise<void>
unmuteIncomingAudio()
Zrušit ztlumení příchozího zvuku
function unmuteIncomingAudio(): Promise<void>
Návraty
Promise<void>
Podrobnosti zděděných metod
dispose()
function dispose()
zděděné zna jedno použití.dispose