CallAdapterCallOperations interface

Paket:

@azure/communication-react

Funktioner för att hantera det aktuella anropet.

Egenskaper

sendRealTimeText

Skicka text i realtid

Metoder

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Lägg till en deltagare i anropet.
createStreamView(string, VideoStreamOptions)	Skapa html-vyn för en dataström.
createTogetherModeStreamView(TogetherModeStreamOptions)	Skapa html-vyn för en dataström.
disposeLocalVideoStreamView()	Ta bort html-vyn för en lokal videoström
disposeRemoteVideoStreamView(string)	Ta bort html-vyn för en fjärrvideoström
disposeScreenShareStreamView(string)	Ta bort html-vyn för en skärmdelningsström
disposeStreamView(string, VideoStreamOptions)	Ta bort html-vyn för en dataström.
disposeTogetherModeStreamView()	Ta bort html-vyn för en dataström.
forbidAudio(string[])	Förbjud att Teams-mötesdeltagare ljudar med sina användar-ID:n.
forbidOthersAudio()	Förbjud Teams mötesljud.
forbidOthersVideo()	Förbjud Teams mötesvideo.
forbidVideo(string[])	Förbjud Teams-mötesdeltagare att video med sina användar-ID:n.
holdCall()	Parkerar samtalet.
leaveCall(boolean)	Lämna samtalet
lowerHand()	Nedre hand för aktuell användare
mute()	Stäng av den aktuella användaren under anropet eller inaktivera mikrofonen lokalt
muteAllRemoteParticipants()	Stäng av ljudet för alla deltagare
muteParticipant(string)	Stänga av ljudet för en deltagare
onReactionClick(Reaction)	Skicka reaktionsemoji
permitAudio(string[])	Tillåt Teams-mötesdeltagare att spela med sina användar-ID:n.
permitOthersAudio()	Tillåt Teams mötesljud.
permitOthersVideo()	Tillåt Teams mötesvideo.
permitVideo(string[])	Tillåt Teams-mötesdeltagare att spela med sina användar-ID:n.
raiseHand()	Räck upp handen för den aktuella användaren
removeParticipant(CommunicationIdentifier)	Ta bort en deltagare från anropet.
removeParticipant(string)	Ta bort en deltagare från anropet.
resumeCall()	Återupptar anropet från ett LocalHold tillstånd.
returnFromBreakoutRoom()	Återgå till ursprungsanropet för breakout room
sendDtmfTone(DtmfTone)	skicka dtmf-ton till en annan deltagare i ett 1:1 PSTN-samtal
setCaptionLanguage(string)	Funktion för att ställa in bildtextspråk
setSpokenLanguage(string)	Funktion för att ställa in talat språk
setTogetherModeSceneSize(number, number)	Beräkna om sittplatserna för tillsammans-läget.
startCamera(VideoStreamOptions)	Starta kameran Den här metoden börjar återge en lokal kameravy när anropet inte är aktivt
startCaptions(StartCaptionsAdapterOptions)	Funktion för att starta bildtexter
startNoiseSuppressionEffect()	Starta brusdämpningseffekten.
startScreenShare()	Börja dela skärmen under ett samtal.
startSpotlight(string[])	Starta spotlight för lokala och fjärranslutna deltagare med deras användar-ID:n. Om ingen matris med användar-ID:n skickas utförs åtgärden på den lokala deltagaren.
startTogetherMode()	Starta tillsammans-läge.
startVideoBackgroundEffect(VideoBackgroundEffect)	Starta videobakgrundseffekten.
stopAllSpotlight()	Stoppa alla spotlights
stopCamera()	Stoppa kameran Den här metoden slutar återge en lokal kameravy när anropet inte är aktivt
stopCaptions(StopCaptionsAdapterOptions)	Funktion för att stoppa textning
stopNoiseSuppressionEffect()	Stoppa brusdämpningseffekten.
stopScreenShare()	Sluta dela skärmen
stopSpotlight(string[])	Stoppa spotlighten för lokala och fjärranslutna deltagare med deras användar-ID:n. Om ingen matris med användar-ID:n skickas utförs åtgärden på den lokala deltagaren.
stopVideoBackgroundEffects()	Stoppa videobakgrundseffekten.
submitSurvey(CallSurvey)	Skicka resultatet av undersökningen om samtalets slut
unmute()	Slå på ljudet för den aktuella användaren under samtalet eller aktivera mikrofonen lokalt
updateBackgroundPickerImages(VideoBackgroundImage[])	Åsidosätt bakgrundsväljarens bilder för att få en bakgrundsersättningseffekt.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Uppdatera den valda videobakgrundseffekten.

Egenskapsinformation

sendRealTimeText

Skicka text i realtid

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

