Dela via


CallWithChatAdapter interface

CallWithChatComposite Adapter-gränssnittet.

Extends

Ärvda egenskaper

forbidAudio

Förbjuder ljud för de angivna användar-ID:na.

forbidOthersAudio

förbjuder ljud för Teams-mötesdeltagare förutom den lokala användaren.

forbidOthersVideo

förbjuder video för Teams-mötesdeltagare förutom den lokala användaren.

forbidVideo

Förbjuder video för de angivna användar-ID:na.

permitAudio

Tillåter ljud för de angivna användar-ID:na.

permitOthersAudio

tillåter ljud för Teams-mötesdeltagare förutom den lokala användaren.

permitOthersVideo

tillåter video för Teams-mötesdeltagare förutom den lokala användaren.

permitVideo

Tillåter video för de angivna användar-ID:na.

sendDtmfTone

Skicka DTMF-ton till en annan deltagare i samtalet i 1:1-samtal

sendRealTimeText

Skicka text i realtid

Ärvda metoder

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Lägger till en ny deltagare i samtalet.

askDevicePermission(PermissionConstraints)

Be om behörigheter för enheter.

createStreamView(string, VideoStreamOptions)

Skapa html-vyn för en dataström.

createTogetherModeStreamView(TogetherModeStreamOptions)

Skapa html-vyn för en togethermode-ström.

deleteMessage(string)

Ta bort ett meddelande i tråden.

dispose()

Ta bort sammansatta

disposeLocalVideoStreamView()

Ta bort html-vyn för en lokal videoström

disposeRemoteVideoStreamView(string)

Ta bort html-vyn för en fjärrvideoström

disposeScreenShareStreamView(string)

Ta bort html-vyn för en skärmdelningsström

disposeStreamView(string, VideoStreamOptions)

Ta bort html-vyn för en dataström.

disposeTogetherModeStreamView()

Ta bort html-vyn för en togethermode-ström.

downloadResourceToCache(ResourceDetails)
fetchInitialData()

Hämta initialt tillstånd för chattkortet.

Utför den minimala hämtning som krävs för ChatComposite- och API-metoder.

getState()

Hämta aktuellt tillstånd

holdCall()

Placerar samtalet i ett lokalt undantag.

joinCall(boolean)

Anslut samtalet med mikrofonen först på/av.

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

leaveCall(boolean)

Lämna samtalet.

loadPreviousChatMessages(number)

Läs in fler tidigare meddelanden i chatttrådshistoriken.

lowerHand()

Sänk handen för lokal användare.

mute()

Stäng av den aktuella användaren under anropet eller inaktivera mikrofonen lokalt.

muteAllRemoteParticipants()

Stänga av ljudet för en deltagare

muteParticipant(string)

Stänga av ljudet för en deltagare

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
off("callEnded", CallEndedListener)
off("callError", (e: AdapterError) => void)
off("callIdChanged", CallIdChangedListener)
off("callParticipantsJoined", ParticipantsJoinedListener)
off("callParticipantsLeft", ParticipantsLeftListener)
off("capabilitiesChanged", CapabilitiesChangedListener)
off("captionsReceived", CaptionsReceivedListener)
off("chatError", (e: AdapterError) => void)
off("chatInitialized", ChatInitializedListener)
off("chatParticipantsAdded", ParticipantsAddedListener)
off("chatParticipantsRemoved", ParticipantsRemovedListener)
off("displayNameChanged", DisplayNameChangedListener)
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
off("isMutedChanged", IsMutedChangedListener)
off("isSpeakingChanged", IsSpeakingChangedListener)
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
off("messageDeleted", MessageReceivedListener)
off("messageEdited", MessageReceivedListener)
off("messageRead", MessageReadListener)
off("messageReceived", MessageReceivedListener)
off("messageSent", MessageReceivedListener)
off("realTimeTextReceived", RealTimeTextReceivedListener)
off("selectedMicrophoneChanged", PropertyChangedEvent)
off("selectedSpeakerChanged", PropertyChangedEvent)
off("spotlightChanged", SpotlightChangedListener)
offStateChange((state: CallWithChatAdapterState) => void)

