@azure/communication-calling package

Clases

CallClient

CallClient es el punto de entrada principal del SDK. CallClient se usa para crear CallAgent y para obtener deviceManager.

LocalAudioStream

Representa una secuencia de audio local para un dispositivo michrophone local.

LocalVideoStream

Representa una secuencia de vídeo local para un dispositivo de cámara local.

VideoStreamRenderer

Representador de una secuencia de vídeo

Interfaces

AcceptCallOptions

Opciones para aceptar una llamada entrante. Pase secuencias de vídeo que se usarán para aceptar una llamada entrante. Si videoOptions no está definido, la llamada entrante se aceptará con el vídeo local desactivado. Si AudioOptions no está definido, la llamada entrante se aceptará con el micrófono predeterminado como origen del administrador de dispositivos.

ActiveAudioEffects

Representa los efectos de audio activos actuales.

AddCommunicationUserOptions

Opciones para agregar un participante AddCommunicationUserOptions a una llamada en curso.

AddMicrosoftTeamsUserOptions

Opciones para agregar un participante MicrosoftTeamsUser a una llamada en curso.

AddPhoneNumberOptions

Opciones para agregar un participante RTC a una llamada en curso.

AddTeamsParticipantOptions

Opciones para agregar un participante de Teams a una llamada de Teams en curso.

AdmitAllOperationResult

Resultado para admitir a todos los participantes.

AdmitLobbyParticipantOptions

Opciones para admitir participantes en la sala de espera.

AudioDeviceInfo

Información sobre un micrófono o un dispositivo de altavoz.

AudioEffect

Efecto de audio base.

AudioEffectsFeature

Interfaz de API para la característica AudioEffects

AudioEffectsStartConfig

Representa la configuración de efectos de audio mientras se inician los efectos

AudioEffectsStopConfig

Representa la configuración de efectos de audio al detener los efectos

AudioInCallDiagnostics

Diagnósticos de calidad de audio

AudioOptions

Opciones de audio proporcionadas al realizar una llamada saliente o unirse a una llamada de grupo.

AudioStreamFeature

Representa una característica de secuencia de audio

AudioStreamFeatureContext

Representa el contexto proporcionado para las características extendidas de secuencia de audio y vídeo en el constructor.

AudioStreamFeatureFactory

Representa el generador de las características de la secuencia de audio.

BackgroundBlurEffect

Efecto de desenfoque de fondo.

BackgroundReplacementConfig

Configuración de reemplazo en segundo plano.

BackgroundReplacementEffect

Efecto de reemplazo de fondo.

BaseFeature

Representa la interfaz base de cualquier característica.

BaseInCallDiagnostics

En Diagnósticos de llamadas recopilados

Call

Representa una llamada.

CallAgent

CallAgent se usa para controlar las llamadas.

CallAgentCommon

Interfaz común callAgent.

CallAgentFeature

Representa una característica CallAgent.

CallAgentFeatureContext

Representa el contexto proporcionado para las características extendidas del agente de llamadas en el constructor.

CallAgentFeatureFactory

Representa el generador de características del agente de llamadas.

CallAgentOptions

Opciones para crear CallAgent.

CallClientFeature

Representa una característica CallClient.

CallClientFeatureContext

Representa el contexto proporcionado para las características de cliente de llamadas extendidas en el constructor.

CallClientFeatureFactory

Representa el generador de características del agente cliente de llamada

CallClientOptions

Opciones de cliente de llamada

CallCommon

La interfaz Común de llamada.

CallConstraints

Representa restricciones para una llamada

CallDiagnostics

Diagnóstico de llamada

CallEndReason

Describe el motivo por el que finalizó la llamada.

CallFeature

Representa una característica de llamada.

CallFeatureContext

Representa el contexto proporcionado para las características de llamada extendidas en el constructor.

CallFeatureFactory

Representa el generador de características de llamada.

CallInfo

Información sobre una llamada.

CallInfoCommon

Interfaz común CallInfo.

CallRating

Representa una clasificación de encuesta de llamadas.

