Call interface

Paquete:

@azure/communication-calling

Representa una llamada.

Extends

CallCommon

Propiedades

info	Obtenga información sobre esta llamada.

Propiedades heredadas

callEndReason	Contiene código o subCódigo que indica cómo finalizó esta llamada.
callerInfo	Información del autor de la llamada si esta llamada está entrante.
direction	Obtenga la dirección de la llamada, ya sea entrante o saliente.
id	Obtenga el identificador único de esta llamada.
isIncomingAudioMuted	Indica si el usuario local ha silenciado el audio entrante.
isLocalVideoStarted	Si el vídeo local está activado.
isMuted	Si el usuario local está silenciado, local o remoto.
isScreenSharingOn	Si el uso compartido de pantalla está activado.
kind	Obtiene el tipo de objeto de llamada.
lobby	Obtenga la sala de espera de reuniones de Teams.
localAudioStreams	Colección de secuencias de audio locales que se envían a otros participantes en una llamada.
localVideoStreams	Colección de secuencias de vídeo locales que se envían a otros participantes en una llamada.
remoteAudioStreams	Colección de secuencias de audio remotas que se reciben desde la llamada.
remoteParticipants	Colección de participantes remotos en esta llamada. En caso de llamadas con participantes de cientos o más, solo los participantes activos multimedia están presentes en esta colección.
role	Obtenga el rol del usuario local en la llamada.
state	Obtenga el estado de esta llamada.
totalParticipantCount	Recuento del número total de participantes en esta llamada.

Métodos

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)	Agregue un participante a esta llamada.
addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)	Agregue un participante a esta llamada.
addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)	Agregue una aplicación de Teams a esta llamada.
addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)	Agregue un participante a esta llamada.
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Agregue un participante a esta llamada.
removeParticipant(CommunicationIdentifier)	Quite un participante de esta llamada.

Métodos heredados

