Dela via


CallAdapter interface

Ett adaptergränssnitt som är specifikt för Azure Communication-identitet som utökar CommonCallAdapter-.

Extends

Ärvda egenskaper

sendRealTimeText

Skicka text i realtid

Metoder

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

startCall(CommunicationIdentifier[], StartCallOptions)

Starta samtalet.

startCall(string[], StartCallOptions)

Starta samtalet.

Ärvda metoder

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Lägg till en deltagare i anropet.

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 dataström.

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 dataström.

forbidAudio(string[])

Förbjud att Teams-mötesdeltagare ljudar med sina användar-ID:n.

forbidOthersAudio()

Förbjud Teams mötesljud.

forbidOthersVideo()

Förbjud Teams mötesvideo.

forbidVideo(string[])

Förbjud Teams-mötesdeltagare att video med sina användar-ID:n.

getState()

Hämta aktuellt tillstånd

holdCall()

Parkerar samtalet.

leaveCall(boolean)

Lämna samtalet

lowerHand()

Nedre hand för aktuell användare

mute()

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

muteAllRemoteParticipants()

Stäng av ljudet för alla deltagare

muteParticipant(string)

Stänga av ljudet för en deltagare

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Funktionen för att avbryta prenumerationen på händelsen "breakoutRoomsUpdated".

off("callEnded", CallEndedListener)

Avsluta prenumerationsfunktionen för händelsen "callEnded".

off("callIdChanged", CallIdChangedListener)

Avsluta prenumerationsfunktionen för händelsen "callIdChanged".

off("capabilitiesChanged", CapabilitiesChangedListener)

Funktionen för att avbryta prenumerationen för händelsen "capabilitiesChanged".

off("captionsReceived", CaptionsReceivedListener)

Funktionen för att avbryta prenumerationen för händelsen "captionsReceived".

off("diagnosticChanged", DiagnosticChangedEventListner)

Avsluta prenumerationsfunktionen för "diagnosticChanged"-händelsen.

off("displayNameChanged", DisplayNameChangedListener)

Avsluta prenumerationsfunktionen för händelsen "displayNameChanged".

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

Avsluta prenumerationsfunktionen för "fel"-händelsen.

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Funktionen för att avbryta prenumerationen för händelsen "isCaptionLanguageChanged".

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Funktionen för att avbryta prenumerationen för händelsen "isCaptionsActiveChanged".

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Avsluta prenumerationsfunktionen för händelsen "isLocalScreenSharingActiveChanged".

off("isMutedChanged", IsMutedChangedListener)

Funktionen Avbryt prenumeration för händelsen isMutedChanged.

off("isSpeakingChanged", IsSpeakingChangedListener)

Avsluta prenumerationsfunktionen för händelsen isSpeakingChanged.

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Funktionen för att avbryta prenumerationen för händelsen "isSpokenLanguageChanged".

off("mutedByOthers", PropertyChangedEvent)

Funktionen för att avbryta prenumerationen för händelsen "mutedByOthers".

off("participantsJoined", ParticipantsJoinedListener)

Avsluta prenumerationsfunktionen för "deltagareJobbad"-händelse.

off("participantsLeft", ParticipantsLeftListener)

Avsluta prenumerationsfunktionen för "participantsLeft"-händelsen.

off("realTimeTextReceived", RealTimeTextReceivedListener)

Funktionen för att avbryta prenumerationen för händelsen "realTimeTextReceived".

off("roleChanged", PropertyChangedEvent)

Funktionen för att avbryta prenumerationen för händelsen "roleChanged".

