Share via


@azure/communication-calling package

Klasser

CallClient

CallClient är den huvudsakliga startpunkten för SDK:et. CallClient används för att skapa CallAgent och för att hämta DeviceManager.

LocalAudioStream

Representerar en lokal ljudström för en lokal michrophone-enhet

LocalVideoStream

Representerar en lokal videoström för en lokal kameraenhet

VideoStreamRenderer

Renderaren för en videoström

Gränssnitt

AcceptCallOptions

Alternativ för att acceptera ett inkommande samtal. Skicka videoströmmar som ska användas för att acceptera ett inkommande samtal. Om videoOptions är odefinierat godkänns det inkommande samtalet med lokal video inaktiverad. Om AudioOptions är odefinierat accepteras det inkommande samtalet med standardmikrofonen som källa från enhetshanteraren.

ActiveAudioEffects

Representerar aktuella aktiva ljudeffekter

AddCommunicationUserOptions

Alternativ för att lägga till en AddCommunicationUserOptions-deltagare i ett pågående anrop.

AddMicrosoftTeamsUserOptions

Alternativ för att lägga till en MicrosoftTeamsUser-deltagare i ett pågående anrop.

AddPhoneNumberOptions

Alternativ för att lägga till en PSTN-deltagare i ett pågående samtal.

AddTeamsParticipantOptions

Alternativ för att lägga till en Teams-deltagare i ett pågående Teams-anrop.

AdmitAllOperationResult

Resultat för att släppa in alla deltagare.

AdmitLobbyParticipantOptions

Alternativ för att tillåta deltagare från lobbyn.

AudioDeviceInfo

Information om en mikrofon- eller högtalarenhet.

AudioEffect

Basljudeffekt.

AudioEffectsFeature

API-gränssnittet för funktionen AudioEffects

AudioEffectsStartConfig

Representerar konfigurationen av ljudeffekter vid start av effekter

AudioEffectsStopConfig

Representerar konfigurationen av ljudeffekter vid stopp av effekter

AudioInCallDiagnostics

Diagnostik för ljudkvalitet

AudioOptions

Ljudalternativ som tillhandahålls när du ringer ett utgående samtal eller ansluter till ett gruppsamtal.

AudioStreamFeature

Representerar en ljudströmfunktion

AudioStreamFeatureContext

Representerar kontexten som tillhandahålls för utökade ljud-/videoströmfunktioner i konstruktorn.

AudioStreamFeatureFactory

Representerar fabriken för ljudströmsfunktionerna

BackgroundBlurEffect

Bakgrundsoskärpa.

BackgroundReplacementConfig

Konfiguration av bakgrundsbyte.

BackgroundReplacementEffect

Bakgrundsersättningseffekt.

BaseFeature

Representerar basgränssnittet för alla funktioner

BaseInCallDiagnostics

I Samtalsdiagnostik har samlats in

Call

Representerar ett samtal.

CallAgent

CallAgent används för att hantera anrop.

CallAgentCommon

Vanliga gränssnitt för CallAgent.

CallAgentFeature

Representerar en CallAgent-funktion.

CallAgentFeatureContext

Representerar kontexten som tillhandahålls för funktioner för utökad anropsagent i konstruktorn.

CallAgentFeatureFactory

Representerar fabriken för anropsagentfunktioner

CallAgentOptions

Alternativ för att skapa CallAgent.

CallClientFeature

Representerar en CallClient-funktion.

CallClientFeatureContext

Representerar kontexten för utökade anropsklientfunktioner i konstruktorn.

CallClientFeatureFactory

Representerar fabriken för anropsklientagentfunktioner

CallClientOptions

Alternativ för samtalsklient

CallCommon

Gränssnittet Anropa vanligt.

CallConstraints

Representerar begränsningar för ett anrop

CallDiagnostics

Anropa diagnostik

CallEndReason

Beskriver orsaken till att samtalet avslutades.

CallFeature

Representerar en samtalsfunktion.

CallFeatureContext

Representerar kontexten för utökade anropsfunktioner i konstruktorn.

CallFeatureFactory

Representerar fabriken för anropsfunktioner

CallInfo

Information om ett samtal.

CallInfoCommon

Vanliga gränssnitt för CallInfo.

CallRating