CallSurvey

Representa el final de la encuesta de llamadas.

CallSurveyFeature

Característica para ACS Live Streaming

CallSurveyResponse

Representa el final de la respuesta de la encuesta de llamadas.

CallerInfo

Información del autor de la llamada.

CapabilitiesChangeInfo

Estructura de datos recibida para cada evento CapabilitiesChangedEventType.

CapabilitiesFeature

Característica de funcionalidades.

Captions

Estructura de datos para el objeto Captions

CaptionsCallFeature

Característica para subtítulos

CaptionsCommon

Estructura de datos para el objeto CaptionsCommon

CaptionsInfo

Estructura de datos recibida para cada evento CaptionsReceivedEventType

CommunicationServicesError

Error que se produce cuando se produce un error en la llamada API.

CompositeAudioDeviceInfo

Información sobre un dispositivo de audio compuesto.

CreateViewOptions

Opciones para el representador de una secuencia de vídeo.

CustomContextOptions

Opciones para llamar al contexto personalizado.

DataChannelCallFeature

Característica de llamada de DataChannel

DataChannelMessage

Mensaje de DataChannel

DataChannelReceiver

Receptor de DataChannel

DataChannelSender

Remitente de DataChannel

DebugInfoCallClientFeature

Característica para la información de depuración de llamadas.

DebugInfoDump

dump id es un uniqueIdentifier para cada volcado de información de depuración.

DeepNoiseSuppressionEffect

Efecto de supresión de ruido profundo

DeviceAccess

Permisos concedidos por el usuario.

DeviceCompatibility

Información de compatibilidad de dispositivos

DeviceEnumeration

Información de enumeración de dispositivos

DeviceManager

El Administrador de dispositivos se usa para controlar dispositivos multimedia del sistema, como cámaras, micrófonos y altavoces.

DiagnosticOptions

Opciones de diagnóstico

Disposable

Desechar un objeto.

DominantSpeakersCallFeature

Característica para llamar al hablante dominante.

DominantSpeakersInfo

Información sobre los hablantes dominantes de una llamada

EmergencyCallOptions
EndpointDetails

Detalles del punto de conexión de un participante remoto

FeatureFactory

Representa la interfaz para factorizar una característica.

GroupCallLocator

Localizador usado para unirse a una llamada de grupo.

GroupChatCallLocator

Localizador usado para unirse a una llamada de chat grupal.

HangUpOptions

Opciones para colgar una llamada.

IceServer

Representa un servidor de hielo (aturdimiento/giro)

InCallDiagnostics

Información de diagnóstico de llamadas

IncomingAudioMediaStats

Tipo genérico de estadísticas multimedia de recepción de audio

IncomingCall

Representa una llamada entrante.

IncomingCallCommon

Interfaz común de llamada entrante.

IncomingCallPushNotificationData

Datos de notificación de inserción de llamadas entrantes

IncomingVideoMediaStats

Tipo genérico de estadísticas multimedia de recepción de vídeo

JoinCallOptions

Opciones para unirse a una llamada de grupo. Pase la secuencia de vídeo que se usará para iniciar una llamada. Los participantes remotos de la llamada recibirán la secuencia de vídeo para que puedan representarla en sus INTERFACES de usuario. Pase el tiempo de las opciones de audio para unirse a la llamada silenciada o sinmutar. Si videoOptions no está definido, la llamada se iniciará con el vídeo local desactivado.

LatestMediaDiagnostics

Diagnósticos multimedia más recientes que se generaron.

LatestNetworkDiagnostics

Diagnósticos de red más recientes que se generaron.

Lobby

Sala de espera de reuniones de Teams

LocalRecordingCallFeature

Característica para la grabación de llamadas.

LocalRecordingInfo

Información de grabación local.

MediaConstraintRange

Intervalo de restricciones

MediaDiagnostics

Diagnósticos multimedia

MediaStatsCallFeature

Característica para obtener estadísticas multimedia mientras se encuentra en una llamada.

MediaStatsCollector

