CommonCallAdapter interface

Paquete:

@azure/communication-react

CallComposite Interfaz del adaptador.

Extends

AdapterState<CallAdapterState>,Disposable,CallAdapterCallOperations,CallAdapterDeviceManagement,CallAdapterSubscribers

Métodos

joinCall(boolean)	Únase a la llamada con el micrófono inicialmente activado o desactivado.
startCall(string[], StartCallOptions)	Inicie la llamada.

Métodos heredados

askDevicePermission(PermissionConstraints)	Solicitar permisos de dispositivos.
createStreamView(string, VideoStreamOptions)	Cree la vista html para una secuencia.
dispose()	Eliminación de la composición
disposeStreamView(string, VideoStreamOptions)	Elimine la vista html de una secuencia.
getState()	Obtener el estado actual
leaveCall(boolean)	Deje la llamada.
mute()	Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente
off("callEnded", CallEndedListener)	Cancele la función para el evento "callEnded".
off("callIdChanged", CallIdChangedListener)	Cancele la función para el evento "callIdChanged".
off("diagnosticChanged", DiagnosticChangedEventListner)	Cancele la función para el evento "diagnosticChanged".
off("displayNameChanged", DisplayNameChangedListener)	Cancele la función para el evento "displayNameChanged".
off("error", (e: AdapterError) => void)	Cancele la función para el evento "error".
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Función Unsubscribe para el evento "isLocalScreenSharingActiveChanged".
off("isMutedChanged", IsMutedChangedListener)	Cancele la función para el evento "isMutedChanged".
off("isSpeakingChanged", IsSpeakingChangedListener)	Cancele la función para el evento "isSpeakingChanged".
off("participantsJoined", ParticipantsJoinedListener)	Cancelar suscripción a la función para el evento "participantsJoined".
off("participantsLeft", ParticipantsLeftListener)	Cancele la función para el evento "participantsLeft".
off("selectedMicrophoneChanged", PropertyChangedEvent)	Cancele la función para el evento "selectedMicrophoneChanged".
off("selectedSpeakerChanged", PropertyChangedEvent)	Cancele la función para el evento "selectedSpeakerChanged".
offStateChange((state: CallAdapterState) => void)	Cancela la suscripción del controlador a eventos stateChanged.
on("callEnded", CallEndedListener)	Función Subscribe para el evento "callEnded".
on("callIdChanged", CallIdChangedListener)	Función Subscribe para el evento "callIdChanged".
on("diagnosticChanged", DiagnosticChangedEventListner)	Función Subscribe para el evento "diagnosticChanged". Este evento se activa cada vez que hay un cambio en los diagnósticos orientados al usuario sobre la llamada en curso.
on("displayNameChanged", DisplayNameChangedListener)	Función Subscribe para el evento "displayNameChanged".
on("error", (e: AdapterError) => void)	Función Subscribe para el evento 'error'.
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)	Función Subscribe para el evento "isLocalScreenSharingActiveChanged".
on("isMutedChanged", IsMutedChangedListener)	Función Subscribe para el evento "isMutedChanged".
on("isSpeakingChanged", IsSpeakingChangedListener)	Función Subscribe para el evento "isSpeakingChanged".
on("participantsJoined", ParticipantsJoinedListener)	Función Subscribe para el evento "participantsJoined".
on("participantsLeft", ParticipantsLeftListener)	Función Subscribe para el evento "participantsLeft".
on("selectedMicrophoneChanged", PropertyChangedEvent)	Función Subscribe para el evento "selectedMicrophoneChanged". Este evento se activa cada vez que el usuario selecciona un nuevo dispositivo de micrófono.
on("selectedSpeakerChanged", PropertyChangedEvent)	Función Subscribe para el evento "selectedSpeakerChanged". Este evento se activa cada vez que el usuario selecciona un nuevo dispositivo de altavoz.
onStateChange((state: CallAdapterState) => void)	Suscribe el controlador a eventos stateChanged.
queryCameras()	Consulta de dispositivos de cámara disponibles.
queryMicrophones()	Consulte los dispositivos de micrófono disponibles.
querySpeakers()	Consulte los dispositivos de micrófono disponibles.
removeParticipant(string)	Quite un participante de la llamada.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Establezca la cámara que se usará en la llamada.
setMicrophone(AudioDeviceInfo)	Establezca el micrófono que se va a usar en la llamada.
setSpeaker(AudioDeviceInfo)	Establezca el altavoz que se usará en la llamada.
startCamera(VideoStreamOptions)	Iniciar la cámara Este método comenzará a representar una vista de cámara local cuando la llamada no esté activa.
startScreenShare()	Comience a compartir la pantalla durante una llamada.
stopCamera()	Detener la cámara Este método dejará de representar una vista de cámara local cuando la llamada no esté activa.
stopScreenShare()	Dejar de compartir la pantalla
unmute()	Desmute el usuario actual durante la llamada o habilite el micrófono localmente.