Avregistrerar hanteraren till stateChanged-händelser.

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
on("callEnded", CallEndedListener)
on("callError", (e: AdapterError) => void)
on("callIdChanged", CallIdChangedListener)
on("callParticipantsJoined", ParticipantsJoinedListener)
on("callParticipantsLeft", ParticipantsLeftListener)
on("capabilitiesChanged", CapabilitiesChangedListener)
on("captionsReceived", CaptionsReceivedListener)
on("chatError", (e: AdapterError) => void)
on("chatInitialized", ChatInitializedListener)
on("chatParticipantsAdded", ParticipantsAddedListener)
on("chatParticipantsRemoved", ParticipantsRemovedListener)
on("displayNameChanged", DisplayNameChangedListener)
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
on("isMutedChanged", IsMutedChangedListener)
on("isSpeakingChanged", IsSpeakingChangedListener)
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
on("messageDeleted", MessageReceivedListener)
on("messageEdited", MessageReceivedListener)
on("messageRead", MessageReadListener)
on("messageReceived", MessageReceivedListener)
on("messageSent", MessageReceivedListener)
on("realTimeTextReceived", RealTimeTextReceivedListener)
on("selectedMicrophoneChanged", PropertyChangedEvent)
on("selectedSpeakerChanged", PropertyChangedEvent)
on("spotlightChanged", SpotlightChangedListener)
onReactionClick(Reaction)

Skicka Reaktion till pågående möte.

onStateChange((state: CallWithChatAdapterState) => void)

Prenumererar hanteraren på stateChanged-händelser.

queryCameras()

Fråga efter tillgängliga kameraenheter.

queryMicrophones()

Fråga efter tillgängliga mikrofonenheter.

querySpeakers()

Fråga efter tillgängliga mikrofonenheter.

raiseHand()

Räck upp handen för den lokala användaren.

removeParticipant(CommunicationIdentifier)

Ta bort en deltagare från anropet.

removeParticipant(string)

Ta bort en deltagare från ett samtal.

removeResourceFromCache(ResourceDetails)
resumeCall()

Återupptar anropet från ett LocalHold-tillstånd.

returnFromBreakoutRoom()

Återgå till ursprungsanropet för breakout room

sendMessage(string, SendMessageOptions)

Skicka ett meddelande i tråden.

sendReadReceipt(string)

Skicka ett läskvitto för ett meddelande.

sendTypingIndicator()

Skicka inmatningsindikatorn i tråden.

setCamera(VideoDeviceInfo, VideoStreamOptions)

Ställ in kameran som ska användas i samtalet.

setCaptionLanguage(string)

Funktion för att ställa in bildtextspråk

setMicrophone(AudioDeviceInfo)

Ställ in mikrofonen som ska användas i samtalet.

setSpeaker(AudioDeviceInfo)

Ställ in högtalaren som ska användas i anropet.

setSpokenLanguage(string)

Funktion för att ställa in talat språk

setTogetherModeSceneSize(number, number)

Beräkna om sittplatserna för tillsammans-läget.

startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)

Starta samtalet.

startCall(string[], StartCallOptions)

Starta samtalet.

startCamera(VideoStreamOptions)

Starta kameran.

Den här metoden börjar återge en lokal kameravy när anropet inte är aktivt.

startCaptions(StartCaptionsAdapterOptions)

Funktion för att starta bildtexter

startNoiseSuppressionEffect()

Starta brusdämpningseffekten.

startScreenShare()

Börja dela skärmen under ett samtal.

startSpotlight(string[])

Starta spotlight

startTogetherMode()

Starta tillsammans-läge.

startVideoBackgroundEffect(VideoBackgroundEffect)

Starta videobakgrundseffekten.

stopAllSpotlight()

Stoppa alla spotlights

stopCamera()

Stoppa kameran.

Den här metoden slutar återge en lokal kameravy när anropet inte är aktivt.

stopCaptions(StopCaptionsAdapterOptions)

Funktion för att stoppa textning

stopNoiseSuppressionEffect()

Starta brusdämpningseffekten.

stopScreenShare()

Sluta dela skärmen.

stopSpotlight(string[])

Stoppa spotlight

stopVideoBackgroundEffects()

Stoppa videobakgrundseffekten.

