CallAdapterCallOperations interface

Csomag:

@azure/communication-react

Az aktuális hívás kezelésére szolgáló funkciók.

Tulajdonságok

sendRealTimeText

Valós idejű szöveg küldése

Metódusok

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Vegyen fel egy résztvevőt a hívásba.
createStreamView(string, VideoStreamOptions)	Hozza létre a html nézetet egy streamhez.
createTogetherModeStreamView(TogetherModeStreamOptions)	Hozza létre a html nézetet egy streamhez.
disposeLocalVideoStreamView()	Helyi videofolyam html-nézetének megszüntetése
disposeRemoteVideoStreamView(string)	Távoli videoadatfolyam html-nézetének megszüntetése
disposeScreenShareStreamView(string)	A html-nézet megszüntetése képernyőmegosztási adatfolyamhoz
disposeStreamView(string, VideoStreamOptions)	A html nézet elvetése egy streamhez.
disposeTogetherModeStreamView()	A html nézet elvetése egy streamhez.
forbidAudio(string[])	Tiltsa meg a Teams-értekezlet résztvevőinek a felhasználói azonosítójuk szerinti hangot.
forbidOthersAudio()	Tiltsa meg a Teams-értekezlet hangját.
forbidOthersVideo()	Tiltsa be a Teams-értekezlet videóját.
forbidVideo(string[])	Tiltsa meg a Teams-értekezlet résztvevőinek felhasználói azonosítójuk szerinti videóját.
holdCall()	Várja a hívást.
leaveCall(boolean)	A hívás elhagyása
lowerHand()	Alsó kéz az aktuális felhasználó számára
mute()	Az aktuális felhasználó elnémítása a hívás során vagy a mikrofon helyi letiltása
muteAllRemoteParticipants()	Az összes résztvevő elnémítása
muteParticipant(string)	Résztvevő elnémítása
onReactionClick(Reaction)	Reakció hangulatjel küldése
permitAudio(string[])	Engedélyezze a Teams-értekezlet résztvevőinek a felhasználói azonosítójuk alapján történő hangot.
permitOthersAudio()	Engedélyezze a Teams-értekezlet hangját.
permitOthersVideo()	Engedélyezze a Teams-értekezlet videóját.
permitVideo(string[])	Engedélyezze a Teams-értekezlet résztvevőinek a felhasználói azonosítójuk alapján történő hangot.
raiseHand()	Kéz felemelése az aktuális felhasználónak
removeParticipant(CommunicationIdentifier)	Résztvevő eltávolítása a hívásból.
removeParticipant(string)	Résztvevő eltávolítása a hívásból.
resumeCall()	Folytatja a hívást egy állapotból LocalHold .
returnFromBreakoutRoom()	Visszatérés a kitörési szoba forráshívásához
sendDtmfTone(DtmfTone)	DTMF-hang küldése egy másik résztvevőnek 1:1 PSTN-hívásban
setCaptionLanguage(string)	Funkció a felirat nyelvének beállításához
setSpokenLanguage(string)	Funkció a beszélt nyelv beállításához
setTogetherModeSceneSize(number, number)	Számítsa újra az üléspozíciókat együtt módban.
startCamera(VideoStreamOptions)	A kamera indítása: Ez a módszer helyi kameranézet megjelenítését kezdi el, ha a hívás nem aktív
startCaptions(StartCaptionsAdapterOptions)	Funkció a feliratok elindításához
startNoiseSuppressionEffect()	Indítsa el a zajcsökkentő hatást.
startScreenShare()	Indítsa el a képernyő megosztását hívás közben.
startSpotlight(string[])	Indítsa el a helyi és távoli résztvevők reflektorfényét a felhasználói azonosítójuk alapján. Ha a rendszer nem ad át felhasználói azonosítók tömbjét, akkor a művelet a helyi résztvevőn történik.
startTogetherMode()	Indítsa el az Együtt módot.
startVideoBackgroundEffect(VideoBackgroundEffect)	Indítsa el a videó háttéreffektust.
stopAllSpotlight()	Állítsa le az összes spotlámpát
stopCamera()	A kamera leállítása Ez a módszer leállítja a helyi kameranézet megjelenítését, ha a hívás nem aktív
stopCaptions(StopCaptionsAdapterOptions)	Funkció a feliratok leállításához
stopNoiseSuppressionEffect()	Állítsa le a zajcsökkentő hatást.
stopScreenShare()	A képernyő megosztásának leállítása
stopSpotlight(string[])	Állítsa le a helyi és távoli résztvevők reflektorfényét felhasználói azonosítójuk alapján. Ha a rendszer nem ad át felhasználói azonosítók tömbjét, akkor a művelet a helyi résztvevőn történik.
stopVideoBackgroundEffects()	Állítsa le a videó háttéreffektusát.
submitSurvey(CallSurvey)	Hívás végi felmérés eredményének elküldése
unmute()	Az aktuális felhasználó visszahangosítása a hívás során, vagy mikrofon helyi engedélyezése
updateBackgroundPickerImages(VideoBackgroundImage[])	Felülbírálja a háttérválasztó képeit a háttércsere hatás érdekében.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Frissítse a kiválasztott videó háttéreffektust.

