Call interface

Balíček:

@azure/communication-calling

Představuje volání.

Extends

CallCommon

Vlastnosti

info	Získejte informace o tomto volání.

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	Získejte směr volání, ať už je to 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	Určuje, jestli je místní video zapnuté.
isMuted	Jestli je místní uživatel ztlumený, místně nebo vzdáleně.
isScreenSharingOn	Určuje, jestli je zapnuté sdílení obrazovky.
kind	Získá typ objektu volání.
lobby	Získejte předsálí schůzky Teams.
localAudioStreams	Kolekce místních zvukových streamů odesílaných jiným účastníkům hovoru
localVideoStreams	Kolekce místních video streamů odesílaných jiným účastníkům hovoru
remoteAudioStreams	Kolekce vzdálených zvukových streamů přijatých z hovoru.
remoteParticipants	Kolekce vzdálených účastníků tohoto volání. V případě hovorů se stovkami nebo více účastníky jsou v této kolekci přítomni pouze aktivní účastníci multimédií.
role	Získejte roli místního uživatele ve volání.
state	Získejte stav tohoto volání.
totalParticipantCount	Celkový počet účastníků tohoto hovoru

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)	Odebrání účastníka z tohoto hovoru

Zděděné metody

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	Načte inicializovaný a zapamatovaný objekt Feature s rozšířeným rozhraním API. Zkontrolujte vlastnosti objektu.* pro všechny dostupné funkce rozšířeného 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()	Ztlumte všechny vzdálené účastníky.
muteIncomingAudio()	Ztlumte příchozí zvuk.
off("idChanged", PropertyChangedEvent)	Funkce Odhlášení odběru události idChanged
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funkce Subscribe pro událost isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Funkce Odhlásit událost 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 Unsubscribe pro událost localVideoStreamsUpdated
off("mutedByOthers", PropertyChangedEvent)	Funkce Unsubscribe pro událost mutedByOthers
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funkce Odhlášení pro událost remoteAudioStreamsUpdated
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funkce Unsubscribe pro událost remoteParticipantsUpdated
off("roleChanged", PropertyChangedEvent)	Funkce pro odhlášení odběru události roleChanged.
off("stateChanged", PropertyChangedEvent)	Funkce Unsubscribe pro událost stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)	Funkce unsubscribe pro událost totalParticipantCountChanged.
on("idChanged", PropertyChangedEvent)	Funkce Subscribe pro událost idChanged
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funkce Subscribe pro událost isIncomingAudioMutedChanged.
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 událost localAudioStreamsUpdated
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Funkce Subscribe pro událost localVideoStreamsUpdated
on("mutedByOthers", PropertyChangedEvent)	Funkce Subscribe pro událost mutedByOthers
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funkce Subscribe pro událost remoteAudioStreamsUpdated
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funkce Subscribe pro událost remoteParticipantsUpdated
on("roleChanged", PropertyChangedEvent)	Funkce Subscribe pro událost roleChanged.
on("stateChanged", PropertyChangedEvent)	Funkce Subscribe pro událost stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)	Funkce Subscribe pro událost totalParticipantCountChanged
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. Poslední použitá omezení budou menší nebo rovna hodnotám zadaným pro tuto metodu. 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)	Zahájení zvuku v hovoru pomocí vlastního zvuku Zdrojem 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 se podporuje v iOSu a Androidu.
startScreenSharing(LocalVideoStream)	Začněte v hovoru odesílat nezpracovaný stream sdílení obrazovky. Odesílání nezpracovaných sdílení obrazovky není podporováno v iOSu ani Androidu. Příchozí sdílení nezpracované obrazovky je podporované v iOSu a Androidu.
startVideo(LocalVideoStream)	Začněte posílat stream videa v hovoru. Vzdálení účastníci hovoru dostanou váš stream videa, aby ho mohli vykreslit ve svých uživatelských rozhraních.
stopAudio()	Zastavte vlastní zvuk v hovoru a přepněte na výchozí zvukové zařízení Správce zařízení.
stopScreenSharing()	Zastavte místní sdílení obrazovky.
stopScreenSharing(LocalVideoStream)	Zastavte místní sdílení obrazovky.
stopVideo(LocalVideoStream)	Zastavte odesílání streamu videa v hovoru. Musí předat stejný objekt LocalVideoStream, který byl použit ke spuštění videa v rozhraní API CallAgent.startCall(), CallAgent.join() API, IncomingCall.accept() API nebo Call.startVideo().
unmute()	Zrušte ztlumení místního mikrofonu.
unmuteIncomingAudio()	Zrušte ztlumení příchozího zvuku.

Podrobnosti vlastnosti

info

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

Získejte informace o tomto volání.

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

Získejte směr volání, ať už je to 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 zCallCommon.id

isIncomingAudioMuted

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

isIncomingAudioMuted: boolean

Hodnota vlastnosti

boolean

Zděděno zCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Určuje, jestli je místní video zapnuté.

isLocalVideoStarted: boolean