Representerar ett betyg för en samtalsundersökning.

CallSurvey

Representerar slutet av samtalsundersökningen.

CallSurveyFeature

Funktion för ACS Live Streaming

CallSurveyResponse

Representerar slutet av svar från samtalsundersökningen.

CallerInfo

Information om uppringaren.

CapabilitiesChangeInfo

Datastruktur som tas emot för varje CapabilitiesChangedEventType-händelse.

CapabilitiesFeature

Funktionsfunktion.

Captions

Datastruktur för undertextobjekt

CaptionsCallFeature

Funktion för undertexter

CaptionsCommon

Datastruktur för CaptionsCommon-objekt

CaptionsInfo

Datastruktur som tas emot för varje CaptionsReceivedEventType-händelse

CommunicationServicesError

Fel som uppstår när API-anropet misslyckas.

CompositeAudioDeviceInfo

Information om en sammansatt ljudenhet.

CreateViewOptions

Alternativ för återgivning av en videoström.

CustomContextOptions

Alternativ för att anropa anpassad kontext.

DataChannelCallFeature

DataChannel-samtalsfunktion

DataChannelMessage

DataChannel-meddelande

DataChannelReceiver

DataChannel-mottagare

DataChannelSender

DataChannel-avsändare

DebugInfoCallClientFeature

Funktion för felsökningsinformation för samtal.

DebugInfoDump

dump-ID är en unikIdentifierare för varje felsökningsinformationsdump

DeepNoiseSuppressionEffect

Djup brusreduceringseffekt

DeviceAccess

Behörigheter som beviljas av användaren.

DeviceCompatibility

Information om enhetskompatibilitet

DeviceEnumeration

Information om enhetsuppräkning

DeviceManager

Enhetshanteraren används för att hantera systemmedieenheter som kameror, mikrofoner och högtalare.

DiagnosticOptions

Diagnostikalternativ

Disposable

Ta bort ett objekt.

DominantSpeakersCallFeature

Funktion för samtalsdominerande talare.

DominantSpeakersInfo

Information om de dominerande talarna i ett samtal

EmergencyCallOptions
EndpointDetails

Information om en fjärrdeltagares slutpunkt

FeatureFactory

Representerar gränssnittet för att ta hänsyn till en funktion

GroupCallLocator

Positionerare som används för att ansluta till ett gruppanrop.

GroupChatCallLocator

Lokaliserare som används för att ansluta till gruppchattsamtal.

HangUpOptions

Alternativ för att lägga på ett samtal.

IceServer

Representerar en isserver (stun/turn)

InCallDiagnostics

Anropa diagnostikinformation

IncomingAudioMediaStats

Allmän typ av mediestatistik för mottagande av ljud

IncomingCall

Representerar ett inkommande samtal.

IncomingCallCommon

Det gemensamma gränssnittet för inkommande samtal.

IncomingCallPushNotificationData

Push-meddelandedata för inkommande samtal

IncomingVideoMediaStats

Allmän typ av video som tar emot mediestatistik

JoinCallOptions

Alternativ för att ansluta till ett gruppsamtal. Skicka videoström som ska användas för att starta ett samtal. Fjärrdeltagare i samtalet får din videoström så att de kan rendera den i sina UIs. Pass audio options weather to join the call muted or unmuted. Om videoOptions är odefinierat startas samtalet med lokal video av.

LatestMediaDiagnostics

Senaste mediediagnostik som har tagits upp.

LatestNetworkDiagnostics

Senaste nätverksdiagnostik som har genererats.

Lobby

Möteslobby för Teams

LocalRecordingCallFeature

Funktion för samtalsinspelning.

LocalRecordingInfo

Lokal inspelningsinformation.

MediaConstraintRange

Begränsningsintervall

MediaDiagnostics

Mediadiagnostik

MediaStatsCallFeature

Funktion för att hämta mediestatistik under ett samtal.

MediaStatsCollector

Mediestatistikinsamlare.

MediaStatsReportSample

mediestatistik från händelsen "sampleReported"

MediaStatsReportSummary

Aggregerad mediestatistik från händelsen "summaryReported"

NetworkConfiguration

Representerar nätverkskonfigurationen som ska anges när anropsklienten skapas

NetworkDiagnostics

Nätverksdiagnostik

