Udostępnij przez


CallAdapterCallManagement interface

Ostrzeżenie

Ten interfejs API jest już przestarzały.

CallAdapter interface will be flatten, consider using CallAdapter directly

Funkcje zarządzania bieżącym wywołaniem lub uruchamiania nowego wywołania

Rozszerzenie

Właściwości dziedziczone

sendRealTimeText

Wysyłanie tekstu w czasie rzeczywistym

Metody

joinCall(boolean)

Dołącz połączenie z mikrofonem początkowo włączony/wyłączony.

joinCall(JoinCallOptions)

Dołącz do rozmowy z torbą opcji, aby ustawić stan początkowy mikrofonu/kamery podczas dołączania do połączenia true = włącz urządzenie podczas dołączania do połączenia false = wyłącz urządzenie podczas dołączania do połączenia "zachowaj" / undefined = zachowaj stan sprzed połączenia

startCall(CommunicationIdentifier[], StartCallOptions)

Uruchom wywołanie.

startCall(string[], StartCallOptions)

Uruchom wywołanie.

Metody dziedziczone

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Dodaj uczestnika do połączenia.

createStreamView(string, VideoStreamOptions)

Utwórz widok HTML dla strumienia.

createTogetherModeStreamView(TogetherModeStreamOptions)

Utwórz widok HTML dla strumienia.

disposeLocalVideoStreamView()

Usuwanie widoku HTML dla lokalnego strumienia wideo

disposeRemoteVideoStreamView(string)

Usuwanie widoku html dla zdalnego strumienia wideo

disposeScreenShareStreamView(string)

Określanie położenia widoku html dla strumienia udziału ekranu

disposeStreamView(string, VideoStreamOptions)

Usuwanie widoku HTML dla strumienia.

disposeTogetherModeStreamView()

Usuwanie widoku HTML dla strumienia.

forbidAudio(string[])

Zabraniaj uczestnikom spotkania w usłudze Teams odtwarzania dźwięku według ich identyfikatorów użytkowników.

forbidOthersAudio()

Zabraniaj dźwięku podczas spotkań w usłudze Teams.

forbidOthersVideo()

Zabraniaj wideo ze spotkania w usłudze Teams.

forbidVideo(string[])

Nie zezwalaj uczestnikom spotkania w usłudze Teams na wideo według ich identyfikatorów użytkowników.

holdCall()

Zawiesza połączenie.

leaveCall(boolean)

Opuść połączenie

lowerHand()

dolna ręka dla bieżącego użytkownika

mute()

Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie

muteAllRemoteParticipants()

Wyciszanie wszystkich uczestników

muteParticipant(string)

Wyciszanie uczestnika

onReactionClick(Reaction)

Wyślij emotikon reakcji

permitAudio(string[])

Zezwalaj uczestnikom spotkania w usłudze Teams na dźwięk według ich identyfikatorów użytkowników.

permitOthersAudio()

Zezwalaj na dźwięk ze spotkania w usłudze Teams.

permitOthersVideo()

Zezwalaj na wideo ze spotkaniem w usłudze Teams.

permitVideo(string[])

Zezwalaj uczestnikom spotkania w usłudze Teams na dźwięk według ich identyfikatorów użytkowników.

raiseHand()

Podnieś rękę dla bieżącego użytkownika

removeParticipant(CommunicationIdentifier)

Usuń uczestnika z połączenia.

removeParticipant(string)

Usuń uczestnika z połączenia.

resumeCall()

Wznawia połączenie ze stanu LocalHold .

returnFromBreakoutRoom()

Powrót do punktu początkowego w oddzielnym pokoju

sendDtmfTone(DtmfTone)

wysyłanie sygnału dtmf do innego uczestnika połączenia PSTN 1:1

setCaptionLanguage(string)

Funkcja do ustawiania języka napisów

setSpokenLanguage(string)

Funkcja ustawiania języka mówionego

setTogetherModeSceneSize(number, number)

Ponownie oblicz pozycje siedzące dla trybu razem.

startCamera(VideoStreamOptions)

Uruchom aparat. Ta metoda rozpocznie renderowanie widoku aparatu lokalnego, gdy wywołanie nie jest aktywne

startCaptions(StartCaptionsAdapterOptions)

Funkcja uruchamiania napisów

startNoiseSuppressionEffect()

