CallAdapterCallManagement interface

Balíček:

@azure/communication-react

Upozornění

Toto rozhraní API je teď zastaralé.

CallAdapter interface will be flatten, consider using CallAdapter directly

Funkce pro správu aktuálního hovoru nebo zahájení nového hovoru

Extends

CallAdapterCallOperations

Zděděné vlastnosti

sendRealTimeText

Odesílání textu v reálném čase

Metody

joinCall(boolean)	Připojte se k hovoru s mikrofonem, který je zpočátku zapnutý nebo vypnutý.
joinCall(JoinCallOptions)	Připojte se k hovoru pomocí panelu možností pro nastavení výchozího stavu mikrofonu/kamery při připojení k hovoru true = zapnutí zařízení při připojování k hovoru false = vypnutí zařízení při připojování k hovoru "ponechat"/undefined = zachovat stav zařízení před voláním
startCall(CommunicationIdentifier[], StartCallOptions)	Zahajte hovor.
startCall(string[], StartCallOptions)	Zahajte hovor.

Zděděné metody

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Přidejte účastníka do hovoru.
createStreamView(string, VideoStreamOptions)	Vytvořte zobrazení HTML pro datový proud.
createTogetherModeStreamView(TogetherModeStreamOptions)	Vytvořte zobrazení HTML pro datový proud.
disposeLocalVideoStreamView()	Uvolnění zobrazení html pro místní datový proud videa
disposeRemoteVideoStreamView(string)	Uvolnění zobrazení html pro vzdálený datový proud videa
disposeScreenShareStreamView(string)	Uvolnění zobrazení HTML pro datový proud sdílené obrazovky
disposeStreamView(string, VideoStreamOptions)	Vyřaďte zobrazení HTML pro datový proud.
disposeTogetherModeStreamView()	Vyřaďte zobrazení HTML pro datový proud.
forbidAudio(string[])	Zakáže účastníkům schůzky v Teams zvuk podle jejich ID uživatelů.
forbidOthersAudio()	Zakázat zvuk schůzky v Teams.
forbidOthersVideo()	Video ze schůzky Zakázat Teams.
forbidVideo(string[])	Zakažte účastníkům schůzky v Teams video podle jejich uživatelských ID.
holdCall()	Přidrží hovor.
leaveCall(boolean)	Opustit hovor
lowerHand()	spodní ruka pro aktuálního uživatele
mute()	Ztlumení aktuálního uživatele během hovoru nebo zakázání mikrofonu místně
muteAllRemoteParticipants()	Ztlumit všechny účastníky
muteParticipant(string)	Ztlumení účastníka
onReactionClick(Reaction)	Odeslat emoji reakce
permitAudio(string[])	Povolte účastníkům schůzky Teams zvuk podle jejich ID uživatele.
permitOthersAudio()	Povolit zvuk schůzky v Teams.
permitOthersVideo()	Povolte video schůzky Teams.
permitVideo(string[])	Povolte účastníkům schůzky Teams zvuk podle jejich ID uživatele.
raiseHand()	Zvednutí ruky pro aktuálního uživatele
removeParticipant(CommunicationIdentifier)	Odeberte účastníka z hovoru.
removeParticipant(string)	Odeberte účastníka z hovoru.
resumeCall()	Obnoví volání ze LocalHold stavu.
returnFromBreakoutRoom()	Návrat k původnímu volání breakout room
sendDtmfTone(DtmfTone)	Odeslání tónu DTMF jinému účastníkovi v hovoru 1:1 PSTN
setCaptionLanguage(string)	Funkce pro nastavení jazyka titulků
setSpokenLanguage(string)	Funkce pro nastavení mluveného jazyka
setTogetherModeSceneSize(number, number)	Přepočítejte polohy sedadel pro režim společně.
startCamera(VideoStreamOptions)	Spuštění kamery Tato metoda začne vykreslovat zobrazení místní kamery, když volání není aktivní.
startCaptions(StartCaptionsAdapterOptions)	Funkce pro začátek titulků
startNoiseSuppressionEffect()	Spusťte efekt potlačení šumu.
startScreenShare()	Během hovoru začněte sdílet obrazovku.
startSpotlight(string[])	Začněte se soustředit na místní a vzdálené účastníky podle jejich ID uživatelů. Pokud není předáno žádné pole ID uživatele, pak se akce provede na lokálním účastníkovi.
startTogetherMode()	Spustit společně.
startVideoBackgroundEffect(VideoBackgroundEffect)	Spusťte efekt pozadí videa.
stopAllSpotlight()	Zastavte všechna světla reflektorů
stopCamera()	Zastavení kamery Tato metoda zastaví vykreslování zobrazení místní kamery, když volání není aktivní.
stopCaptions(StopCaptionsAdapterOptions)	Funkce pro zastavení titulků
stopNoiseSuppressionEffect()	Zastavte efekt potlačení šumu.
stopScreenShare()	Ukončení sdílení obrazovky
stopSpotlight(string[])	Zastavte reflektory pro místní a vzdálené účastníky podle jejich ID uživatele. Pokud není předáno žádné pole ID uživatele, pak se akce provede na lokálním účastníkovi.
stopVideoBackgroundEffects()	Zastavte efekt pozadí videa.
submitSurvey(CallSurvey)	Odeslání výsledku průzkumu na konci hovoru
unmute()	Zrušení ztlumení aktuálního uživatele během hovoru nebo povolení mikrofonu místně
updateBackgroundPickerImages(VideoBackgroundImage[])	Přepište obrazy pro výběr pozadí, aby se nahradilo pozadí.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Aktualizujte vybraný efekt pozadí videa.