OptimalVideoCountCallFeature

Funktion för optimalt videoantal

OutgoingAudioMediaStats

Allmän typ av mediastatistik för sändning av ljud

OutgoingVideoMediaStats

Allmän typ av mediastatistik för videosändning

PPTLiveCallFeature

PPTLive-funktion.

ParticipantInfo

Representerar en deltagare i ett anrop.

PermissionConstraints

Definiera begränsningar för åtkomst till lokala enheter.

PreCallDiagnosticsFeature

PreCallDiagnostics-funktion

ProxyConfiguration

Representerar proxykonfigurationen för proxyservern för att skicka trafik via proxyservern.

RaiseHandCallFeature

Funktionen För att höja handsamtalsreaktionen.

RaisedHand

Höj handtillståndsobjektet

RaisedHandChangedEvent

Information om händelser med lägre hand

RatingScale

Klassificeringsskala för att åsidosätta standardskalan

ReactionCallFeature

Funktionen Mötesreaktion.

ReactionEventPayload

Datamodell för reaktionsmeddelande

ReactionMessage

Typ av reaktionsmeddelande

RecordingCallFeature

Funktion för samtalsinspelning.

RecordingInfo

Information om samtalsinspelning.

RejectLobbyParticipantOptions

Alternativ för att avvisa en deltagare från lobbyn.

RemoteAudioStream

Fjärrljudströmmen för samtalet.

RemoteParticipant

Representerar en fjärrdeltagare i ett anrop.

RemoteVideoStream

Representerar en fjärrdeltagares video- eller skärmdelning.

RemoteVideoStreamCommon

Representerar en fjärrdeltagares video- eller skärmdelning eller liveström.

RoomCallLocator

Positionerare som används för att ansluta till ett rumssamtal.

SpotlightCallFeature

Spotlight-samtalsfunktion.

SpotlightedParticipant

Händelseobjektet Spotlight-tillstånd har ändrats

StartCallOptions

Alternativ för att starta ett utgående samtal.

StartCaptionsOptions

Alternativ som skickas till StartCaptions

StartTeamsCallOptions

Alternativ för att starta ett utgående Teams-samtal.

StartTeamsGroupCallOptions

Alternativ för att starta ett utgående Teams-gruppsamtal.

StreamSize

Stream storlek.

SubmitSurveyOptions

Alternativ för att skicka samtalsundersökning.

TeamsCall

Representerar ett Teams-samtal.

TeamsCallAgent

TeamsCallAgent används för att hantera Teams-anrop.

TeamsCallAgentOptions

Alternativ för att skapa TeamsCallAgent.

TeamsCallInfo

Information om ett Teams-samtal.

TeamsCaptions

Datastruktur för TeamsCaptions-objekt

TeamsCaptionsInfo

Datastruktur som tas emot för varje CaptionsReceivedEventType-händelse

TeamsIncomingCall

Avgudar ett inkommande Teams-samtal.

TeamsMeetingAudioConferencingCallFeature

TeamsMeetingAudioConferencing-samtalsfunktionen.

TeamsMeetingAudioConferencingDetails

Representerar information om teams-mötesljudkonferenser

TeamsMeetingAudioConferencingPhoneNumber

Representerar telefonnummer som tilldelats en brygga för ljudkonferens

TeamsMeetingCoordinatesLocator

Positionerare som används för att ansluta till ett möte med möteskoordinater.

TeamsMeetingIdLocator

Positionerare som används för att ansluta till ett möte med mötes-ID och kod.

TeamsMeetingLinkLocator

Positionerare som används för att ansluta till ett möte med möteslänk.

TranscriptionCallFeature

Funktion för samtalstranskription.

Transfer

Representerar ett överföringsobjekt

TransferCallFeature

Funktion för samtalsöverföring.

TransferErrorCode

Felkod för överföring

TransferEventArgs

Överföra händelsebas

TransferToCallLocator

Överföra samtal till ett annat samtal

TransferToCallOptions

Alternativ för att överföra ett samtal till ett samtal

TransferToParticipantLocator

Överföra samtal till deltagare

TransferToParticipantOptions

Alternativ för att överföra ett samtal till en deltagare

TransportMediaStats

Allmän typ av transportmediestatistik

TurnConfiguration