Uruchom efekt tłumienia szumów.

startScreenShare()

Rozpocznij udostępnianie ekranu podczas połączenia.

startSpotlight(string[])

Uruchom funkcję W centrum uwagi dla uczestników lokalnych i zdalnych na podstawie ich identyfikatorów użytkowników. Jeśli nie zostanie przekazana żadna tablica identyfikatorów użytkowników, wykonywana jest akcja na uczestniku lokalnym.

startTogetherMode()

Rozpocznij razem tryb.

startVideoBackgroundEffect(VideoBackgroundEffect)

Uruchom efekt tła wideo.

stopAllSpotlight()

Wyłączanie wszystkich reflektorów punktowych

stopCamera()

Zatrzymaj kamerę Ta metoda przestanie renderować widok aparatu lokalnego, gdy wywołanie nie jest aktywne

stopCaptions(StopCaptionsAdapterOptions)

Funkcja zatrzymywania napisów

stopNoiseSuppressionEffect()

Zatrzymaj efekt tłumienia szumów.

stopScreenShare()

Zatrzymaj udostępnianie ekranu

stopSpotlight(string[])

Zatrzymaj funkcję Spotlight dla uczestników lokalnych i zdalnych na podstawie ich identyfikatorów użytkowników. Jeśli nie zostanie przekazana żadna tablica identyfikatorów użytkowników, wykonywana jest akcja na uczestniku lokalnym.

stopVideoBackgroundEffects()

Zatrzymaj efekt tła wideo.

submitSurvey(CallSurvey)

Wyślij wynik ankiety na koniec rozmowy

unmute()

Wyciszanie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie

updateBackgroundPickerImages(VideoBackgroundImage[])

Zastąp obrazy selektora tła, aby uzyskać efekt zastąpienia tła.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Zaktualizuj wybrany efekt tła wideo.

Szczegóły właściwości dziedziczonej

sendRealTimeText

Wysyłanie tekstu w czasie rzeczywistym

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

Wartość właściwości

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

Odziedziczone poCallAdapterCallOperations.sendRealTimeText

Szczegóły metody

joinCall(boolean)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use joinCall(options?:JoinCallOptions) instead.

Dołącz połączenie z mikrofonem początkowo włączony/wyłączony.

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

Parametry

microphoneOn

boolean

Czy mikrofon jest początkowo włączony

Zwraca

undefined | Call

joinCall(JoinCallOptions)

Dołącz do rozmowy z torbą opcji, aby ustawić stan początkowy mikrofonu/kamery podczas dołączania do połączenia true = włącz urządzenie podczas dołączania do połączenia false = wyłącz urządzenie podczas dołączania do połączenia "zachowaj" / undefined = zachowaj stan sprzed połączenia

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

Parametry

options
JoinCallOptions

param, aby początkowo włączyć/wyłączyć mikrofon/kamerę/użyć stanu przed połączeniem.

Zwraca

undefined | Call

startCall(CommunicationIdentifier[], StartCallOptions)

Uruchom wywołanie.

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

Parametry

participants

CommunicationIdentifier[]

Tablica do <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> wywołania

Zwraca

undefined | Call

startCall(string[], StartCallOptions)

Uruchom wywołanie.

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

Parametry

participants

string[]

Tablica identyfikatorów uczestników do przyłączenia

Zwraca

undefined | Call

Szczegóły metody dziedziczonej

addParticipant(CommunicationUserIdentifier)

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

Parametry

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Dodaj uczestnika do połączenia.

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

Parametry

participant
PhoneNumberIdentifier

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.addParticipant

createStreamView(string, VideoStreamOptions)

Utwórz widok HTML dla strumienia.

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

Parametry

remoteUserId

string

Identyfikator uczestnika do renderowania, pozostaw go niezdefiniowany, aby utworzyć lokalny widok aparatu

options
VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void | CreateVideoStreamViewResult>

Uwagi

Ta metoda jest implementowana dla złożonego

dziedziczone zCallAdapterCallOperations.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Utwórz widok HTML dla strumienia.

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

Parametry

options
TogetherModeStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Uwagi

Ta metoda jest implementowana dla złożonego

Odziedziczone poCallAdapterCallOperations.createTogetherModeStreamView

disposeLocalVideoStreamView()

