CallAdapterCallOperations interface

Pakket:

@azure/communication-react

Functionaliteit voor het beheren van de huidige aanroep.

Eigenschappen

sendRealTimeText

Verzend realtime tekst

Methoden

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Voeg een deelnemer toe aan het gesprek.
createStreamView(string, VideoStreamOptions)	Maak de HTML-weergave voor een stream.
createTogetherModeStreamView(TogetherModeStreamOptions)	Maak de HTML-weergave voor een stream.
disposeLocalVideoStreamView()	Beschik over de html-weergave voor een lokale videostream
disposeRemoteVideoStreamView(string)	Beschik over de html-weergave voor een externe videostream
disposeScreenShareStreamView(string)	Beschik over de html-weergave voor een stream voor het delen van schermen
disposeStreamView(string, VideoStreamOptions)	De HTML-weergave voor een stream verwijderen.
disposeTogetherModeStreamView()	De HTML-weergave voor een stream verwijderen.
forbidAudio(string[])	Verbied het luisteren van deelnemers aan Teams-vergaderingen via hun gebruikers-ID's.
forbidOthersAudio()	Verbied audio van Teams-vergaderingen.
forbidOthersVideo()	Verbied video's van Teams-vergaderingen.
forbidVideo(string[])	Verbied video's van deelnemers aan Teams-vergaderingen op basis van hun gebruikers-id's.
holdCall()	Zet het gesprek in de wacht.
leaveCall(boolean)	Laat het gesprek staan
lowerHand()	Onderhand voor huidige gebruiker
mute()	De huidige gebruiker dempen tijdens het gesprek of de microfoon lokaal uitschakelen
muteAllRemoteParticipants()	Alle deelnemers dempen
muteParticipant(string)	Een deelnemer dempen
onReactionClick(Reaction)	Reactie-emoji verzenden
permitAudio(string[])	Sta audio toe aan deelnemers aan Teams-vergaderingen op basis van hun gebruikers-id's.
permitOthersAudio()	Sta audio van Teams-vergaderingen toe.
permitOthersVideo()	Sta video's voor Teams-vergaderingen toe.
permitVideo(string[])	Sta audio toe aan deelnemers aan Teams-vergaderingen op basis van hun gebruikers-id's.
raiseHand()	Hand opsteken voor huidige gebruiker
removeParticipant(CommunicationIdentifier)	Een deelnemer uit het gesprek verwijderen.
removeParticipant(string)	Een deelnemer uit het gesprek verwijderen.
resumeCall()	Hervat het gesprek vanuit een LocalHold staat.
returnFromBreakoutRoom()	Terug naar de oorspronkelijke oproep van de breakout room
sendDtmfTone(DtmfTone)	dtmf-toon verzenden naar een andere deelnemer aan een 1:1 PSTN-gesprek
setCaptionLanguage(string)	Functie om de taal van ondertiteling in te stellen
setSpokenLanguage(string)	Functie om gesproken taal in te stellen
setTogetherModeSceneSize(number, number)	Bereken de zitposities voor de samen-modus opnieuw.
startCamera(VideoStreamOptions)	De camera starten Met deze methode wordt een lokale cameraweergave weergegeven wanneer de oproep niet actief is
startCaptions(StartCaptionsAdapterOptions)	Functie om ondertiteling te starten
startNoiseSuppressionEffect()	Start het ruisonderdrukkingseffect.
startScreenShare()	Begin met het delen van het scherm tijdens een gesprek.
startSpotlight(string[])	Start spotlight voor lokale en externe deelnemers op basis van hun gebruikers-id's. Als er geen matrix met gebruikers-id's wordt doorgegeven, wordt er actie ondernomen op de lokale deelnemer.
startTogetherMode()	Start de modus Samen.
startVideoBackgroundEffect(VideoBackgroundEffect)	Start het achtergrondeffect van de video.
stopAllSpotlight()	Stop alle schijnwerpers
stopCamera()	Stop de camera Deze methode stopt met het weergeven van een lokale cameraweergave wanneer de oproep niet actief is
stopCaptions(StopCaptionsAdapterOptions)	Functie om ondertiteling te stoppen
stopNoiseSuppressionEffect()	Stop het ruisonderdrukkingseffect.
stopScreenShare()	Het delen van het scherm stoppen
stopSpotlight(string[])	Stop spotlight voor lokale en externe deelnemers op basis van hun gebruikers-ID's. Als er geen matrix met gebruikers-id's wordt doorgegeven, wordt er actie ondernomen op de lokale deelnemer.
stopVideoBackgroundEffects()	Stop het achtergrondeffect van de video.
submitSurvey(CallSurvey)	Het resultaat van de enquête aan het einde van het gesprek verzenden
unmute()	Het dempen van de huidige gebruiker opheffen tijdens het gesprek of lokaal microfoon inschakelen
updateBackgroundPickerImages(VideoBackgroundImage[])	Overschrijf de afbeeldingen van de achtergrondkiezer voor het vervangingseffect van de achtergrond.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Werk het geselecteerde video-achtergrondeffect bij.