Hodnota vlastnosti

boolean

Zděděno zCallCommon.isLocalVideoStarted

isMuted

Jestli 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íská 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 zCallCommon.lobby

localAudioStreams

Kolekce místních zvukových streamů odesílaných jiným účastníkům hovoru

localAudioStreams: readonly LocalAudioStream[]

Hodnota vlastnosti

readonly LocalAudioStream[]

Zděděno zCallCommon.localAudioStreams

localVideoStreams

Kolekce místních video streamů odesílaných jiným účastníkům hovoru

localVideoStreams: readonly LocalVideoStream[]

Hodnota vlastnosti

readonly LocalVideoStream[]

Zděděno zCallCommon.localVideoStreams

remoteAudioStreams

Kolekce vzdálených zvukových streamů přijatých z hovoru.

remoteAudioStreams: readonly RemoteAudioStream[]

Hodnota vlastnosti

readonly RemoteAudioStream[]

Zděděno zCallCommon.remoteAudioStreams

remoteParticipants

Kolekce vzdálených účastníků tohoto volání. V případě hovorů se stovkami nebo více účastníky jsou v této kolekci přítomni pouze aktivní účastníci multimédií.

remoteParticipants: readonly RemoteParticipant[]

Hodnota vlastnosti

readonly RemoteParticipant[]

Zděděno zCallCommon.remoteParticipants

role

Získejte roli místního uživatele ve volání.

role: ParticipantRole

Hodnota vlastnosti

ParticipantRole

Zděděno zCallCommon.role

state

Získejte stav tohoto volání.

state: CallState

Hodnota vlastnosti

CallState

Zděděno zCallCommon.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í.

Celkový počet účastníků tohoto hovoru

totalParticipantCount: number

Hodnota vlastnosti

number

Zděděno zCallCommon.totalParticipantCount

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ý se má 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ý se má přidat.

options

AddCommunicationUserOptions

Další možnosti pro správu 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á se má 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ý se má přidat.

options

AddMicrosoftTeamsUserOptions

Další možnosti pro správu 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ý se má 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 v 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)

Odebrání účastníka z tohoto hovoru

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

Parametry

identifier

CommunicationIdentifier

Identifikátor účastníka, který se má 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 zapamatovaný objekt Feature s rozšířeným rozhraním API. Zkontrolujte vlastnosti objektu.* pro všechny dostupné funkce rozšířeného 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>

Továrna pro konstruktor funkcí volání, který poskytuje rozšířené rozhraní API.

Návraty

TFeature

Zděděno zcallCommon.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 zCallCommon.hold

mute()

Ztlumit místní mikrofon.

function mute(): Promise<void>

Návraty

Promise<void>

Zděděno zCallCommon.mute

muteAllRemoteParticipants()

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

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

function muteAllRemoteParticipants(): Promise<void>

Návraty

Promise<void>

Zděděno zcallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Ztlumte příchozí zvuk.

function muteIncomingAudio(): Promise<void>

Návraty

Promise<void>

Zděděno zCallCommon.muteIncomingAudio

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

zpětné volání 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 událost isIncomingAudioMutedChanged.

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

Parametry

event

"isIncomingAudioMutedChanged"

název události.

listener

PropertyChangedEvent

zpětné volání fn, která bude volána, když se změní hodnota této vlastnosti.

Zděděno zCallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Funkce Odhlásit událost isLocalVideoStartedChanged.

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

Parametry

event

"isLocalVideoStartedChanged"

název události.

listener

PropertyChangedEvent

zpětné volání fn, která bude volána, když se změní hodnota 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

zpětné volání fn, která bude volána, když se změní hodnota 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

zpětné volání 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>

zpětné volání 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 Unsubscribe pro událost localVideoStreamsUpdated

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

Parametry

event

"localVideoStreamsUpdated"

název události.

listener

CollectionUpdatedEvent<LocalVideoStream>

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

Zděděno zCallCommon.off