dispose()
feature<TFeature>(CallFeatureFactory<TFeature>)	Recupera un objeto Feature inicializado y memoizado con la API extendida. Compruebe el objeto Features.* para ver todas las características de llamadas extendidas disponibles en este paquete, por ejemplo: const call: Call = ...; call.feature(Features.Recording).isRecordingActive; call.feature(Features.Captions).startCaptions('en-us')
hangUp(HangUpOptions)	Hang up the call (Colgar la llamada)
hold()	Ponga esta llamada en espera.
mute()	Silenciar el micrófono local.
muteAllRemoteParticipants()	Silenciar a todos los participantes remotos.
muteIncomingAudio()	Silenciar el audio entrante.
off("idChanged", PropertyChangedEvent)	Cancelar la suscripción de la función para el evento idChanged.
off("isIncomingAudioMutedChanged", PropertyChangedEvent)	Función Subscribe para el evento isIncomingAudioMutedChanged.
off("isLocalVideoStartedChanged", PropertyChangedEvent)	Función Unsubscribe para el evento isLocalVideoStartedChanged.
off("isMutedChanged", PropertyChangedEvent)	Función Subscribe para el evento isMutedChanged.
off("isScreenSharingOnChanged", PropertyChangedEvent)	Función Unsubscribe para el evento isScreenSharingChanged.
off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Función Unsubscribe para el evento localAudioStreamsUpdated.
off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Función Unsubscribe para el evento localVideoStreamsUpdated.
off("mutedByOthers", PropertyChangedEvent)	Cancele la función para el evento mutedByOthers.
off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Cancele la función para el evento remoteAudioStreamsUpdated.
off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Cancele la función para el evento remoteParticipantsUpdated.
off("roleChanged", PropertyChangedEvent)	Función de cancelación de suscripción para el evento roleChanged.
off("stateChanged", PropertyChangedEvent)	Cancele la función para el evento stateChanged.
off("totalParticipantCountChanged", PropertyChangedEvent)	función unsubscribe para el evento totalParticipantCountChanged.
on("idChanged", PropertyChangedEvent)	Función Subscribe para el evento idChanged.
on("isIncomingAudioMutedChanged", PropertyChangedEvent)	Función Subscribe para el evento isIncomingAudioMutedChanged.
on("isLocalVideoStartedChanged", PropertyChangedEvent)	Función Subscribe para el evento isLocalVideoStartedChanged.
on("isMutedChanged", PropertyChangedEvent)	Función Subscribe para el evento isMutedChanged.
on("isScreenSharingOnChanged", PropertyChangedEvent)	Función Subscribe para el evento isScreenSharingChanged.
on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)	Función Subscribe para el evento localAudioStreamsUpdated.
on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)	Función Subscribe para el evento localVideoStreamsUpdated.
on("mutedByOthers", PropertyChangedEvent)	Función Subscribe para el evento mutedByOthers.
on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)	Función Subscribe para el evento remoteAudioStreamsUpdated.
on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)	Función Subscribe para el evento remoteParticipantsUpdated.
on("roleChanged", PropertyChangedEvent)	Función Subscribe para el evento roleChanged.
on("stateChanged", PropertyChangedEvent)	Función Subscribe para el evento stateChanged.
on("totalParticipantCountChanged", PropertyChangedEvent)	Función Subscribe para el evento totalParticipantCountChanged.
resume()	Reanude esta llamada si está en estado "LocalHold".
sendDtmf(DtmfTone)	Enviar tono DTMF.
setConstraints(CallConstraints)	Establecer restricciones de llamada. Este método establece las restricciones máximas de según los valores proporcionados. Las restricciones aplicadas finales serán menores o iguales que los valores proporcionados aquí a este método. Si se proporciona un valor 0, no se aplicará ninguna restricción para esa restricción. Si se proporciona un valor indefinido, se usará el valor anterior usado para esa restricción.
startAudio(LocalAudioStream)	Inicie el audio en la llamada con audio personalizado. El origen localAudioStream debe ser mediaStream.
startScreenSharing()	Comience a enviar una secuencia de uso compartido de pantalla en una llamada. El explorador le pedirá que seleccione la pantalla, la aplicación o la pestaña del explorador. No se admite el envío de secuencias de uso compartido de pantalla en iOS ni Android. La secuencia de uso compartido de pantalla entrante se admite en iOS y Android.
startScreenSharing(LocalVideoStream)	Comience a enviar una secuencia de uso compartido de pantalla sin formato en una llamada. No se admite el envío de uso compartido de pantalla sin formato en iOS ni Android. El uso compartido de pantalla sin procesar entrante se admite en iOS y Android.
startVideo(LocalVideoStream)	Comience a enviar secuencias de vídeo en la llamada. Los participantes remotos de la llamada recibirán la secuencia de vídeo para que puedan representarla en sus INTERFACES de usuario.
stopAudio()	Detenga el audio personalizado en la llamada y cambie al dispositivo de audio predeterminado del Administrador de dispositivos.
stopScreenSharing()	Detenga el uso compartido de pantalla local.
stopScreenSharing(LocalVideoStream)	Detenga el uso compartido de pantalla local.
stopVideo(LocalVideoStream)	Detenga el envío de secuencias de vídeo en la llamada. Debe pasar el mismo objeto LocalVideoStream que se usó para iniciar el vídeo en la API CallAgent.startCall(), CallAgent.join() API , IncomingCall.accept() API o Call.startVideo().
unmute()	Desmute el micrófono local.
unmuteIncomingAudio()	Desmute el audio entrante.

Detalles de las propiedades

info

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Obtenga información sobre esta llamada.

info: CallInfo

Valor de propiedad

CallInfo

Detalles de las propiedades heredadas

callEndReason

Contiene código o subCódigo que indica cómo finalizó esta llamada.

callEndReason?: CallEndReason

Valor de propiedad

CallEndReason

Heredado deCallCommon.callEndReason

callerInfo

Información del autor de la llamada si esta llamada está entrante.

callerInfo: CallerInfo

Valor de propiedad

CallerInfo

Heredado deCallCommon.callerInfo

direction

Obtenga la dirección de la llamada, ya sea entrante o saliente.

direction: CallDirection

Valor de propiedad

CallDirection

Heredado deCallCommon.direction

id

Obtenga el identificador único de esta llamada.

id: string

Valor de propiedad

string

Heredado deCallCommon.id

isIncomingAudioMuted

Indica si el usuario local ha silenciado el audio entrante.