Representerar turserverkonfigurationen för att skicka all medietrafik genom den.

UserFacingDiagnosticsFeature

Funktion för anropsdiagnostik.

VideoConstraints

Begränsning för videoström

VideoDeviceInfo

Information om en kameraenhet.

VideoEffect

Basvideoeffekt.

VideoEffectConfig

Konfiguration av basvideoeffekt.

VideoEffectsFeature

API-gränssnitt för funktionen VideoEffects

VideoInCallDiagnostics

Diagnostik för videokvalitet

VideoOptions

Representerar videoalternativ i CallOption

VideoStreamFeature

Representerar en videoströmfunktion

VideoStreamFeatureContext

Representerar kontexten som tillhandahålls för utökade funktioner för ljud-/videoströmmar i konstutorn.

VideoStreamFeatureFactory

Representerar fabriken för videoströmsfunktioner

VideoStreamRendererView

Vyn för en videoström.

Volume

Typalias

AudioDeviceType

Typ av ljudenhet.

AudioEffectsFeatureErrorListener

Återanropstyp för ljudeffekter för fellyssnare

AudioEffectsFeatureEvent

Funktionshändelser för ljudeffekter

AudioEffectsFeatureListener

Återanropstyp för ljudeffekter för lyssnare

AudioIssue

Representerar slutet av samtalsundersökningens ljudproblem.

Exempel

NoLocalAudio - other participants unable to hear me.
NoRemoteAudio - participant unable to hear another participant's audio.
Echo - heard echo.
AudioNoise - heard audio noise.
LowVolume - call audio volume was low.
AudioStoppedUnexpectedly - call audio stopped unexpectedly.
DistortedSpeech - audio was distorted.
AudioInterruption - audio was interrupted.
OtherIssues - any other audio issue not listed here.
AudioSourceChangedEvent

Nyttolast för ljudkällans ändrade händelse.

AudioStreamFeatureCtor

Representerar konstruktorn för AudioStreamFeature-objektet, tillsammans med kontextargumentet.

BackgroundBlurConfig

Konfiguration av oskärpa i bakgrunden.

CallAgentFeatureCtor

Representerar konstruktorn för CallAgentFeature-objekt, tillsammans med kontextargumentet.

CallClientFeatureCtor

Representerar konstruktorn för CallClientFeature-objekt, tillsammans med kontextargumentet.

CallDirection

Anropsriktning:

  • "Inkommande"
  • "Utgående"
CallEndedEvent

Nyttolast för samtalssluten händelse.

CallFeatureCtor

Representerar konstruktorn för CallFeature-objekt, tillsammans med kontextargumentet.

CallInformationContext
CallInformationIdentifierKind
CallInformationScenario
CallInitializationResult

Initieringstillstånd för anropsstack

CallState

Anropa tillstånd.

CapabilitiesChangeHandler

Motringningsdefinition för hantering av händelsen CaptionsReceivedEventType.

CapabilitiesChangedEventType

Händelsetyp för funktioner som ändrats händelse

CapabilitiesChangedReason

Funktioner har ändrat orsak

CapabilityResolutionReason

Orsak till kapacitetsmatchning

CaptionLanguageChangedEventType

Händelsetyp för bildtext språk ändrad händelse

CaptionsHandler

Motringningsdefinition för hantering av händelsen CaptionsReceivedEventType

CaptionsKind

Textningstyp för klassificering av objekttyp för undertexter

CaptionsKindChangedEventType

Händelsetyp för ändrad händelse av textningstyp

CaptionsPropertyChangedEventType

Händelsetyp för ändrad händelse för undertextegenskap

CaptionsReceivedEventType

Händelsetyp för undertexter mottagna händelser

CaptionsResultType

Typ för att klassificera slutiteten för den aktuella frasens transkription

CaptionInfo har ResultType of Partial om texten innehåller delvis talade meningar. CaptionInfo har ResultType of Final om meningen har transkriberats helt.

ChangedParticipantCapabilities

Ändrade deltagarfunktioner

CollectionUpdatedEvent

Nyttolast för samlingsuppladdad händelse.

CompositeAudioDeviceType

Typ av sammansatt ljudenhet.

ConnectionState