submitSurvey(CallSurvey)

Skicka resultatet av undersökningen om samtalets slut

unmute()

Slå på ljudet för den aktuella användaren under anropet eller aktivera mikrofonen lokalt.

updateBackgroundPickerImages(VideoBackgroundImage[])

Åsidosätt bakgrundsväljarens bilder för att få en bakgrundsersättningseffekt.

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

Uppdatera ett meddelandeinnehåll.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Uppdatera den valda videobakgrundseffekten

Information om ärvda egenskaper

forbidAudio

Förbjuder ljud för de angivna användar-ID:na.

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

Egenskapsvärde

(userIds: string[]) => Promise<void>

Ärvd frånCallWithChatAdapterManagement.forbidAudio

forbidOthersAudio

förbjuder ljud för Teams-mötesdeltagare förutom den lokala användaren.

forbidOthersAudio: () => Promise<void>

Egenskapsvärde

() => Promise<void>

Ärvd frånCallWithChatAdapterManagement.forbidOthersAudio

forbidOthersVideo

förbjuder video för Teams-mötesdeltagare förutom den lokala användaren.

forbidOthersVideo: () => Promise<void>

Egenskapsvärde

() => Promise<void>

Ärvd frånCallWithChatAdapterManagement.forbidOthersVideo

forbidVideo

Förbjuder video för de angivna användar-ID:na.

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

Egenskapsvärde

(userIds: string[]) => Promise<void>

Ärvd frånCallWithChatAdapterManagement.forbidVideo

permitAudio

Tillåter ljud för de angivna användar-ID:na.

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

Egenskapsvärde

(userIds: string[]) => Promise<void>

Ärvd frånCallWithChatAdapterManagement.permitAudio

permitOthersAudio

tillåter ljud för Teams-mötesdeltagare förutom den lokala användaren.

permitOthersAudio: () => Promise<void>

Egenskapsvärde

() => Promise<void>

Ärvd frånCallWithChatAdapterManagement.permitOthersAudio

permitOthersVideo

tillåter video för Teams-mötesdeltagare förutom den lokala användaren.

permitOthersVideo: () => Promise<void>

Egenskapsvärde

() => Promise<void>

Ärvd frånCallWithChatAdapterManagement.permitOthersVideo

permitVideo

Tillåter video för de angivna användar-ID:na.

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

Egenskapsvärde

(userIds: string[]) => Promise<void>

Ärvd frånCallWithChatAdapterManagement.permitVideo

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>

Ärvd frånCallWithChatAdapterManagement.sendDtmfTone

sendRealTimeText

Skicka text i realtid

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

Egenskapsvärde

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

Ärvd frånCallWithChatAdapterManagement.sendRealTimeText

Ärvd metodinformation

addParticipant(CommunicationUserIdentifier)

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

Parametrar

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Lägger till en ny deltagare i samtalet.

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

Parametrar

participant
PhoneNumberIdentifier

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.addParticipant

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.

ärvd frånCallWithChatAdapterManagement.askDevicePermission

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.

ärvd frånCallWithChatAdapterManagement.createStreamView

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

Kommentarer

Den här metoden implementeras för sammansatta

Ärvd frånCallWithChatAdapterManagement.createTogetherModeStreamView

deleteMessage(string)

Ta bort ett meddelande i tråden.

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

Parametrar

messageId

string

Returer

Promise<void>

ärvd frånCallWithChatAdapterManagement.deleteMessage

dispose()

Ta bort sammansatta

function dispose()

Ärvt frånDisposable_2.dispose

disposeLocalVideoStreamView()

Ta bort html-vyn för en lokal videoström

function disposeLocalVideoStreamView(): Promise<void>

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.disposeLocalVideoStreamView

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>

Ärvd frånCallWithChatAdapterManagement.disposeRemoteVideoStreamView

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

Ärvd frånCallWithChatAdapterManagement.disposeScreenShareStreamView

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.

ärvd frånCallWithChatAdapterManagement.disposeStreamView

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

Ärvd frånCallWithChatAdapterManagement.disposeTogetherModeStreamView

downloadResourceToCache(ResourceDetails)

function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>

Parametrar

resourceDetails
ResourceDetails

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.downloadResourceToCache

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>