Eigenschapdetails

sendRealTimeText

Verzend realtime tekst

sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>

Waarde van eigenschap

(text: string, isFinalized: boolean) => Promise<void>

Methodedetails

addParticipant(CommunicationUserIdentifier)

function addParticipant(participant: CommunicationUserIdentifier): Promise<void>

Parameters

participant

CommunicationUserIdentifier

Retouren

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Voeg een deelnemer toe aan het gesprek.

function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>

Parameters

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Retouren

Promise<void>

createStreamView(string, VideoStreamOptions)

Maak de HTML-weergave voor een stream.

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

Parameters

remoteUserId

string

Id van de deelnemer die moet worden weergegeven, laat deze ongewijzigd om de lokale cameraweergave te maken

options

VideoStreamOptions

Opties om te bepalen hoe videostreams worden weergegeven <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retouren

Promise<void | CreateVideoStreamViewResult>

Opmerkingen

Deze methode wordt geïmplementeerd voor samengesteld

createTogetherModeStreamView(TogetherModeStreamOptions)

Maak de HTML-weergave voor een stream.

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

Parameters

options

TogetherModeStreamOptions

Opties om te bepalen hoe videostreams worden weergegeven <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retouren

Promise<void | TogetherModeStreamViewResult>

Opmerkingen

Deze methode wordt geïmplementeerd voor samengesteld

disposeLocalVideoStreamView()

Beschik over de html-weergave voor een lokale videostream

function disposeLocalVideoStreamView(): Promise<void>

Retouren

Promise<void>

disposeRemoteVideoStreamView(string)

Beschik over de html-weergave voor een externe videostream

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

Parameters

remoteUserId

string

Id van de deelnemer om over te beschikken

Retouren

Promise<void>

disposeScreenShareStreamView(string)

Beschik over de html-weergave voor een stream voor het delen van schermen

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

Parameters

remoteUserId

string

Id van de deelnemer waarvoor de streamweergave voor het delen van het scherm moet worden verwijderd.

Retouren

Promise<void>

Opmerkingen

Deze methode is geïmplementeerd voor composiet

disposeStreamView(string, VideoStreamOptions)

Waarschuwing

Deze API is nu afgeschaft.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

De HTML-weergave voor een stream verwijderen.

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

Parameters

remoteUserId

string

Id van de deelnemer die moet worden weergegeven, laat deze ongedefinieerd om de lokale cameraweergave te verwijderen

options

VideoStreamOptions

Opties om te bepalen hoe videostreams worden weergegeven <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retouren

Promise<void>

Opmerkingen

Deze methode wordt geïmplementeerd voor samengesteld

disposeTogetherModeStreamView()

De HTML-weergave voor een stream verwijderen.

function disposeTogetherModeStreamView(): Promise<void>

Retouren

Promise<void>

Opmerkingen

Deze methode wordt geïmplementeerd voor samengesteld

forbidAudio(string[])