isIncomingAudioMuted: boolean

Valor de propiedad

boolean

Heredado deCallCommon.isIncomingAudioMuted

isLocalVideoStarted

Si el vídeo local está activado.

isLocalVideoStarted: boolean

Valor de propiedad

boolean

Heredado deCallCommon.isLocalVideoStarted

isMuted

Si el usuario local está silenciado, local o remoto.

isMuted: boolean

Valor de propiedad

boolean

Heredado deCallCommon.isMuted

isScreenSharingOn

Si el uso compartido de pantalla está activado.

isScreenSharingOn: boolean

Valor de propiedad

boolean

Heredado deCallCommon.isScreenSharingOn

kind

Obtiene el tipo de objeto de llamada.

kind: CallKind

Valor de propiedad

CallKind

Heredado deCallCommon.kind

lobby

Obtenga la sala de espera de reuniones de Teams.

lobby: Lobby

Valor de propiedad

Lobby

Heredado deCallCommon.lobby

localAudioStreams

Colección de secuencias de audio locales que se envían a otros participantes en una llamada.

localAudioStreams: readonly LocalAudioStream[]

Valor de propiedad

readonly LocalAudioStream[]

Heredado deCallCommon.localAudioStreams

localVideoStreams

Colección de secuencias de vídeo locales que se envían a otros participantes en una llamada.

localVideoStreams: readonly LocalVideoStream[]

Valor de propiedad

readonly LocalVideoStream[]

Heredado deCallCommon.localVideoStreams

remoteAudioStreams

Colección de secuencias de audio remotas que se reciben desde la llamada.

remoteAudioStreams: readonly RemoteAudioStream[]

Valor de propiedad

readonly RemoteAudioStream[]

Heredado deCallCommon.remoteAudioStreams

remoteParticipants

Colección de participantes remotos en esta llamada. En caso de llamadas con participantes de cientos o más, solo los participantes activos multimedia están presentes en esta colección.

remoteParticipants: readonly RemoteParticipant[]

Valor de propiedad

readonly RemoteParticipant[]

Heredado deCallCommon.remoteParticipants

role

Obtenga el rol del usuario local en la llamada.

role: ParticipantRole

Valor de propiedad

ParticipantRole

Heredado deCallCommon.role

state

Obtenga el estado de esta llamada.

state: CallState

Valor de propiedad

CallState

Heredado deCallCommon.state

totalParticipantCount

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Recuento del número total de participantes en esta llamada.

totalParticipantCount: number

Valor de propiedad

number

Heredado deCallCommon.totalParticipantCount

Detalles del método

addParticipant(CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier)

Agregue un participante a esta llamada.

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

Parámetros

identifier

CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier

Identificador del participante que se va a agregar.

Devoluciones

RemoteParticipant

El objeto RemoteParticipant asociado al participante agregado correctamente.

addParticipant(CommunicationUserIdentifier, AddCommunicationUserOptions)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Agregue un participante a esta llamada.

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

Parámetros

identifier

CommunicationUserIdentifier

Identificador del participante que se va a agregar.

options

AddCommunicationUserOptions

Opciones adicionales para administrar la llamada.

Devoluciones

RemoteParticipant

El objeto RemoteParticipant asociado al participante agregado correctamente.

addParticipant(MicrosoftTeamsAppIdentifier | UnknownIdentifier)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Agregue una aplicación de Teams a esta llamada.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

Parámetros

identifier

MicrosoftTeamsAppIdentifier | UnknownIdentifier

Identificador de la aplicación de Teams que se va a agregar.

Devoluciones

RemoteParticipant

El objeto RemoteParticipant asociado a la aplicación de Teams agregada correctamente.

addParticipant(MicrosoftTeamsUserIdentifier, AddMicrosoftTeamsUserOptions)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Agregue un participante a esta llamada.

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

Parámetros

identifier

MicrosoftTeamsUserIdentifier

Identificador del participante que se va a agregar.

options

AddMicrosoftTeamsUserOptions

Opciones adicionales para administrar la llamada.

Devoluciones

RemoteParticipant

El objeto RemoteParticipant asociado al participante agregado correctamente.

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Agregue un participante a esta llamada.

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