Recopilador de estadísticas multimedia.

MediaStatsReportSample

estadísticas multimedia del evento "sampleReported"

MediaStatsReportSummary

Estadísticas de medios agregadas del evento "summaryReported"

NetworkConfiguration

Representa la configuración de red que se va a establecer al crear el cliente de llamada.

NetworkDiagnostics

Diagnósticos de red

OptimalVideoCountCallFeature

Característica para el recuento óptimo de vídeos

OutgoingAudioMediaStats

Tipo genérico de estadísticas multimedia de envío de audio

OutgoingVideoMediaStats

Tipo genérico de estadísticas multimedia de envío de vídeo

PPTLiveCallFeature

Característica PPTLive.

ParticipantInfo

Representa a un participante en una llamada.

PermissionConstraints

Defina restricciones para acceder a los dispositivos locales.

PreCallDiagnosticsFeature

Característica PreCallDiagnostics

ProxyConfiguration

Representa la configuración de proxy del servidor proxy para enviar tráfico a través de ese servidor proxy.

RaiseHandCallFeature

Función de reacción de llamada de elevación de mano.

RaisedHand

Raise hand state (objeto)

RaisedHandChangedEvent

Información de eventos de mano inferior

RatingScale

Escala de clasificación para invalidar la escala predeterminada

ReactionCallFeature

Característica de reacción de reunión.

ReactionEventPayload

Modelo de datos de mensajes de reacción

ReactionMessage

Tipo de mensaje de reacción

RecordingCallFeature

Característica para la grabación de llamadas.

RecordingInfo

Información de grabación de llamadas.

RejectLobbyParticipantOptions

Opciones para rechazar a un participante de la sala de espera.

RemoteAudioStream

Secuencia de audio remota de la llamada.

RemoteParticipant

Representa un participante remoto en una llamada.

RemoteVideoStream

Representa el vídeo o el uso compartido de pantalla de un participante remoto.

RemoteVideoStreamCommon

Representa el vídeo o el uso compartido de pantalla o streaming en vivo de un participante remoto.

RoomCallLocator

Localizador usado para unirse a una llamada de sala.

SpotlightCallFeature

Característica de llamada de Spotlight.

SpotlightedParticipant

Objeto de evento cambiado de estado de Spotlight

StartCallOptions

Opciones para iniciar una llamada saliente.

StartCaptionsOptions

Opciones pasadas a StartCaptions

StartTeamsCallOptions

Opciones para iniciar una llamada saliente de Teams.

StartTeamsGroupCallOptions

Opciones para iniciar una llamada de grupo de Teams saliente.

StreamSize

Stream tamaño.

SubmitSurveyOptions

Opciones para enviar una encuesta de llamadas.

TeamsCall

Representa una llamada de Teams.

TeamsCallAgent

TeamsCallAgent se usa para controlar las llamadas de Teams.

TeamsCallAgentOptions

Opciones para crear TeamsCallAgent.

TeamsCallInfo

Información sobre una llamada de Teams.

TeamsCaptions

Estructura de datos para el objeto TeamsCaptions

TeamsCaptionsInfo

Estructura de datos recibida para cada evento CaptionsReceivedEventType

TeamsIncomingCall

Reorente una llamada entrante de Teams.

TeamsMeetingAudioConferencingCallFeature

Característica de llamada TeamsMeetingAudioConferencing.

TeamsMeetingAudioConferencingDetails

Representa los detalles de una audioconferencia de reuniones de Teams.

TeamsMeetingAudioConferencingPhoneNumber

Representa el número de teléfono asignado a un puente de audioconferencia.

TeamsMeetingCoordinatesLocator

Localizador usado para unirse a una reunión con coordenadas de reunión.

TeamsMeetingIdLocator

Localizador usado para unirse a una reunión con el identificador y el código de la reunión.

TeamsMeetingLinkLocator

Localizador usado para unirse a una reunión con el vínculo de reunión.

TranscriptionCallFeature

Característica para la transcripción de llamadas.

Transfer