off("selectedMicrophoneChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för händelsen "selectedMicrophoneChanged".

off("selectedSpeakerChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för händelsen "selectedSpeakerChanged".

off("spotlightChanged", SpotlightChangedListener)

Funktion för att avsluta prenumerationen på händelsen 'spotlightChanged'.

off("transferAccepted", TransferAcceptedListener)

Funktionen för att avbryta prenumerationen för händelsen "transferRequested".

offStateChange((state: CallAdapterState) => void)

Avregistrerar hanteraren till stateChanged-händelser.

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Prenumerationsfunktion för evenemanget "breakoutRoomsUpdated".

on("callEnded", CallEndedListener)

Prenumerationsfunktionen för händelsen "callEnded".

on("callIdChanged", CallIdChangedListener)

Prenumerationsfunktionen för händelsen "callIdChanged".

on("capabilitiesChanged", CapabilitiesChangedListener)

Prenumerationsfunktion för händelsen "capabilitiesChanged".

on("captionsReceived", CaptionsReceivedListener)

Prenumerationsfunktion för händelsen "captionsReceived".

on("diagnosticChanged", DiagnosticChangedEventListner)

Prenumerationsfunktionen för händelsen "diagnosticChanged".

Den här händelsen utlöses när det sker en ändring i användarinriktad diagnostik om det pågående anropet.

on("displayNameChanged", DisplayNameChangedListener)

Prenumerationsfunktionen för händelsen "displayNameChanged".

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

Prenumerationsfunktionen för "fel"-händelsen.

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Prenumerationsfunktion för händelsen "isCaptionLanguageChanged".

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Prenumerationsfunktion för händelsen 'isCaptionsActiveChanged'.

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Prenumerationsfunktionen för händelsen "isLocalScreenSharingActiveChanged".

on("isMutedChanged", IsMutedChangedListener)

Prenumerationsfunktionen för händelsen "isMutedChanged".

on("isSpeakingChanged", IsSpeakingChangedListener)

Prenumerationsfunktionen för händelsen isSpeakingChanged.

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Prenumerationsfunktion för händelsen "isSpokenLanguageChanged".

on("mutedByOthers", PropertyChangedEvent)

Prenumerationsfunktion för händelsen "mutedByOthers".

on("participantsJoined", ParticipantsJoinedListener)

Prenumerationsfunktionen för evenemanget "participantsJoined".

on("participantsLeft", ParticipantsLeftListener)

Prenumerationsfunktion för "participantsLeft"-händelse.

on("realTimeTextReceived", RealTimeTextReceivedListener)

Prenumerationsfunktion för händelsen "realTimeTextReceived".

on("roleChanged", PropertyChangedEvent)

Prenumerationsfunktion för händelsen "roleChanged".

on("selectedMicrophoneChanged", PropertyChangedEvent)

Prenumerationsfunktionen för händelsen "selectedMicrophoneChanged".

Den här händelsen utlöses när användaren väljer en ny mikrofonenhet.

on("selectedSpeakerChanged", PropertyChangedEvent)

Prenumerationsfunktionen för händelsen "selectedSpeakerChanged".

Den här händelsen utlöses när användaren väljer en ny talarenhet.

on("spotlightChanged", SpotlightChangedListener)

Prenumerationsfunktion för evenemanget 'spotlightChanged'.

on("transferAccepted", TransferAcceptedListener)

Prenumerationsfunktion för händelsen "transferRequested".

onReactionClick(Reaction)

Skicka reaktionsemoji

onStateChange((state: CallAdapterState) => void)

Prenumererar hanteraren på stateChanged-händelser.

permitAudio(string[])

Tillåt Teams-mötesdeltagare att spela med sina användar-ID:n.

permitOthersAudio()

Tillåt Teams mötesljud.

permitOthersVideo()

Tillåt Teams mötesvideo.

permitVideo(string[])

Tillåt Teams-mötesdeltagare att spela med sina användar-ID:n.

queryCameras()

Fråga efter tillgängliga kameraenheter.

queryMicrophones()

Fråga efter tillgängliga mikrofonenheter.

querySpeakers()

Fråga efter tillgängliga högtalarenheter.

raiseHand()

Räck upp handen för den aktuella användaren

removeParticipant(CommunicationIdentifier)

Ta bort en deltagare från anropet.

removeParticipant(string)

Ta bort en deltagare från anropet.

resumeCall()

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

returnFromBreakoutRoom()

Återgå till ursprungsanropet för breakout room

sendDtmfTone(DtmfTone)

skicka dtmf-ton till en annan deltagare i ett 1:1 PSTN-samtal

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.

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 för lokala och fjärranslutna deltagare med deras användar-ID:n. Om ingen matris med användar-ID:n skickas utförs åtgärden på den lokala deltagaren.

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

Stoppa brusdämpningseffekten.

stopScreenShare()

Sluta dela skärmen

stopSpotlight(string[])

Stoppa spotlighten för lokala och fjärranslutna deltagare med deras användar-ID:n. Om ingen matris med användar-ID:n skickas utförs åtgärden på den lokala deltagaren.

stopVideoBackgroundEffects()

Stoppa videobakgrundseffekten.

submitSurvey(CallSurvey)

Skicka resultatet av undersökningen om samtalets slut

unmute()

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

updateBackgroundPickerImages(VideoBackgroundImage[])

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

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Uppdatera den valda videobakgrundseffekten.

Information om ärvda egenskaper

sendRealTimeText

Skicka text i realtid

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

Egenskapsvärde

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

Ärvd frånCommonCallAdapter.sendRealTimeText

Metodinformation

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

startCall(CommunicationIdentifier[], StartCallOptions)

Starta samtalet.

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

Parametrar

participants

CommunicationIdentifier[]

En matris med <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> som ska anropas

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

Returer

undefined | Call

Ärvd metodinformation

addParticipant(CommunicationUserIdentifier)

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

Parametrar

Returer

Promise<void>

Ärvd frånCommonCallAdapter.addParticipant

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Lägg till en deltagare i anropet.

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

Parametrar

participant
PhoneNumberIdentifier

Returer

Promise<void>

Ärvd frånCommonCallAdapter.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ånCommonCallAdapter.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 sammansatta

ärvd frånCommonCallAdapter.createStreamView

createTogetherModeStreamView(TogetherModeStreamOptions)

Skapa html-vyn för en dataströ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ånCommonCallAdapter.createTogetherModeStreamView

dispose()

Ta bort sammansatta

function dispose()

ärvd frånCommonCallAdapter.dispose

disposeLocalVideoStreamView()

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

function disposeLocalVideoStreamView(): Promise<void>

Returer

Promise<void>

Ärvd frånCommonCallAdapter.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ånCommonCallAdapter.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ånCommonCallAdapter.disposeScreenShareStreamView

disposeStreamView(string, VideoStreamOptions)

Varning

Det här API:et är nu inaktuellt.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

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 sammansatta

ärvd frånCommonCallAdapter.disposeStreamView

disposeTogetherModeStreamView()

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

function disposeTogetherModeStreamView(): Promise<void>

Returer

Promise<void>

Kommentarer

Den här metoden implementeras för sammansatta

Ärvd frånCommonCallAdapter.disposeTogetherModeStreamView

forbidAudio(string[])

Förbjud att Teams-mötesdeltagare ljudar med sina användar-ID:n.

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

Parametrar

userIds

string[]

Returer

Promise<void>

Ärvd frånCommonCallAdapter.forbidAudio

forbidOthersAudio()

Förbjud Teams mötesljud.

function forbidOthersAudio(): Promise<void>

Returer

Promise<void>

Ärvd frånCommonCallAdapter.forbidOthersAudio

forbidOthersVideo()

Förbjud Teams mötesvideo.

function forbidOthersVideo(): Promise<void>

Returer

Promise<void>

Ärvt frånCommonCallAdapter.forbidOthersVideo

forbidVideo(string[])

Förbjud Teams-mötesdeltagare att video med sina användar-ID:n.

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

Parametrar

userIds

string[]

Returer

Promise<void>

Ärvd frånCommonCallAdapter.forbidVideo

getState()

Hämta aktuellt tillstånd

function getState(): CallAdapterState

Returer

ärvd frånCommonCallAdapter.getState

holdCall()

Parkerar samtalet.

function holdCall(): Promise<void>

Returer

Promise<void>

Ärvd frånCommonCallAdapter.holdCall

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ånCommonCallAdapter.leaveCall

lowerHand()

Nedre hand för aktuell användare

function lowerHand(): Promise<void>

Returer

Promise<void>

Ärvt frånCommonCallAdapter.lowerHand

mute()

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

function mute(): Promise<void>

Returer

Promise<void>

ärvd frånCommonCallAdapter.mute

muteAllRemoteParticipants()

Stäng av ljudet för alla deltagare

function muteAllRemoteParticipants(): Promise<void>

Returer

Promise<void>

Ärvd frånCommonCallAdapter.muteAllRemoteParticipants

muteParticipant(string)

Stänga av ljudet för en deltagare

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

Parametrar

userId

string

ID för deltagaren som ska tystas

Returer

Promise<void>

Ärvd frånCommonCallAdapter.muteParticipant

off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Funktionen för att avbryta prenumerationen på händelsen "breakoutRoomsUpdated".

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

Parametrar

event

"breakoutRoomsUpdated"

ärvd frånCommonCallAdapter.off

off("callEnded", CallEndedListener)

Avsluta prenumerationsfunktionen för händelsen "callEnded".

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

Parametrar

event

"callEnded"

ärvd frånCommonCallAdapter.off

off("callIdChanged", CallIdChangedListener)

Avsluta prenumerationsfunktionen för händelsen "callIdChanged".

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

Parametrar

event

"callIdChanged"

ärvd frånCommonCallAdapter.off

off("capabilitiesChanged", CapabilitiesChangedListener)

Funktionen för att avbryta prenumerationen för händelsen "capabilitiesChanged".

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

Parametrar

event

"capabilitiesChanged"

ärvd frånCommonCallAdapter.off

off("captionsReceived", CaptionsReceivedListener)

Funktionen för att avbryta prenumerationen för händelsen "captionsReceived".

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

Parametrar

event

"captionsReceived"

ärvd frånCommonCallAdapter.off

off("diagnosticChanged", DiagnosticChangedEventListner)

Avsluta prenumerationsfunktionen för "diagnosticChanged"-händelsen.

function off(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parametrar

event

"diagnosticChanged"

ärvd frånCommonCallAdapter.off

off("displayNameChanged", DisplayNameChangedListener)

Avsluta prenumerationsfunktionen för händelsen "displayNameChanged".

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

Parametrar

event

"displayNameChanged"

ärvd frånCommonCallAdapter.off

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

Avsluta prenumerationsfunktionen för "fel"-händelsen.

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

Parametrar

event

"error"

listener

(e: AdapterError) => void

ärvd frånCommonCallAdapter.off

off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Funktionen för att avbryta prenumerationen för händelsen "isCaptionLanguageChanged".

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

Parametrar

event

"isCaptionLanguageChanged"

ärvd frånCommonCallAdapter.off

off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Funktionen för att avbryta prenumerationen för händelsen "isCaptionsActiveChanged".

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

Parametrar

event

"isCaptionsActiveChanged"

ärvd frånCommonCallAdapter.off

off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Avsluta prenumerationsfunktionen för händelsen "isLocalScreenSharingActiveChanged".

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

Parametrar

event

"isLocalScreenSharingActiveChanged"

ärvd frånCommonCallAdapter.off

off("isMutedChanged", IsMutedChangedListener)

Funktionen Avbryt prenumeration för händelsen isMutedChanged.

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

Parametrar

event

"isMutedChanged"

ärvd frånCommonCallAdapter.off

off("isSpeakingChanged", IsSpeakingChangedListener)

Avsluta prenumerationsfunktionen för händelsen isSpeakingChanged.

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

Parametrar

event

"isSpeakingChanged"

ärvd frånCommonCallAdapter.off

off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Funktionen för att avbryta prenumerationen för händelsen "isSpokenLanguageChanged".

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

Parametrar

event

"isSpokenLanguageChanged"

ärvd frånCommonCallAdapter.off

off("mutedByOthers", PropertyChangedEvent)

Funktionen för att avbryta prenumerationen för händelsen "mutedByOthers".

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

Parametrar

event

"mutedByOthers"

ärvd frånCommonCallAdapter.off

off("participantsJoined", ParticipantsJoinedListener)

Avsluta prenumerationsfunktionen för "deltagareJobbad"-händelse.

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

Parametrar

event

"participantsJoined"

ärvd frånCommonCallAdapter.off

off("participantsLeft", ParticipantsLeftListener)

Avsluta prenumerationsfunktionen för "participantsLeft"-händelsen.

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

Parametrar

event

"participantsLeft"

ärvd frånCommonCallAdapter.off

off("realTimeTextReceived", RealTimeTextReceivedListener)

Funktionen för att avbryta prenumerationen för händelsen "realTimeTextReceived".

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

Parametrar

event

"realTimeTextReceived"

ärvd frånCommonCallAdapter.off

off("roleChanged", PropertyChangedEvent)

Funktionen för att avbryta prenumerationen för händelsen "roleChanged".

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

Parametrar

event

"roleChanged"

ärvd frånCommonCallAdapter.off

off("selectedMicrophoneChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för händelsen "selectedMicrophoneChanged".

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

Parametrar

event

"selectedMicrophoneChanged"

ärvd frånCommonCallAdapter.off

off("selectedSpeakerChanged", PropertyChangedEvent)

Avsluta prenumerationsfunktionen för händelsen "selectedSpeakerChanged".

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

Parametrar

event

"selectedSpeakerChanged"

ärvd frånCommonCallAdapter.off

off("spotlightChanged", SpotlightChangedListener)

Funktion för att avsluta prenumerationen på händelsen 'spotlightChanged'.

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

Parametrar

event

"spotlightChanged"

ärvd frånCommonCallAdapter.off

off("transferAccepted", TransferAcceptedListener)

Funktionen för att avbryta prenumerationen för händelsen "transferRequested".

function off(event: "transferAccepted", listener: TransferAcceptedListener)

Parametrar

event

"transferAccepted"

ärvd frånCommonCallAdapter.off

offStateChange((state: CallAdapterState) => void)

Avregistrerar hanteraren till stateChanged-händelser.

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

Parametrar

handler

(state: CallAdapterState) => void

ärvd frånCommonCallAdapter.offStateChange

on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)

Prenumerationsfunktion för evenemanget "breakoutRoomsUpdated".

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

Parametrar

event

"breakoutRoomsUpdated"

ärvd frånCommonCallAdapter.on

on("callEnded", CallEndedListener)

Prenumerationsfunktionen för händelsen "callEnded".

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

Parametrar

event

"callEnded"

ärvd frånCommonCallAdapter.on

on("callIdChanged", CallIdChangedListener)

Prenumerationsfunktionen för händelsen "callIdChanged".

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

Parametrar

event

"callIdChanged"

Kommentarer

Händelsen utlöses när callId för den aktuella användaren ändras.

ärvd frånCommonCallAdapter.on

on("capabilitiesChanged", CapabilitiesChangedListener)

Prenumerationsfunktion för händelsen "capabilitiesChanged".

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

Parametrar

event

"capabilitiesChanged"

ärvd frånCommonCallAdapter.on

on("captionsReceived", CaptionsReceivedListener)

Prenumerationsfunktion för händelsen "captionsReceived".

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

Parametrar

event

"captionsReceived"

ärvd frånCommonCallAdapter.on

on("diagnosticChanged", DiagnosticChangedEventListner)

Prenumerationsfunktionen för händelsen "diagnosticChanged".

Den här händelsen utlöses när det sker en ändring i användarinriktad diagnostik om det pågående anropet.

function on(event: "diagnosticChanged", listener: DiagnosticChangedEventListner)

Parametrar

event

"diagnosticChanged"

ärvd frånCommonCallAdapter.on

on("displayNameChanged", DisplayNameChangedListener)

Prenumerationsfunktionen för händelsen "displayNameChanged".

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

Parametrar

event

"displayNameChanged"

ärvd frånCommonCallAdapter.on

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

Prenumerationsfunktionen för "fel"-händelsen.

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

Parametrar

event

"error"

listener

(e: AdapterError) => void

ärvd frånCommonCallAdapter.on

on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)

Prenumerationsfunktion för händelsen "isCaptionLanguageChanged".

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

Parametrar

event

"isCaptionLanguageChanged"

ärvd frånCommonCallAdapter.on

on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)

Prenumerationsfunktion för händelsen 'isCaptionsActiveChanged'.

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

Parametrar

event

"isCaptionsActiveChanged"

ärvd frånCommonCallAdapter.on

on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)