Parámetros

identifier

PhoneNumberIdentifier

Identificador del participante que se va a agregar.

options

AddPhoneNumberOptions

Opciones adicionales para administrar la llamada RTC. Por ejemplo, al establecer el número de teléfono del identificador de llamada en una llamada RTC.

Devoluciones

RemoteParticipant

El objeto RemoteParticipant asociado al participante agregado correctamente.

removeParticipant(CommunicationIdentifier)

Quite un participante de esta llamada.

function removeParticipant(identifier: CommunicationIdentifier): Promise<void>

Parámetros

identifier

CommunicationIdentifier

Identificador del participante que se va a quitar.

Devoluciones

Promise<void>

Detalles de los métodos heredados

dispose()

function dispose()

Heredado deCallCommon.dispose

feature<TFeature>(CallFeatureFactory<TFeature>)

Recupera un objeto Feature inicializado y memoizado con la API extendida. Compruebe el objeto Features.* para ver todas las características de llamadas extendidas disponibles en este paquete, por ejemplo:

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

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

Parámetros

factory

CallFeatureFactory<TFeature>

Generador del constructor de características de llamada que proporciona una API extendida.

Devoluciones

TFeature

Heredado deCallCommon.feature

hangUp(HangUpOptions)

Hang up the call (Colgar la llamada)

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

Parámetros

options

HangUpOptions

Opciones hangUp.

Devoluciones

Promise<void>

Heredado deCallCommon.hangUp

hold()

Ponga esta llamada en espera.