Podrobnosti zděděných vlastností

sendRealTimeText

Odesílání textu v reálném čase

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

Hodnota vlastnosti

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

Zděděno zCallAdapterCallOperations.sendRealTimeText

Podrobnosti metody

joinCall(boolean)

Upozornění

Toto rozhraní API je teď zastaralé.

Use joinCall(options?:JoinCallOptions) instead.

Připojte se k hovoru s mikrofonem, který je zpočátku zapnutý nebo vypnutý.

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

Parametry

microphoneOn

boolean

Jestli je mikrofon původně povolený

Návraty

undefined | Call

joinCall(JoinCallOptions)

Připojte se k hovoru pomocí panelu možností pro nastavení výchozího stavu mikrofonu/kamery při připojení k hovoru true = zapnutí zařízení při připojování k hovoru false = vypnutí zařízení při připojování k hovoru "ponechat"/undefined = zachovat stav zařízení před voláním

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

Parametry

options

JoinCallOptions

Parametr pro počáteční zapnutí/vypnutí mikrofonu/kamery/použití stavu před vyvoláním.

Návraty

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

Zahajte hovor.

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

Parametry

participants

CommunicationIdentifier[]

Pole <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> má být voláno

options

StartCallOptions

Návraty

undefined | Call

startCall(string[], StartCallOptions)

Zahajte hovor.

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

Parametry

participants

string[]

Pole ID účastníků, ke které se chcete připojit

options

StartCallOptions

Návraty

undefined | Call

Podrobnosti zděděných metod

addParticipant(CommunicationUserIdentifier)

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

Parametry

participant

CommunicationUserIdentifier

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Přidejte účastníka do hovoru.

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

Parametry

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.addParticipant

createStreamView(string, VideoStreamOptions)

Vytvořte zobrazení HTML pro datový proud.

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

Parametry

remoteUserId

string

ID účastníka, který se má vykreslit, ponechte ho nedefinovaný a vytvořte zobrazení místní kamery.

options

VideoStreamOptions

Možnosti pro řízení vykreslování streamů videa <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Návraty

Promise<void | CreateVideoStreamViewResult>

Poznámky

Tato metoda je implementována pro složené

zděděno zCallAdapterCallOperations.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Vytvořte zobrazení HTML pro datový proud.

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

Parametry

options

TogetherModeStreamOptions

Možnosti pro řízení vykreslování streamů videa <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Návraty

Promise<void | TogetherModeStreamViewResult>

Poznámky

Tato metoda je implementována pro složené

Zděděno zCallAdapterCallOperations.createTogetherModeStreamView

disposeLocalVideoStreamView()

Uvolnění zobrazení html pro místní datový proud videa

