CallAdapterCallOperations interface

Balíček:

@azure/communication-react

Funkce pro správu aktuálního volání

Vlastnosti

sendRealTimeText

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

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 vlastnosti

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>

Podrobnosti metody

addParticipant(CommunicationUserIdentifier)

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

Parametry

participant

CommunicationUserIdentifier

Návraty

Promise<void>

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>

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é

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é

disposeLocalVideoStreamView()

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

function disposeLocalVideoStreamView(): Promise<void>

Návraty

Promise<void>

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>

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í

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é

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é

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>

forbidOthersAudio()

Zakázat zvuk schůzky v Teams.

function forbidOthersAudio(): Promise<void>

Návraty

Promise<void>

forbidOthersVideo()

Video ze schůzky Zakázat Teams.

function forbidOthersVideo(): Promise<void>

Návraty

Promise<void>

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>

holdCall()

Přidrží hovor.

function holdCall(): Promise<void>

Návraty

Promise<void>

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>

lowerHand()

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

function lowerHand(): Promise<void>

Návraty

Promise<void>

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>

muteAllRemoteParticipants()

Ztlumit všechny účastníky

function muteAllRemoteParticipants(): Promise<void>

Návraty

Promise<void>

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>

onReactionClick(Reaction)

Odeslat emoji reakce

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

Parametry

reaction

Reaction

Návraty

Promise<void>

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>

permitOthersAudio()

Povolit zvuk schůzky v Teams.

function permitOthersAudio(): Promise<void>

Návraty

Promise<void>

permitOthersVideo()

Povolte video schůzky Teams.

function permitOthersVideo(): Promise<void>

Návraty

Promise<void>

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>

raiseHand()

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

function raiseHand(): Promise<void>

Návraty

Promise<void>

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>

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>

resumeCall()

Obnoví volání ze LocalHold stavu.

function resumeCall(): Promise<void>

Návraty

Promise<void>

returnFromBreakoutRoom()

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

function returnFromBreakoutRoom(): Promise<void>

Návraty

Promise<void>

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>

setCaptionLanguage(string)

Funkce pro nastavení jazyka titulků

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

Parametry

language

string

Jazyk nastavený pro titulek

Návraty

Promise<void>

setSpokenLanguage(string)

Funkce pro nastavení mluveného jazyka

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

Parametry

language

string

Mluvený jazyk

Návraty

Promise<void>

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é

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>

startCaptions(StartCaptionsAdapterOptions)

Funkce pro začátek titulků

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

Parametry

options

StartCaptionsAdapterOptions

Volby pro úvodní titulky

Návraty

Promise<void>

startNoiseSuppressionEffect()

Spusťte efekt potlačení šumu.

function startNoiseSuppressionEffect(): Promise<void>

Návraty

Promise<void>

startScreenShare()

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

function startScreenShare(): Promise<void>

Návraty

Promise<void>

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>

startTogetherMode()

Spustit společně.

function startTogetherMode(): Promise<void>

Návraty

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

Spusťte efekt pozadí videa.

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

Parametry

videoBackgroundEffect

VideoBackgroundEffect

Návraty

Promise<void>

stopAllSpotlight()

Zastavte všechna světla reflektorů

function stopAllSpotlight(): Promise<void>

Návraty

Promise<void>

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>

stopCaptions(StopCaptionsAdapterOptions)

Funkce pro zastavení titulků

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

Parametry

options

StopCaptionsAdapterOptions

Návraty

Promise<void>

stopNoiseSuppressionEffect()

Zastavte efekt potlačení šumu.

function stopNoiseSuppressionEffect(): Promise<void>

Návraty

Promise<void>

stopScreenShare()

Ukončení sdílení obrazovky

function stopScreenShare(): Promise<void>

Návraty

Promise<void>

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>

stopVideoBackgroundEffects()

Zastavte efekt pozadí videa.

function stopVideoBackgroundEffects(): Promise<void>

Návraty

Promise<void>

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>

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>

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í.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Aktualizujte vybraný efekt pozadí videa.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametry

selectedVideoBackground

VideoBackgroundEffect