Call interface

Balíček:

@azure/communication-calling

Představuje volání.

Extends

CallCommon

Vlastnosti

info	Získejte informace o tomto hovoru.

Zděděné vlastnosti

callEndReason	Obsahuje kód nebo podkód označující, jak toto volání skončilo.
callerInfo	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í.
isIncomingAudioMuted	Určuje, jestli místní uživatel ztlumil příchozí zvuk.
isLocalVideoStarted	Jestli je místní video zapnuté.
isMuted	Ať už je místní uživatel ztlumený, místně nebo vzdáleně.
isScreenSharingOn	Určuje, jestli je zapnuté sdílení obrazovky.
kind	Získejte typ objektu volání.
lobby	Získejte předsálí schůzky Teams.
localAudioStreams	Kolekce místních zvukových proudů, které se odesílají ostatním účastníkům hovoru.
localVideoStreams	Kolekce místních streamů videa, které se odesílají ostatním účastníkům hovoru.
remoteAudioStreams	Kolekce vzdálených zvukových proudů přijatých z volání
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í.
role	Získejte roli místního uživatele v hovoru.
state	Získejte stav tohoto volání.
totalParticipantCount	Počet celkového počtu účastníků tohoto hovoru
transferorInfo	Iniciátor převodu v případě scénářů přenosu/předávání

Metody

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)	Přidejte účastníka do tohoto hovoru.
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)	Přidejte účastníka do tohoto hovoru.
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)	Přidejte do tohoto hovoru aplikaci Teams.
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)	Přidejte účastníka do tohoto hovoru.
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Přidejte účastníka do tohoto hovoru.
removeParticipant(CommunicationIdentifier)	Odeberte účastníka z tohoto hovoru.

Zděděné metody

dispose()
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')
hangUp(HangUpOptions)	Zavěste hovor.
hold()	Přidržte tento hovor.
mute()	Ztlumit místní mikrofon.
muteAllRemoteParticipants()	Ztlumit všechny vzdálené účastníky.
muteIncomingAudio()	Ztlumit příchozí zvuk.
off("callerInfoChanged", PropertyChangedEvent)	Funkce odhlášení odběru informací o volajícím změnila událost.
off("idChanged", PropertyChangedEvent)	Funkce odhlášení odběru události idChanged
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funkce Subscribe pro isIncomingAudioMutedChanged událost.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Funkce Odhlášení odběru události isLocalVideoStartedChanged
off("isMutedChanged", PropertyChangedEvent)	Funkce Subscribe pro událost isMutedChanged
off("isScreenSharingOnChanged", PropertyChangedEvent)	Funkce Odhlášení odběru události isScreenSharingChanged
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Funkce odhlášení odběru události localAudioStreamsUpdated
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Funkce odhlášení odběru události localVideoStreamsUpdated
off("mutedByOthers", PropertyChangedEvent)	Funkce Odhlášení odběru pro ztlumenou událostByOthers
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funkce Odhlášení odběru události remoteAudioStreamsUpdated
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funkce Odhlášení odběru události remoteParticipantsUpdated
off("roleChanged", PropertyChangedEvent)	Funkce odhlášení odběru pro událost roleChanged
off("stateChanged", PropertyChangedEvent)	Funkce odhlášení odběru pro událost stateChanged
off("totalParticipantCountChanged", PropertyChangedEvent)	funkce odběru pro totalParticipantCountChanged událost.
off("transferorInfoChanged", PropertyChangedEvent)	Funkce odhlášení odběru informací o volajícím změnila událost.
on("callerInfoChanged", PropertyChangedEvent)	Přihlášení k odběru funkce pro změněnou událost informací o volajícím
on("idChanged", PropertyChangedEvent)	Přihlášení funkce k odběru události idChanged
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funkce Subscribe pro isIncomingAudioMutedChanged událost.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Funkce Subscribe pro událost isLocalVideoStartedChanged
on("isMutedChanged", PropertyChangedEvent)	Funkce Subscribe pro událost isMutedChanged
on("isScreenSharingOnChanged", PropertyChangedEvent)	Funkce Subscribe pro událost isScreenSharingChanged
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Funkce Subscribe pro localAudioStreamsUpdated událost.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Funkce Subscribe pro událost localVideoStreamsUpdated
on("mutedByOthers", PropertyChangedEvent)	Funkce Subscribe pro ztlumenou událostByOthers
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funkce Subscribe pro událost remoteAudioStreamsUpdated
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funkce Subscribe pro událost remoteParticipantsUpdated
on("roleChanged", PropertyChangedEvent)	Přihlásit se k odběru funkce pro událost roleChanged
on("stateChanged", PropertyChangedEvent)	Funkce Přihlásit se k odběru události stateChanged
on("totalParticipantCountChanged", PropertyChangedEvent)	Funkce Subscribe pro totalParticipantCountChanged událost.
on("transferorInfoChanged", PropertyChangedEvent)	Přihlášení k odběru funkce pro změněnou událost informací o volajícím
resume()	Pokračujte v tomto volání, pokud je ve stavu LocalHold.
sendDtmf(DtmfTone)	Odeslat tón DTMF.
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.
startAudio(LocalAudioStream)	V hovoru můžete zahájit zvuk s vlastním zvukem. Zdroj LocalAudioStream by měl být MediaStream.
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.
startScreenSharing(LocalVideoStream)	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.
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.
stopAudio()	Zastavte vlastní zvuk v hovoru a přepněte do výchozího zvukového zařízení Správce zařízení.
stopScreenSharing()	Zastavte sdílení místní obrazovky.
stopScreenSharing(LocalVideoStream)	Zastavte sdílení místní obrazovky.
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.
unmute()	Zrušit ztlumení místního mikrofonu.
unmuteIncomingAudio()	Zrušit ztlumení příchozího zvuku