Representa un objeto Transfer

TransferCallFeature

Característica para la transferencia de llamadas.

TransferErrorCode

Código de error de transferencia

TransferEventArgs

Base de eventos de transferencia

TransferToCallLocator

Transferencia de una llamada a otra llamada

TransferToCallOptions

Opciones para transferir una llamada a una llamada

TransferToParticipantLocator

Transferencia de la llamada al participante

TransferToParticipantOptions

Opciones para transferir una llamada a un participante

TransportMediaStats

Tipo genérico de estadísticas de medios de transporte

TurnConfiguration

Representa la configuración del servidor turn para enviar todo el tráfico multimedia a través de él.

UserFacingDiagnosticsFeature

Característica para diagnósticos de llamadas.

VideoConstraints

Restricción de la secuencia de vídeo

VideoDeviceInfo

Información sobre un dispositivo de cámara.

VideoEffect

Efecto de vídeo base.

VideoEffectConfig

Configuración del efecto de vídeo base.

VideoEffectsFeature

Interfaz de API para la característica VideoEffects

VideoInCallDiagnostics

Diagnósticos de calidad de vídeo

VideoOptions

Representa la opción de vídeo en CallOption

VideoStreamFeature

Representa una característica de secuencia de vídeo

VideoStreamFeatureContext

Representa el contexto proporcionado para las características extendidas de secuencia de audio y vídeo en el constuctor.

VideoStreamFeatureFactory

Representa el generador de características de secuencia de vídeo.

VideoStreamRendererView

Vista de una secuencia de vídeo.

Volume

Alias de tipos

AudioDeviceType

Tipo de un dispositivo de audio.

AudioEffectsFeatureErrorListener

Tipo de devolución de llamada del agente de escucha de errores de efectos de audio

AudioEffectsFeatureEvent

Eventos de características de efectos de audio

AudioEffectsFeatureListener

Tipo de devolución de llamada del agente de escucha de efectos de audio

AudioIssue

Representa el final de los problemas de audio de la encuesta de llamadas.

Ejemplo

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

Carga para el evento modificado de origen de audio.

AudioStreamFeatureCtor

Representa el constructor del objeto AudioStreamFeature, junto con el argumento de contexto.

BackgroundBlurConfig

Configuración de desenfoque en segundo plano.

CallAgentFeatureCtor

Representa el constructor para los objetos CallAgentFeature, junto con el argumento de contexto.

CallClientFeatureCtor

Representa el constructor de los objetos CallClientFeature, junto con el argumento de contexto.

CallDirection

Dirección de una llamada:

  • 'Incoming'
  • 'Saliente'
CallEndedEvent

Carga útil para el evento finalizado de llamada.

CallFeatureCtor

Representa el constructor para los objetos CallFeature, junto con el argumento de contexto.

CallInformationContext
CallInformationIdentifierKind
CallInformationScenario
CallInitializationResult

Estados de inicialización de pila de llamadas

CallState

Estados de llamada.

CapabilitiesChangeHandler

Definición de devolución de llamada para controlar el evento CaptionsReceivedEventType.

CapabilitiesChangedEventType

Tipo de evento para el evento modificado de funcionalidades

CapabilitiesChangedReason

Motivo de cambio de funcionalidades

CapabilityResolutionReason

Motivo de resolución de funcionalidad

CaptionLanguageChangedEventType

Tipo de evento para subtítulo evento de cambio de idioma

CaptionsHandler

Definición de devolución de llamada para controlar el evento CaptionsReceivedEventType

CaptionsKind

Tipo de títulos para clasificar el tipo de objeto Captions

CaptionsKindChangedEventType

Tipo de evento para evento Modificado de tipo captions

CaptionsPropertyChangedEventType

Tipo de evento para el evento cambiado de propiedad captions

CaptionsReceivedEventType

Tipo de evento para los subtítulos recibidos

CaptionsResultType

Tipo para clasificar la finalización de la transcripción de la frase actual