Prenumerationsfunktionen för händelsen "isLocalScreenSharingActiveChanged".

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

Parametrar

event

"isLocalScreenSharingActiveChanged"

ärvd frånCommonCallAdapter.on

on("isMutedChanged", IsMutedChangedListener)

Prenumerationsfunktionen för händelsen "isMutedChanged".

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

Parametrar

event

"isMutedChanged"

Kommentarer

Händelsen utlöses när den aktuella användaren eller fjärranvändarens avstängningstillstånd ändras

ärvd frånCommonCallAdapter.on

on("isSpeakingChanged", IsSpeakingChangedListener)

Prenumerationsfunktionen för händelsen isSpeakingChanged.

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

Parametrar

event

"isSpeakingChanged"

ärvd frånCommonCallAdapter.on

on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)

Prenumerationsfunktion för händelsen "isSpokenLanguageChanged".

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

Parametrar

event

"isSpokenLanguageChanged"

ärvd frånCommonCallAdapter.on

on("mutedByOthers", PropertyChangedEvent)

Prenumerationsfunktion för händelsen "mutedByOthers".

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

Parametrar

event

"mutedByOthers"

ärvd frånCommonCallAdapter.on

on("participantsJoined", ParticipantsJoinedListener)

Prenumerationsfunktionen för evenemanget "participantsJoined".

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

