CallWithChatAdapterManagement interface

Pakiet:

@azure/communication-react

Funkcje zarządzania bieżącym połączeniem za pomocą czatu.

Metody

askDevicePermission(PermissionConstraints)	Poproś o uprawnienia urządzeń.
createStreamView(string, VideoStreamOptions)	Utwórz widok HTML dla strumienia.
deleteMessage(string)	Usuń komunikat w wątku.
disposeStreamView(string, VideoStreamOptions)	Usuwanie widoku HTML dla strumienia.
fetchInitialData()	Pobierz stan początkowy dla karty czatu. Wykonuje minimalne pobieranie niezbędne dla metod ChatComposite i API.
joinCall(boolean)	Dołącz połączenie z mikrofonem początkowo włączony/wyłączony.
leaveCall(boolean)	Pozostaw połączenie.
loadPreviousChatMessages(number)	Załaduj więcej poprzednich wiadomości w historii wątku czatu.
mute()	Wycisz bieżącego użytkownika podczas połączenia lub wyłącz mikrofon lokalnie.
queryCameras()	Wykonywanie zapytań dotyczących dostępnych urządzeń z aparatami fotograficznymi.
queryMicrophones()	Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.
querySpeakers()	Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.
removeParticipant(string)	Usuń uczestnika z połączenia.
sendMessage(string, SendMessageOptions)	Wyślij wiadomość w wątku.
sendReadReceipt(string)	Wyślij potwierdzenie odczytu dla wiadomości.
sendTypingIndicator()	Wyślij wskaźnik wpisywania w wątku.
setCamera(VideoDeviceInfo, VideoStreamOptions)	Ustaw aparat do użycia w wywołaniu.
setMicrophone(AudioDeviceInfo)	Ustaw mikrofon do użycia w wywołaniu.
setSpeaker(AudioDeviceInfo)	Ustaw głośnik do użycia w wywołaniu.
startCall(string[], StartCallOptions)	Uruchom wywołanie.
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 aparat. Ta metoda przestanie renderować widok aparatu lokalnego, gdy wywołanie nie jest aktywne.
stopScreenShare()	Zatrzymaj udostępnianie ekranu.
unmute()	Anuluj wyciszenie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie.
updateMessage(string, string, Record<string, string>)	Aktualizowanie zawartości wiadomości.

Szczegóły metody

askDevicePermission(PermissionConstraints)

Poproś o uprawnienia urządzeń.

function askDevicePermission(constrain: PermissionConstraints): Promise<void>

Parametry

constrain

PermissionConstraints

Definiowanie ograniczeń dotyczących uzyskiwania dostępu do urządzeń lokalnych <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>

Zwraca

Promise<void>

Uwagi

Jeśli uprawnienia nie zostały jeszcze przyznane, zostanie wyświetlone okno uprawnień przeglądarki.

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.

deleteMessage(string)

Usuń komunikat w wątku.

function deleteMessage(messageId: string): Promise<void>

Parametry

messageId

string

Zwraca

Promise<void>

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

fetchInitialData()

Pobierz stan początkowy dla karty czatu.

Wykonuje minimalne pobieranie niezbędne dla metod ChatComposite i API.

function fetchInitialData(): Promise<void>

Zwraca

Promise<void>

joinCall(boolean)

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

leaveCall(boolean)

Pozostaw połączenie.

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

Parametry

forEveryone

boolean

Czy usunąć wszystkich uczestników podczas opuszczania

Zwraca

Promise<void>

loadPreviousChatMessages(number)

Załaduj więcej poprzednich wiadomości w historii wątku czatu.

function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>

Parametry

messagesToLoad

number

Zwraca

Promise<boolean>

Uwagi

Ta metoda jest zwykle używana do kontrolowania przyrostowego pobierania/nieskończonego przewijania.

mute()

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

function mute(): Promise<void>

Zwraca

Promise<void>

queryCameras()

Wykonywanie zapytań dotyczących dostępnych urządzeń z aparatami fotograficznymi.

function queryCameras(): Promise<VideoDeviceInfo[]>

Zwraca

Promise<VideoDeviceInfo[]>

Tablica jednostek informacji o urządzeniu wideo <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>

Uwagi

Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()

queryMicrophones()

Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.

function queryMicrophones(): Promise<AudioDeviceInfo[]>

Zwraca

Promise<AudioDeviceInfo[]>

Tablica jednostek informacji o urządzeniu audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Uwagi

Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()

querySpeakers()

Wykonywanie zapytań dotyczących dostępnych urządzeń mikrofonowych.

function querySpeakers(): Promise<AudioDeviceInfo[]>

Zwraca

Promise<AudioDeviceInfo[]>

Tablica jednostek informacji o urządzeniu audio <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>

Uwagi

Ta metoda powinna być wywoływana po wywołaniu metody askDevicePermission()

removeParticipant(string)

Usuń uczestnika z połączenia.

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

Parametry

userId

string

UserId uczestnika do usunięcia.

Zwraca

Promise<void>

sendMessage(string, SendMessageOptions)

Wyślij wiadomość w wątku.

function sendMessage(content: string, options?: SendMessageOptions): Promise<void>

Parametry

content

string

options

SendMessageOptions

Zwraca

Promise<void>

sendReadReceipt(string)

Wyślij potwierdzenie odczytu dla wiadomości.

function sendReadReceipt(chatMessageId: string): Promise<void>

Parametry

chatMessageId

string

Zwraca

Promise<void>

sendTypingIndicator()

Wyślij wskaźnik wpisywania w wątku.

function sendTypingIndicator(): Promise<void>

Zwraca

Promise<void>

setCamera(VideoDeviceInfo, VideoStreamOptions)

Ustaw aparat do użycia w wywołaniu.

function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>

Parametry

sourceInfo

VideoDeviceInfo

Urządzenie aparatu do wyboru, wybierz jedno zwrócone przez queryCameras

options

VideoStreamOptions

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

Zwraca

Promise<void>

setMicrophone(AudioDeviceInfo)

Ustaw mikrofon do użycia w wywołaniu.

function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>

Parametry

sourceInfo

AudioDeviceInfo

Urządzenie mikrofonu do wyboru, wybierz jedno zwrócone przez zapytanieMicrophones

Zwraca

Promise<void>

setSpeaker(AudioDeviceInfo)

Ustaw głośnik do użycia w wywołaniu.

function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>

Parametry

sourceInfo

AudioDeviceInfo

Urządzenie mówiące do wyboru, wybierz jedno zwrócone przez querySpeakers

Zwraca

Promise<void>

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

options

StartCallOptions

Zwraca

undefined | Call

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>

startScreenShare()

Rozpocznij udostępnianie ekranu podczas połączenia.

function startScreenShare(): Promise<void>

Zwraca

Promise<void>

stopCamera()

Zatrzymaj aparat.

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

function stopCamera(): Promise<void>

Zwraca

Promise<void>

stopScreenShare()

Zatrzymaj udostępnianie ekranu.

function stopScreenShare(): Promise<void>

Zwraca

Promise<void>

unmute()

Anuluj wyciszenie bieżącego użytkownika podczas połączenia lub włączanie mikrofonu lokalnie.

function unmute(): Promise<void>

Zwraca

Promise<void>

updateMessage(string, string, Record<string, string>)

Aktualizowanie zawartości wiadomości.

function updateMessage(messageId: string, content: string, metadata?: Record<string, string>): Promise<void>

Parametry

messageId

string

content

string

metadata

Record<string, string>

Zwraca

Promise<void>