Verbied het luisteren van deelnemers aan Teams-vergaderingen via hun gebruikers-ID's.

function forbidAudio(userIds: string[]): Promise<void>

Parameters

userIds

string[]

Retouren

Promise<void>

forbidOthersAudio()

Verbied audio van Teams-vergaderingen.

function forbidOthersAudio(): Promise<void>

Retouren

Promise<void>

forbidOthersVideo()

Verbied video's van Teams-vergaderingen.

function forbidOthersVideo(): Promise<void>

Retouren

Promise<void>

forbidVideo(string[])

Verbied video's van deelnemers aan Teams-vergaderingen op basis van hun gebruikers-id's.

function forbidVideo(userIds: string[]): Promise<void>

Parameters

userIds

string[]

Retouren

Promise<void>

holdCall()

Zet het gesprek in de wacht.

function holdCall(): Promise<void>

Retouren

Promise<void>

leaveCall(boolean)

Laat het gesprek staan

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

Parameters

forEveryone

boolean

Of alle deelnemers moeten worden verwijderd wanneer u vertrekt

Retouren

Promise<void>

lowerHand()

Onderhand voor huidige gebruiker

function lowerHand(): Promise<void>

Retouren

Promise<void>

mute()

De huidige gebruiker dempen tijdens het gesprek of de microfoon lokaal uitschakelen

function mute(): Promise<void>

Retouren

Promise<void>

muteAllRemoteParticipants()

Alle deelnemers dempen

function muteAllRemoteParticipants(): Promise<void>

Retouren

Promise<void>

muteParticipant(string)

Een deelnemer dempen

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

Parameters

userId

string

Id van de deelnemer om te dempen

Retouren

Promise<void>

onReactionClick(Reaction)

Reactie-emoji verzenden

function onReactionClick(reaction: Reaction): Promise<void>

Parameters

reaction

Reaction

Retouren

Promise<void>

permitAudio(string[])

Sta audio toe aan deelnemers aan Teams-vergaderingen op basis van hun gebruikers-id's.

function permitAudio(userIds: string[]): Promise<void>

Parameters

userIds

string[]

Retouren

Promise<void>

permitOthersAudio()

Sta audio van Teams-vergaderingen toe.

function permitOthersAudio(): Promise<void>

Retouren

Promise<void>

permitOthersVideo()

Sta video's voor Teams-vergaderingen toe.

function permitOthersVideo(): Promise<void>

Retouren

Promise<void>

permitVideo(string[])

Sta audio toe aan deelnemers aan Teams-vergaderingen op basis van hun gebruikers-id's.

function permitVideo(userIds: string[]): Promise<void>

Parameters

userIds

string[]

Retouren

Promise<void>

raiseHand()

Hand opsteken voor huidige gebruiker

function raiseHand(): Promise<void>

Retouren

Promise<void>

removeParticipant(CommunicationIdentifier)

Een deelnemer uit het gesprek verwijderen.

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

Parameters

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> van de te verwijderen deelnemer

Retouren

Promise<void>

removeParticipant(string)

Een deelnemer uit het gesprek verwijderen.

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

Parameters

userId

string

Id van de deelnemer die moet worden verwijderd

Retouren

Promise<void>

resumeCall()

Hervat het gesprek vanuit een LocalHold staat.

function resumeCall(): Promise<void>

Retouren

Promise<void>

returnFromBreakoutRoom()

Terug naar de oorspronkelijke oproep van de breakout room

function returnFromBreakoutRoom(): Promise<void>

Retouren

Promise<void>

sendDtmfTone(DtmfTone)

dtmf-toon verzenden naar een andere deelnemer aan een 1:1 PSTN-gesprek

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

Parameters

dtmfTone

DtmfTone

Retouren

Promise<void>

setCaptionLanguage(string)

Functie om de taal van ondertiteling in te stellen

function setCaptionLanguage(language: string): Promise<void>

Parameters

language

string

Taal ingesteld voor ondertiteling

Retouren

Promise<void>

setSpokenLanguage(string)