off("mutedByOthers", 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 Unsubscribe pro událost mutedByOthers

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

Parametry

event

"mutedByOthers"

název události.

listener

PropertyChangedEvent

fn zpětného volání, která byla použita k odhlášení odběru této události.

Zděděno zCallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Funkce Odhlášení pro událost remoteAudioStreamsUpdated

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

Parametry

event

"remoteAudioStreamsUpdated"

název události.

listener

CollectionUpdatedEvent<RemoteAudioStream>

zpětné volání 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 Unsubscribe pro událost remoteParticipantsUpdated

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

Parametry

event

"remoteParticipantsUpdated"

název události.

listener

CollectionUpdatedEvent<RemoteParticipant>

zpětné volání 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 pro odhlášení odběru události roleChanged.

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

Parametry

event

"roleChanged"

název události.

listener

PropertyChangedEvent

zpětné volání 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 Unsubscribe pro událost stateChanged.

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

Parametry

event

"stateChanged"

název události.

listener

PropertyChangedEvent

zpětné volání 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 unsubscribe pro událost totalParticipantCountChanged.

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

Parametry

event

"totalParticipantCountChanged"

název události.

listener

PropertyChangedEvent

zpětné volání fn, která bude volána, když se změní počet účastníků.

Zděděno zCallCommon.off

on("idChanged", PropertyChangedEvent)

Funkce Subscribe pro událost idChanged

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

Parametry

event

"idChanged"

název události.

listener

PropertyChangedEvent

callback fn, která bude volána při změně hodnoty této vlastnosti.

Zděděno zCallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Funkce Subscribe pro událost isIncomingAudioMutedChanged.

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

Parametry

event

"isIncomingAudioMutedChanged"

název události.

listener

PropertyChangedEvent

callback fn, která bude volána 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ána 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ána 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ána při změně hodnoty této vlastnosti.

Zděděno zCallCommon.on

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Funkce Subscribe pro událost localAudioStreamsUpdated

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

Parametry

event

"localAudioStreamsUpdated"

název události.

listener

CollectionUpdatedEvent<LocalAudioStream>

zpětné volání fn, která bude volána, když se tato kolekce změní, bude předávat pole přidaných a odebraných prvků.

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>

zpětné volání fn, která bude volána, když se tato kolekce změní, bude předávat pole přidaných a odebraných prvků.

Zděděno zCallCommon.on

on("mutedByOthers", 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 událost mutedByOthers

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

Parametry

event

"mutedByOthers"

název události.

listener

PropertyChangedEvent

zpětné volání 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>

zpětné volání fn, která bude volána, když se tato kolekce změní, bude předávat pole přidaných a odebraných prvků.

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>

zpětné volání fn, která bude volána, když se tato kolekce změní, bude předávat pole přidaných a odebraných prvků.

Zděděno zCallCommon.on

on("roleChanged", PropertyChangedEvent)

Funkce Subscribe pro událost roleChanged.

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

Parametry

event

"roleChanged"

název události.

listener

PropertyChangedEvent

callback fn, která bude volána při změně hodnoty této vlastnosti.

Zděděno zCallCommon.on

on("stateChanged", PropertyChangedEvent)

Funkce Subscribe pro událost stateChanged.

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

Parametry

event

"stateChanged"

název události.

listener

PropertyChangedEvent

callback fn, která bude volána 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 událost totalParticipantCountChanged

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

Parametry

event

"totalParticipantCountChanged"

název události.

listener

PropertyChangedEvent

zpětné volání fn, která bude volána, když se změní počet účastníků.

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. Poslední použitá omezení budou menší nebo rovna hodnotám zadaným pro tuto metodu. 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)

Zahájení zvuku v hovoru pomocí vlastního zvuku Zdrojem 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 se podporuje v iOSu a Androidu.

function startScreenSharing(): Promise<void>

Návraty

Promise<void>

Zděděno zCallCommon.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 v hovoru odesílat nezpracovaný stream sdílení obrazovky.
• Odesílání nezpracovaných sdílení obrazovky není podporováno v iOSu ani Androidu.
• Příchozí sdílení nezpracované obrazovky je podporované v iOSu a Androidu.

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

Parametry

localVideoStream

LocalVideoStream

Představuje místní nezpracovaný stream sdílení obrazovky, který přijímá MediaStream v konstruktoru.

Návraty

Promise<void>

Zděděno zCallCommon.startScreenSharing

startVideo(LocalVideoStream)

Začněte posílat stream videa v hovoru. Vzdálení účastníci hovoru dostanou váš stream videa, 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í video stream, který přebírá zdroj kamery v konstruktoru.

Návraty

Promise<void>

Zděděno zCallCommon.startVideo

stopAudio()

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

function stopAudio()

Zděděno zCallCommon.stopAudio

stopScreenSharing()

Zastavte místní sdílení obrazovky.

function stopScreenSharing(): Promise<void>

Návraty

Promise<void>

Zděděno zCallCommon.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 místní sdílení obrazovky.

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

Parametry

localVideoStream

LocalVideoStream

Místní stream sdílení obrazovky pro zastavení streamování.

Návraty

Promise<void>

Zděděno zCallCommon.stopScreenSharing

stopVideo(LocalVideoStream)

Zastavte odesílání streamu videa v hovoru. Musí předat stejný objekt LocalVideoStream, který byl použit ke spuštění videa v rozhraní API CallAgent.startCall(), CallAgent.join() API, IncomingCall.accept() API nebo Call.startVideo().

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

Parametry

localVideoStream

LocalVideoStream

Místní video stream pro zastavení streamování.

Návraty

Promise<void>

Zděděno zCallCommon.stopVideo

unmute()

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

function unmute(): Promise<void>

Návraty

Promise<void>

Zděděno zCallCommon.unmute

unmuteIncomingAudio()

Zrušte ztlumení příchozího zvuku.

function unmuteIncomingAudio(): Promise<void>

Návraty

Promise<void>

Zděděno zCallCommon.unmuteIncomingAudio