CallWithChatAdapterManagement interface
Funkce pro správu aktuálního hovoru pomocí chatu
Vlastnosti
| forbid |
Zakáže zvuk pro zadaná ID uživatelů. |
| forbid |
Zakáže zvuk pro účastníky schůzky Teams s výjimkou místního uživatele. |
| forbid |
Zakáže video pro účastníky schůzky Teams s výjimkou místního uživatele. |
| forbid |
Zakáže video pro zadané ID uživatele. |
| permit |
Povoluje zvuk pro zadaná ID uživatelů. |
| permit |
povolí zvuk pro účastníky schůzky Teams s výjimkou místního uživatele. |
| permit |
povolí video pro účastníky schůzky Teams s výjimkou místního uživatele. |
| permit |
Povolí video pro zadaná ID uživatele. |
| send |
Odeslání DTMF tónu jinému účastníkovi hovoru v hovoru 1:1 |
| send |
Odesílání textu v reálném čase |
Metody
| add |
|
| add |
Přidá do hovoru nového účastníka. |
| ask |
Požádejte o oprávnění zařízení. |
| create |
Vytvořte zobrazení HTML pro datový proud. |
| create |
Vytvořte zobrazení html pro datový proud togethermode. |
| delete |
Odstraňte zprávu ve vlákně. |
| dispose |
Uvolnění zobrazení html pro místní datový proud videa |
| dispose |
Uvolnění zobrazení html pro vzdálený datový proud videa |
| dispose |
Uvolnění zobrazení HTML pro datový proud sdílené obrazovky |
| dispose |
Vyřaďte zobrazení HTML pro datový proud. |
| dispose |
Uvolněte zobrazení html pro datový proud togethermode. |
| download |
|
| fetch |
Načtěte počáteční stav adaptéru chatu. Provede minimální načtení potřebné pro metody ChatComposite a rozhraní API. |
| hold |
Umístí hovor do localholdu. |
| join |
Připojte se k hovoru s mikrofonem, který je zpočátku zapnutý nebo vypnutý. |
| join |
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 |
| leave |
Nechte hovor. |
| load |
Načtěte další předchozí zprávy v historii vlákna chatu. |
| lower |
Spodní ruka pro místního uživatele. |
| mute() | Ztlumte aktuálního uživatele během hovoru nebo zakažte mikrofon místně. |
| mute |
Ztlumení účastníka |
| mute |
Ztlumení účastníka |
| on |
Odeslat reakci na probíhající schůzku. |
| query |
Zadejte dotaz na dostupná zařízení fotoaparátu. |
| query |
Zadejte dotaz na dostupná mikrofonní zařízení. |
| query |
Zadejte dotaz na dostupná mikrofonní zařízení. |
| raise |
Zvedněte ruku pro místního uživatele. |
| remove |
Odeberte účastníka z hovoru. |
| remove |
Odeberte účastníka z hovoru. |
| remove |
|
| resume |
Obnoví volání ze stavu LocalHold. |
| return |
Návrat k původnímu volání breakout room |
| send |
Odešle zprávu ve vlákně. |
| send |
Odešle potvrzení o přečtení zprávy. |
| send |
Odešlete do vlákna indikátor psaní. |
| set |
Nastavte kameru tak, aby se používala při hovoru. |
| set |
Funkce pro nastavení jazyka titulků |
| set |
Nastavte mikrofon tak, aby se používal při hovoru. |
| set |
Nastavte reproduktor, který se má použít při hovoru. |
| set |
Funkce pro nastavení mluveného jazyka |
| set |
Přepočítejte polohy sedadel pro režim společně. |
| start |
Zahajte hovor. |
| start |
Zahajte hovor. |
| start |
Spusťte kameru. Tato metoda začne vykreslovat zobrazení místní kamery, když volání není aktivní. |
| start |
Funkce pro začátek titulků |
| start |
Spusťte efekt potlačení šumu. |
| start |
Během hovoru začněte sdílet obrazovku. |
| start |
Začněte v centru pozornosti |
| start |
Spusťte režim společně. |
| start |
Spusťte efekt pozadí videa. |
| stop |
Zastavte všechna světla reflektorů |
| stop |
Zastavte kameru. Tato metoda přestane vykreslovat zobrazení místní kamery, pokud volání není aktivní. |
| stop |
Funkce pro zastavení titulků |
| stop |
Spusťte efekt potlačení šumu. |
| stop |
Přestaňte sdílet obrazovku. |
| stop |
Zastavte reflektor |
| stop |
Zastavte efekt pozadí videa. |
| submit |
Odeslání výsledku průzkumu na konci hovoru |
| unmute() | Zrušte ztlumení aktuálního uživatele během hovoru nebo povolte mikrofon místně. |
| update |
Přepište obrazy pro výběr pozadí, aby se nahradilo pozadí. |
| update |
Aktualizujte obsah zprávy. |
| update |
Aktualizace vybraného efektu pozadí videa |
Podrobnosti vlastnosti
forbidAudio
Zakáže zvuk pro zadaná ID uživatelů.
forbidAudio: (userIds: string[]) => Promise<void>
Hodnota vlastnosti
(userIds: string[]) => Promise<void>
forbidOthersAudio
Zakáže zvuk pro účastníky schůzky Teams s výjimkou místního uživatele.
forbidOthersAudio: () => Promise<void>
Hodnota vlastnosti
() => Promise<void>
forbidOthersVideo
Zakáže video pro účastníky schůzky Teams s výjimkou místního uživatele.
forbidOthersVideo: () => Promise<void>
Hodnota vlastnosti
() => Promise<void>
forbidVideo
Zakáže video pro zadané ID uživatele.
forbidVideo: (userIds: string[]) => Promise<void>
Hodnota vlastnosti
(userIds: string[]) => Promise<void>
permitAudio
Povoluje zvuk pro zadaná ID uživatelů.
permitAudio: (userIds: string[]) => Promise<void>
Hodnota vlastnosti
(userIds: string[]) => Promise<void>
permitOthersAudio
povolí zvuk pro účastníky schůzky Teams s výjimkou místního uživatele.
permitOthersAudio: () => Promise<void>
Hodnota vlastnosti
() => Promise<void>
permitOthersVideo
povolí video pro účastníky schůzky Teams s výjimkou místního uživatele.
permitOthersVideo: () => Promise<void>
Hodnota vlastnosti
() => Promise<void>
permitVideo
Povolí video pro zadaná ID uživatele.
permitVideo: (userIds: string[]) => Promise<void>
Hodnota vlastnosti
(userIds: string[]) => Promise<void>
sendDtmfTone
Odeslání DTMF tónu jinému účastníkovi hovoru v hovoru 1:1
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>
Hodnota vlastnosti
(dtmfTone: DtmfTone) => Promise<void>
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řidá do hovoru nového účastníka.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Parametry
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Návraty
Promise<void>
askDevicePermission(PermissionConstraints)
Požádejte o oprávnění zařízení.
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>
Parametry
- constrain
- PermissionConstraints
Definování omezení pro přístup k místním zařízením <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Návraty
Promise<DeviceAccess>
Poznámky
Okno oprávnění prohlížeče se zobrazí, pokud ještě nejsou udělena oprávnění.
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 togethermode.
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é
deleteMessage(string)
Odstraňte zprávu ve vlákně.
function deleteMessage(messageId: string): Promise<void>
Parametry
- messageId
-
string
Návraty
Promise<void>
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)
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()
Uvolněte zobrazení html pro datový proud togethermode.
function disposeTogetherModeStreamView(): Promise<void>
Návraty
Promise<void>
Poznámky
Tato metoda je implementována pro složené
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Parametry
- resourceDetails
- ResourceDetails
Návraty
Promise<void>
fetchInitialData()
Načtěte počáteční stav adaptéru chatu.
Provede minimální načtení potřebné pro metody ChatComposite a rozhraní API.
function fetchInitialData(): Promise<void>
Návraty
Promise<void>
holdCall()
Umístí hovor do localholdu.
function holdCall(): Promise<void>
Návraty
Promise<void>
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
leaveCall(boolean)
Nechte hovor.
function leaveCall(forEveryone?: boolean): Promise<void>
Parametry
- forEveryone
-
boolean
Zda odebrat všechny účastníky při odjezdu
Návraty
Promise<void>
loadPreviousChatMessages(number)
Načtěte další předchozí zprávy v historii vlákna chatu.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
Parametry
- messagesToLoad
-
number
Návraty
Promise<boolean>
Poznámky
Tato metoda se obvykle používá k řízení přírůstkového načítání nebo nekonečného posouvání.
lowerHand()
Spodní ruka pro místního uživatele.
function lowerHand(): Promise<void>
Návraty
Promise<void>
mute()
Ztlumte aktuálního uživatele během hovoru nebo zakažte mikrofon místně.
function mute(): Promise<void>
Návraty
Promise<void>
muteAllRemoteParticipants()
Ztlumení účastníka
function muteAllRemoteParticipants(): Promise<void>
Návraty
Promise<void>
muteParticipant(string)
Ztlumení účastníka
function muteParticipant(userId: string): Promise<void>
Parametry
- userId
-
string
Návraty
Promise<void>
onReactionClick(Reaction)
Odeslat reakci na probíhající schůzku.
function onReactionClick(reaction: Reaction): Promise<void>
Parametry
- reaction
- Reaction
Hodnota typu <xref:%40azure%2Fcommunication-calling%23Reaction>
Návraty
Promise<void>
queryCameras()
Zadejte dotaz na dostupná zařízení fotoaparátu.
function queryCameras(): Promise<VideoDeviceInfo[]>
Návraty
Promise<VideoDeviceInfo[]>
Pole informačních entit videoza zařízení <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Poznámky
Tato metoda by se měla volat po zadání metody askDevicePermission()
queryMicrophones()
Zadejte dotaz na dostupná mikrofonní zařízení.
function queryMicrophones(): Promise<AudioDeviceInfo[]>
Návraty
Promise<AudioDeviceInfo[]>
Pole entit informací o zvukových zařízeních <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Poznámky
Tato metoda by se měla volat po zadání metody askDevicePermission()
querySpeakers()
Zadejte dotaz na dostupná mikrofonní zařízení.
function querySpeakers(): Promise<AudioDeviceInfo[]>
Návraty
Promise<AudioDeviceInfo[]>
Pole entit informací o zvukových zařízeních <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Poznámky
Tato metoda by se měla volat po zadání metody askDevicePermission()
raiseHand()
Zvedněte ruku pro místní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 uživatele účastníka, který chcete odebrat.
Návraty
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
Parametry
- resourceDetails
- ResourceDetails
resumeCall()
Obnoví volání ze stavu LocalHold.
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>
sendMessage(string, SendMessageOptions)
Odešle zprávu ve vlákně.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parametry
- content
-
string
- options
- SendMessageOptions
Návraty
Promise<void>
sendReadReceipt(string)
Odešle potvrzení o přečtení zprávy.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parametry
- chatMessageId
-
string
Návraty
Promise<void>
sendTypingIndicator()
Odešlete do vlákna indikátor psaní.
function sendTypingIndicator(): Promise<void>
Návraty
Promise<void>
setCamera(VideoDeviceInfo, VideoStreamOptions)
Nastavte kameru tak, aby se používala při hovoru.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>
Parametry
- sourceInfo
- VideoDeviceInfo
Vyberte zařízení fotoaparátu, které chcete vybrat, vyberte jedno vrácené queryCameras
- options
- VideoStreamOptions
Možnosti řízení, jak se stream fotoaparátu vykresluje <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
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>
setMicrophone(AudioDeviceInfo)
Nastavte mikrofon tak, aby se používal při hovoru.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>
Parametry
- sourceInfo
- AudioDeviceInfo
Výběr zařízení mikrofonu, výběr zařízení vrácený dotazemMicrophones
Návraty
Promise<void>
setSpeaker(AudioDeviceInfo)
Nastavte reproduktor, který se má použít při hovoru.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>
Parametry
- sourceInfo
- AudioDeviceInfo
Zařízení mluvčího, které chcete zvolit, vyberte jeden vrácený dotazYSpeakers
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é
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
Zahajte hovor.
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call
Parametry
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
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
startCamera(VideoStreamOptions)
Spusťte kameru.
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 v centru pozornosti
function startSpotlight(userIds?: string[]): Promise<void>
Parametry
- userIds
-
string[]
Návraty
Promise<void>
startTogetherMode()
Spusťte režim společně.
function startTogetherMode(): Promise<void>
Návraty
Promise<void>
Poznámky
Tato metoda je implementována pro složené
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()
Zastavte kameru.
Tato metoda přestane vykreslovat zobrazení místní kamery, pokud 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()
Spusťte efekt potlačení šumu.
function stopNoiseSuppressionEffect(): Promise<void>
Návraty
Promise<void>
stopScreenShare()
Přestaňte sdílet obrazovku.
function stopScreenShare(): Promise<void>
Návraty
Promise<void>
stopSpotlight(string[])
Zastavte reflektor
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šte ztlumení aktuálního uživatele během hovoru nebo povolte mikrofon 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
Pole vlastních obrázků na pozadí.
updateMessage(string, string, Record<string, string>)
Aktualizujte obsah zprávy.
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>
Parametry
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
Návraty
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Aktualizace vybraného efektu pozadí videa
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parametry
- selectedVideoBackground
- VideoBackgroundEffect