Parametrar

event

"participantsJoined"

ärvd frånCommonCallAdapter.on

on("participantsLeft", ParticipantsLeftListener)

Prenumerationsfunktion för "participantsLeft"-händelse.

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

Parametrar

event

"participantsLeft"

ärvd frånCommonCallAdapter.on

on("realTimeTextReceived", RealTimeTextReceivedListener)

Prenumerationsfunktion för händelsen "realTimeTextReceived".

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

Parametrar

event

"realTimeTextReceived"

ärvd frånCommonCallAdapter.on

on("roleChanged", PropertyChangedEvent)

Prenumerationsfunktion för händelsen "roleChanged".

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

Parametrar

event

"roleChanged"

ärvd frånCommonCallAdapter.on

on("selectedMicrophoneChanged", PropertyChangedEvent)

Prenumerationsfunktionen för händelsen "selectedMicrophoneChanged".

Den här händelsen utlöses när användaren väljer en ny mikrofonenhet.

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

Parametrar

event

"selectedMicrophoneChanged"

ärvd frånCommonCallAdapter.on

on("selectedSpeakerChanged", PropertyChangedEvent)

Prenumerationsfunktionen för händelsen "selectedSpeakerChanged".

Den här händelsen utlöses när användaren väljer en ny talarenhet.

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