Podrobnosti vlastnosti

info

Získejte informace o tomto hovoru.

info: CallInfo

Hodnota vlastnosti

CallInfo

Podrobnosti zděděných vlastností

callEndReason

Obsahuje kód nebo podkód označující, jak toto volání skončilo.

callEndReason?: CallEndReason

Hodnota vlastnosti

CallEndReason

zděděno zCallCommon.callEndReason

callerInfo

Informace o volajícím, pokud je tento hovor příchozí.

callerInfo: CallerInfo

Hodnota vlastnosti

CallerInfo

zděděno zCallCommon.callerInfo

direction

Směr volání získáte bez ohledu na to, jestli je příchozí nebo odchozí.

direction: CallDirection

Hodnota vlastnosti

CallDirection

zděděno zCallCommon.direction

id

Získejte jedinečné ID pro toto volání.

id: string

Hodnota vlastnosti

string

zděděno zeCallCommon.id

isIncomingAudioMuted

Určuje, jestli místní uživatel ztlumil příchozí zvuk.

isIncomingAudioMuted: boolean

Hodnota vlastnosti

boolean

zděděno zCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Jestli je místní video zapnuté.

isLocalVideoStarted: boolean

Hodnota vlastnosti

boolean

zděděno zCallCommon.isLocalVideoStarted

isMuted

Ať už je místní uživatel ztlumený, místně nebo vzdáleně.

isMuted: boolean

Hodnota vlastnosti

boolean

zděděno zCallCommon.isMuted

isScreenSharingOn

Určuje, jestli je zapnuté sdílení obrazovky.

isScreenSharingOn: boolean

Hodnota vlastnosti

boolean

zděděno zCallCommon.isScreenSharingOn

kind

Získejte typ objektu volání.

kind: CallKind

Hodnota vlastnosti

CallKind

zděděno zcallCommon.kind

lobby

Získejte předsálí schůzky Teams.

lobby: Lobby

Hodnota vlastnosti

Lobby

zděděno z CallCommon.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[]

zděděno zCallCommon.localAudioStreams

localVideoStreams

Kolekce místních streamů videa, které se odesílají ostatním účastníkům hovoru.

localVideoStreams: readonly LocalVideoStream[]

Hodnota vlastnosti

readonly LocalVideoStream[]

zděděno zCallCommon.localVideoStreams

remoteAudioStreams

Kolekce vzdálených zvukových proudů přijatých z volání