Functie om gesproken taal in te stellen

function setSpokenLanguage(language: string): Promise<void>

Parameters

language

string

spreektaal

Retouren

Promise<void>

setTogetherModeSceneSize(number, number)

Bereken de zitposities voor de samen-modus opnieuw.

function setTogetherModeSceneSize(width: number, height: number)

Parameters

width

number

Breedte van de container

height

number

Hoogte van de container

Opmerkingen

Deze methode wordt geïmplementeerd voor samengesteld

startCamera(VideoStreamOptions)

De camera starten Met deze methode wordt een lokale cameraweergave weergegeven wanneer de oproep niet actief is

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

Parameters

options

VideoStreamOptions

Opties om te bepalen hoe videostreams worden weergegeven <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Retouren

Promise<void>

startCaptions(StartCaptionsAdapterOptions)

Functie om ondertiteling te starten

function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>

Parameters

options

StartCaptionsAdapterOptions

Opties voor het starten van ondertiteling

Retouren

Promise<void>

startNoiseSuppressionEffect()

Start het ruisonderdrukkingseffect.

function startNoiseSuppressionEffect(): Promise<void>

Retouren

Promise<void>

startScreenShare()

Begin met het delen van het scherm tijdens een gesprek.

function startScreenShare(): Promise<void>

Retouren

Promise<void>

startSpotlight(string[])

Start spotlight voor lokale en externe deelnemers op basis van hun gebruikers-id's. Als er geen matrix met gebruikers-id's wordt doorgegeven, wordt er actie ondernomen op de lokale deelnemer.

function startSpotlight(userIds?: string[]): Promise<void>

Parameters

userIds

string[]

Retouren

Promise<void>

startTogetherMode()

Start de modus Samen.

function startTogetherMode(): Promise<void>

Retouren

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

Start het achtergrondeffect van de video.

function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>

Parameters

videoBackgroundEffect

VideoBackgroundEffect

Retouren

Promise<void>

stopAllSpotlight()

Stop alle schijnwerpers

function stopAllSpotlight(): Promise<void>

Retouren

Promise<void>

stopCamera()

Stop de camera Deze methode stopt met het weergeven van een lokale cameraweergave wanneer de oproep niet actief is

function stopCamera(): Promise<void>

Retouren

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Functie om ondertiteling te stoppen

function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>

Parameters

options

StopCaptionsAdapterOptions

Retouren

Promise<void>

stopNoiseSuppressionEffect()

Stop het ruisonderdrukkingseffect.

function stopNoiseSuppressionEffect(): Promise<void>

Retouren

Promise<void>

stopScreenShare()

Het delen van het scherm stoppen

function stopScreenShare(): Promise<void>

Retouren

Promise<void>

stopSpotlight(string[])

Stop spotlight voor lokale en externe deelnemers op basis van hun gebruikers-ID's. Als er geen matrix met gebruikers-id's wordt doorgegeven, wordt er actie ondernomen op de lokale deelnemer.

function stopSpotlight(userIds?: string[]): Promise<void>

Parameters

userIds

string[]

Retouren

Promise<void>

stopVideoBackgroundEffects()

Stop het achtergrondeffect van de video.

function stopVideoBackgroundEffects(): Promise<void>

Retouren

Promise<void>

submitSurvey(CallSurvey)

Het resultaat van de enquête aan het einde van het gesprek verzenden

function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>

Parameters

survey

CallSurvey

Retouren

Promise<undefined | CallSurveyResponse>

unmute()

Het dempen van de huidige gebruiker opheffen tijdens het gesprek of lokaal microfoon inschakelen

function unmute(): Promise<void>

Retouren

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

Overschrijf de afbeeldingen van de achtergrondkiezer voor het vervangingseffect van de achtergrond.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parameters

backgroundImages

VideoBackgroundImage[]

Reeks aangepaste achtergrondafbeeldingen.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Werk het geselecteerde video-achtergrondeffect bij.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parameters

selectedVideoBackground

VideoBackgroundEffect