CaptionInfo tendrá ResultType de Partial si el texto contiene frase parcialmente hablada. CaptionInfo tendrá ResultType de Final si una vez que la oración se ha transcrito por completo.

ChangedParticipantCapabilities

Funcionalidades de participante modificadas

CollectionUpdatedEvent

Carga útil para el evento actualizado de recopilación.

CompositeAudioDeviceType

Tipo de un dispositivo de audio compuesto.

ConnectionState

ConnectionState se usa para indicar el estado de conexión de CallAgent.

  • 'Conectado': CallAgent está conectado y listo para recibir llamadas entrantes.
  • 'Desconectado': CallAgent está desconectado y es posible que no reciba llamadas entrantes.
ConnectionStateChangedEvent

Carga para el evento de cambio de estado.

ConnectionStateChangedReason

Motivo por el que el estado de conexión ha cambiado.

DataChannelPriority

opción priority en DataChannelSenderOpenOptions

DataChannelReceiverCloseEvent

Agente de escucha de eventos de cierre de DataChannel

DataChannelReceiverCreatedEvent

Agente de escucha de eventos DataChannelReceiverCreated

DataChannelReceiverMessageReadyEvent

Agente de escucha de eventos de DataChannel messageReady

DataChannelReliability

opción de confiabilidad en DataChannelSenderOpenOptions

DataChannelSenderOpenOptions

Opciones del remitente para crear un objeto remitente de DataChannel

DeviceAvailabilityGrade

Grado de disponibilidad del dispositivo

DeviceSupportGrade

Nivel de soporte técnico del explorador o del sistema operativo

DeviceType

Tipo de dispositivo.

DiagnosticChangedEventArgs

Argumentos del agente de escucha para el evento "diagnosticChanged" de llamada

  • value es DiagnosticQuality o DiagnosticFlag:
    • DiagnosticQuality = enum { Good = 1, Poor = 2, Bad = 3 }.
    • DiagnosticFlag = true | Falso.
  • valueType = 'DiagnosticQuality' | 'DiagnosticFlag'
DiagnosticFlag

Valor de marca booleana para diagnósticos relacionados booleanos como DeviceSpeakWhileMuted, NoNetwork, etc.

DiagnosticValueType

Tipo de valor de diagnóstico. DiagnosticQuality o DiagnosticFlag

DtmfTone

Tono DTMF para llamadas RTC.

Environment

Información del explorador

EnvironmentInfo

Información del entorno

GroupLocator

Localizador de grupos.

IncomingCallEvent

Carga para el evento de llamada entrante.

IncomingScreenShareMediaStats

Tipo genérico de estadísticas multimedia de recepción de recursos compartidos de pantalla

LatestDiagnosticValue

Valor más reciente para un diagnóstico de llamadas

LoweredHandEventType

Nombre del tipo de evento para la característica de mano inferior

LoweredHandListener

Definición de devolución de llamada para controlar el evento LowerHandEventType.

MediaDiagnosticChangedEventArgs
  • diagnostic es el tipo de diagnóstico multimedia, por ejemplo, hablandoWhileMicrophoneIsMuted, cameraStartFailed, etc.
MediaDiagnosticType

Tipos de diagnóstico multimedia

MediaStatValue

Propiedades de estadísticas en el evento summaryReported

MediaStatsAggregation

Propiedades de agregación para cada campo de estadísticas.

MediaStatsCollectorOptions

Opciones del recopilador de estadísticas multimedia

MediaStatsReportSampleEvent

Carga útil para las estadísticas multimedia emitidas por el evento sampleReported.

MediaStatsReportSummaryEvent

Carga de estadísticas multimedia emitidas por el evento summaryReported.

MediaStreamType

Tipo de secuencia multimedia.

  • Vídeo: transmisión multimedia desde un dispositivo de cámara
  • ScreenSharing: transmisión multimedia desde una pestaña de pantalla, aplicación o explorador
  • RawMedia: secuencia multimedia de vídeo sin formato o secuencia de uso compartido de pantalla sin formato
  • LiveStream: streaming multimedia desde una transmisión en vivo
  • Audio: transmisión multimedia desde un dispositivo de audio