remoteAudioStreams: readonly RemoteAudioStream[]

Hodnota vlastnosti

readonly RemoteAudioStream[]

zděděno zCallCommon.remoteAudioStreams

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[]

zděděné zcallCommon.remoteParticipants

role

Získejte roli místního uživatele v hovoru.

role: ParticipantRole

Hodnota vlastnosti

ParticipantRole

zděděno z CallCommon.role

state

Získejte stav tohoto volání.

state: CallState

Hodnota vlastnosti

CallState

zděděno z CallCommon.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

zděděno zCallCommon.totalParticipantCount

transferorInfo

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í.

Iniciátor převodu v případě scénářů přenosu/předávání

transferorInfo?: CallerInfo

Hodnota vlastnosti

CallerInfo

zděděný z CallCommon.transferorInfo

Podrobnosti metody

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)

Přidejte účastníka do tohoto hovoru.

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

Parametry

identifier

CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier

Identifikátor účastníka, který chcete přidat.

Návraty

RemoteParticipant

Objekt RemoteParticipant přidružený k úspěšně přidanému účastníkovi.

addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)

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í.

Přidejte účastníka do tohoto hovoru.

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

Parametry

identifier

CommunicationUserIdentifier

Identifikátor účastníka, který chcete přidat.

options

AddCommunicationUserOptions

Další možnosti správy hovoru

Návraty

RemoteParticipant

Objekt RemoteParticipant přidružený k úspěšně přidanému účastníkovi.

addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)

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í.

Přidejte do tohoto hovoru aplikaci Teams.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

Parametry

identifier

MicrosoftTeamsAppIdentifier | UnknownIdentifier

Identifikátor aplikace Teams, který chcete přidat.

Návraty

RemoteParticipant

Objekt RemoteParticipant přidružený k úspěšně přidané aplikaci Teams.

addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)

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í.

Přidejte účastníka do tohoto hovoru.

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

Parametry

identifier

MicrosoftTeamsUserIdentifier

Identifikátor účastníka, který chcete přidat.

options

AddMicrosoftTeamsUserOptions

Další možnosti správy hovoru

Návraty

RemoteParticipant

Objekt RemoteParticipant přidružený k úspěšně přidanému účastníkovi.

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Přidejte účastníka do tohoto hovoru.

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

Parametry

identifier

PhoneNumberIdentifier

Identifikátor účastníka, který chcete přidat.

options

AddPhoneNumberOptions

Další možnosti správy volání do veřejné telefonní sítě Například nastavení telefonního čísla Id volajícího ve volání do veřejné telefonní sítě.

Návraty

RemoteParticipant

Objekt RemoteParticipant přidružený k úspěšně přidanému účastníkovi.

removeParticipant(CommunicationIdentifier)

Odeberte účastníka z tohoto hovoru.

function removeParticipant(identifier: CommunicationIdentifier): Promise<void>

Parametry

identifier

CommunicationIdentifier

Identifikátor účastníka, který chcete odebrat.

Návraty

Promise<void>

Podrobnosti zděděných metod

dispose()

function dispose()

zděděno zCallCommon.dispose

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

zděděno z funkceCallCommon.feature

hangUp(HangUpOptions)

Zavěste hovor.

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

Parametry

options

HangUpOptions

Možnosti hangupu.

Návraty

Promise<void>

zděděno zcallCommon.hangUp

hold()

Přidržte tento hovor.

function hold(): Promise<void>

Návraty

Promise<void>

zděděno z CallCommon.hold

mute()

Ztlumit místní mikrofon.

function mute(): Promise<void>

Návraty

Promise<void>

zděděno z CallCommon.mute

muteAllRemoteParticipants()

Ztlumit všechny vzdálené účastníky.

function muteAllRemoteParticipants(): Promise<void>

Návraty

Promise<void>

zděděno zCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Ztlumit příchozí zvuk.

function muteIncomingAudio(): Promise<void>

Návraty

Promise<void>

zděděno zCallCommon.muteIncomingAudio