ConnectionState används för att ange anslutningstillståndet för CallAgent.

  • "Ansluten" – CallAgent är ansluten och redo att ta emot inkommande samtal.
  • "Frånkopplad" – CallAgent är frånkopplad och kanske inte tar emot inkommande samtal.
ConnectionStateChangedEvent

Nyttolast för tillstånds ändrad händelse.

ConnectionStateChangedReason

Orsak till att anslutningstillståndet har ändrats.

DataChannelPriority

prioritetsalternativ i DataChannelSenderOpenOptions

DataChannelReceiverCloseEvent

DataChannel stäng händelselyssnare

DataChannelReceiverCreatedEvent

DataChannel-dataChannelReceiverSkapad händelselyssnare

DataChannelReceiverMessageReadyEvent

DataChannel messageReady händelselyssnare

DataChannelReliability

tillförlitlighetsalternativ i DataChannelSenderOpenOptions

DataChannelSenderOpenOptions

Avsändaralternativ för att skapa ett DataChannel-avsändarobjekt

DeviceAvailabilityGrade

Tillgänglighetsklass för enheter

DeviceSupportGrade

Webbläsar-/OS-supportklass

DeviceType

Typ av enhet.

DiagnosticChangedEventArgs

Lyssnarargument för anropet "diagnosticChanged"-händelsen

  • värdet är DiagnosticQuality eller DiagnosticFlag:
    • DiagnosticQuality = enum { Good = 1, Poor = 2, Bad = 3 }.
    • DiagnosticFlag = true | Falska.
  • valueType = 'DiagnosticQuality' | "DiagnosticFlag"
DiagnosticFlag

Booleskt flaggvärde för boolesk relaterad diagnostik, till exempel DeviceSpeakWhileMuted, NoNetwork osv.

DiagnosticValueType

Diagnostikvärdetyp. DiagnosticQuality eller DiagnosticFlag

DtmfTone

DTMF-ton för PSTN-anrop.

Environment

Webbläsarinformation

EnvironmentInfo

Miljöinformation

GroupLocator

Grupplokaliserare.

IncomingCallEvent

Nyttolast för inkommande samtalshändelse.

IncomingScreenShareMediaStats

Allmän typ av skärmdelning får mediestatistik

LatestDiagnosticValue

Senaste värdet för en anropsdiagnostik

LoweredHandEventType

Namn på händelsetyp för nedsänerad handfunktion

LoweredHandListener

Motringningsdefinition för hantering av LowerHandEventType-händelsen.

MediaDiagnosticChangedEventArgs
  • diagnostik är den typ av mediadiagnostik, t.ex. speakingWhileMicrophoneIsMuted, cameraStartFailed, etc...
MediaDiagnosticType

Mediadiagnostiktyper

MediaStatValue

Egenskaper för statistik i sammanfattningRapporterad händelse

MediaStatsAggregation

Egenskaper för sammansättning för varje statistikfält.

MediaStatsCollectorOptions

Alternativ för mediestatistikinsamlare

MediaStatsReportSampleEvent

Nyttolast för mediestatistik som genereras exempelRapporterad händelse.

MediaStatsReportSummaryEvent

Nyttolast för mediestatistik som genereras sammanfattningRapporterad händelse.

MediaStreamType

Typ av medieström.

  • Video – Medieström från en kameraenhet
  • ScreenSharing – Medieström från en skärm, app eller webbläsarflik
  • RawMedia – Rå videomedieström eller rå skärmdelningsström
  • LiveStream – Medieström från en liveström
  • Ljud – Medieström från ljudenhet
MeetingLocator

Möteslokaliserare.

NetworkDiagnosticChangedEventArgs
  • diagnostik är typen av nätverksdiagnostik, t.ex. networkRcvQuality, noNetwrok osv. DeviceSpeakWhileMuted osv.
NetworkDiagnosticType

Typ av nätverksdiagnostik

NoiseSuppressionEffectName

Representerar namn på brusundertryckningseffekt

OutgoingScreenShareMediaStats

Allmän typ av skärmdelningsstatistik för att skicka media

OverallIssue

Representerar samtalsproblem i slutet av samtalsundersökningen.

Exempel

CallCannotJoin - participant is unable to join the call.
CallCannotInvite - participant is unable to add another participant in the call.
HadToRejoin - participant rejoined the call due the call quality issue.
CallEndedUnexpectedly - when the call ended unexpectedly.
OtherIssues - any other overall call issue not listed here.
ParticipantCapabilities