MeetingLocator

Localizador de reuniones.

NetworkDiagnosticChangedEventArgs
  • diagnostic es el tipo de diagnóstico de red, por ejemplo, networkRcvQuality, noNetwrok, etc. DeviceSpeakWhileMuted, etc...
NetworkDiagnosticType

Tipo de diagnóstico de red

NoiseSuppressionEffectName

Representa los nombres de efectos de supresión de ruido.

OutgoingScreenShareMediaStats

Tipo genérico de estadísticas multimedia de envío de recursos compartidos de pantalla

OverallIssue

Representa el final de los problemas de llamada de la encuesta de llamadas.

Ejemplo

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

Funcionalidades de los participantes

ParticipantCapabilityName

Motivo de resolución de funcionalidad

ParticipantRole

Rol participante.

PreCallDiagnosticsResult

Resultados del diagnóstico

PropertyChangedEvent

Carga para el evento de cambio de propiedad.

PushNotificationData

Datos de notificación de inserción

QualityGrade

Grado de calidad de llamadas

RaisedHandEventType

Nombre del tipo de evento para la característica raise hand

RaisedHandListener

Definición de devolución de llamada para controlar el evento RaisedHandEventType.

Reaction

Tipos de reacción definidos para todos

ReactionListener

Definición de devolución de llamada para controlar el evento ReactionEventType.

RemoteParticipantState

Estado del participante remoto.

ResultCategories

Categorías de resultados de error

RoomLocator

Localizador de salas.

RunOptions

Opciones de PreCallDiagnostics

ScalingMode

Modo de escalado de la vista de una secuencia de vídeo.

ScreenshareIssue

Representa el final de los problemas de uso compartido de pantalla de la encuesta de llamadas.

Ejemplo

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

Tipo de evento para el evento de cambio de idioma hablado de subtítulos

SpotlightChangedEventType

Nombre del tipo de evento para la característica Spotlight

TeamsCaptionsHandler

Definición de devolución de llamada para controlar el evento CaptionsReceivedEventType

TeamsIncomingCallEvent

Carga para el evento de llamada entrante de Teams.

TranscriptionPropertyChangedEventType

Evento cambiado de propiedad de transcripción.

TransferAcceptedEvent

Evento en el que se aceptó una transferencia

TransferAcceptedEventType

Nombre del tipo de evento para la transferencia aceptada

TransferState

Estado de transferencia

VideoDeviceType

Tipo de dispositivo de vídeo.

VideoEffectError

Tipo de error de efecto de vídeo.

VideoEffectErrorPayload

Carga de error del efecto de vídeo.

VideoEffectName

Representa el nombre de un efecto de vídeo.

VideoEffectProcessor

Tipo de unión para todos los efectos

VideoEffectsFeatureErrorListener

Tipo de agente de escucha para la función de suscripción "effectsError"

VideoEffectsFeatureEvent

Tipos de eventos de suscripción

VideoEffectsFeatureListener

Tipo de agente de escucha para las funciones de suscripción de características de efectos

VideoIssue

Representa el final de los problemas de vídeo de la encuesta de llamadas.

Ejemplo

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

Representa restricciones de secuencia de vídeo

VideoSourceChangedEvent

Carga del evento cambiado de origen de vídeo.

VideoStreamFeatureCtor

Representa el constructor del objeto VideoStreamFeature, junto con el argumento de contexto.

xHeader

Encabezado X.

Enumeraciones

CallAgentKind

Tipo de objeto de agente de llamada.

CallKind

Tipo de objeto de llamada.

DiagnosticQuality

Valor de calidad para diagnósticos relacionados con la calidad, como NetworkSendQuality, NetworkRevQuality, etc. Bueno = 1, sin problema. Pobre = 2, problema leve. Malo = 3, problema grave.

IncomingCallKind

Tipo de objeto de llamada entrante.

LocalRecordingState

Estado de recoring local

RecordingState

Estado de grabación.