Parametrar

event

"selectedSpeakerChanged"

ärvd frånCommonCallAdapter.on

on("spotlightChanged", SpotlightChangedListener)

Prenumerationsfunktion för evenemanget 'spotlightChanged'.

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

Parametrar

event

"spotlightChanged"

ärvd frånCommonCallAdapter.on

on("transferAccepted", TransferAcceptedListener)

Prenumerationsfunktion för händelsen "transferRequested".

function on(event: "transferAccepted", listener: TransferAcceptedListener)

Parametrar

event

"transferAccepted"

ärvd frånCommonCallAdapter.on

onReactionClick(Reaction)

Skicka reaktionsemoji

function onReactionClick(reaction: Reaction): Promise<void>

Parametrar

reaction
Reaction

Returer

Promise<void>

Ärvd frånCommonCallAdapter.onReactionClick

onStateChange((state: CallAdapterState) => void)

Prenumererar hanteraren på stateChanged-händelser.

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

Parametrar

handler

(state: CallAdapterState) => void

ärvd frånCommonCallAdapter.onStateChange

permitAudio(string[])

Tillåt Teams-mötesdeltagare att spela med sina användar-ID:n.

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

Parametrar

userIds

string[]

Returer

Promise<void>

Ärvt frånCommonCallAdapter.permitAudio

