TeamsCall interface

Paket:

@azure/communication-calling

Representerar ett Teams-samtal.

Extends

CallCommon

Egenskaper

info	Hämta information om det här Teams-samtalet.

Ärvda egenskaper

callEndReason	Innehåller kod/underkod som anger hur det här anropet avslutades.
callerInfo	Uppringarinformation om det här samtalet är inkommande.
direction	Hämta samtalsriktningen, oavsett om det är Inkommande eller Utgående.
id	Hämta det unika ID:t för det här samtalet.
isIncomingAudioMuted	Om den lokala användaren har stängt av inkommande ljud.
isLocalVideoStarted	Om lokal video är på.
isMuted	Oavsett om den lokala användaren är avstängd, lokalt eller via fjärranslutning.
isScreenSharingOn	Om skärmdelning är aktiverat.
kind	Hämta typen av anropsobjekt.
lobby	Hämta möteslobbyn för Teams.
localAudioStreams	Insamling av lokala ljudströmmar som skickas till andra deltagare i ett samtal.
localVideoStreams	Insamling av lokala videoströmmar som skickas till andra deltagare i ett samtal.
remoteAudioStreams	Insamling av fjärrljudströmmar som tas emot från samtalet.
remoteParticipants	Insamling av fjärrdeltagare i det här anropet. Vid samtal med deltagare på hundra eller fler finns endast mediaaktiva deltagare i den här samlingen.
role	Hämta rollen för den lokala användaren i anropet.
state	Hämta tillståndet för det här samtalet.
totalParticipantCount	Antal deltagare i det här samtalet.

Metoder

addParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier, AddTeamsParticipantOptions)	Lägg till en deltagare.
removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)	Ta bort en deltagare från det här anropet.

Ärvda metoder

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	Hämtar ett initierat och pmiserat funktionsobjekt med utökat API. Kontrollera objektfunktionerna.* för alla tillgängliga funktioner för utökade anrop i det här paketet, till exempel: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Lägg på.
hold()	Vänta med samtalet.
mute()	Stäng av den lokala mikrofonen.
muteAllRemoteParticipants()	Stäng av ljudet för alla fjärranslutna deltagare.
muteIncomingAudio()	Stäng av ljudet för inkommande ljud.
off("idChanged", PropertyChangedEvent)	Funktionen Avbryt prenumeration för idChanged-händelse.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funktionen Subscribe för isIncomingAudioMutedChanged-händelsen.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Funktionen Avbryt prenumeration för isLocalVideoStartedChanged-händelsen.
off("isMutedChanged", PropertyChangedEvent)	Funktionen Subscribe för händelsen isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Funktionen Avbryt prenumeration för isScreenSharingChanged-händelsen.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Funktionen Avbryt prenumeration för händelsen localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Funktionen Avbryt prenumeration för händelsen localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	Funktionen Avbryt prenumeration för mutedByOthers-händelsen.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funktionen Avbryt prenumeration för remoteAudioStreamsUpdated-händelsen.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funktionen Avbryt prenumeration för remoteParticipantsUpdated-händelsen.
off("roleChanged", PropertyChangedEvent)	Funktionen Avbryt prenumeration för roleChanged-händelse.
off("stateChanged", PropertyChangedEvent)	Funktionen Avbryt prenumeration för stateChanged-händelse.
off("totalParticipantCountChanged", PropertyChangedEvent)	funktionen för att avbryta prenumerationen för händelsen totalParticipantCountChanged.
on("idChanged", PropertyChangedEvent)	Prenumerationsfunktion för idChanged-händelse.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Funktionen Subscribe för isIncomingAudioMutedChanged-händelsen.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Funktionen Subscribe för händelsen isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	Funktionen Subscribe för händelsen isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Funktionen Subscribe för händelsen isScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Funktionen Subscribe för localAudioStreamsUpdated-händelsen.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Funktionen Subscribe för händelsen localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	Prenumerationsfunktion för mutedByOthers-händelse.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funktionen Subscribe för remoteAudioStreamsUpdated-händelsen.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funktionen Subscribe för remoteParticipantsUpdated-händelsen.
on("roleChanged", PropertyChangedEvent)	Prenumerationsfunktion för roleChanged-händelse.
on("stateChanged", PropertyChangedEvent)	Prenumerationsfunktion för stateChanged-händelse.
on("totalParticipantCountChanged", PropertyChangedEvent)	Funktionen Subscribe för händelsen totalParticipantCountChanged.
resume()	Återuppta det här anropet om det är i tillståndet "LocalHold".
sendDtmf(DtmfTone)	Skicka DTMF-tonen.
setConstraints(CallConstraints)	Ange anropsbegränsningar. Den här metoden anger maxbegränsningarna för baserat på de angivna värdena. De sista tillämpade begränsningarna är mindre än eller lika med de värden som anges här för den här metoden. Om 0 värde anges tillämpas ingen begränsning för den begränsningen. Om ett odefinierat värde anges används det tidigare värdet för den begränsningen.
startAudio(LocalAudioStream)	Starta ljud i samtalet med anpassat ljud. LocalAudioStream-källan ska vara en MediaStream.
startScreenSharing()	Börja skicka skärmdelningsström i ett samtal. Webbläsaren uppmanas att välja fliken skärm, app eller webbläsare. Det går inte att skicka skärmdelningsström på iOS eller Android. Inkommande skärmdelningsström stöds på iOS och Android.
startScreenSharing(LocalVideoStream)	Börja skicka rå skärmdelningsström i ett anrop. Det går inte att skicka råskärmsdelning på iOS eller Android. Inkommande råskärmsdelning stöds på iOS och Android.
startVideo(LocalVideoStream)	Börja skicka videoström i samtalet. Fjärrdeltagare i samtalet får din videoström så att de kan rendera den i sina UIs.
stopAudio()	Stoppa anpassat ljud i samtalet och växla till Enhetshanterarens standardljudenhet.
stopScreenSharing()	Stoppa lokal skärmdelning.
stopScreenSharing(LocalVideoStream)	Stoppa lokal skärmdelning.
stopVideo(LocalVideoStream)	Sluta skicka videoström i samtalet. Måste skicka samma LocalVideoStream-objekt som användes för att starta video i API:et CallAgent.startCall(), CallAgent.join() API, IncomingCall.accept() API eller Call.startVideo() API.
unmute()	Slå på den lokala mikrofonen.
unmuteIncomingAudio()	Slå på ljudet för inkommande ljud.