ärvd frånCallWithChatAdapterManagement.fetchInitialData

getState()

Hämta aktuellt tillstånd

function getState(): CallWithChatAdapterState

Returer

ärvd frånAdapterState.getState

holdCall()

Placerar samtalet i ett lokalt undantag.

function holdCall(): Promise<void>

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.holdCall

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

ärvd frånCallWithChatAdapterManagement.joinCall

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

ärvd frånCallWithChatAdapterManagement.joinCall

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>

ärvd frånCallWithChatAdapterManagement.leaveCall

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.

ärvd frånCallWithChatAdapterManagement.loadPreviousChatMessages

lowerHand()

Sänk handen för lokal användare.

function lowerHand(): Promise<void>

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.lowerHand

mute()

Stäng av den aktuella användaren under anropet eller inaktivera mikrofonen lokalt.

function mute(): Promise<void>

Returer

Promise<void>

ärvd frånCallWithChatAdapterManagement.mute

muteAllRemoteParticipants()

Stänga av ljudet för en deltagare

function muteAllRemoteParticipants(): Promise<void>

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.muteAllRemoteParticipants

muteParticipant(string)

Stänga av ljudet för en deltagare

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

Parametrar

userId

string

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parametrar

event

"breakoutRoomsUpdated"

ärvd frånCallWithChatAdapterSubscriptions.off

off("callEnded", CallEndedListener)

function off(event: "callEnded", listener: CallEndedListener)

Parametrar

event

"callEnded"

ärvd frånCallWithChatAdapterSubscriptions.off

off("callError", (e: AdapterError) => void)

function off(event: "callError", listener: (e: AdapterError) => void)

Parametrar

event

"callError"

listener

(e: AdapterError) => void

ärvd frånCallWithChatAdapterSubscriptions.off

off("callIdChanged", CallIdChangedListener)

function off(event: "callIdChanged", listener: CallIdChangedListener)

Parametrar

event

"callIdChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("callParticipantsJoined", ParticipantsJoinedListener)

function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)

Parametrar

event

"callParticipantsJoined"

ärvd frånCallWithChatAdapterSubscriptions.off

off("callParticipantsLeft", ParticipantsLeftListener)

function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)

Parametrar

event

"callParticipantsLeft"

ärvd frånCallWithChatAdapterSubscriptions.off

off("capabilitiesChanged", CapabilitiesChangedListener)

function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parametrar

event

"capabilitiesChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("captionsReceived", CaptionsReceivedListener)

function off(event: "captionsReceived", listener: CaptionsReceivedListener)

Parametrar

event

"captionsReceived"

ärvd frånCallWithChatAdapterSubscriptions.off

off("chatError", (e: AdapterError) => void)

function off(event: "chatError", listener: (e: AdapterError) => void)

Parametrar

event

"chatError"

listener

(e: AdapterError) => void

ärvd frånCallWithChatAdapterSubscriptions.off

off("chatInitialized", ChatInitializedListener)

function off(event: "chatInitialized", listener: ChatInitializedListener)

Parametrar

event

"chatInitialized"

ärvd frånCallWithChatAdapterSubscriptions.off

off("chatParticipantsAdded", ParticipantsAddedListener)

function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parametrar

event

"chatParticipantsAdded"

ärvd frånCallWithChatAdapterSubscriptions.off

off("chatParticipantsRemoved", ParticipantsRemovedListener)

function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parametrar

event

"chatParticipantsRemoved"

ärvd frånCallWithChatAdapterSubscriptions.off

off("displayNameChanged", DisplayNameChangedListener)