Egenskapsvärde

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

Metodinformation

addParticipant(CommunicationUserIdentifier)

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

Parametrar

participant

CommunicationUserIdentifier

Returer

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Lägg till en deltagare i anropet.

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

Parametrar

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Returer

Promise<void>

createStreamView(string, VideoStreamOptions)

Skapa html-vyn för en dataström.

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

Parametrar

remoteUserId

string

ID för deltagaren som ska återges, lämna det odefinierat för att skapa den lokala kameravyn

options

VideoStreamOptions

Alternativ för att styra hur videoströmmar återges <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returer

Promise<void | CreateVideoStreamViewResult>

Kommentarer

Den här metoden implementeras för sammansatta

createTogetherModeStreamView(TogetherModeStreamOptions)

Skapa html-vyn för en dataström.

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

Parametrar

options

TogetherModeStreamOptions

Alternativ för att styra hur videoströmmar återges <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returer

Promise<void | TogetherModeStreamViewResult>

Kommentarer

Den här metoden implementeras för sammansatta

disposeLocalVideoStreamView()

Ta bort html-vyn för en lokal videoström

function disposeLocalVideoStreamView(): Promise<void>

Returer

Promise<void>

disposeRemoteVideoStreamView(string)

Ta bort html-vyn för en fjärrvideoström

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

Parametrar

remoteUserId

string

ID för den deltagare som ska disponeras

Returer

Promise<void>

disposeScreenShareStreamView(string)

Ta bort html-vyn för en skärmdelningsström

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

Parametrar

remoteUserId

string

ID för deltagaren som skärmdelningsströmvyn ska disponeras för.

Returer

Promise<void>

Kommentarer

Den här metoden implementeras för sammansatta

disposeStreamView(string, VideoStreamOptions)

Varning

Det här API:et är nu inaktuellt.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

Ta bort html-vyn för en dataström.

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

Parametrar

remoteUserId

string

ID för deltagaren som ska återges, lämna det odefinierat för att ta bort den lokala kameravyn

options

VideoStreamOptions

Alternativ för att styra hur videoströmmar återges <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returer

Promise<void>

Kommentarer

Den här metoden implementeras för sammansatta

disposeTogetherModeStreamView()

Ta bort html-vyn för en dataström.

function disposeTogetherModeStreamView(): Promise<void>

Returer

Promise<void>

Kommentarer

Den här metoden implementeras för sammansatta

forbidAudio(string[])

Förbjud att Teams-mötesdeltagare ljudar med sina användar-ID:n.

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

Parametrar

userIds

string[]

Returer

Promise<void>

forbidOthersAudio()

Förbjud Teams mötesljud.

function forbidOthersAudio(): Promise<void>

Returer

Promise<void>

forbidOthersVideo()

Förbjud Teams mötesvideo.

function forbidOthersVideo(): Promise<void>

Returer

Promise<void>

forbidVideo(string[])

Förbjud Teams-mötesdeltagare att video med sina användar-ID:n.

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

Parametrar

userIds

string[]

Returer

Promise<void>

holdCall()

Parkerar samtalet.

function holdCall(): Promise<void>

Returer

Promise<void>

leaveCall(boolean)

Lämna samtalet

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

Parametrar

forEveryone

boolean

Om alla deltagare ska tas bort när de lämnar

Returer

Promise<void>

lowerHand()

Nedre hand för aktuell användare

function lowerHand(): Promise<void>

Returer

Promise<void>

mute()

Stäng av den aktuella användaren under anropet eller inaktivera mikrofonen lokalt

function mute(): Promise<void>

Returer

Promise<void>

muteAllRemoteParticipants()

Stäng av ljudet för alla deltagare

function muteAllRemoteParticipants(): Promise<void>

Returer

Promise<void>

muteParticipant(string)

Stänga av ljudet för en deltagare

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

Parametrar

userId

string

ID för deltagaren som ska tystas

Returer

Promise<void>

onReactionClick(Reaction)

Skicka reaktionsemoji

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

Parametrar

reaction

Reaction

Returer

Promise<void>

permitAudio(string[])

Tillåt Teams-mötesdeltagare att spela med sina användar-ID:n.

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

Parametrar

userIds

string[]

Returer

Promise<void>

permitOthersAudio()

Tillåt Teams mötesljud.

function permitOthersAudio(): Promise<void>

Returer

Promise<void>

permitOthersVideo()

Tillåt Teams mötesvideo.

function permitOthersVideo(): Promise<void>

Returer

Promise<void>

permitVideo(string[])

Tillåt Teams-mötesdeltagare att spela med sina användar-ID:n.

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

Parametrar

userIds

string[]

Returer

Promise<void>

raiseHand()