Detalles del método

joinCall(boolean)

Únase a la llamada con el micrófono inicialmente activado o desactivado.

function joinCall(microphoneOn?: boolean)

Parámetros

microphoneOn

boolean

Si el micrófono está habilitado inicialmente

startCall(string[], StartCallOptions)

Inicie la llamada.

function startCall(participants: string[], options?: StartCallOptions)

Parámetros

participants

string[]

Matriz de identificadores de participante que se van a unir

options

StartCallOptions

Detalles de los métodos heredados

askDevicePermission(PermissionConstraints)

Solicitar permisos de dispositivos.

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

Parámetros

constrain

PermissionConstraints

Definición de restricciones para acceder a dispositivos locales <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Devoluciones

Promise<void>

Comentarios

Aparecerá la ventana de permisos del explorador si aún no se conceden permisos.

Heredado deCallAdapterDeviceManagement.askDevicePermission

createStreamView(string, VideoStreamOptions)

Cree la vista html para una secuencia.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parámetros

remoteUserId

string

Identificador del participante que se va a representar, déjelo sin definir para crear la vista de cámara local.

options

VideoStreamOptions

Opciones para controlar cómo se representan las secuencias de vídeo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluciones

Promise<void | CreateVideoStreamViewResult>

Comentarios

Este método se implementa para compuesto.

Heredado deCallAdapterCallOperations.createStreamView

dispose()

Eliminación de la composición

function dispose()

Heredado deDispose.dispose

disposeStreamView(string, VideoStreamOptions)

Elimine la vista html de una secuencia.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parámetros

remoteUserId

string

Identificador del participante que se va a representar, déjelo sin definir para eliminar la vista de cámara local.

options

VideoStreamOptions

Opciones para controlar cómo se representan las secuencias de vídeo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluciones

Promise<void>

Comentarios

Este método se implementa para compuesto.

Heredado deCallAdapterCallOperations.disposeStreamView

getState()

Obtener el estado actual

function getState(): CallAdapterState

Devoluciones

CallAdapterState

Heredado deAdapterState.getState

leaveCall(boolean)

Deje la llamada.

function leaveCall(forEveryone?: boolean): Promise<void>

Parámetros

forEveryone

boolean

Si se van a quitar todos los participantes

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.leaveCall

mute()

Silenciar al usuario actual durante la llamada o deshabilitar el micrófono localmente