Tulajdonság adatai

sendRealTimeText

Valós idejű szöveg küldése

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

Tulajdonság értéke

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

Metódus adatai

addParticipant(CommunicationUserIdentifier)

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

Paraméterek

participant

CommunicationUserIdentifier

Válaszok

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Vegyen fel egy résztvevőt a hívásba.

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

Paraméterek

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Válaszok

Promise<void>

createStreamView(string, VideoStreamOptions)

Hozza létre a html nézetet egy streamhez.

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

Paraméterek

remoteUserId

string

A renderelni kívánt résztvevő azonosítója, a helyi kameranézet létrehozásához hagyja meg nem definiálva

options

VideoStreamOptions

A videóstreamek megjelenítési módjának szabályozása <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Válaszok

Promise<void | CreateVideoStreamViewResult>

Megjegyzések

Ez a módszer összetett

createTogetherModeStreamView(TogetherModeStreamOptions)

Hozza létre a html nézetet egy streamhez.

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

Paraméterek

options

TogetherModeStreamOptions

A videóstreamek megjelenítési módjának szabályozása <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Válaszok

Promise<void | TogetherModeStreamViewResult>

Megjegyzések

Ez a módszer összetett

disposeLocalVideoStreamView()

Helyi videofolyam html-nézetének megszüntetése

function disposeLocalVideoStreamView(): Promise<void>

Válaszok

Promise<void>

disposeRemoteVideoStreamView(string)

Távoli videoadatfolyam html-nézetének megszüntetése

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

Paraméterek

remoteUserId

string

Az elidegenítendő résztvevő azonosítója

Válaszok

Promise<void>

disposeScreenShareStreamView(string)

A html-nézet megszüntetése képernyőmegosztási adatfolyamhoz

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

Paraméterek

remoteUserId

string

Annak a résztvevőnek az azonosítója, akire a képernyőmegosztási adatfolyam nézetet el kell helyezni.

Válaszok

Promise<void>

Megjegyzések

Ez a módszer összetett

disposeStreamView(string, VideoStreamOptions)

Figyelmeztetés

Ez az API már elavult.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

A html nézet elvetése egy streamhez.

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

Paraméterek

remoteUserId

string

A renderelni kívánt résztvevő azonosítója, a helyi kameranézet elvetéséhez hagyja meg nem definiálva

options

VideoStreamOptions

A videóstreamek megjelenítési módjának szabályozása <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Válaszok

Promise<void>

Megjegyzések

Ez a módszer összetett

disposeTogetherModeStreamView()

A html nézet elvetése egy streamhez.

function disposeTogetherModeStreamView(): Promise<void>

Válaszok

