CallWithChatAdapterManagement interface
Funktioner för att hantera det aktuella samtalet med chatt.
Egenskaper
| forbid |
Förbjuder ljud för de angivna användar-ID:na. |
| forbid |
förbjuder ljud för Teams-mötesdeltagare förutom den lokala användaren. |
| forbid |
förbjuder video för Teams-mötesdeltagare förutom den lokala användaren. |
| forbid |
Förbjuder video för de angivna användar-ID:na. |
| permit |
Tillåter ljud för de angivna användar-ID:na. |
| permit |
tillåter ljud för Teams-mötesdeltagare förutom den lokala användaren. |
| permit |
tillåter video för Teams-mötesdeltagare förutom den lokala användaren. |
| permit |
Tillåter video för de angivna användar-ID:na. |
| send |
Skicka DTMF-ton till en annan deltagare i samtalet i 1:1-samtal |
| send |
Skicka text i realtid |
Metoder
| add |
|
| add |
Lägger till en ny deltagare i samtalet. |
| ask |
Be om behörigheter för enheter. |
| create |
Skapa html-vyn för en dataström. |
| create |
Skapa html-vyn för en togethermode-ström. |
| delete |
Ta bort ett meddelande i tråden. |
| dispose |
Ta bort html-vyn för en lokal videoström |
| dispose |
Ta bort html-vyn för en fjärrvideoström |
| dispose |
Ta bort html-vyn för en skärmdelningsström |
| dispose |
Ta bort html-vyn för en dataström. |
| dispose |
Ta bort html-vyn för en togethermode-ström. |
| download |
|
| fetch |
Hämta initialt tillstånd för chattkortet. Utför den minimala hämtning som krävs för ChatComposite- och API-metoder. |
| hold |
Placerar samtalet i ett lokalt undantag. |
| join |
Anslut samtalet med mikrofonen först på/av. |
| join |
Gå med i samtalet med alternativpåse för att ställa in mikrofonens/kamerans initiala tillstånd när du går med i samtalet true = slå på enheten när du går med i samtalet false = stäng av enheten när du går med i samtalet 'behåll'/odefinierad = behåll enheternas föranropstillstånd |
| leave |
Lämna samtalet. |
| load |
Läs in fler tidigare meddelanden i chatttrådshistoriken. |
| lower |
Sänk handen för lokal användare. |
| mute() | Stäng av den aktuella användaren under anropet eller inaktivera mikrofonen lokalt. |
| mute |
Stänga av ljudet för en deltagare |
| mute |
Stänga av ljudet för en deltagare |
| on |
Skicka Reaktion till pågående möte. |
| query |
Fråga efter tillgängliga kameraenheter. |
| query |
Fråga efter tillgängliga mikrofonenheter. |
| query |
Fråga efter tillgängliga mikrofonenheter. |
| raise |
Räck upp handen för den lokala användaren. |
| remove |
Ta bort en deltagare från anropet. |
| remove |
Ta bort en deltagare från ett samtal. |
| remove |
|
| resume |
Återupptar anropet från ett LocalHold-tillstånd. |
| return |
Återgå till ursprungsanropet för breakout room |
| send |
Skicka ett meddelande i tråden. |
| send |
Skicka ett läskvitto för ett meddelande. |
| send |
Skicka inmatningsindikatorn i tråden. |
| set |
Ställ in kameran som ska användas i samtalet. |
| set |
Funktion för att ställa in bildtextspråk |
| set |
Ställ in mikrofonen som ska användas i samtalet. |
| set |
Ställ in högtalaren som ska användas i anropet. |
| set |
Funktion för att ställa in talat språk |
| set |
Beräkna om sittplatserna för tillsammans-läget. |
| start |
Starta samtalet. |
| start |
Starta samtalet. |
| start |
Starta kameran. Den här metoden börjar återge en lokal kameravy när anropet inte är aktivt. |
| start |
Funktion för att starta bildtexter |
| start |
Starta brusdämpningseffekten. |
| start |
Börja dela skärmen under ett samtal. |
| start |
Starta spotlight |
| start |
Starta tillsammans-läge. |
| start |
Starta videobakgrundseffekten. |
| stop |
Stoppa alla spotlights |
| stop |
Stoppa kameran. Den här metoden slutar återge en lokal kameravy när anropet inte är aktivt. |
| stop |
Funktion för att stoppa textning |
| stop |
Starta brusdämpningseffekten. |
| stop |
Sluta dela skärmen. |
| stop |
Stoppa spotlight |
| stop |
Stoppa videobakgrundseffekten. |
| submit |
Skicka resultatet av undersökningen om samtalets slut |
| unmute() | Slå på ljudet för den aktuella användaren under anropet eller aktivera mikrofonen lokalt. |
| update |
Åsidosätt bakgrundsväljarens bilder för att få en bakgrundsersättningseffekt. |
| update |
Uppdatera ett meddelandeinnehåll. |
| update |
Uppdatera den valda videobakgrundseffekten |
Egenskapsinformation
forbidAudio
Förbjuder ljud för de angivna användar-ID:na.
forbidAudio: (userIds: string[]) => Promise<void>
Egenskapsvärde
(userIds: string[]) => Promise<void>
forbidOthersAudio
förbjuder ljud för Teams-mötesdeltagare förutom den lokala användaren.
forbidOthersAudio: () => Promise<void>
Egenskapsvärde
() => Promise<void>
forbidOthersVideo
förbjuder video för Teams-mötesdeltagare förutom den lokala användaren.
forbidOthersVideo: () => Promise<void>
Egenskapsvärde
() => Promise<void>
forbidVideo
Förbjuder video för de angivna användar-ID:na.
forbidVideo: (userIds: string[]) => Promise<void>
Egenskapsvärde
(userIds: string[]) => Promise<void>
permitAudio
Tillåter ljud för de angivna användar-ID:na.
permitAudio: (userIds: string[]) => Promise<void>
Egenskapsvärde
(userIds: string[]) => Promise<void>
permitOthersAudio
tillåter ljud för Teams-mötesdeltagare förutom den lokala användaren.
permitOthersAudio: () => Promise<void>
Egenskapsvärde
() => Promise<void>
permitOthersVideo
tillåter video för Teams-mötesdeltagare förutom den lokala användaren.
permitOthersVideo: () => Promise<void>
Egenskapsvärde
() => Promise<void>
permitVideo
Tillåter video för de angivna användar-ID:na.
permitVideo: (userIds: string[]) => Promise<void>
Egenskapsvärde
(userIds: string[]) => Promise<void>
sendDtmfTone
Skicka DTMF-ton till en annan deltagare i samtalet i 1:1-samtal
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>
Egenskapsvärde
(dtmfTone: DtmfTone) => Promise<void>
sendRealTimeText
Skicka text i realtid
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>
Egenskapsvärde
(text: string, isFinalized: boolean) => Promise<void>
Metodinformation
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Parametrar
- participant
- CommunicationUserIdentifier
Returer
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Lägger till en ny deltagare i samtalet.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Parametrar
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Returer
Promise<void>
askDevicePermission(PermissionConstraints)
Be om behörigheter för enheter.
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>
Parametrar
- constrain
- PermissionConstraints
Definiera begränsningar för åtkomst till lokala enheter <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Returer
Promise<DeviceAccess>
Kommentarer
Webbläsarbehörighetsfönstret visas om behörigheter inte har beviljats ännu.
createStreamView(string, VideoStreamOptions)
Skapa html-vyn för en dataström.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>
Parametrar
- remoteUserId
-
string
ID för deltagaren som ska återges, lämna det odefinierat för att skapa den lokala kameravyn
- options
- VideoStreamOptions
Alternativ för att styra hur videoströmmar återges <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Returer
Promise<void | CreateVideoStreamViewResult>
Kommentarer
Den här metoden implementeras för sammansatt.
createTogetherModeStreamView(TogetherModeStreamOptions)
Skapa html-vyn för en togethermode-ström.
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>
Parametrar
- options
- TogetherModeStreamOptions
Alternativ för att styra hur videoströmmar återges <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Returer
Promise<void | TogetherModeStreamViewResult>
Kommentarer
Den här metoden implementeras för sammansatta
deleteMessage(string)
Ta bort ett meddelande i tråden.
function deleteMessage(messageId: string): Promise<void>
Parametrar
- messageId
-
string
Returer
Promise<void>
disposeLocalVideoStreamView()
Ta bort html-vyn för en lokal videoström
function disposeLocalVideoStreamView(): Promise<void>
Returer
Promise<void>
disposeRemoteVideoStreamView(string)
Ta bort html-vyn för en fjärrvideoström
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>
Parametrar
- remoteUserId
-
string
ID för den deltagare som ska disponeras
Returer
Promise<void>
disposeScreenShareStreamView(string)
Ta bort html-vyn för en skärmdelningsström
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>
Parametrar
- remoteUserId
-
string
ID för deltagaren som skärmdelningsströmvyn ska disponeras för.
Returer
Promise<void>
Kommentarer
Den här metoden implementeras för sammansatta
disposeStreamView(string, VideoStreamOptions)
Ta bort html-vyn för en dataström.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>
Parametrar
- remoteUserId
-
string
ID för deltagaren som ska återges, lämna det odefinierat för att ta bort den lokala kameravyn
- options
- VideoStreamOptions
Alternativ för att styra hur videoströmmar återges <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Returer
Promise<void>
Kommentarer
Den här metoden implementeras för sammansatt.
disposeTogetherModeStreamView()
Ta bort html-vyn för en togethermode-ström.
function disposeTogetherModeStreamView(): Promise<void>
Returer
Promise<void>
Kommentarer
Den här metoden implementeras för sammansatta
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Parametrar
- resourceDetails
- ResourceDetails
Returer
Promise<void>
fetchInitialData()
Hämta initialt tillstånd för chattkortet.
Utför den minimala hämtning som krävs för ChatComposite- och API-metoder.
function fetchInitialData(): Promise<void>
Returer
Promise<void>
holdCall()
Placerar samtalet i ett lokalt undantag.
function holdCall(): Promise<void>
Returer
Promise<void>
joinCall(boolean)
Varning
Det här API:et är nu inaktuellt.
Use joinCall(options?:JoinCallOptions) instead.
Anslut samtalet med mikrofonen först på/av.
function joinCall(microphoneOn?: boolean): undefined | Call
Parametrar
- microphoneOn
-
boolean
Om mikrofonen är aktiverad från början
Returer
undefined | Call
joinCall(JoinCallOptions)
Gå med i samtalet med alternativpåse för att ställa in mikrofonens/kamerans initiala tillstånd när du går med i samtalet true = slå på enheten när du går med i samtalet false = stäng av enheten när du går med i samtalet 'behåll'/odefinierad = behåll enheternas föranropstillstånd
function joinCall(options?: JoinCallOptions): undefined | Call
Parametrar
- options
- JoinCallOptions
Param för att ställa in mikrofonen/kameran initialt på/av/använd församtalsläge.
Returer
undefined | Call
leaveCall(boolean)
Lämna samtalet.
function leaveCall(forEveryone?: boolean): Promise<void>
Parametrar
- forEveryone
-
boolean
Om alla deltagare ska tas bort när de lämnar
Returer
Promise<void>
loadPreviousChatMessages(number)
Läs in fler tidigare meddelanden i chatttrådshistoriken.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
Parametrar
- messagesToLoad
-
number
Returer
Promise<boolean>
Kommentarer
Den här metoden används vanligtvis för att styra inkrementell hämtning/oändlig rullning.
lowerHand()
Sänk handen för lokal användare.
function lowerHand(): Promise<void>
Returer
Promise<void>
mute()
Stäng av den aktuella användaren under anropet eller inaktivera mikrofonen lokalt.
function mute(): Promise<void>
Returer
Promise<void>
muteAllRemoteParticipants()
Stänga av ljudet för en deltagare
function muteAllRemoteParticipants(): Promise<void>
Returer
Promise<void>
muteParticipant(string)
Stänga av ljudet för en deltagare
function muteParticipant(userId: string): Promise<void>
Parametrar
- userId
-
string
Returer
Promise<void>
onReactionClick(Reaction)
Skicka Reaktion till pågående möte.
function onReactionClick(reaction: Reaction): Promise<void>
Parametrar
- reaction
- Reaction
Ett värde av typen <xref:%40azure%2Fcommunication-calling%23Reaction>
Returer
Promise<void>
queryCameras()
Fråga efter tillgängliga kameraenheter.
function queryCameras(): Promise<VideoDeviceInfo[]>
Returer
Promise<VideoDeviceInfo[]>
En matris med entiteter för videoenhetsinformation <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Kommentarer
Den här metoden ska anropas efter askDevicePermission()
queryMicrophones()
Fråga efter tillgängliga mikrofonenheter.
function queryMicrophones(): Promise<AudioDeviceInfo[]>
Returer
Promise<AudioDeviceInfo[]>
En matris med informationsentiteter för ljudenheter <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Kommentarer
Den här metoden ska anropas efter askDevicePermission()
querySpeakers()
Fråga efter tillgängliga mikrofonenheter.
function querySpeakers(): Promise<AudioDeviceInfo[]>
Returer
Promise<AudioDeviceInfo[]>
En matris med informationsentiteter för ljudenheter <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Kommentarer
Den här metoden ska anropas efter askDevicePermission()
raiseHand()
Räck upp handen för den lokala användaren.
function raiseHand(): Promise<void>
Returer
Promise<void>
removeParticipant(CommunicationIdentifier)
Ta bort en deltagare från anropet.
function removeParticipant(participant: CommunicationIdentifier): Promise<void>
Parametrar
- participant
- CommunicationIdentifier
<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> för deltagaren som ska tas bort
Returer
Promise<void>
removeParticipant(string)
Ta bort en deltagare från ett samtal.
function removeParticipant(userId: string): Promise<void>
Parametrar
- userId
-
string
UserId för deltagaren att ta bort.
Returer
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
Parametrar
- resourceDetails
- ResourceDetails
resumeCall()
Återupptar anropet från ett LocalHold-tillstånd.
function resumeCall(): Promise<void>
Returer
Promise<void>
returnFromBreakoutRoom()
Återgå till ursprungsanropet för breakout room
function returnFromBreakoutRoom(): Promise<void>
Returer
Promise<void>
sendMessage(string, SendMessageOptions)
Skicka ett meddelande i tråden.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parametrar
- content
-
string
- options
- SendMessageOptions
Returer
Promise<void>
sendReadReceipt(string)
Skicka ett läskvitto för ett meddelande.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parametrar
- chatMessageId
-
string
Returer
Promise<void>
sendTypingIndicator()
Skicka inmatningsindikatorn i tråden.
function sendTypingIndicator(): Promise<void>
Returer
Promise<void>
setCamera(VideoDeviceInfo, VideoStreamOptions)
Ställ in kameran som ska användas i samtalet.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>
Parametrar
- sourceInfo
- VideoDeviceInfo
Kameraenhet att välja, välj en som returneras av queryCameras
- options
- VideoStreamOptions
Alternativ för att styra hur kameraströmmen återges <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Returer
Promise<void>
setCaptionLanguage(string)
Funktion för att ställa in bildtextspråk
function setCaptionLanguage(language: string): Promise<void>
Parametrar
- language
-
string
Språk inställt för bildtext
Returer
Promise<void>
setMicrophone(AudioDeviceInfo)
Ställ in mikrofonen som ska användas i samtalet.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>
Parametrar
- sourceInfo
- AudioDeviceInfo
Mikrofonenhet att välja, välj en som returneras av frågaMicrophones
Returer
Promise<void>
setSpeaker(AudioDeviceInfo)
Ställ in högtalaren som ska användas i anropet.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>
Parametrar
- sourceInfo
- AudioDeviceInfo
Talarenhet att välja, välj en som returneras av querySpeakers
Returer
Promise<void>
setSpokenLanguage(string)
Funktion för att ställa in talat språk
function setSpokenLanguage(language: string): Promise<void>
Parametrar
- language
-
string
talat språk
Returer
Promise<void>
setTogetherModeSceneSize(number, number)
Beräkna om sittplatserna för tillsammans-läget.
function setTogetherModeSceneSize(width: number, height: number)
Parametrar
- width
-
number
Behållarens bredd
- height
-
number
Behållarens höjd
Kommentarer
Den här metoden implementeras för sammansatta
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
Starta samtalet.
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call
Parametrar
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
En matris med <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> som ska anropas
- options
- StartCallOptions
Returer
undefined | Call
startCall(string[], StartCallOptions)
Starta samtalet.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
Parametrar
- participants
-
string[]
En matris med deltagar-ID:t som ska kopplas
- options
- StartCallOptions
Returer
undefined | Call
startCamera(VideoStreamOptions)
Starta kameran.
Den här metoden börjar återge en lokal kameravy när anropet inte är aktivt.
function startCamera(options?: VideoStreamOptions): Promise<void>
Parametrar
- options
- VideoStreamOptions
Alternativ för att styra hur videoströmmar återges <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Returer
Promise<void>
startCaptions(StartCaptionsAdapterOptions)
Funktion för att starta bildtexter
function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>
Parametrar
- options
- StartCaptionsAdapterOptions
Alternativ för starttexter
Returer
Promise<void>
startNoiseSuppressionEffect()
Starta brusdämpningseffekten.
function startNoiseSuppressionEffect(): Promise<void>
Returer
Promise<void>
startScreenShare()
Börja dela skärmen under ett samtal.
function startScreenShare(): Promise<void>
Returer
Promise<void>
startSpotlight(string[])
Starta spotlight
function startSpotlight(userIds?: string[]): Promise<void>
Parametrar
- userIds
-
string[]
Returer
Promise<void>
startTogetherMode()
Starta tillsammans-läge.
function startTogetherMode(): Promise<void>
Returer
Promise<void>
Kommentarer
Den här metoden implementeras för sammansatta
startVideoBackgroundEffect(VideoBackgroundEffect)
Starta videobakgrundseffekten.
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>
Parametrar
- videoBackgroundEffect
- VideoBackgroundEffect
Returer
Promise<void>
stopAllSpotlight()
Stoppa alla spotlights
function stopAllSpotlight(): Promise<void>
Returer
Promise<void>
stopCamera()
Stoppa kameran.
Den här metoden slutar återge en lokal kameravy när anropet inte är aktivt.
function stopCamera(): Promise<void>
Returer
Promise<void>
stopCaptions(StopCaptionsAdapterOptions)
Funktion för att stoppa textning
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Parametrar
- options
- StopCaptionsAdapterOptions
Returer
Promise<void>
stopNoiseSuppressionEffect()
Starta brusdämpningseffekten.
function stopNoiseSuppressionEffect(): Promise<void>
Returer
Promise<void>
stopScreenShare()
Sluta dela skärmen.
function stopScreenShare(): Promise<void>
Returer
Promise<void>
stopSpotlight(string[])
Stoppa spotlight
function stopSpotlight(userIds?: string[]): Promise<void>
Parametrar
- userIds
-
string[]
Returer
Promise<void>
stopVideoBackgroundEffects()
Stoppa videobakgrundseffekten.
function stopVideoBackgroundEffects(): Promise<void>
Returer
Promise<void>
submitSurvey(CallSurvey)
Skicka resultatet av undersökningen om samtalets slut
function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>
Parametrar
- survey
- CallSurvey
Returer
Promise<undefined | CallSurveyResponse>
unmute()
Slå på ljudet för den aktuella användaren under anropet eller aktivera mikrofonen lokalt.
function unmute(): Promise<void>
Returer
Promise<void>
updateBackgroundPickerImages(VideoBackgroundImage[])
Åsidosätt bakgrundsväljarens bilder för att få en bakgrundsersättningseffekt.
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])
Parametrar
- backgroundImages
Matris med anpassade bakgrundsbilder.
updateMessage(string, string, Record<string, string>)
Uppdatera ett meddelandeinnehåll.
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>
Parametrar
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
Returer
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Uppdatera den valda videobakgrundseffekten
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parametrar
- selectedVideoBackground
- VideoBackgroundEffect