function off(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parametrar

event

"displayNameChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parametrar

event

"isCaptionLanguageChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parametrar

event

"isCaptionsActiveChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parametrar

event

"isLocalScreenSharingActiveChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("isMutedChanged", IsMutedChangedListener)

function off(event: "isMutedChanged", listener: IsMutedChangedListener)

Parametrar

event

"isMutedChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("isSpeakingChanged", IsSpeakingChangedListener)

function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parametrar

event

"isSpeakingChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parametrar

event

"isSpokenLanguageChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("messageDeleted", MessageReceivedListener)

function off(event: "messageDeleted", listener: MessageReceivedListener)

Parametrar

event

"messageDeleted"

ärvd frånCallWithChatAdapterSubscriptions.off

off("messageEdited", MessageReceivedListener)

function off(event: "messageEdited", listener: MessageReceivedListener)

Parametrar

event

"messageEdited"

ärvd frånCallWithChatAdapterSubscriptions.off

off("messageRead", MessageReadListener)

function off(event: "messageRead", listener: MessageReadListener)

Parametrar

event

"messageRead"

ärvd frånCallWithChatAdapterSubscriptions.off

off("messageReceived", MessageReceivedListener)

function off(event: "messageReceived", listener: MessageReceivedListener)

Parametrar

event

"messageReceived"

ärvd frånCallWithChatAdapterSubscriptions.off

off("messageSent", MessageReceivedListener)

function off(event: "messageSent", listener: MessageReceivedListener)

Parametrar

event

"messageSent"

ärvd frånCallWithChatAdapterSubscriptions.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parametrar

event

"realTimeTextReceived"

ärvd frånCallWithChatAdapterSubscriptions.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parametrar

event

"selectedMicrophoneChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("selectedSpeakerChanged", PropertyChangedEvent)

function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parametrar

event

"selectedSpeakerChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

off("spotlightChanged", SpotlightChangedListener)

function off(event: "spotlightChanged", listener: SpotlightChangedListener)

Parametrar

event

"spotlightChanged"

ärvd frånCallWithChatAdapterSubscriptions.off

offStateChange((state: CallWithChatAdapterState) => void)

Avregistrerar hanteraren till stateChanged-händelser.

function offStateChange(handler: (state: CallWithChatAdapterState) => void)

Parametrar

handler

(state: CallWithChatAdapterState) => void

ärvd frånAdapterState.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)

Parametrar

event

"breakoutRoomsUpdated"

ärvd frånCallWithChatAdapterSubscriptions.on

on("callEnded", CallEndedListener)

function on(event: "callEnded", listener: CallEndedListener)

Parametrar

event

"callEnded"

ärvd frånCallWithChatAdapterSubscriptions.on

on("callError", (e: AdapterError) => void)

function on(event: "callError", listener: (e: AdapterError) => void)

Parametrar

event

"callError"

listener

(e: AdapterError) => void

ärvd frånCallWithChatAdapterSubscriptions.on

on("callIdChanged", CallIdChangedListener)

function on(event: "callIdChanged", listener: CallIdChangedListener)

Parametrar

event

"callIdChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("callParticipantsJoined", ParticipantsJoinedListener)

function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)

Parametrar

event

"callParticipantsJoined"

ärvd frånCallWithChatAdapterSubscriptions.on

on("callParticipantsLeft", ParticipantsLeftListener)

function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)

Parametrar

event

"callParticipantsLeft"

ärvd frånCallWithChatAdapterSubscriptions.on

on("capabilitiesChanged", CapabilitiesChangedListener)

function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)

Parametrar

event

"capabilitiesChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("captionsReceived", CaptionsReceivedListener)

function on(event: "captionsReceived", listener: CaptionsReceivedListener)

Parametrar

event

"captionsReceived"

ärvd frånCallWithChatAdapterSubscriptions.on

on("chatError", (e: AdapterError) => void)

function on(event: "chatError", listener: (e: AdapterError) => void)

Parametrar

event

"chatError"

listener

(e: AdapterError) => void

ärvd frånCallWithChatAdapterSubscriptions.on

on("chatInitialized", ChatInitializedListener)

function on(event: "chatInitialized", listener: ChatInitializedListener)

Parametrar

event

"chatInitialized"

ärvd frånCallWithChatAdapterSubscriptions.on

on("chatParticipantsAdded", ParticipantsAddedListener)

function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)

Parametrar

event

"chatParticipantsAdded"

ärvd frånCallWithChatAdapterSubscriptions.on

on("chatParticipantsRemoved", ParticipantsRemovedListener)

function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)

Parametrar

event

"chatParticipantsRemoved"

ärvd frånCallWithChatAdapterSubscriptions.on

on("displayNameChanged", DisplayNameChangedListener)

