CallCommon interface

Paket:

@azure/communication-calling

Gränssnittet Anropa vanligt.

Extends

Disposable

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 stängde av inkommande ljud.
isLocalVideoStarted	Om lokal video är på.
isMuted	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ärranslutna deltagare i det här samtalet. 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

feature<TFeature>(CallFeatureFactory<TFeature>)	Hämtar ett initierat och memorerat 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å samtalet.
hold()	Spärra samtalet.
mute()	Stäng av den lokala mikrofonen.
muteAllRemoteParticipants()	Stäng av ljudet för alla fjärranslutna deltagare.
muteIncomingAudio()	Stäng av inkommande ljud.
off("idChanged", PropertyChangedEvent)	Avsluta prenumerationsfunktionen för idChanged-händelsen.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Prenumerationsfunktionen för isIncomingAudioMutedChanged-händelsen.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Funktionen Avbryt prenumeration för isLocalVideoStartedChanged-händelsen.
off("isMutedChanged", PropertyChangedEvent)	Prenumerationsfunktionen för isMutedChanged-händelsen.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Funktionen Avbryt prenumeration för isScreenSharingChanged-händelsen.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Funktionen Avbryt prenumeration för localAudioStreamsUpdated-händelsen.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Funktionen Avbryt prenumeration för localVideoStreamsUpdated-händelsen.
off("mutedByOthers", PropertyChangedEvent)	Avsluta prenumerationsfunktionen för mutedByOthers-händelsen.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Funktionen Avbryt prenumeration för remoteAudioStreamsUpdated-händelsen.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Avprenumerationsfunktionen för remoteParticipantsUpdated-händelsen.
off("roleChanged", PropertyChangedEvent)	Avsluta prenumerationsfunktionen för roleChanged-händelsen.
off("stateChanged", PropertyChangedEvent)	Avsluta prenumerationsfunktionen för stateChanged-händelsen.
off("totalParticipantCountChanged", PropertyChangedEvent)	funktionen unsubscribe för totalParticipantCountChanged-händelsen.
on("idChanged", PropertyChangedEvent)	Prenumerationsfunktion för idChanged-händelse.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Prenumerationsfunktionen för isIncomingAudioMutedChanged-händelsen.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Prenumerationsfunktionen för isLocalVideoStartedChanged-händelsen.
on("isMutedChanged", PropertyChangedEvent)	Prenumerationsfunktionen för isMutedChanged-händelsen.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Prenumerationsfunktionen för isScreenSharingChanged-händelsen.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Prenumerationsfunktionen för localAudioStreamsUpdated-händelsen.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Prenumerationsfunktionen för localVideoStreamsUpdated-händelsen.
on("mutedByOthers", PropertyChangedEvent)	Prenumerationsfunktion för mutedByOthers-händelse.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Prenumerationsfunktionen för remoteAudioStreamsUpdated-händelsen.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Funktionen Prenumerera 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)	Prenumerationsfunktion för händelsen totalParticipantCountChanged.
resume()	Återuppta det här anropet om det är i tillståndet "LocalHold".
sendDtmf(DtmfTone)	Skicka DTMF-ton.
setConstraints(CallConstraints)	Ange anropsbegränsningar. Den här metoden anger maxbegränsningarna för baserat på de värden som anges. 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ärdet anges tillämpas ingen begränsning för den begränsningen. Om 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. Sändning av skärmdelningsström stöds inte 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 samtal. 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 återge 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().
unmute()	Slå på den lokala mikrofonen.
unmuteIncomingAudio()	Slå på ljudet för inkommande ljud.

Ärvda metoder

dispose()

Egenskapsinformation

callEndReason

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

callEndReason?: CallEndReason

Egenskapsvärde

CallEndReason

callerInfo

Uppringarinformation om det här samtalet är inkommande.

callerInfo: CallerInfo

Egenskapsvärde

CallerInfo

direction

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

direction: CallDirection

Egenskapsvärde

CallDirection

id

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

id: string

Egenskapsvärde

string

isIncomingAudioMuted

Om den lokala användaren stängde av inkommande ljud.

isIncomingAudioMuted: boolean

Egenskapsvärde

boolean

isLocalVideoStarted

Om lokal video är på.

isLocalVideoStarted: boolean

Egenskapsvärde

boolean

isMuted

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

isMuted: boolean

Egenskapsvärde

boolean

isScreenSharingOn

Om skärmdelning är aktiverat.

isScreenSharingOn: boolean

Egenskapsvärde

boolean

kind

Hämta typen av anropsobjekt.

kind: CallKind

Egenskapsvärde

CallKind

lobby

Hämta möteslobbyn för Teams.

lobby: Lobby

Egenskapsvärde

Lobby

localAudioStreams

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

localAudioStreams: readonly LocalAudioStream[]

Egenskapsvärde

readonly LocalAudioStream[]

localVideoStreams

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

localVideoStreams: readonly LocalVideoStream[]

