CallAdapterCallManagement interface

Paket:

@azure/communication-react

Varning

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

CallAdapter interface will be flatten, consider using CallAdapter directly

Funktioner för att hantera det aktuella anropet eller starta ett nytt anrop

Extends

CallAdapterCallOperations

Ärvda egenskaper

sendRealTimeText

Skicka text i realtid

Metoder

joinCall(boolean)	Anslut samtalet med mikrofonen först på/av.
joinCall(JoinCallOptions)	Gå med i samtalet med alternativpåse för att ställa in mikrofonens/kamerans initiala tillstånd när du går med i samtalet true = slå på enheten när du går med i samtalet false = stäng av enheten när du går med i samtalet 'behåll'/odefinierad = behåll enheternas föranropstillstånd
startCall(CommunicationIdentifier[], StartCallOptions)	Starta samtalet.
startCall(string[], StartCallOptions)	Starta samtalet.

Ärvda 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.

Information om ärvda egenskaper

sendRealTimeText

Skicka text i realtid

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

Egenskapsvärde

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

Ärvd frånCallAdapterCallOperations.sendRealTimeText

Metodinformation

joinCall(boolean)

Varning

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

Use joinCall(options?:JoinCallOptions) instead.

Anslut samtalet med mikrofonen först på/av.

function joinCall(microphoneOn?: boolean): undefined | Call

Parametrar

microphoneOn

boolean

Om mikrofonen är aktiverad från början

Returer

undefined | Call

joinCall(JoinCallOptions)

Gå med i samtalet med alternativpåse för att ställa in mikrofonens/kamerans initiala tillstånd när du går med i samtalet true = slå på enheten när du går med i samtalet false = stäng av enheten när du går med i samtalet 'behåll'/odefinierad = behåll enheternas föranropstillstånd

function joinCall(options?: JoinCallOptions): undefined | Call

Parametrar

options

JoinCallOptions

Param för att ställa in mikrofonen/kameran initialt på/av/använd församtalsläge.

Returer

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

Starta samtalet.

function startCall(participants: CommunicationIdentifier[], options?: StartCallOptions): undefined | Call

Parametrar

participants

CommunicationIdentifier[]

En matris med <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> som ska anropas

options

StartCallOptions

Returer

undefined | Call

startCall(string[], StartCallOptions)

Starta samtalet.

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

Parametrar

participants

string[]

En matris med deltagar-ID:t som ska kopplas

options

StartCallOptions

Returer

undefined | Call

Ärvd metodinformation

addParticipant(CommunicationUserIdentifier)

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

Parametrar

participant

CommunicationUserIdentifier

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.addParticipant

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>

Ärvd frånCallAdapterCallOperations.addParticipant

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

ärvd frånCallAdapterCallOperations.createStreamView

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

Ärvd frånCallAdapterCallOperations.createTogetherModeStreamView

disposeLocalVideoStreamView()

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