off("callerInfoChanged", 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 odhlášení odběru informací o volajícím změnila událost.

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

Parametry

event

"callerInfoChanged"

listener

PropertyChangedEvent

zděděno zCallCommon.off

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.

zděděno zCallCommon.off

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.

zděděno zCallCommon.off

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.

zděděno zCallCommon.off

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.

zděděno zCallCommon.off

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.

zděděno zCallCommon.off

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

CollectionUpdatedEvent<LocalAudioStream>

callback fn, který byl použit k přihlášení k odběru této události.

zděděno zCallCommon.off

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

CollectionUpdatedEvent<LocalVideoStream>

callback fn, který byl použit k přihlášení k odběru této události.

zděděno zCallCommon.off

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.

zděděno zCallCommon.off

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

CollectionUpdatedEvent<RemoteAudioStream>

callback fn, který byl použit k přihlášení k odběru této události.

zděděno zCallCommon.off

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

CollectionUpdatedEvent<RemoteParticipant>

callback fn, který byl použit k přihlášení k odběru této události.

zděděno zCallCommon.off

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.

zděděno zCallCommon.off

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.

zděděno zCallCommon.off

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ů.

zděděno zCallCommon.off

off("transferorInfoChanged", 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 odhlášení odběru informací o volajícím změnila událost.

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

Parametry

event

"transferorInfoChanged"

listener

PropertyChangedEvent

zděděno zCallCommon.off

on("callerInfoChanged", 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í.

Přihlášení k odběru funkce pro změněnou událost informací o volajícím

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

Parametry

event

"callerInfoChanged"

listener

PropertyChangedEvent

zděděno zCallCommon.on

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.

zděděno zCallCommon.on

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.

zděděno zCallCommon.on

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.

zděděno zCallCommon.on

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.

zděděno zCallCommon.on

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.

zděděno zCallCommon.on

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

CollectionUpdatedEvent<LocalAudioStream>

callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.

zděděno zCallCommon.on

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

CollectionUpdatedEvent<LocalVideoStream>

callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.

zděděno zCallCommon.on

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.

zděděno zCallCommon.on

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

CollectionUpdatedEvent<RemoteAudioStream>

callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.

zděděno zCallCommon.on

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

CollectionUpdatedEvent<RemoteParticipant>

callback fn, který bude volán, když se tato kolekce změní, předá pole přidaných a odebraných elementů.

zděděno zCallCommon.on

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.

zděděno zCallCommon.on

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.

zděděno zCallCommon.on

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ů.

zděděno zCallCommon.on

on("transferorInfoChanged", 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í.

Přihlášení k odběru funkce pro změněnou událost informací o volajícím

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

Parametry

event

"transferorInfoChanged"

listener

PropertyChangedEvent

zděděno zCallCommon.on

resume()

Pokračujte v tomto volání, pokud je ve stavu LocalHold.

function resume(): Promise<void>

Návraty

Promise<void>

zděděno zcallCommon.resume

sendDtmf(DtmfTone)

Odeslat tón DTMF.

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

Parametry

dtmfTone

DtmfTone

Návraty

Promise<void>

zděděno zCallCommon.sendDtmf

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>

zděděno zCallCommon.setConstraints

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>

zděděno zCallCommon.startAudio

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>

zděděné z CallCommon.startScreenSharing

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>

zděděné z CallCommon.startScreenSharing

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>

zděděno z CallCommon.startVideo

stopAudio()

Zastavte vlastní zvuk v hovoru a přepněte do výchozího zvukového zařízení Správce zařízení.

function stopAudio()

zděděno zCallCommon.stopAudio

stopScreenSharing()

Zastavte sdílení místní obrazovky.

function stopScreenSharing(): Promise<void>

Návraty

Promise<void>

zděděný z CallCommon.stopScreenSharing

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>

zděděný z CallCommon.stopScreenSharing

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>

zděděné z CallCommon.stopVideo

unmute()

Zrušit ztlumení místního mikrofonu.

function unmute(): Promise<void>

Návraty

Promise<void>

zděděno z CallCommon.unmute

unmuteIncomingAudio()

Zrušit ztlumení příchozího zvuku

function unmuteIncomingAudio(): Promise<void>

Návraty

Promise<void>

zděděno zCallCommon.unmuteIncomingAudio