CallAdapterCallManagement interface

Pakiet:

@azure/communication-react

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

Extends

CallAdapterCallOperations

Metody

joinCall(boolean)	Dołącz do połączenia z mikrofonem początkowo włączony/wyłączony.
startCall(string[], StartCallOptions)	Uruchom połączenie.

Metody dziedziczone

createStreamView(string, VideoStreamOptions)	Utwórz widok HTML dla strumienia.
disposeStreamView(string, VideoStreamOptions)	Usuwanie widoku HTML dla strumienia.
leaveCall(boolean)	Pozostaw połączenie
mute()	Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie
removeParticipant(string)	Usuń uczestnika z połączenia.
startCamera(VideoStreamOptions)	Uruchom aparat. Ta metoda rozpocznie renderowanie lokalnego widoku aparatu, gdy wywołanie nie jest aktywne
startScreenShare()	Rozpocznij udostępnianie ekranu podczas połączenia.
stopCamera()	Zatrzymaj kamerę Ta metoda zatrzyma renderowanie lokalnego widoku aparatu, gdy wywołanie nie jest aktywne
stopScreenShare()	Zatrzymaj udostępnianie ekranu
unmute()	Usuń wyciszenie bieżącego użytkownika podczas połączenia lub lokalne włączanie mikrofonu

Szczegóły metody

joinCall(boolean)

Dołącz do połączenia 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

startCall(string[], StartCallOptions)

Uruchom połączenie.

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

Parametry

participants

string[]

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

options

StartCallOptions

Zwraca

undefined | Call

Szczegóły metody dziedziczonej

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

disposeStreamView(string, VideoStreamOptions)

Usuwanie widoku HTML dla strumienia.

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

Parametry

remoteUserId

string

Identyfikator uczestnika do renderowania, pozostaw niezdefiniowany w celu usunięcia lokalnego widoku kamery

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

leaveCall(boolean)

Pozostaw połączenie

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

Parametry

forEveryone

boolean

Czy usunąć wszystkich uczestników podczas opuszczania

Zwraca

Promise<void>

Dziedziczone zCallAdapterCallOperations.leaveCallCall

mute()

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

function mute(): Promise<void>

Zwraca

Promise<void>

Dziedziczone zcallAdapterCallOperations.mute

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

startCamera(VideoStreamOptions)

Uruchom aparat. Ta metoda rozpocznie renderowanie lokalnego widoku aparatu, 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

startScreenShare()

Rozpocznij udostępnianie ekranu podczas połączenia.

function startScreenShare(): Promise<void>

Zwraca

Promise<void>

Dziedziczone zcallAdapterCallOperations.startScreenShare

stopCamera()

Zatrzymaj kamerę Ta metoda zatrzyma renderowanie lokalnego widoku aparatu, gdy wywołanie nie jest aktywne

function stopCamera(): Promise<void>

Zwraca

Promise<void>

Dziedziczone zCallAdapterCallOperations.stopCamera

stopScreenShare()

Zatrzymaj udostępnianie ekranu

function stopScreenShare(): Promise<void>

Zwraca

Promise<void>

Dziedziczone zcallAdapterCallOperations.stopScreenShare

unmute()

Usuń wyciszenie bieżącego użytkownika podczas połączenia lub lokalne włączanie mikrofonu

function unmute(): Promise<void>

Zwraca

Promise<void>

Dziedziczone zcallAdapterCallOperations.unmute