Call interface
Representerar ett anrop.
- Extends
Egenskaper
info | Hämta information om det här samtalet. |
Ärvda egenskaper
call |
Innehåller kod/underkod som anger hur det här anropet avslutades. |
caller |
Uppringarens information 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 anropet. |
is |
Om den lokala användaren stängde av inkommande ljud. |
is |
Om lokal video är på. |
is |
Om den lokala användaren är avstängd, lokalt eller via fjärranslutning. |
is |
Om skärmdelning är aktiverat. |
kind | Hämta typen av anropsobjekt. |
lobby | Hämta möteslobbyn för Teams. |
local |
Insamling av lokala ljudströmmar som skickas till andra deltagare i ett samtal. |
local |
Insamling av lokala videoströmmar som skickas till andra deltagare i ett samtal. |
remote |
Insamling av fjärrljudströmmar som tas emot från samtalet. |
remote |
Insamling av fjärranslutna deltagare i det här samtalet. Vid samtal med deltagare på hundra eller fler finns endast mediaaktiva deltagare i denna samling. |
role | Hämta rollen för den lokala användaren i anropet. |
state | Hämta tillståndet för det här anropet. |
total |
Antal deltagare i det här samtalet. |
Metoder
add |
Lägg till en deltagare i det här anropet. |
add |
Lägg till en deltagare i det här anropet. |
add |
Lägg till en Teams-app i det här anropet. |
add |
Lägg till en deltagare i det här anropet. |
add |
Lägg till en deltagare i det här anropet. |
remove |
Ta bort en deltagare från det här samtalet. |
Ärvda metoder
dispose() | |
feature<TFeature>(Call |
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:
|
hang |
Lägg på. |
hold() | Vänta med samtalet. |
mute() | Stäng av den lokala mikrofonen. |
mute |
Stäng av ljudet för alla fjärranslutna deltagare. |
mute |
Stäng av ljudet för inkommande ljud. |
off("id |
Funktionen Avbryt prenumeration för idChanged-händelse. |
off("is |
Funktionen Subscribe för isIncomingAudioMutedChanged-händelsen. |
off("is |
Funktionen Avbryt prenumeration för isLocalVideoStartedChanged-händelsen. |
off("is |
Funktionen Subscribe för händelsen isMutedChanged. |
off("is |
Funktionen Avsluta prenumeration för isScreenSharingChanged-händelsen. |
off("local |
Avprenumerationsfunktionen för localAudioStreamsUpdated-händelsen. |
off("local |
Avsluta prenumerationsfunktionen för localVideoStreamsUpdated-händelsen. |
off("muted |
Avsluta prenumerationsfunktionen för mutedByOthers-händelsen. |
off("remote |
Funktionen Avbryt prenumeration för remoteAudioStreamsUpdated-händelsen. |
off("remote |
Avprenumerationsfunktionen för remoteParticipantsUpdated-händelsen. |
off("role |
Avsluta prenumerationsfunktionen för roleChanged-händelsen. |
off("state |
Avsluta prenumerationsfunktionen för stateChanged-händelsen. |
off("total |
funktionen unsubscribe för totalParticipantCountChanged-händelsen. |
on("id |
Prenumerationsfunktion för idChanged-händelse. |
on("is |
Funktionen Prenumerera på händelsen isIncomingAudioMutedChanged. |
on("is |
Funktionen Prenumerera på händelsen isLocalVideoStartedChanged. |
on("is |
Funktionen Prenumerera på händelsen isMutedChanged. |
on("is |
Funktionen Prenumerera på händelsen isScreenSharingChanged. |
on("local |
Funktionen Subscribe för localAudioStreamsUpdated-händelsen. |
on("local |
Funktionen Prenumerera för händelsen localVideoStreamsUpdated. |
on("muted |
Prenumerationsfunktionen för mutedByOthers-händelsen. |
on("remote |
Funktionen Subscribe för remoteAudioStreamsUpdated-händelsen. |
on("remote |
Funktionen Prenumerera för remoteParticipantsUpdated-händelsen. |
on("role |
Prenumerationsfunktion för roleChanged-händelse. |
on("state |
Prenumerationsfunktion för stateChanged-händelse. |
on("total |
Funktionen Prenumerera för händelsen totalParticipantCountChanged. |
resume() | Återuppta det här anropet om det är i "LocalHold"-tillstånd. |
send |
Skicka DTMF-ton. |
set |
Ange samtalsbegränsningar. Den här metoden anger maxbegränsningarna för baserat på de angivna värdena. De slutgiltiga 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 ett odefinierat värde anges används det tidigare värdet för den begränsningen. |
start |
Starta ljud i samtalet med anpassat ljud. LocalAudioStream-källan ska vara en MediaStream. |
start |
|
start |
|
start |
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. |
stop |
Stoppa anpassat ljud i samtalet och växla till Enhetshanterarens standardljudenhet. |
stop |
Stoppa lokal skärmdelning. |
stop |
Stoppa lokal skärmdelning. |
stop |
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() eller Call.startVideo() API. |
unmute() | Slå på ljudet för den lokala mikrofonen. |
unmute |
Slå på ljudet för inkommande ljud. |
Egenskapsinformation
info
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ö.
Hämta information om det här samtalet.
info: CallInfo
Egenskapsvärde
Information om ärvda egenskaper
callEndReason
Innehåller kod/underkod som anger hur det här anropet avslutades.
callEndReason?: CallEndReason
Egenskapsvärde
Ärvd frånCallCommon.callEndReason
callerInfo
Uppringarens information om det här samtalet är inkommande.
callerInfo: CallerInfo
Egenskapsvärde
Ärvd frånCallCommon.callerInfo
direction
Hämta samtalsriktningen, oavsett om det är Inkommande eller Utgående.
direction: CallDirection
Egenskapsvärde
Ärvd frånCallCommon.direction
id
isIncomingAudioMuted
Om den lokala användaren stängde 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
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
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ärranslutna deltagare i det här samtalet. Vid samtal med deltagare på hundra eller fler finns endast mediaaktiva deltagare i denna samling.
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
Ärvd frånCallCommon.role
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(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)
Lägg till en deltagare i det här anropet.
function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant
Parametrar
- identifier
Identifieraren för deltagaren som ska läggas till.
Returer
RemoteParticipant-objektet som är associerat med den deltagare som har lagts till.
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)
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 i det här anropet.
function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant
Parametrar
- identifier
- CommunicationUserIdentifier
Identifieraren för deltagaren som ska läggas till.
- options
- AddCommunicationUserOptions
Ytterligare alternativ för att hantera anropet.
Returer
RemoteParticipant-objektet som är associerat med den deltagare som har lagts till.
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)
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 Teams-app i det här anropet.
function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant
Parametrar
- identifier
Identifieraren för Teams-appen som ska läggas till.
Returer
RemoteParticipant-objektet som är associerat med teams-appen som har lagts till.
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)
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 i det här anropet.
function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant
Parametrar
- identifier
- MicrosoftTeamsUserIdentifier
Identifieraren för deltagaren som ska läggas till.
- options
- AddMicrosoftTeamsUserOptions
Ytterligare alternativ för att hantera anropet.
Returer
RemoteParticipant-objektet som är associerat med den deltagare som har lagts till.
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Lägg till en deltagare i det här anropet.
function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant
Parametrar
- identifier
- PhoneNumberIdentifier
Identifieraren för deltagaren som ska läggas till.
- options
- AddPhoneNumberOptions
Ytterligare alternativ för att hantera PSTN-anropet. Du kan till exempel ange nummerpresentationstelefonnumret i ett PSTN-samtal.
Returer
RemoteParticipant-objektet som är associerat med den deltagare som har lagts till.
removeParticipant(CommunicationIdentifier)
Ta bort en deltagare från det här samtalet.
function removeParticipant(identifier: CommunicationIdentifier): Promise<void>
Parametrar
- identifier
- CommunicationIdentifier
Identifieraren för deltagaren som ska avlägsnas.
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()
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 Avsluta 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>)
Avprenumerationsfunktionen för localAudioStreamsUpdated-händelsen.
function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)
Parametrar
- event
-
"localAudioStreamsUpdated"
händelsenamn.
- listener
callback fn som användes för att prenumerera på den här händelsen.
Ärvd frånCallCommon.off
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)
Avsluta prenumerationsfunktionen för localVideoStreamsUpdated-händelsen.
function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)
Parametrar
- event
-
"localVideoStreamsUpdated"
händelsenamn.
- listener
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ö.
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.
Ä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
callback fn som användes för att prenumerera på den här händelsen.
Ärvd frånCallCommon.off
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
Avprenumerationsfunktionen för remoteParticipantsUpdated-händelsen.
function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)
Parametrar
- event
-
"remoteParticipantsUpdated"
händelsenamn.
- listener
callback fn som användes för att prenumerera på den här händelsen.
Ärvd frånCallCommon.off
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.
Ärvd frånCallCommon.off
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.
Ä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 unsubscribe för totalParticipantCountChanged-händelsen.
function off(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)
Parametrar
- event
-
"totalParticipantCountChanged"
händelsenamn.
- listener
- PropertyChangedEvent
callback fn som anropas när deltagarantalet ä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 Prenumerera på händelsen isIncomingAudioMutedChanged.
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 Prenumerera på 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 Prenumerera på 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 Prenumerera på 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
callback fn som kommer att anropas när den här samlingen ändras skickas matriser med tillagda och borttagna element.
Ärvd frånCallCommon.on
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)
Funktionen Prenumerera för händelsen localVideoStreamsUpdated.
function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)
Parametrar
- event
-
"localVideoStreamsUpdated"
händelsenamn.
- listener
callback fn som kommer att anropas när den här samlingen ändras skickas 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ö.
Prenumerationsfunktionen för mutedByOthers-händelsen.
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
callback fn som kommer att anropas när den här samlingen ändras skickas matriser med tillagda och borttagna element.
Ärvd frånCallCommon.on
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)
Funktionen Prenumerera för remoteParticipantsUpdated-händelsen.
function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)
Parametrar
- event
-
"remoteParticipantsUpdated"
händelsenamn.
- listener
callback fn som kommer att anropas när den här samlingen ändras skickas 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 Prenumerera för händelsen totalParticipantCountChanged.
function on(event: "totalParticipantCountChanged", listener: PropertyChangedEvent)
Parametrar
- event
-
"totalParticipantCountChanged"
händelsenamn.
- listener
- PropertyChangedEvent
callback fn som anropas när deltagarantalet ändras.
Ärvd frånCallCommon.on
resume()
Återuppta det här anropet om det är i "LocalHold"-tillstånd.
function resume(): Promise<void>
Returer
Promise<void>
Ärvd frånCallCommon.resume
sendDtmf(DtmfTone)
Skicka DTMF-ton.
function sendDtmf(dtmfTone: DtmfTone): Promise<void>
Parametrar
- dtmfTone
- DtmfTone
Returer
Promise<void>
Ärvd frånCallCommon.sendDtmf
setConstraints(CallConstraints)
Ange samtalsbegränsningar. Den här metoden anger maxbegränsningarna för baserat på de angivna värdena. De slutgiltiga 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 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ärmdelning på iOS eller Android.
- Inkommande rådata för skärmdelning 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>
Ä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 strömning.
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() 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å ljudet för 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