Egenskapsinformation

info

Hämta information om det här Teams-samtalet.

info: TeamsCallInfo

Egenskapsvärde

TeamsCallInfo

Information om ärvda egenskaper

callEndReason

Innehåller kod/underkod som anger hur det här anropet avslutades.

callEndReason?: CallEndReason

Egenskapsvärde

CallEndReason

Ärvd frånCallCommon.callEndReason

callerInfo

Uppringarinformation om det här samtalet är inkommande.

callerInfo: CallerInfo

Egenskapsvärde

CallerInfo

Ärvd frånCallCommon.callerInfo

direction

Hämta samtalsriktningen, oavsett om det är Inkommande eller Utgående.

direction: CallDirection

Egenskapsvärde

CallDirection

Ärvd frånCallCommon.direction

id

Hämta det unika ID:t för det här samtalet.

id: string

Egenskapsvärde

string

Ärvd frånCallCommon.id

isIncomingAudioMuted

Om den lokala användaren har stängt av inkommande ljud.

isIncomingAudioMuted: boolean

Egenskapsvärde

boolean

Ärvd frånCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Om lokal video är på.

isLocalVideoStarted: boolean

Egenskapsvärde

boolean

Ärvd frånCallCommon.isLocalVideoStarted

isMuted

Oavsett om den lokala användaren är avstängd, lokalt eller via fjärranslutning.

isMuted: boolean

Egenskapsvärde

boolean

Ärvd frånCallCommon.isMuted

isScreenSharingOn

Om skärmdelning är aktiverat.

isScreenSharingOn: boolean

Egenskapsvärde

boolean

Ärvd frånCallCommon.isScreenSharingOn

kind

Hämta typen av anropsobjekt.

kind: CallKind

Egenskapsvärde

CallKind

Ärvd frånCallCommon.kind

lobby

Hämta möteslobbyn för Teams.

lobby: Lobby

Egenskapsvärde

Lobby

Ärvd frånCallCommon.lobby

localAudioStreams

Insamling av lokala ljudströmmar som skickas till andra deltagare i ett samtal.

localAudioStreams: readonly LocalAudioStream[]

Egenskapsvärde

readonly LocalAudioStream[]

Ärvd frånCallCommon.localAudioStreams

localVideoStreams

Insamling av lokala videoströmmar som skickas till andra deltagare i ett samtal.