Deltagarfunktioner

ParticipantCapabilityName

Orsak till kapacitetsmatchning

ParticipantRole

Deltagarroll.

PreCallDiagnosticsResult

Diagnostiska resultat

PropertyChangedEvent

Nyttolast för händelse som ändrats av egenskapen.

PushNotificationData

Push-meddelandedata

QualityGrade

Samtalskvalitetsbetyg

RaisedHandEventType

Namn på händelsetyp för funktionen för att höja handen

RaisedHandListener

Motringningsdefinition för hantering av RaisedHandEventType-händelsen.

Reaction

Reaktionstyper som definierats för alla

ReactionListener

Motringningsdefinition för hantering av ReactionEventType-händelsen.

RemoteParticipantState

Fjärrdeltagarens tillstånd.

ResultCategories

Resultatkategorier för fel

RoomLocator

Rumslokaliserare.

RunOptions

PreCallDiagnostics-alternativ

ScalingMode

Skalningsläget för vyn av en videoström.

ScreenshareIssue

Representerar problem med skärmdelning i slutet av samtalsundersökningen.

Exempel

NoContentLocal - other participants unable to see my screen.
NoContentRemote - participant unable to saw another participant's screen share.
CannotPresent - participant was unable to share the screen.
LowQuality - screen share video quality was low.
Freezes - screen share freezes.
StoppedUnexpectedly - screen share stopped unexpectedly.
LargeDelay - watch screen share having large delay.
OtherIssues - any other screen share issue not listed here.
SpokenLanguageChangedEventType

Händelsetyp för ändrad händelse för textning av talat språk

SpotlightChangedEventType

Namn på händelsetyp för Spotlight-funktion

TeamsCaptionsHandler

Motringningsdefinition för hantering av händelsen CaptionsReceivedEventType

TeamsIncomingCallEvent

Nyttolast för inkommande teams-samtalshändelse.

TranscriptionPropertyChangedEventType

Transkriptionsegenskapen ändrade händelsen.

TransferAcceptedEvent

Händelse av att en överföring accepterades

TransferAcceptedEventType

Namn på händelsetyp för godkänd överföring

TransferState

Överföringstillstånd

VideoDeviceType

Typ av videoenhet.

VideoEffectError

Feltyp för videoeffekt.

VideoEffectErrorPayload

Nyttolast för videoeffektfel.

VideoEffectName

Representerar namnet på en videoeffekt.

VideoEffectProcessor

Unionstyp för alla effekter

VideoEffectsFeatureErrorListener

Lyssnartyp för prenumerationsfunktionen "effectsError"

VideoEffectsFeatureEvent

Typer av prenumerationshändelser

VideoEffectsFeatureListener

Lyssnartyp för funktionsprenumereringsfunktioner för effekter

VideoIssue

Representerar videoproblem i slutet av samtalsundersökningen.

Exempel

NoVideoReceived - participant unable to saw another participant's video.
NoVideoSent - other participants unable to see me.
LowQuality - video quality was low.
Freezes - video freezes.
StoppedUnexpectedly - video stopped unexpectedly.
DarkVideoReceived - participant receives dark video.
AudioVideoOutOfSync - participant watch video and audio out of sync.
OtherIssues - any other video issue not listed here.
VideoSendConstraints

Representerar begränsningar för videoströmmar

VideoSourceChangedEvent

Nyttolast för videokällans ändrade händelse.

VideoStreamFeatureCtor

Representerar konstruktorn för VideoStreamFeature-objektet, tillsammans med kontextargumentet.

xHeader

X-header.

Uppräkningar

CallAgentKind

Typen av anropsagentobjekt.

CallKind

Typen av anropsobjekt.

DiagnosticQuality

Kvalitetsvärde för kvalitetsrelaterad diagnostik, till exempel NetworkSendQuality, NetworkRevQuality osv. Bra = 1, inga problem. Poor = 2, mild problem. Dålig = 3, allvarligt problem.

IncomingCallKind

Typen av inkommande samtalsobjekt.

LocalRecordingState

Tillstånd för lokal omkorrigering

RecordingState

Inspelningstillstånd.