Usuwanie widoku HTML dla lokalnego strumienia wideo

function disposeLocalVideoStreamView(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.disposeLocalVideoStreamView

disposeRemoteVideoStreamView(string)

Usuwanie widoku html dla zdalnego strumienia wideo

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

Parametry

remoteUserId

string

Identyfikator uczestnika do rozporządzania

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.disposeRemoteVideoStreamView

disposeScreenShareStreamView(string)

Określanie położenia widoku html dla strumienia udziału ekranu

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

Parametry

remoteUserId

string

Identyfikator uczestnika, dla którego ma zostać usunięty widok strumienia udziału ekranu.

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla kompozytów

Odziedziczone poCallAdapterCallOperations.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Ostrzeżenie

Ten interfejs API jest już przestarzały.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

Usuwanie widoku HTML dla strumienia.

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

Parametry

remoteUserId

string

Identyfikator uczestnika do renderowania, pozostaw niezdefiniowany, aby usunąć widok aparatu lokalnego

options
VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla złożonego

dziedziczone zCallAdapterCallOperations.disposeStreamView

disposeTogetherModeStreamView()

Usuwanie widoku HTML dla strumienia.

function disposeTogetherModeStreamView(): Promise<void>

Zwraca

Promise<void>

Uwagi

Ta metoda jest implementowana dla złożonego

Odziedziczone poCallAdapterCallOperations.disposeTogetherModeStreamView

forbidAudio(string[])

Zabraniaj uczestnikom spotkania w usłudze Teams odtwarzania dźwięku według ich identyfikatorów użytkowników.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.forbidAudio

forbidOthersAudio()

Zabraniaj dźwięku podczas spotkań w usłudze Teams.

function forbidOthersAudio(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.forbidOthersAudio

forbidOthersVideo()

Zabraniaj wideo ze spotkania w usłudze Teams.

function forbidOthersVideo(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.forbidOthersVideo

forbidVideo(string[])

Nie zezwalaj uczestnikom spotkania w usłudze Teams na wideo według ich identyfikatorów użytkowników.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.forbidVideo

holdCall()

Zawiesza połączenie.

function holdCall(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.holdCall

leaveCall(boolean)

Opuść połączenie

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

Parametry

forEveryone

boolean

Czy usunąć wszystkich uczestników podczas opuszczania

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.leaveCall

lowerHand()

dolna ręka dla bieżącego użytkownika

function lowerHand(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.lowerHand

mute()

Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie

function mute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.mute

muteAllRemoteParticipants()

Wyciszanie wszystkich uczestników

function muteAllRemoteParticipants(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.muteAllRemoteParticipants

muteParticipant(string)

Wyciszanie uczestnika

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

Parametry

userId

string

Identyfikator uczestnika, który ma zostać wyciszony

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.muteParticipant

onReactionClick(Reaction)

Wyślij emotikon reakcji

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

Parametry

reaction
Reaction

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.onReactionClick

permitAudio(string[])

Zezwalaj uczestnikom spotkania w usłudze Teams na dźwięk według ich identyfikatorów użytkowników.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.permitAudio

permitOthersAudio()

Zezwalaj na dźwięk ze spotkania w usłudze Teams.

function permitOthersAudio(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.permitOthersAudio

permitOthersVideo()

Zezwalaj na wideo ze spotkaniem w usłudze Teams.

function permitOthersVideo(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.permitOthersVideo

permitVideo(string[])

Zezwalaj uczestnikom spotkania w usłudze Teams na dźwięk według ich identyfikatorów użytkowników.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.permitVideo

raiseHand()

Podnieś rękę dla bieżącego użytkownika

function raiseHand(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.raiseHand

removeParticipant(CommunicationIdentifier)

Usuń uczestnika z połączenia.

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

Parametry

participant
CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> uczestnika, który ma zostać usunięty

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.removeParticipant

removeParticipant(string)

Usuń uczestnika z połączenia.

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

Parametry

userId

string

Identyfikator uczestnika do usunięcia

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.removeParticipant

resumeCall()

Wznawia połączenie ze stanu LocalHold .

function resumeCall(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.resumeCall

returnFromBreakoutRoom()

Powrót do punktu początkowego w oddzielnym pokoju

function returnFromBreakoutRoom(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

wysyłanie sygnału dtmf do innego uczestnika połączenia PSTN 1:1

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

Parametry

dtmfTone
DtmfTone

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.sendDtmfTone

setCaptionLanguage(string)

Funkcja do ustawiania języka napisów

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

Parametry

language

string

Język ustawiony dla podpisu

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.setCaptionLanguage

setSpokenLanguage(string)

Funkcja ustawiania języka mówionego

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

Parametry

language

string

Język mówiony

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.setSpokenLanguage

setTogetherModeSceneSize(number, number)

Ponownie oblicz pozycje siedzące dla trybu razem.

function setTogetherModeSceneSize(width: number, height: number)

Parametry

width

number

Szerokość kontenera

height

number

Wysokość kontenera

Uwagi

Ta metoda jest implementowana dla złożonego

Odziedziczone poCallAdapterCallOperations.setTogetherModeSceneSize

startCamera(VideoStreamOptions)

Uruchom aparat. Ta metoda rozpocznie renderowanie widoku aparatu lokalnego, gdy wywołanie nie jest aktywne

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

Parametry

options
VideoStreamOptions

Opcje kontrolowania sposobu renderowania strumieni wideo <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.startCamera

startCaptions(StartCaptionsAdapterOptions)

Funkcja uruchamiania napisów

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

Parametry

options
StartCaptionsAdapterOptions

Opcje napisów początkowych

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.startCaptions

startNoiseSuppressionEffect()

Uruchom efekt tłumienia szumów.

function startNoiseSuppressionEffect(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.startNoiseSuppressionEffect

startScreenShare()

Rozpocznij udostępnianie ekranu podczas połączenia.

function startScreenShare(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.startScreenShare

startSpotlight(string[])

Uruchom funkcję W centrum uwagi dla uczestników lokalnych i zdalnych na podstawie ich identyfikatorów użytkowników. Jeśli nie zostanie przekazana żadna tablica identyfikatorów użytkowników, wykonywana jest akcja na uczestniku lokalnym.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.startSpotlight

startTogetherMode()

Rozpocznij razem tryb.

function startTogetherMode(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Uruchom efekt tła wideo.

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

Parametry

videoBackgroundEffect
VideoBackgroundEffect

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.startVideoBackgroundEffect

stopAllSpotlight()

Wyłączanie wszystkich reflektorów punktowych

function stopAllSpotlight(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.stopAllSpotlight

stopCamera()

Zatrzymaj kamerę Ta metoda przestanie renderować widok aparatu lokalnego, gdy wywołanie nie jest aktywne

function stopCamera(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funkcja zatrzymywania napisów

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

Parametry

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.stopCaptions

stopNoiseSuppressionEffect()

Zatrzymaj efekt tłumienia szumów.

function stopNoiseSuppressionEffect(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.stopNoiseSuppressionEffect

stopScreenShare()

Zatrzymaj udostępnianie ekranu

function stopScreenShare(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.stopScreenShare

stopSpotlight(string[])

Zatrzymaj funkcję Spotlight dla uczestników lokalnych i zdalnych na podstawie ich identyfikatorów użytkowników. Jeśli nie zostanie przekazana żadna tablica identyfikatorów użytkowników, wykonywana jest akcja na uczestniku lokalnym.

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

Parametry

userIds

string[]

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.stopSpotlight

stopVideoBackgroundEffects()

Zatrzymaj efekt tła wideo.

function stopVideoBackgroundEffects(): Promise<void>

Zwraca

Promise<void>

Odziedziczone poCallAdapterCallOperations.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Wyślij wynik ankiety na koniec rozmowy

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

Parametry

survey
CallSurvey

Zwraca

Promise<undefined | CallSurveyResponse>

Odziedziczone poCallAdapterCallOperations.submitSurvey

unmute()

Wyciszanie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie

function unmute(): Promise<void>

Zwraca

Promise<void>

dziedziczone zCallAdapterCallOperations.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Zastąp obrazy selektora tła, aby uzyskać efekt zastąpienia tła.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parametry

backgroundImages

VideoBackgroundImage[]

Tablica niestandardowych obrazów tła.

Odziedziczone poCallAdapterCallOperations.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Zaktualizuj wybrany efekt tła wideo.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametry

selectedVideoBackground
VideoBackgroundEffect

Odziedziczone poCallAdapterCallOperations.updateSelectedVideoBackgroundEffect