localVideoStreams: readonly LocalVideoStream[]

Egenskapsvärde

readonly LocalVideoStream[]

Ärvd frånCallCommon.localVideoStreams

remoteAudioStreams

Insamling av fjärrljudströmmar som tas emot från samtalet.

remoteAudioStreams: readonly RemoteAudioStream[]

Egenskapsvärde

readonly RemoteAudioStream[]

Ärvd frånCallCommon.remoteAudioStreams

remoteParticipants

Insamling av fjärrdeltagare i det här anropet. Vid samtal med deltagare på hundra eller fler finns endast mediaaktiva deltagare i den här samlingen.

remoteParticipants: readonly RemoteParticipant[]

Egenskapsvärde

readonly RemoteParticipant[]

Ärvd frånCallCommon.remoteParticipants

role

Hämta rollen för den lokala användaren i anropet.

role: ParticipantRole

Egenskapsvärde

ParticipantRole

Ärvd frånCallCommon.role

state

Hämta tillståndet för det här samtalet.

state: CallState

Egenskapsvärde

CallState

Ärvd frånCallCommon.state

totalParticipantCount

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Antal deltagare i det här samtalet.

totalParticipantCount: number

Egenskapsvärde

number

Ärvt frånCallCommon.totalParticipantCount

Metodinformation

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

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Lägg till en deltagare.

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

Parametrar

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier

Deltagare som ska läggas till

options

AddTeamsParticipantOptions

AddTeamsParticipantOptions

Returer

RemoteParticipant

removeParticipant(PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier)

Ta bort en deltagare från det här anropet.

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

Parametrar

participant

PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | UnknownIdentifier

deltagaren som ska tas bort.

Returer

Promise<void>

Ärvd metodinformation

dispose()

function dispose()

Ärvd frånCallCommon.dispose

feature<TFeature>(CallFeatureFactory<TFeature>)

Hämtar ett initierat och pmiserat funktionsobjekt med utökat API. Kontrollera objektfunktionerna.* för alla tillgängliga funktioner för utökade anrop i det här paketet, till exempel:

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

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

Parametrar

factory

CallFeatureFactory<TFeature>

Fabriken för anropsfunktionskonstruktorn som tillhandahåller ett utökat API.

Returer

TFeature

Ärvd frånCallCommon.feature

hangUp(HangUpOptions)

Lägg på.

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

Parametrar

options

HangUpOptions

HangUp-alternativ.

Returer

Promise<void>

Ärvd frånCallCommon.hangUp

hold()

Vänta med samtalet.

function hold(): Promise<void>

Returer

Promise<void>

Ärvd frånCallCommon.hold

mute()

Stäng av den lokala mikrofonen.

function mute(): Promise<void>

Returer

Promise<void>

Ärvd frånCallCommon.mute

muteAllRemoteParticipants()

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Stäng av ljudet för alla fjärranslutna deltagare.

function muteAllRemoteParticipants(): Promise<void>

Returer

Promise<void>

Ärvd frånCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Stäng av ljudet för inkommande ljud.

function muteIncomingAudio(): Promise<void>

Returer

Promise<void>

Ärvd frånCallCommon.muteIncomingAudio