function disposeLocalVideoStreamView(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.disposeLocalVideoStreamView

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>

Ärvd frånCallAdapterCallOperations.disposeRemoteVideoStreamView

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

Ärvd frånCallAdapterCallOperations.disposeScreenShareStreamView

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

ärvd frånCallAdapterCallOperations.disposeStreamView

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

Ärvd frånCallAdapterCallOperations.disposeTogetherModeStreamView

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>

Ärvd frånCallAdapterCallOperations.forbidAudio

forbidOthersAudio()

Förbjud Teams mötesljud.

function forbidOthersAudio(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.forbidOthersAudio

forbidOthersVideo()

Förbjud Teams mötesvideo.

function forbidOthersVideo(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.forbidOthersVideo

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>

Ärvd frånCallAdapterCallOperations.forbidVideo

holdCall()

Parkerar samtalet.

function holdCall(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.holdCall

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>

ärvd frånCallAdapterCallOperations.leaveCall

lowerHand()

Nedre hand för aktuell användare

function lowerHand(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.lowerHand

mute()

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

function mute(): Promise<void>

Returer

Promise<void>

ärvd frånCallAdapterCallOperations.mute

muteAllRemoteParticipants()

Stäng av ljudet för alla deltagare

function muteAllRemoteParticipants(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.muteAllRemoteParticipants

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>

Ärvd frånCallAdapterCallOperations.muteParticipant

onReactionClick(Reaction)

Skicka reaktionsemoji

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

Parametrar

reaction

Reaction

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.onReactionClick

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>

Ärvd frånCallAdapterCallOperations.permitAudio

permitOthersAudio()

Tillåt Teams mötesljud.

function permitOthersAudio(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.permitOthersAudio

permitOthersVideo()

Tillåt Teams mötesvideo.

function permitOthersVideo(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.permitOthersVideo

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>

Ärvd frånCallAdapterCallOperations.permitVideo

raiseHand()

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

function raiseHand(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.raiseHand

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>

ärvd frånCallAdapterCallOperations.removeParticipant

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>

ärvd frånCallAdapterCallOperations.removeParticipant

resumeCall()

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

function resumeCall(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.resumeCall

returnFromBreakoutRoom()

Återgå till ursprungsanropet för breakout room

function returnFromBreakoutRoom(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.returnFromBreakoutRoom

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>

Ärvd frånCallAdapterCallOperations.sendDtmfTone

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>

Ärvd frånCallAdapterCallOperations.setCaptionLanguage

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>

Ärvd frånCallAdapterCallOperations.setSpokenLanguage

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

Ärvd frånCallAdapterCallOperations.setTogetherModeSceneSize

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>

ärvd frånCallAdapterCallOperations.startCamera

startCaptions(StartCaptionsAdapterOptions)

Funktion för att starta bildtexter

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

Parametrar

options

StartCaptionsAdapterOptions

Alternativ för starttexter

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.startCaptions

startNoiseSuppressionEffect()

Starta brusdämpningseffekten.

function startNoiseSuppressionEffect(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.startNoiseSuppressionEffect

startScreenShare()

Börja dela skärmen under ett samtal.

function startScreenShare(): Promise<void>

Returer

Promise<void>

ärvd frånCallAdapterCallOperations.startScreenShare

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>

Ärvd frånCallAdapterCallOperations.startSpotlight

startTogetherMode()

Starta tillsammans-läge.

function startTogetherMode(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Starta videobakgrundseffekten.

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

Parametrar

videoBackgroundEffect

VideoBackgroundEffect

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.startVideoBackgroundEffect

stopAllSpotlight()

Stoppa alla spotlights

function stopAllSpotlight(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.stopAllSpotlight

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>

ärvd frånCallAdapterCallOperations.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funktion för att stoppa textning

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

Parametrar

options

StopCaptionsAdapterOptions

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.stopCaptions

stopNoiseSuppressionEffect()

Stoppa brusdämpningseffekten.

function stopNoiseSuppressionEffect(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.stopNoiseSuppressionEffect

stopScreenShare()

Sluta dela skärmen

function stopScreenShare(): Promise<void>

Returer

Promise<void>

ärvd frånCallAdapterCallOperations.stopScreenShare

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>

Ärvd frånCallAdapterCallOperations.stopSpotlight

stopVideoBackgroundEffects()

Stoppa videobakgrundseffekten.

function stopVideoBackgroundEffects(): Promise<void>

Returer

Promise<void>

Ärvd frånCallAdapterCallOperations.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Skicka resultatet av undersökningen om samtalets slut

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

Parametrar

survey

CallSurvey

Returer

Promise<undefined | CallSurveyResponse>

Ärvd frånCallAdapterCallOperations.submitSurvey

unmute()

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

function unmute(): Promise<void>

Returer

Promise<void>

ärvd frånCallAdapterCallOperations.unmute

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.

Ärvd frånCallAdapterCallOperations.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Uppdatera den valda videobakgrundseffekten.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametrar

selectedVideoBackground

VideoBackgroundEffect

Ärvd frånCallAdapterCallOperations.updateSelectedVideoBackgroundEffect