permitOthersAudio()

Tillåt Teams mötesljud.

function permitOthersAudio(): Promise<void>

Returer

Promise<void>

Ärvd frånCommonCallAdapter.permitOthersAudio

permitOthersVideo()

Tillåt Teams mötesvideo.

function permitOthersVideo(): Promise<void>

Returer

Promise<void>

Ärvd frånCommonCallAdapter.permitOthersVideo

permitVideo(string[])

Tillåt Teams-mötesdeltagare att spela med sina användar-ID:n.

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

Parametrar

userIds

string[]

Returer

Promise<void>

Ärvd frånCommonCallAdapter.permitVideo

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ånCommonCallAdapter.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ånCommonCallAdapter.queryMicrophones

querySpeakers()

Fråga efter tillgängliga högtalarenheter.

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ånCommonCallAdapter.querySpeakers

raiseHand()

Räck upp handen för den aktuella användaren

function raiseHand(): Promise<void>

Returer

Promise<void>

Ärvt frånCommonCallAdapter.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ånCommonCallAdapter.removeParticipant

removeParticipant(string)

Ta bort en deltagare från anropet.

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

Parametrar

userId

string

ID för deltagaren som ska tas bort

Returer

Promise<void>

ärvd frånCommonCallAdapter.removeParticipant