function disposeLocalVideoStreamView(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Uvolnění zobrazení html pro vzdálený datový proud videa

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

Parametry

remoteUserId

string

Průkaz totožnosti účastníka, se kterým má nakládat

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Uvolnění zobrazení HTML pro datový proud sdílené obrazovky

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

Parametry

remoteUserId

string

Id účastníka, pro který se má uvolnit zobrazení streamu sdílení obrazovky.

Návraty

Promise<void>

Poznámky

Tato metoda je implementována pro kompozitní

Zděděno zCallAdapterCallOperations.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Upozornění

Toto rozhraní API je teď zastaralé.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

Vyřaďte zobrazení HTML pro datový proud.

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

Parametry

remoteUserId

string

ID účastníka, který se má vykreslit, nechte ho nedefinovaný a odstraňte zobrazení místní kamery.

options

VideoStreamOptions

Možnosti pro řízení vykreslování streamů videa <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Návraty

Promise<void>

Poznámky

Tato metoda je implementována pro složené

zděděno zCallAdapterCallOperations.disposeStreamView

disposeTogetherModeStreamView()

Vyřaďte zobrazení HTML pro datový proud.

function disposeTogetherModeStreamView(): Promise<void>

Návraty

Promise<void>

Poznámky

Tato metoda je implementována pro složené

Zděděno zCallAdapterCallOperations.disposeTogetherModeStreamView

forbidAudio(string[])

Zakáže účastníkům schůzky v Teams zvuk podle jejich ID uživatelů.

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

Parametry

userIds

string[]

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.forbidAudio

forbidOthersAudio()

Zakázat zvuk schůzky v Teams.

function forbidOthersAudio(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.forbidOthersAudio

forbidOthersVideo()

Video ze schůzky Zakázat Teams.

function forbidOthersVideo(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.forbidOthersVideo

forbidVideo(string[])

Zakažte účastníkům schůzky v Teams video podle jejich uživatelských ID.

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

Parametry

userIds

string[]

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.forbidVideo

holdCall()

Přidrží hovor.

function holdCall(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.holdCall

leaveCall(boolean)

Opustit hovor

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

Parametry

forEveryone

boolean

Zda odebrat všechny účastníky při odjezdu

Návraty

Promise<void>

zděděno zCallAdapterCallOperations.leaveCall

lowerHand()

spodní ruka pro aktuálního uživatele

function lowerHand(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.lowerHand

mute()

Ztlumení aktuálního uživatele během hovoru nebo zakázání mikrofonu místně

function mute(): Promise<void>

Návraty

Promise<void>

zděděno zCallAdapterCallOperations.mute

muteAllRemoteParticipants()

Ztlumit všechny účastníky

function muteAllRemoteParticipants(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.muteAllRemoteParticipants

muteParticipant(string)

Ztlumení účastníka

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

Parametry

userId

string

Id účastníka, který má být ztlumen

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.muteParticipant

onReactionClick(Reaction)

Odeslat emoji reakce

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

Parametry

reaction

Reaction

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.onReactionClick

permitAudio(string[])

Povolte účastníkům schůzky Teams zvuk podle jejich ID uživatele.

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

Parametry

userIds

string[]

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.permitAudio

permitOthersAudio()

Povolit zvuk schůzky v Teams.

function permitOthersAudio(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.permitOthersAudio

permitOthersVideo()

Povolte video schůzky Teams.

function permitOthersVideo(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.permitOthersVideo

permitVideo(string[])

Povolte účastníkům schůzky Teams zvuk podle jejich ID uživatele.

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

Parametry

userIds

string[]

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.permitVideo

raiseHand()

Zvednutí ruky pro aktuálního uživatele

function raiseHand(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.raiseHand

removeParticipant(CommunicationIdentifier)

Odeberte účastníka z hovoru.

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

Parametry

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> účastníka, který má být odstraněn

Návraty

Promise<void>

zděděno zCallAdapterCallOperations.removeParticipant

removeParticipant(string)

Odeberte účastníka z hovoru.

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

Parametry

userId

string

ID účastníka, který se má odebrat

Návraty

Promise<void>

zděděno zCallAdapterCallOperations.removeParticipant

resumeCall()

Obnoví volání ze LocalHold stavu.

function resumeCall(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.resumeCall

returnFromBreakoutRoom()

Návrat k původnímu volání breakout room

function returnFromBreakoutRoom(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

Odeslání tónu DTMF jinému účastníkovi v hovoru 1:1 PSTN

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

Parametry

dtmfTone

DtmfTone

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.sendDtmfTone

setCaptionLanguage(string)

Funkce pro nastavení jazyka titulků

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

Parametry

language

string

Jazyk nastavený pro titulek

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.setCaptionLanguage

setSpokenLanguage(string)

Funkce pro nastavení mluveného jazyka

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

Parametry

language

string

Mluvený jazyk

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Přepočítejte polohy sedadel pro režim společně.

function setTogetherModeSceneSize(width: number, height: number)

Parametry

width

number

Šířka kontejneru

height

number

Výška kontejneru

Poznámky

Tato metoda je implementována pro složené

Zděděno zCallAdapterCallOperations.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

Spuštění kamery Tato metoda začne vykreslovat zobrazení místní kamery, když volání není aktivní.

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

Parametry

options

VideoStreamOptions

Možnosti pro řízení vykreslování streamů videa <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Návraty

Promise<void>

zděděno zCallAdapterCallOperations.startCamera

startCaptions(StartCaptionsAdapterOptions)

Funkce pro začátek titulků

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

Parametry

options

StartCaptionsAdapterOptions

Volby pro úvodní titulky

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.startCaptions

startNoiseSuppressionEffect()

Spusťte efekt potlačení šumu.

function startNoiseSuppressionEffect(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.startNoiseSuppressionEffect

startScreenShare()

Během hovoru začněte sdílet obrazovku.

function startScreenShare(): Promise<void>

Návraty

Promise<void>

zděděné zCallAdapterCallOperations.startScreenShare

startSpotlight(string[])

Začněte se soustředit na místní a vzdálené účastníky podle jejich ID uživatelů. Pokud není předáno žádné pole ID uživatele, pak se akce provede na lokálním účastníkovi.

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

Parametry

userIds

string[]

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.startSpotlight

startTogetherMode()

Spustit společně.

function startTogetherMode(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Spusťte efekt pozadí videa.

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

Parametry

videoBackgroundEffect

VideoBackgroundEffect

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.startVideoBackgroundEffect

stopAllSpotlight()

Zastavte všechna světla reflektorů

function stopAllSpotlight(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.stopAllSpotlight

stopCamera()

Zastavení kamery Tato metoda zastaví vykreslování zobrazení místní kamery, když volání není aktivní.

function stopCamera(): Promise<void>

Návraty

Promise<void>

zděděno zCallAdapterCallOperations.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funkce pro zastavení titulků

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

Parametry

options

StopCaptionsAdapterOptions

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.stopCaptions

stopNoiseSuppressionEffect()

Zastavte efekt potlačení šumu.

function stopNoiseSuppressionEffect(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.stopNoiseSuppressionEffect

stopScreenShare()

Ukončení sdílení obrazovky

function stopScreenShare(): Promise<void>

Návraty

Promise<void>

zděděné zCallAdapterCallOperations.stopScreenShare

stopSpotlight(string[])

Zastavte reflektory pro místní a vzdálené účastníky podle jejich ID uživatele. Pokud není předáno žádné pole ID uživatele, pak se akce provede na lokálním účastníkovi.

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

Parametry

userIds

string[]

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.stopSpotlight

stopVideoBackgroundEffects()

Zastavte efekt pozadí videa.

function stopVideoBackgroundEffects(): Promise<void>

Návraty

Promise<void>

Zděděno zCallAdapterCallOperations.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Odeslání výsledku průzkumu na konci hovoru

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

Parametry

survey

CallSurvey

Návraty

Promise<undefined | CallSurveyResponse>

Zděděno zCallAdapterCallOperations.submitSurvey

unmute()

Zrušení ztlumení aktuálního uživatele během hovoru nebo povolení mikrofonu místně

function unmute(): Promise<void>

Návraty

Promise<void>

zděděno zCallAdapterCallOperations.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Přepište obrazy pro výběr pozadí, aby se nahradilo pozadí.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parametry

backgroundImages

VideoBackgroundImage[]

Pole vlastních obrázků na pozadí.

Zděděno zCallAdapterCallOperations.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aktualizujte vybraný efekt pozadí videa.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametry

selectedVideoBackground

VideoBackgroundEffect

Zděděno zCallAdapterCallOperations.updateSelectedVideoBackgroundEffect