function hold(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallCommon.hold

mute()

Silenciar el micrófono local.

function mute(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallCommon.mute

muteAllRemoteParticipants()

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Silenciar a todos los participantes remotos.

function muteAllRemoteParticipants(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallCommon.muteAllRemoteParticipants

muteIncomingAudio()

Silenciar el audio entrante.

function muteIncomingAudio(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallCommon.muteIncomingAudio

off("idChanged", PropertyChangedEvent)

Cancelar la suscripción de la función para el evento idChanged.

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

Parámetros

event

"idChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn que se usó para suscribirse a este evento.

Heredado deCallCommon.off

off("isIncomingAudioMutedChanged", PropertyChangedEvent)

Función Subscribe para el evento isIncomingAudioMutedChanged.

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

Parámetros

event

"isIncomingAudioMutedChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.off

off("isLocalVideoStartedChanged", PropertyChangedEvent)

Función Unsubscribe para el evento isLocalVideoStartedChanged.

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

Parámetros

event

"isLocalVideoStartedChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.off

off("isMutedChanged", PropertyChangedEvent)

Función Subscribe para el evento isMutedChanged.

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

Parámetros

event

"isMutedChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.off

off("isScreenSharingOnChanged", PropertyChangedEvent)

Función Unsubscribe para el evento isScreenSharingChanged.

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

Parámetros

event

"isScreenSharingOnChanged"

nombre del evento.

listener

PropertyChangedEvent

callback fn que se usó para suscribirse a este evento.

Heredado deCallCommon.off

off("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Función Unsubscribe para el evento localAudioStreamsUpdated.

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

Parámetros

event

"localAudioStreamsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<LocalAudioStream>

callback fn que se usó para suscribirse a este evento.

Heredado deCallCommon.off

off("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Función Unsubscribe para el evento localVideoStreamsUpdated.

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

Parámetros

event

"localVideoStreamsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<LocalVideoStream>

callback fn que se usó para suscribirse a este evento.

Heredado deCallCommon.off

off("mutedByOthers", PropertyChangedEvent)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Cancele la función para el evento mutedByOthers.

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

Parámetros

event

"mutedByOthers"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn que se usó para cancelar la suscripción a este evento.

Heredado deCallCommon.off

off("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Cancele la función para el evento remoteAudioStreamsUpdated.

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

Parámetros

event

"remoteAudioStreamsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<RemoteAudioStream>

callback fn que se usó para suscribirse a este evento.

Heredado deCallCommon.off

off("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Cancele la función para el evento remoteParticipantsUpdated.

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

Parámetros

event

"remoteParticipantsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<RemoteParticipant>

callback fn que se usó para suscribirse a este evento.

Heredado deCallCommon.off

off("roleChanged", PropertyChangedEvent)

Función de cancelación de suscripción para el evento roleChanged.

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

Parámetros

event

"roleChanged"

nombre del evento.

listener

PropertyChangedEvent

callback fn que se usó para suscribirse a este evento.

Heredado deCallCommon.off

off("stateChanged", PropertyChangedEvent)

Cancele la función para el evento stateChanged.

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

Parámetros

event

"stateChanged"

nombre del evento.

listener

PropertyChangedEvent

callback fn que se usó para suscribirse a este evento.

Heredado deCallCommon.off

off("totalParticipantCountChanged", PropertyChangedEvent)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

función unsubscribe para el evento totalParticipantCountChanged.

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

Parámetros

event

"totalParticipantCountChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el recuento de participantes.

Heredado deCallCommon.off

on("idChanged", PropertyChangedEvent)

Función Subscribe para el evento idChanged.

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

Parámetros

event

"idChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.on

on("isIncomingAudioMutedChanged", PropertyChangedEvent)

Función Subscribe para el evento isIncomingAudioMutedChanged.

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

Parámetros

event

"isIncomingAudioMutedChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.on

on("isLocalVideoStartedChanged", PropertyChangedEvent)

Función Subscribe para el evento isLocalVideoStartedChanged.

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

Parámetros

event

"isLocalVideoStartedChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.on

on("isMutedChanged", PropertyChangedEvent)

Función Subscribe para el evento isMutedChanged.

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

Parámetros

event

"isMutedChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.on

on("isScreenSharingOnChanged", PropertyChangedEvent)

Función Subscribe para el evento isScreenSharingChanged.

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

Parámetros

event

"isScreenSharingOnChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.on

on("localAudioStreamsUpdated", CollectionUpdatedEvent<LocalAudioStream>)

Función Subscribe para el evento localAudioStreamsUpdated.

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

Parámetros

event

"localAudioStreamsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<LocalAudioStream>

devolución de llamada fn que se llamará cuando esta colección cambie, pasará matrices de elementos agregados y quitados.

Heredado deCallCommon.on

on("localVideoStreamsUpdated", CollectionUpdatedEvent<LocalVideoStream>)

Función Subscribe para el evento localVideoStreamsUpdated.

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

Parámetros

event

"localVideoStreamsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<LocalVideoStream>

devolución de llamada fn que se llamará cuando esta colección cambie, pasará matrices de elementos agregados y quitados.

Heredado deCallCommon.on

on("mutedByOthers", PropertyChangedEvent)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Función Subscribe para el evento mutedByOthers.

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

Parámetros

event

"mutedByOthers"

nombre del evento.

listener

PropertyChangedEvent

callback fn que se usó para suscribirse a este evento.

Heredado deCallCommon.on

on("remoteAudioStreamsUpdated", CollectionUpdatedEvent<RemoteAudioStream>)

Función Subscribe para el evento remoteAudioStreamsUpdated.

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

Parámetros

event

"remoteAudioStreamsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<RemoteAudioStream>

devolución de llamada fn que se llamará cuando esta colección cambie, pasará matrices de elementos agregados y quitados.

Heredado deCallCommon.on

on("remoteParticipantsUpdated", CollectionUpdatedEvent<RemoteParticipant>)

Función Subscribe para el evento remoteParticipantsUpdated.

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

Parámetros

event

"remoteParticipantsUpdated"

nombre del evento.

listener

CollectionUpdatedEvent<RemoteParticipant>

devolución de llamada fn que se llamará cuando esta colección cambie, pasará matrices de elementos agregados y quitados.

Heredado deCallCommon.on

on("roleChanged", PropertyChangedEvent)

Función Subscribe para el evento roleChanged.

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

Parámetros

event

"roleChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.on

on("stateChanged", PropertyChangedEvent)

Función Subscribe para el evento stateChanged.

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

Parámetros

event

"stateChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el valor de esta propiedad.

Heredado deCallCommon.on

on("totalParticipantCountChanged", PropertyChangedEvent)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Función Subscribe para el evento totalParticipantCountChanged.

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

Parámetros

event

"totalParticipantCountChanged"

nombre del evento.

listener

PropertyChangedEvent

devolución de llamada fn a la que se llamará cuando cambie el recuento de participantes.

Heredado deCallCommon.on

resume()

Reanude esta llamada si está en estado "LocalHold".

function resume(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallCommon.resume

sendDtmf(DtmfTone)

Enviar tono DTMF.

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

Parámetros

dtmfTone

DtmfTone

Devoluciones

Promise<void>

Heredado deCallCommon.sendDtmf

setConstraints(CallConstraints)

Establecer restricciones de llamada. Este método establece las restricciones máximas de según los valores proporcionados. Las restricciones aplicadas finales serán menores o iguales que los valores proporcionados aquí a este método. Si se proporciona un valor 0, no se aplicará ninguna restricción para esa restricción. Si se proporciona un valor indefinido, se usará el valor anterior usado para esa restricción.

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

Parámetros

constraints

CallConstraints

Objeto que representa las restricciones de llamada que se van a establecer

Devoluciones

Promise<void>

Heredado deCallCommon.setConstraints

startAudio(LocalAudioStream)

Inicie el audio en la llamada con audio personalizado. El origen localAudioStream debe ser mediaStream.

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

Parámetros

localAudioStream

LocalAudioStream

Devoluciones

Promise<void>

Heredado deCallCommon.startAudio

startScreenSharing()

• Comience a enviar una secuencia de uso compartido de pantalla en una llamada. El explorador le pedirá que seleccione la pantalla, la aplicación o la pestaña del explorador.
• No se admite el envío de secuencias de uso compartido de pantalla en iOS ni Android.
• La secuencia de uso compartido de pantalla entrante se admite en iOS y Android.

function startScreenSharing(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallCommon.startScreenSharing

startScreenSharing(LocalVideoStream)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

• Comience a enviar una secuencia de uso compartido de pantalla sin formato en una llamada.
• No se admite el envío de uso compartido de pantalla sin formato en iOS ni Android.
• El uso compartido de pantalla sin procesar entrante se admite en iOS y Android.

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

Parámetros

localVideoStream

LocalVideoStream

Representa una secuencia de uso compartido de pantalla sin formato local que toma un objeto MediaStream en el constructor.

Devoluciones

Promise<void>

Heredado deCallCommon.startScreenSharing

startVideo(LocalVideoStream)

Comience a enviar secuencias de vídeo en la llamada. Los participantes remotos de la llamada recibirán la secuencia de vídeo para que puedan representarla en sus INTERFACES de usuario.

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

Parámetros

localVideoStream

LocalVideoStream

Representa una secuencia de vídeo local que toma un origen de cámara en el constructor.

Devoluciones

Promise<void>

Heredado deCallCommon.startVideo

stopAudio()

Detenga el audio personalizado en la llamada y cambie al dispositivo de audio predeterminado del Administrador de dispositivos.

function stopAudio()

Heredado deCallCommon.stopAudio

stopScreenSharing()

Detenga el uso compartido de pantalla local.

function stopScreenSharing(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallCommon.stopScreenSharing

stopScreenSharing(LocalVideoStream)

Nota

Este API está en fase beta y se ofrece a los desarrolladores como versión preliminar. Puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Detenga el uso compartido de pantalla local.

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

Parámetros

localVideoStream

LocalVideoStream

Secuencia de uso compartido de pantalla local para detener el streaming.

Devoluciones

Promise<void>

Heredado deCallCommon.stopScreenSharing

stopVideo(LocalVideoStream)

Detenga el envío de secuencias de vídeo en la llamada. Debe pasar el mismo objeto LocalVideoStream que se usó para iniciar el vídeo en la API CallAgent.startCall(), CallAgent.join() API , IncomingCall.accept() API o Call.startVideo().

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

Parámetros

localVideoStream

LocalVideoStream

Secuencia de vídeo local para detener el streaming.

Devoluciones

Promise<void>

Heredado deCallCommon.stopVideo

unmute()

Desmute el micrófono local.

function unmute(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallCommon.unmute

unmuteIncomingAudio()

Desmute el audio entrante.

function unmuteIncomingAudio(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallCommon.unmuteIncomingAudio