resumeCall()

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

function resumeCall(): Promise<void>

Returer

Promise<void>

Ärvd frånCommonCallAdapter.resumeCall

returnFromBreakoutRoom()

Återgå till ursprungsanropet för breakout room

function returnFromBreakoutRoom(): Promise<void>

Returer

Promise<void>

Ärvt frånCommonCallAdapter.returnFromBreakoutRoom

sendDtmfTone(DtmfTone)

skicka dtmf-ton till en annan deltagare i ett 1:1 PSTN-samtal

function sendDtmfTone(dtmfTone: DtmfTone): Promise<void>

Parametrar

dtmfTone
DtmfTone

Returer

Promise<void>

Ärvd frånCommonCallAdapter.sendDtmfTone

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ånCommonCallAdapter.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>

Ärvt frånCommonCallAdapter.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ånCommonCallAdapter.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ånCommonCallAdapter.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ånCommonCallAdapter.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

Ärvt frånCommonCallAdapter.setTogetherModeSceneSize

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ånCommonCallAdapter.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ånCommonCallAdapter.startCaptions

startNoiseSuppressionEffect()

Starta brusdämpningseffekten.

function startNoiseSuppressionEffect(): Promise<void>

Returer

Promise<void>

Ärvt frånCommonCallAdapter.startNoiseSuppressionEffect

startScreenShare()

Börja dela skärmen under ett samtal.

function startScreenShare(): Promise<void>

Returer

Promise<void>

ärvd frånCommonCallAdapter.startScreenShare

startSpotlight(string[])

Starta spotlight för lokala och fjärranslutna deltagare med deras användar-ID:n. Om ingen matris med användar-ID:n skickas utförs åtgärden på den lokala deltagaren.

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

Parametrar

userIds

string[]

Returer

Promise<void>

Ärvd frånCommonCallAdapter.startSpotlight

startTogetherMode()

Starta tillsammans-läge.

function startTogetherMode(): Promise<void>

Returer

Promise<void>

Ärvt frånCommonCallAdapter.startTogetherMode

startVideoBackgroundEffect(VideoBackgroundEffect)

Starta videobakgrundseffekten.

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

Parametrar

videoBackgroundEffect
VideoBackgroundEffect

Returer

Promise<void>

Ärvd frånCommonCallAdapter.startVideoBackgroundEffect

stopAllSpotlight()

Stoppa alla spotlights

function stopAllSpotlight(): Promise<void>

Returer

Promise<void>

Ärvt frånCommonCallAdapter.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ånCommonCallAdapter.stopCamera

stopCaptions(StopCaptionsAdapterOptions)

Funktion för att stoppa textning

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

Parametrar

Returer

Promise<void>

Ärvd frånCommonCallAdapter.stopCaptions

stopNoiseSuppressionEffect()

Stoppa brusdämpningseffekten.

function stopNoiseSuppressionEffect(): Promise<void>

Returer

Promise<void>

Ärvt frånCommonCallAdapter.stopNoiseSuppressionEffect

stopScreenShare()

Sluta dela skärmen

function stopScreenShare(): Promise<void>

Returer

Promise<void>

ärvd frånCommonCallAdapter.stopScreenShare

stopSpotlight(string[])

Stoppa spotlighten för lokala och fjärranslutna deltagare med deras användar-ID:n. Om ingen matris med användar-ID:n skickas utförs åtgärden på den lokala deltagaren.

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

Parametrar

userIds

string[]

Returer

Promise<void>

Ärvd frånCommonCallAdapter.stopSpotlight

stopVideoBackgroundEffects()

Stoppa videobakgrundseffekten.

function stopVideoBackgroundEffects(): Promise<void>

Returer

Promise<void>

Ärvd frånCommonCallAdapter.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ånCommonCallAdapter.submitSurvey

unmute()

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

function unmute(): Promise<void>

Returer

Promise<void>

ärvd frånCommonCallAdapter.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ånCommonCallAdapter.updateBackgroundPickerImages

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Uppdatera den valda videobakgrundseffekten.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametrar

selectedVideoBackground
VideoBackgroundEffect

Ärvd frånCommonCallAdapter.updateSelectedVideoBackgroundEffect