Promise<void>

Megjegyzések

Ez a módszer összetett

forbidAudio(string[])

Tiltsa meg a Teams-értekezlet résztvevőinek a felhasználói azonosítójuk szerinti hangot.

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

Paraméterek

userIds

string[]

Válaszok

Promise<void>

forbidOthersAudio()

Tiltsa meg a Teams-értekezlet hangját.

function forbidOthersAudio(): Promise<void>

Válaszok

Promise<void>

forbidOthersVideo()

Tiltsa be a Teams-értekezlet videóját.

function forbidOthersVideo(): Promise<void>

Válaszok

Promise<void>

forbidVideo(string[])

Tiltsa meg a Teams-értekezlet résztvevőinek felhasználói azonosítójuk szerinti videóját.

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

Paraméterek

userIds

string[]

Válaszok

Promise<void>

holdCall()

Várja a hívást.

function holdCall(): Promise<void>

Válaszok

Promise<void>

leaveCall(boolean)

A hívás elhagyása

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

Paraméterek

forEveryone

boolean

Az összes résztvevő eltávolítása kilépéskor

Válaszok

Promise<void>

lowerHand()

Alsó kéz az aktuális felhasználó számára

function lowerHand(): Promise<void>

Válaszok

Promise<void>

mute()

Az aktuális felhasználó elnémítása a hívás során vagy a mikrofon helyi letiltása

function mute(): Promise<void>

Válaszok

Promise<void>

muteAllRemoteParticipants()

Az összes résztvevő elnémítása

function muteAllRemoteParticipants(): Promise<void>

Válaszok

Promise<void>

muteParticipant(string)

Résztvevő elnémítása

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

Paraméterek

userId

string

A némítani kívánt résztvevő azonosítója

Válaszok

Promise<void>

onReactionClick(Reaction)

Reakció hangulatjel küldése

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

Paraméterek

reaction

Reaction

Válaszok

Promise<void>

permitAudio(string[])

Engedélyezze a Teams-értekezlet résztvevőinek a felhasználói azonosítójuk alapján történő hangot.

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

Paraméterek

userIds

string[]

Válaszok

Promise<void>

permitOthersAudio()

Engedélyezze a Teams-értekezlet hangját.

function permitOthersAudio(): Promise<void>

Válaszok

Promise<void>

permitOthersVideo()

Engedélyezze a Teams-értekezlet videóját.

function permitOthersVideo(): Promise<void>

Válaszok

Promise<void>

permitVideo(string[])

Engedélyezze a Teams-értekezlet résztvevőinek a felhasználói azonosítójuk alapján történő hangot.

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

Paraméterek

userIds

string[]

Válaszok

Promise<void>

raiseHand()

Kéz felemelése az aktuális felhasználónak

function raiseHand(): Promise<void>

Válaszok

Promise<void>

removeParticipant(CommunicationIdentifier)

Résztvevő eltávolítása a hívásból.

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

Paraméterek

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> eltávolítandó résztvevő

Válaszok

Promise<void>

removeParticipant(string)

Résztvevő eltávolítása a hívásból.

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

Paraméterek

userId

string

Az eltávolítandó résztvevő azonosítója

Válaszok

Promise<void>

resumeCall()

Folytatja a hívást egy állapotból LocalHold .

function resumeCall(): Promise<void>

Válaszok

Promise<void>

returnFromBreakoutRoom()

Visszatérés a kitörési szoba forráshívásához

function returnFromBreakoutRoom(): Promise<void>

Válaszok

Promise<void>

sendDtmfTone(DtmfTone)

DTMF-hang küldése egy másik résztvevőnek 1:1 PSTN-hívásban

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

Paraméterek

dtmfTone

DtmfTone

Válaszok

Promise<void>

setCaptionLanguage(string)

Funkció a felirat nyelvének beállításához

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

Paraméterek

language

string

A feliratozáshoz beállított nyelv

Válaszok

Promise<void>