Räck upp handen för den aktuella användaren

function raiseHand(): Promise<void>

Returer

Promise<void>

removeParticipant(CommunicationIdentifier)

Ta bort en deltagare från anropet.

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

Parametrar

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> för deltagaren som ska tas bort

Returer

Promise<void>

removeParticipant(string)

Ta bort en deltagare från anropet.

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

Parametrar

userId

string

ID för deltagaren som ska tas bort

Returer

Promise<void>

resumeCall()

Återupptar anropet från ett LocalHold tillstånd.

function resumeCall(): Promise<void>

Returer

Promise<void>

returnFromBreakoutRoom()

Återgå till ursprungsanropet för breakout room

function returnFromBreakoutRoom(): Promise<void>

Returer

Promise<void>

sendDtmfTone(DtmfTone)

skicka dtmf-ton till en annan deltagare i ett 1:1 PSTN-samtal

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

Parametrar

dtmfTone

DtmfTone

Returer

Promise<void>

setCaptionLanguage(string)

Funktion för att ställa in bildtextspråk

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

Parametrar

language

string

Språk inställt för bildtext

Returer

Promise<void>

setSpokenLanguage(string)

Funktion för att ställa in talat språk

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

Parametrar

language

string

talat språk

Returer

Promise<void>

setTogetherModeSceneSize(number, number)

Beräkna om sittplatserna för tillsammans-läget.

function setTogetherModeSceneSize(width: number, height: number)

Parametrar

width

number

Behållarens bredd

height

number

Behållarens höjd

Kommentarer

Den här metoden implementeras för sammansatta

startCamera(VideoStreamOptions)

Starta kameran Den här metoden börjar återge en lokal kameravy när anropet inte är aktivt

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

Parametrar

options

VideoStreamOptions

Alternativ för att styra hur videoströmmar återges <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Returer

Promise<void>

startCaptions(StartCaptionsAdapterOptions)

Funktion för att starta bildtexter

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

Parametrar

options

StartCaptionsAdapterOptions

Alternativ för starttexter

Returer

Promise<void>

startNoiseSuppressionEffect()

Starta brusdämpningseffekten.

function startNoiseSuppressionEffect(): Promise<void>

Returer

Promise<void>

startScreenShare()

Börja dela skärmen under ett samtal.

function startScreenShare(): Promise<void>

Returer

Promise<void>

startSpotlight(string[])

Starta spotlight för lokala och fjärranslutna deltagare med deras användar-ID:n. Om ingen matris med användar-ID:n skickas utförs åtgärden på den lokala deltagaren.

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

Parametrar

userIds

string[]

Returer

Promise<void>

startTogetherMode()

Starta tillsammans-läge.

function startTogetherMode(): Promise<void>

Returer

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

Starta videobakgrundseffekten.

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

Parametrar

videoBackgroundEffect

VideoBackgroundEffect

Returer

Promise<void>

stopAllSpotlight()

Stoppa alla spotlights

function stopAllSpotlight(): Promise<void>

Returer

Promise<void>

stopCamera()

Stoppa kameran Den här metoden slutar återge en lokal kameravy när anropet inte är aktivt

function stopCamera(): Promise<void>

Returer

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Funktion för att stoppa textning

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

Parametrar

options

StopCaptionsAdapterOptions

Returer

Promise<void>

stopNoiseSuppressionEffect()

Stoppa brusdämpningseffekten.

function stopNoiseSuppressionEffect(): Promise<void>

Returer

Promise<void>

stopScreenShare()

Sluta dela skärmen

function stopScreenShare(): Promise<void>

Returer

Promise<void>

stopSpotlight(string[])

Stoppa spotlighten för lokala och fjärranslutna deltagare med deras användar-ID:n. Om ingen matris med användar-ID:n skickas utförs åtgärden på den lokala deltagaren.

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

Parametrar

userIds

string[]

Returer

Promise<void>

stopVideoBackgroundEffects()

Stoppa videobakgrundseffekten.

function stopVideoBackgroundEffects(): Promise<void>

Returer

Promise<void>

submitSurvey(CallSurvey)

Skicka resultatet av undersökningen om samtalets slut

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

Parametrar

survey

CallSurvey

Returer

Promise<undefined | CallSurveyResponse>

unmute()

Slå på ljudet för den aktuella användaren under samtalet eller aktivera mikrofonen lokalt

function unmute(): Promise<void>

Returer

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

Åsidosätt bakgrundsväljarens bilder för att få en bakgrundsersättningseffekt.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parametrar

backgroundImages

VideoBackgroundImage[]

Matris med anpassade bakgrundsbilder.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Uppdatera den valda videobakgrundseffekten.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametrar

selectedVideoBackground

VideoBackgroundEffect