Egenskapsvärde

readonly LocalVideoStream[]

remoteAudioStreams

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

remoteAudioStreams: readonly RemoteAudioStream[]

Egenskapsvärde

readonly RemoteAudioStream[]

remoteParticipants

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

remoteParticipants: readonly RemoteParticipant[]

Egenskapsvärde

readonly RemoteParticipant[]

role

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

role: ParticipantRole

Egenskapsvärde

ParticipantRole

state

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

state: CallState

Egenskapsvärde

CallState

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

Metodinformation

feature<TFeature>(CallFeatureFactory<TFeature>)

Hämtar ett initierat och memorerat 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

hangUp(HangUpOptions)

Lägg på samtalet.

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

Parametrar

options

HangUpOptions

HangUp-alternativ.

Returer

Promise<void>

hold()

Spärra samtalet.

function hold(): Promise<void>

Returer

Promise<void>

mute()

Stäng av den lokala mikrofonen.

function mute(): Promise<void>

Returer

Promise<void>

muteAllRemoteParticipants()

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

function muteAllRemoteParticipants(): Promise<void>

Returer

Promise<void>

muteIncomingAudio()

Stäng av inkommande ljud.

function muteIncomingAudio(): Promise<void>

Returer

Promise<void>

off("idChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för idChanged-händelsen.

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.

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

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

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.

off("isMutedChanged", PropertyChangedEvent)

Prenumerationsfunktionen för isMutedChanged-händelsen.

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.

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.

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

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

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.

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

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

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.

off("mutedByOthers", PropertyChangedEvent)

Avsluta prenumerationsfunktionen 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.

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.

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

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

off("roleChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för roleChanged-händelsen.

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.

off("stateChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för stateChanged-händelsen.

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.

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 unsubscribe för totalParticipantCountChanged-händelsen.

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

Parametrar

event

"totalParticipantCountChanged"

händelsenamn.

listener

PropertyChangedEvent

återanrop fn som kommer att anropas när antalet deltagare ändras.

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.

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

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

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Prenumerationsfunktionen för isLocalVideoStartedChanged-händelsen.

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.

on("isMutedChanged", PropertyChangedEvent)

Prenumerationsfunktionen för isMutedChanged-händelsen.

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.

on("isScreenSharingOnChanged", PropertyChangedEvent)

Prenumerationsfunktionen för isScreenSharingChanged-händelsen.

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.

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Prenumerationsfunktionen för localAudioStreamsUpdated-händelsen.

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

Parametrar

event

"localAudioStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<LocalAudioStream>

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

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Prenumerationsfunktionen för localVideoStreamsUpdated-händelsen.

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

Parametrar

event

"localVideoStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<LocalVideoStream>

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

on("mutedByOthers", PropertyChangedEvent)

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.

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Prenumerationsfunktionen för remoteAudioStreamsUpdated-händelsen.

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

Parametrar

event

"remoteAudioStreamsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<RemoteAudioStream>

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

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Funktionen Prenumerera för remoteParticipantsUpdated-händelsen.

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

Parametrar

event

"remoteParticipantsUpdated"

händelsenamn.

listener

CollectionUpdatedEvent<RemoteParticipant>

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

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.

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.

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

Prenumerationsfunktion för händelsen totalParticipantCountChanged.

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

Parametrar

event

"totalParticipantCountChanged"

händelsenamn.

listener

PropertyChangedEvent

återanrop fn som kommer att anropas när antalet deltagare ändras.

resume()

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

function resume(): Promise<void>

Returer

Promise<void>

sendDtmf(DtmfTone)

Skicka DTMF-ton.

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

Parametrar

dtmfTone

DtmfTone

Returer

Promise<void>

setConstraints(CallConstraints)

Ange anropsbegränsningar. Den här metoden anger maxbegränsningarna för baserat på de värden som anges. 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ärdet anges tillämpas ingen begränsning för den begränsningen. Om 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>

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>

startScreenSharing()

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

function startScreenSharing(): Promise<void>

Returer

Promise<void>

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 samtal.
• 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 konstruktorn.

Returer

Promise<void>

startVideo(LocalVideoStream)

Börja skicka videoström i samtalet. Fjärrdeltagare i samtalet får din videoström så att de kan återge 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>

stopAudio()

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

function stopAudio()

stopScreenSharing()

Stoppa lokal skärmdelning.

function stopScreenSharing(): Promise<void>

Returer

Promise<void>

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 strömning.

Returer

Promise<void>

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().

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

Parametrar

localVideoStream

LocalVideoStream

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

Returer

Promise<void>

unmute()

Slå på den lokala mikrofonen.

function unmute(): Promise<void>

Returer

Promise<void>

unmuteIncomingAudio()

Slå på ljudet för inkommande ljud.

function unmuteIncomingAudio(): Promise<void>

Returer

Promise<void>

Ärvd metodinformation

dispose()

function dispose()

ärvd frånDisposable.dispose