setSpokenLanguage(string)

Funkció a beszélt nyelv beállításához

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

Paraméterek

language

string

beszélt nyelv

Válaszok

Promise<void>

setTogetherModeSceneSize(number, number)

Számítsa újra az üléspozíciókat együtt módban.

function setTogetherModeSceneSize(width: number, height: number)

Paraméterek

width

number

A tartály szélessége

height

number

A tartály magassága

Megjegyzések

Ez a módszer összetett

startCamera(VideoStreamOptions)

A kamera indítása: Ez a módszer helyi kameranézet megjelenítését kezdi el, ha a hívás nem aktív

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

Paraméterek

options

VideoStreamOptions

A videóstreamek megjelenítési módjának szabályozása <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Válaszok

Promise<void>

startCaptions(StartCaptionsAdapterOptions)

Funkció a feliratok elindításához

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

Paraméterek

options

StartCaptionsAdapterOptions

A kezdő feliratok beállításai

Válaszok

Promise<void>

startNoiseSuppressionEffect()

Indítsa el a zajcsökkentő hatást.

function startNoiseSuppressionEffect(): Promise<void>

Válaszok

Promise<void>

startScreenShare()

Indítsa el a képernyő megosztását hívás közben.

function startScreenShare(): Promise<void>

Válaszok

Promise<void>

startSpotlight(string[])

Indítsa el a helyi és távoli résztvevők reflektorfényét a felhasználói azonosítójuk alapján. Ha a rendszer nem ad át felhasználói azonosítók tömbjét, akkor a művelet a helyi résztvevőn történik.

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

Paraméterek

userIds

string[]

Válaszok

Promise<void>

startTogetherMode()

Indítsa el az Együtt módot.

function startTogetherMode(): Promise<void>

Válaszok

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

Indítsa el a videó háttéreffektust.

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

Paraméterek

videoBackgroundEffect

VideoBackgroundEffect

Válaszok

Promise<void>

stopAllSpotlight()

Állítsa le az összes spotlámpát

function stopAllSpotlight(): Promise<void>

Válaszok

Promise<void>

stopCamera()

A kamera leállítása Ez a módszer leállítja a helyi kameranézet megjelenítését, ha a hívás nem aktív

function stopCamera(): Promise<void>

Válaszok

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Funkció a feliratok leállításához

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

Paraméterek

options

StopCaptionsAdapterOptions

Válaszok

Promise<void>

stopNoiseSuppressionEffect()

Állítsa le a zajcsökkentő hatást.

function stopNoiseSuppressionEffect(): Promise<void>

Válaszok

Promise<void>

stopScreenShare()

A képernyő megosztásának leállítása

function stopScreenShare(): Promise<void>

Válaszok

Promise<void>

stopSpotlight(string[])

Állítsa le a helyi és távoli résztvevők reflektorfényét felhasználói azonosítójuk alapján. Ha a rendszer nem ad át felhasználói azonosítók tömbjét, akkor a művelet a helyi résztvevőn történik.

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

Paraméterek

userIds

string[]

Válaszok

Promise<void>

stopVideoBackgroundEffects()

Állítsa le a videó háttéreffektusát.

function stopVideoBackgroundEffects(): Promise<void>

Válaszok

Promise<void>

submitSurvey(CallSurvey)

Hívás végi felmérés eredményének elküldése

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

Paraméterek

survey

CallSurvey

Válaszok

Promise<undefined | CallSurveyResponse>

unmute()

Az aktuális felhasználó visszahangosítása a hívás során, vagy mikrofon helyi engedélyezése

function unmute(): Promise<void>

Válaszok

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

Felülbírálja a háttérválasztó képeit a háttércsere hatás érdekében.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Paraméterek

backgroundImages

VideoBackgroundImage[]

Egyéni háttérképek tömbje.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Frissítse a kiválasztott videó háttéreffektust.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Paraméterek

selectedVideoBackground

VideoBackgroundEffect