off("idChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för idChanged-händelse.

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

Parametrar

event

"idChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

Ärvd frånCallCommon.off

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Funktionen Subscribe för isIncomingAudioMutedChanged-händelsen.

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

Parametrar

event

"isIncomingAudioMutedChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för isLocalVideoStartedChanged-händelsen.

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

Parametrar

event

"isLocalVideoStartedChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.off

off("isMutedChanged", PropertyChangedEvent)

Funktionen Subscribe för händelsen isMutedChanged.

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

Parametrar

event

"isMutedChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.off

off("isScreenSharingOnChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för isScreenSharingChanged-händelsen.

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

Parametrar

event

"isScreenSharingOnChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

Ärvd frånCallCommon.off

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Funktionen Avbryt prenumeration för händelsen localAudioStreamsUpdated.

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

Parametrar

event

"localAudioStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn som användes för att prenumerera på den här händelsen.

Ärvd frånCallCommon.off

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Funktionen Avbryt prenumeration för händelsen localVideoStreamsUpdated.

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

Parametrar

event

"localVideoStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn som användes för att prenumerera på den här händelsen.

Ärvd frånCallCommon.off

off("mutedByOthers", PropertyChangedEvent)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Funktionen Avbryt prenumeration för mutedByOthers-händelsen.

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

Parametrar

event

"mutedByOthers"

händelsenamn.

listener

PropertyChangedEvent

callback fn som användes för att avbryta prenumerationen på den här händelsen.

Ärvd frånCallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Funktionen Avbryt prenumeration för remoteAudioStreamsUpdated-händelsen.

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

Parametrar

event

"remoteAudioStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn som användes för att prenumerera på den här händelsen.

Ärvd frånCallCommon.off

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Funktionen Avbryt prenumeration för remoteParticipantsUpdated-händelsen.

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

Parametrar

event

"remoteParticipantsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn som användes för att prenumerera på den här händelsen.

Ärvd frånCallCommon.off

off("roleChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för roleChanged-händelse.

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

Parametrar

event

"roleChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

Ärvd frånCallCommon.off

off("stateChanged", PropertyChangedEvent)

Funktionen Avbryt prenumeration för stateChanged-händelse.

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

Parametrar

event

"stateChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

Ärvd frånCallCommon.off

off("totalParticipantCountChanged", PropertyChangedEvent)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

funktionen för att avbryta prenumerationen för händelsen totalParticipantCountChanged.

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

Parametrar

event

"totalParticipantCountChanged"

händelsenamn.

listener

PropertyChangedEvent

motringning fn som anropas när antalet deltagare ändras.

Ärvd frånCallCommon.off

on("idChanged", PropertyChangedEvent)

Prenumerationsfunktion för idChanged-händelse.

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

Parametrar

event

"idChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Funktionen Subscribe för isIncomingAudioMutedChanged-händelsen.

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

Parametrar

event

"isIncomingAudioMutedChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.on

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Funktionen Subscribe för händelsen isLocalVideoStartedChanged.

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

Parametrar

event

"isLocalVideoStartedChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.on

on("isMutedChanged", PropertyChangedEvent)

Funktionen Subscribe för händelsen isMutedChanged.

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

Parametrar

event

"isMutedChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.on

on("isScreenSharingOnChanged", PropertyChangedEvent)

Funktionen Subscribe för händelsen isScreenSharingChanged.

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

Parametrar

event

"isScreenSharingOnChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.on

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Funktionen Subscribe för localAudioStreamsUpdated-händelsen.

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

Parametrar

event

"localAudioStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<LocalAudioStream>

motringning fn som anropas när den här samlingen kommer att ändras, kommer den att skicka matriser med tillagda och borttagna element.

Ärvd frånCallCommon.on

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Funktionen Subscribe för händelsen localVideoStreamsUpdated.

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

Parametrar

event

"localVideoStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<LocalVideoStream>

motringning fn som anropas när den här samlingen kommer att ändras, kommer den att skicka matriser med tillagda och borttagna element.

Ärvd frånCallCommon.on

on("mutedByOthers", PropertyChangedEvent)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Prenumerationsfunktion för mutedByOthers-händelse.

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

Parametrar

event

"mutedByOthers"

händelsenamn.

listener

PropertyChangedEvent

callback fn som användes för att prenumerera på den här händelsen.

Ärvd frånCallCommon.on

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Funktionen Subscribe för remoteAudioStreamsUpdated-händelsen.

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

Parametrar

event

"remoteAudioStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<RemoteAudioStream>

motringning fn som anropas när den här samlingen kommer att ändras, kommer den att skicka matriser med tillagda och borttagna element.

Ärvd frånCallCommon.on

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Funktionen Subscribe för remoteParticipantsUpdated-händelsen.

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

Parametrar

event

"remoteParticipantsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<RemoteParticipant>

motringning fn som anropas när den här samlingen kommer att ändras, kommer den att skicka matriser med tillagda och borttagna element.

Ärvd frånCallCommon.on

on("roleChanged", PropertyChangedEvent)

Prenumerationsfunktion för roleChanged-händelse.

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

Parametrar

event

"roleChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.on

on("stateChanged", PropertyChangedEvent)

Prenumerationsfunktion för stateChanged-händelse.

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

Parametrar

event

"stateChanged"

händelsenamn.

listener

PropertyChangedEvent

callback fn som anropas när värdet för den här egenskapen ändras.

Ärvd frånCallCommon.on

on("totalParticipantCountChanged", PropertyChangedEvent)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Funktionen Subscribe för händelsen totalParticipantCountChanged.

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

Parametrar

event

"totalParticipantCountChanged"

händelsenamn.

listener

PropertyChangedEvent

motringning fn som anropas när antalet deltagare ändras.

Ärvd frånCallCommon.on

resume()

Återuppta det här anropet om det är i tillståndet "LocalHold".

function resume(): Promise<void>

Returer

Promise<void>

Ärvd frånCallCommon.resume

sendDtmf(DtmfTone)

Skicka DTMF-tonen.

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

Parametrar

dtmfTone

DtmfTone

Returer

Promise<void>

Ärvd frånCallCommon.sendDtmf

setConstraints(CallConstraints)

Ange anropsbegränsningar. Den här metoden anger maxbegränsningarna för baserat på de angivna värdena. De sista tillämpade begränsningarna är mindre än eller lika med de värden som anges här för den här metoden. Om 0 värde anges tillämpas ingen begränsning för den begränsningen. Om ett odefinierat värde anges används det tidigare värdet för den begränsningen.

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

Parametrar

constraints

CallConstraints

Objekt som representerar de anropsbegränsningar som ska anges

Returer

Promise<void>

Ärvd frånCallCommon.setConstraints

startAudio(LocalAudioStream)

Starta ljud i samtalet med anpassat ljud. LocalAudioStream-källan ska vara en MediaStream.

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

Parametrar

localAudioStream

LocalAudioStream

Returer

Promise<void>

Ärvd frånCallCommon.startAudio

startScreenSharing()

• Börja skicka skärmdelningsström i ett samtal. Webbläsaren uppmanas att välja fliken skärm, app eller webbläsare.
• Det går inte att skicka skärmdelningsström på iOS eller Android.
• Inkommande skärmdelningsström stöds på iOS och Android.

function startScreenSharing(): Promise<void>

Returer

Promise<void>

Ärvd frånCallCommon.startScreenSharing

startScreenSharing(LocalVideoStream)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

• Börja skicka rå skärmdelningsström i ett anrop.
• Det går inte att skicka råskärmsdelning på iOS eller Android.
• Inkommande råskärmsdelning stöds på iOS och Android.

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

Parametrar

localVideoStream

LocalVideoStream

Representerar en lokal rå skärmdelningsström som tar en MediaStream i konstruktor.

Returer

Promise<void>

Ärvd frånCallCommon.startScreenSharing

startVideo(LocalVideoStream)

Börja skicka videoström i samtalet. Fjärrdeltagare i samtalet får din videoström så att de kan rendera den i sina UIs.

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

Parametrar

localVideoStream

LocalVideoStream

Representerar en lokal videoström som tar en kamerakälla i konstruktorn.

Returer

Promise<void>

Ärvd frånCallCommon.startVideo

stopAudio()

Stoppa anpassat ljud i samtalet och växla till Enhetshanterarens standardljudenhet.

function stopAudio()

Ärvd frånCallCommon.stopAudio

stopScreenSharing()

Stoppa lokal skärmdelning.

function stopScreenSharing(): Promise<void>

Returer

Promise<void>

Ärvd frånCallCommon.stopScreenSharing

stopScreenSharing(LocalVideoStream)

Anteckning

Denna API är i betaversion och tillhandahålls som en förhandsversion för utvecklare och kan komma att ändras utifrån den feedback vi får. Använd inte detta API i en produktionsmiljö.

Stoppa lokal skärmdelning.

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

Parametrar

localVideoStream

LocalVideoStream

Den lokala skärmdelningsströmmen för att stoppa direktuppspelningen.

Returer

Promise<void>

Ärvd frånCallCommon.stopScreenSharing

stopVideo(LocalVideoStream)

Sluta skicka videoström i samtalet. Måste skicka samma LocalVideoStream-objekt som användes för att starta video i API:et CallAgent.startCall(), CallAgent.join() API, IncomingCall.accept() API eller Call.startVideo() API.

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

Parametrar

localVideoStream

LocalVideoStream

Den lokala videoströmmen för att stoppa strömning.

Returer

Promise<void>

Ärvd frånCallCommon.stopVideo

unmute()

Slå på den lokala mikrofonen.

function unmute(): Promise<void>

Returer

Promise<void>

Ärvd frånCallCommon.unmute

unmuteIncomingAudio()

Slå på ljudet för inkommande ljud.

function unmuteIncomingAudio(): Promise<void>

Returer

Promise<void>

Ärvd frånCallCommon.unmuteIncomingAudio