function mute(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.mute

off("callEnded", CallEndedListener)

Cancele la función para el evento "callEnded".

function off(event: "callEnded", listener: CallEndedListener)

Parámetros

event

"callEnded"

listener

CallEndedListener

Heredado deCallAdapterSubscribers.off

off("callIdChanged", CallIdChangedListener)

Cancele la función para el evento "callIdChanged".

function off(event: "callIdChanged", listener: CallIdChangedListener)

Parámetros

event

"callIdChanged"

listener

CallIdChangedListener

Heredado deCallAdapterSubscribers.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Cancele la función para el evento "diagnosticChanged".

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parámetros

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Heredado deCallAdapterSubscribers.off

off("displayNameChanged", DisplayNameChangedListener)

Cancele la función para el evento "displayNameChanged".

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parámetros

event

"displayNameChanged"

listener

DisplayNameChangedListener

Heredado deCallAdapterSubscribers.off

off("error", (e: AdapterError) => void)

Cancele la función para el evento "error".

function off(event: "error", listener: (e: AdapterError) => void)

Parámetros

event

"error"

listener

(e: AdapterError) => void

Heredado deCallAdapterSubscribers.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Función Unsubscribe para el evento "isLocalScreenSharingActiveChanged".

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parámetros

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Heredado deCallAdapterSubscribers.off

off("isMutedChanged", IsMutedChangedListener)

Cancele la función para el evento "isMutedChanged".

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

Parámetros

event

"isMutedChanged"

listener

IsMutedChangedListener

Heredado deCallAdapterSubscribers.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Cancele la función para el evento "isSpeakingChanged".

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parámetros

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Heredado deCallAdapterSubscribers.off

off("participantsJoined", ParticipantsJoinedListener)

Cancelar suscripción a la función para el evento "participantsJoined".

function off(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parámetros

event

"participantsJoined"

listener

ParticipantsJoinedListener

Heredado deCallAdapterSubscribers.off

off("participantsLeft", ParticipantsLeftListener)

Cancele la función para el evento "participantsLeft".

function off(event: "participantsLeft", listener: ParticipantsLeftListener)

Parámetros

event

"participantsLeft"

listener

ParticipantsLeftListener

Heredado deCallAdapterSubscribers.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Cancele la función para el evento "selectedMicrophoneChanged".

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

Parámetros

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Heredado deCallAdapterSubscribers.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Cancele la función para el evento "selectedSpeakerChanged".

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

Parámetros

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Heredado deCallAdapterSubscribers.off

offStateChange((state: CallAdapterState) => void)

Cancela la suscripción del controlador a eventos stateChanged.

function offStateChange(handler: (state: CallAdapterState) => void)

Parámetros

handler

(state: CallAdapterState) => void

Heredado deAdapterState.offStateChange

on("callEnded", CallEndedListener)

Función Subscribe para el evento "callEnded".

function on(event: "callEnded", listener: CallEndedListener)

Parámetros

event

"callEnded"

listener

CallEndedListener

Heredado deCallAdapterSubscribers.on

on("callIdChanged", CallIdChangedListener)

Función Subscribe para el evento "callIdChanged".

function on(event: "callIdChanged", listener: CallIdChangedListener)

Parámetros

event

"callIdChanged"

listener

CallIdChangedListener

Comentarios

El evento se desencadenará cuando se cambie callId del usuario actual.

Heredado deCallAdapterSubscribers.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Función Subscribe para el evento "diagnosticChanged".

Este evento se activa cada vez que hay un cambio en los diagnósticos orientados al usuario sobre la llamada en curso.

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parámetros

event

"diagnosticChanged"

listener

DiagnosticChangedEventListner

Heredado deCallAdapterSubscribers.on

on("displayNameChanged", DisplayNameChangedListener)

Función Subscribe para el evento "displayNameChanged".

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parámetros

event

"displayNameChanged"

listener

DisplayNameChangedListener

Heredado deCallAdapterSubscribers.on

on("error", (e: AdapterError) => void)

Función Subscribe para el evento 'error'.

function on(event: "error", listener: (e: AdapterError) => void)

Parámetros

event

"error"

listener

(e: AdapterError) => void

Heredado deCallAdapterSubscribers.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Función Subscribe para el evento "isLocalScreenSharingActiveChanged".

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parámetros

event

"isLocalScreenSharingActiveChanged"

listener

IsLocalScreenSharingActiveChangedListener

Heredado deCallAdapterSubscribers.on

on("isMutedChanged", IsMutedChangedListener)

Función Subscribe para el evento "isMutedChanged".

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

Parámetros

event

"isMutedChanged"

listener

IsMutedChangedListener

Comentarios

El evento se desencadenará siempre que el usuario actual o el estado de silenciación del usuario remoto cambien.

Heredado deCallAdapterSubscribers.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Función Subscribe para el evento "isSpeakingChanged".

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parámetros

event

"isSpeakingChanged"

listener

IsSpeakingChangedListener

Heredado deCallAdapterSubscribers.on

on("participantsJoined", ParticipantsJoinedListener)

Función Subscribe para el evento "participantsJoined".

function on(event: "participantsJoined", listener: ParticipantsJoinedListener)

Parámetros

event

"participantsJoined"

listener

ParticipantsJoinedListener

Heredado deCallAdapterSubscribers.on

on("participantsLeft", ParticipantsLeftListener)

Función Subscribe para el evento "participantsLeft".

function on(event: "participantsLeft", listener: ParticipantsLeftListener)

Parámetros

event

"participantsLeft"

listener

ParticipantsLeftListener

Heredado deCallAdapterSubscribers.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Función Subscribe para el evento "selectedMicrophoneChanged".

Este evento se activa cada vez que el usuario selecciona un nuevo dispositivo de micrófono.

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

Parámetros

event

"selectedMicrophoneChanged"

listener

PropertyChangedEvent

Heredado deCallAdapterSubscribers.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Función Subscribe para el evento "selectedSpeakerChanged".

Este evento se activa cada vez que el usuario selecciona un nuevo dispositivo de altavoz.

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

Parámetros

event

"selectedSpeakerChanged"

listener

PropertyChangedEvent

Heredado deCallAdapterSubscribers.on

onStateChange((state: CallAdapterState) => void)

Suscribe el controlador a eventos stateChanged.

function onStateChange(handler: (state: CallAdapterState) => void)

Parámetros

handler

(state: CallAdapterState) => void

Heredado deAdapterState.onStateChange

queryCameras()

Consulta de dispositivos de cámara disponibles.

function queryCameras(): Promise<VideoDeviceInfo[]>

Devoluciones

Promise<VideoDeviceInfo[]>

Matriz de entidades de información de dispositivo de vídeo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Comentarios

Se debe llamar a este método después de askDevicePermission()

Heredado deCallAdapterDeviceManagement.queryCameras

queryMicrophones()

Consulte los dispositivos de micrófono disponibles.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Devoluciones

Promise<AudioDeviceInfo[]>

Matriz de entidades de información de dispositivos de audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentarios

Se debe llamar a este método después de askDevicePermission()

Heredado deCallAdapterDeviceManagement.queryMicrophones

querySpeakers()

Consulte los dispositivos de micrófono disponibles.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Devoluciones

Promise<AudioDeviceInfo[]>

Matriz de entidades de información de dispositivos de audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Comentarios

Se debe llamar a este método después de askDevicePermission()

Heredado deCallAdapterDeviceManagement.querySpeakers

removeParticipant(string)

Quite un participante de la llamada.

function removeParticipant(userId: string): Promise<void>

Parámetros

userId

string

Identificador del participante que se va a quitar

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.removeParticipant

setCamera(VideoDeviceInfo, VideoStreamOptions)

Establezca la cámara que se usará en la llamada.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parámetros

sourceInfo

VideoDeviceInfo

Dispositivo de cámara que elegir, elija uno devuelto por queryCameras.

options

VideoStreamOptions

Opciones para controlar cómo se representa la secuencia de cámara <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluciones

Promise<void>

Heredado deCallAdapterDeviceManagement.setCamera

setMicrophone(AudioDeviceInfo)

Establezca el micrófono que se va a usar en la llamada.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parámetros

sourceInfo

AudioDeviceInfo

Dispositivo de micrófono que se va a elegir, elija uno devuelto por consultaMicrophones

Devoluciones

Promise<void>

Heredado deCallAdapterDeviceManagement.setMicrophone

setSpeaker(AudioDeviceInfo)

Establezca el altavoz que se usará en la llamada.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parámetros

sourceInfo

AudioDeviceInfo

Dispositivo de altavoz que elegir, elija uno devuelto por querySpeakers.

Devoluciones

Promise<void>

Heredado deCallAdapterDeviceManagement.setSpeaker

startCamera(VideoStreamOptions)

Iniciar la cámara Este método comenzará a representar una vista de cámara local cuando la llamada no esté activa.

function startCamera(options?: VideoStreamOptions): Promise<void>

Parámetros

options

VideoStreamOptions

Opciones para controlar cómo se representan las secuencias de vídeo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.startCamera

startScreenShare()

Comience a compartir la pantalla durante una llamada.

function startScreenShare(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.startScreenShare

stopCamera()

Detener la cámara Este método dejará de representar una vista de cámara local cuando la llamada no esté activa.

function stopCamera(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.stopCamera

stopScreenShare()

Dejar de compartir la pantalla

function stopScreenShare(): Promise<void>

Devoluciones

Promise<void>

Heredado deCallAdapterCallOperations.stopScreenShare

unmute()

Desmute el usuario actual durante la llamada o habilite el micrófono localmente.

function unmute(): Promise<void>

Devoluciones

Promise<void>

Se hereda deCallAdapterCallOperations.unmute