function on(event: "displayNameChanged", listener: DisplayNameChangedListener)

Parametrar

event

"displayNameChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)

Parametrar

event

"isCaptionLanguageChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)

Parametrar

event

"isCaptionsActiveChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)

Parametrar

event

"isLocalScreenSharingActiveChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("isMutedChanged", IsMutedChangedListener)

function on(event: "isMutedChanged", listener: IsMutedChangedListener)

Parametrar

event

"isMutedChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("isSpeakingChanged", IsSpeakingChangedListener)

function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)

Parametrar

event

"isSpeakingChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)

Parametrar

event

"isSpokenLanguageChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("messageDeleted", MessageReceivedListener)

function on(event: "messageDeleted", listener: MessageReceivedListener)

Parametrar

event

"messageDeleted"

ärvd frånCallWithChatAdapterSubscriptions.on

on("messageEdited", MessageReceivedListener)

function on(event: "messageEdited", listener: MessageReceivedListener)

Parametrar

event

"messageEdited"

ärvd frånCallWithChatAdapterSubscriptions.on

on("messageRead", MessageReadListener)

function on(event: "messageRead", listener: MessageReadListener)

Parametrar

event

"messageRead"

ärvd frånCallWithChatAdapterSubscriptions.on

on("messageReceived", MessageReceivedListener)

function on(event: "messageReceived", listener: MessageReceivedListener)

Parametrar

event

"messageReceived"

ärvd frånCallWithChatAdapterSubscriptions.on

on("messageSent", MessageReceivedListener)

function on(event: "messageSent", listener: MessageReceivedListener)

Parametrar

event

"messageSent"

ärvd frånCallWithChatAdapterSubscriptions.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)

Parametrar

event

"realTimeTextReceived"

ärvd frånCallWithChatAdapterSubscriptions.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)

Parametrar

event

"selectedMicrophoneChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("selectedSpeakerChanged", PropertyChangedEvent)

function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)

Parametrar

event

"selectedSpeakerChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

on("spotlightChanged", SpotlightChangedListener)

function on(event: "spotlightChanged", listener: SpotlightChangedListener)

Parametrar

event

"spotlightChanged"

ärvd frånCallWithChatAdapterSubscriptions.on

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>

Ärvd frånCallWithChatAdapterManagement.onReactionClick

onStateChange((state: CallWithChatAdapterState) => void)

Prenumererar hanteraren på stateChanged-händelser.

function onStateChange(handler: (state: CallWithChatAdapterState) => void)

Parametrar

handler

(state: CallWithChatAdapterState) => void

ärvd frånAdapterState.onStateChange

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

ärvd frånCallWithChatAdapterManagement.queryCameras

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

ärvd frånCallWithChatAdapterManagement.queryMicrophones

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

ärvd frånCallWithChatAdapterManagement.querySpeakers

raiseHand()

Räck upp handen för den lokala användaren.

function raiseHand(): Promise<void>

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.raiseHand

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>

ärvd frånCallWithChatAdapterManagement.removeParticipant

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>

ärvd frånCallWithChatAdapterManagement.removeParticipant

removeResourceFromCache(ResourceDetails)

function removeResourceFromCache(resourceDetails: ResourceDetails)

Parametrar

resourceDetails
ResourceDetails

Ärvd frånCallWithChatAdapterManagement.removeResourceFromCache

resumeCall()

Återupptar anropet från ett LocalHold-tillstånd.

function resumeCall(): Promise<void>

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.resumeCall

returnFromBreakoutRoom()

Återgå till ursprungsanropet för breakout room

function returnFromBreakoutRoom(): Promise<void>

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.returnFromBreakoutRoom

sendMessage(string, SendMessageOptions)

Skicka ett meddelande i tråden.

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

Parametrar

content

string

Returer

Promise<void>

ärvd frånCallWithChatAdapterManagement.sendMessage

sendReadReceipt(string)

Skicka ett läskvitto för ett meddelande.

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

Parametrar

chatMessageId

string

Returer

Promise<void>

ärvd frånCallWithChatAdapterManagement.sendReadReceipt

sendTypingIndicator()

Skicka inmatningsindikatorn i tråden.

function sendTypingIndicator(): Promise<void>

Returer

Promise<void>

ärvd frånCallWithChatAdapterManagement.sendTypingIndicator

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>

Ärvd frånCallWithChatAdapterManagement.setCamera

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>

Ärvd frånCallWithChatAdapterManagement.setCaptionLanguage

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>

ärvd frånCallWithChatAdapterManagement.setMicrophone

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>

ärvd frånCallWithChatAdapterManagement.setSpeaker

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>

Ärvd frånCallWithChatAdapterManagement.setSpokenLanguage

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

Ärvd frånCallWithChatAdapterManagement.setTogetherModeSceneSize

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

Returer

undefined | Call

ärvd frånCallWithChatAdapterManagement.startCall

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

Returer

undefined | Call

ärvd frånCallWithChatAdapterManagement.startCall

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>

ärvd frånCallWithChatAdapterManagement.startCamera

startCaptions(StartCaptionsAdapterOptions)

Funktion för att starta bildtexter

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

Parametrar

options
StartCaptionsAdapterOptions

Alternativ för starttexter

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.startCaptions

startNoiseSuppressionEffect()

Starta brusdämpningseffekten.

function startNoiseSuppressionEffect(): Promise<void>

Returer

Promise<void>

Ärvt frånCallWithChatAdapterManagement.startNoiseSuppressionEffect

startScreenShare()

Börja dela skärmen under ett samtal.

function startScreenShare(): Promise<void>

Returer

Promise<void>

ärvd frånCallWithChatAdapterManagement.startScreenShare

startSpotlight(string[])

Starta spotlight

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

Parametrar

userIds

string[]

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.startSpotlight

startTogetherMode()

Starta tillsammans-läge.

function startTogetherMode(): Promise<void>

Returer

Promise<void>

Kommentarer

Den här metoden implementeras för sammansatta

Ärvd frånCallWithChatAdapterManagement.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Starta videobakgrundseffekten.

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

Parametrar

videoBackgroundEffect
VideoBackgroundEffect

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.startVideoBackgroundEffect

stopAllSpotlight()

Stoppa alla spotlights

function stopAllSpotlight(): Promise<void>

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.stopAllSpotlight

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>

ärvd frånCallWithChatAdapterManagement.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funktion för att stoppa textning

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

Parametrar

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.stopCaptions

stopNoiseSuppressionEffect()

Starta brusdämpningseffekten.

function stopNoiseSuppressionEffect(): Promise<void>

Returer

Promise<void>

Ärvt frånCallWithChatAdapterManagement.stopNoiseSuppressionEffect

stopScreenShare()

Sluta dela skärmen.

function stopScreenShare(): Promise<void>

Returer

Promise<void>

ärvd frånCallWithChatAdapterManagement.stopScreenShare

stopSpotlight(string[])

Stoppa spotlight

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

Parametrar

userIds

string[]

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.stopSpotlight

stopVideoBackgroundEffects()

Stoppa videobakgrundseffekten.

function stopVideoBackgroundEffects(): Promise<void>

Returer

Promise<void>

Ärvd frånCallWithChatAdapterManagement.stopVideoBackgroundEffects

submitSurvey(CallSurvey)

Skicka resultatet av undersökningen om samtalets slut

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

Parametrar

survey
CallSurvey

Returer

Promise<undefined | CallSurveyResponse>

Ärvd frånCallWithChatAdapterManagement.submitSurvey

unmute()

Slå på ljudet för den aktuella användaren under anropet eller aktivera mikrofonen lokalt.

function unmute(): Promise<void>

Returer

Promise<void>

ärvd frånCallWithChatAdapterManagement.unmute

updateBackgroundPickerImages(VideoBackgroundImage[])

Åsidosätt bakgrundsväljarens bilder för att få en bakgrundsersättningseffekt.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parametrar

backgroundImages

VideoBackgroundImage[]

Matris med anpassade bakgrundsbilder.

Ärvd frånCallWithChatAdapterManagement.updateBackgroundPickerImages

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>

ärvd frånCallWithChatAdapterManagement.updateMessage

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Uppdatera den valda videobakgrundseffekten

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametrar

selectedVideoBackground
VideoBackgroundEffect

Ärvd frånCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect