CallWithChatAdapter interface
rozhraní CallWithChatComposite Adapter.
- Extends
Zděděné vlastnosti
| forbid |
Zakáže zvuk pro zadaná ID uživatelů. |
| forbid |
Zakáže zvuk pro účastníky schůzky Teams s výjimkou místního uživatele. |
| forbid |
Zakáže video pro účastníky schůzky Teams s výjimkou místního uživatele. |
| forbid |
Zakáže video pro zadané ID uživatele. |
| permit |
Povoluje zvuk pro zadaná ID uživatelů. |
| permit |
povolí zvuk pro účastníky schůzky Teams s výjimkou místního uživatele. |
| permit |
povolí video pro účastníky schůzky Teams s výjimkou místního uživatele. |
| permit |
Povolí video pro zadaná ID uživatele. |
| send |
Odeslání DTMF tónu jinému účastníkovi hovoru v hovoru 1:1 |
| send |
Odesílání textu v reálném čase |
Zděděné metody
Podrobnosti zděděných vlastností
forbidAudio
Zakáže zvuk pro zadaná ID uživatelů.
forbidAudio: (userIds: string[]) => Promise<void>
Hodnota vlastnosti
(userIds: string[]) => Promise<void>
forbidOthersAudio
Zakáže zvuk pro účastníky schůzky Teams s výjimkou místního uživatele.
forbidOthersAudio: () => Promise<void>
Hodnota vlastnosti
() => Promise<void>
forbidOthersVideo
Zakáže video pro účastníky schůzky Teams s výjimkou místního uživatele.
forbidOthersVideo: () => Promise<void>
Hodnota vlastnosti
() => Promise<void>
forbidVideo
Zakáže video pro zadané ID uživatele.
forbidVideo: (userIds: string[]) => Promise<void>
Hodnota vlastnosti
(userIds: string[]) => Promise<void>
permitAudio
Povoluje zvuk pro zadaná ID uživatelů.
permitAudio: (userIds: string[]) => Promise<void>
Hodnota vlastnosti
(userIds: string[]) => Promise<void>
permitOthersAudio
povolí zvuk pro účastníky schůzky Teams s výjimkou místního uživatele.
permitOthersAudio: () => Promise<void>
Hodnota vlastnosti
() => Promise<void>
permitOthersVideo
povolí video pro účastníky schůzky Teams s výjimkou místního uživatele.
permitOthersVideo: () => Promise<void>
Hodnota vlastnosti
() => Promise<void>
permitVideo
Povolí video pro zadaná ID uživatele.
permitVideo: (userIds: string[]) => Promise<void>
Hodnota vlastnosti
(userIds: string[]) => Promise<void>
sendDtmfTone
Odeslání DTMF tónu jinému účastníkovi hovoru v hovoru 1:1
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>
Hodnota vlastnosti
(dtmfTone: DtmfTone) => Promise<void>
sendRealTimeText
Odesílání textu v reálném čase
sendRealTimeText: (text: string, isFinalized: boolean) => Promise<void>
Hodnota vlastnosti
(text: string, isFinalized: boolean) => Promise<void>
Podrobnosti zděděných metod
addParticipant(CommunicationUserIdentifier)
function addParticipant(participant: CommunicationUserIdentifier): Promise<void>
Parametry
- participant
- CommunicationUserIdentifier
Návraty
Promise<void>
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)
Přidá do hovoru nového účastníka.
function addParticipant(participant: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): Promise<void>
Parametry
- participant
- PhoneNumberIdentifier
- options
- AddPhoneNumberOptions
Návraty
Promise<void>
askDevicePermission(PermissionConstraints)
Požádejte o oprávnění zařízení.
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>
Parametry
- constrain
- PermissionConstraints
Definování omezení pro přístup k místním zařízením <xref:%40azure%2Fcommunication-calling%23PermissionConstraints>
Návraty
Promise<DeviceAccess>
Poznámky
Okno oprávnění prohlížeče se zobrazí, pokud ještě nejsou udělena oprávnění.
createStreamView(string, VideoStreamOptions)
Vytvořte zobrazení HTML pro datový proud.
function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>
Parametry
- remoteUserId
-
string
ID účastníka, který se má vykreslit, ponechte ho nedefinovaný a vytvořte zobrazení místní kamery.
- options
- VideoStreamOptions
Možnosti pro řízení vykreslování streamů videa <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Návraty
Promise<void | CreateVideoStreamViewResult>
Poznámky
Tato metoda je implementována pro složené.
createTogetherModeStreamView(TogetherModeStreamOptions)
Vytvořte zobrazení html pro datový proud togethermode.
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>
Parametry
- options
- TogetherModeStreamOptions
Možnosti pro řízení vykreslování streamů videa <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Návraty
Promise<void | TogetherModeStreamViewResult>
Poznámky
Tato metoda je implementována pro složené
Zděděno zCallWithChatAdapterManagement.createTogetherModeStreamView
deleteMessage(string)
Odstraňte zprávu ve vlákně.
function deleteMessage(messageId: string): Promise<void>
Parametry
- messageId
-
string
Návraty
Promise<void>
dispose()
disposeLocalVideoStreamView()
Uvolnění zobrazení html pro místní datový proud videa
function disposeLocalVideoStreamView(): Promise<void>
Návraty
Promise<void>
Zděděno zCallWithChatAdapterManagement.disposeLocalVideoStreamView
disposeRemoteVideoStreamView(string)
Uvolnění zobrazení html pro vzdálený datový proud videa
function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>
Parametry
- remoteUserId
-
string
Průkaz totožnosti účastníka, se kterým má nakládat
Návraty
Promise<void>
Zděděno zCallWithChatAdapterManagement.disposeRemoteVideoStreamView
disposeScreenShareStreamView(string)
Uvolnění zobrazení HTML pro datový proud sdílené obrazovky
function disposeScreenShareStreamView(remoteUserId: string): Promise<void>
Parametry
- remoteUserId
-
string
Id účastníka, pro který se má uvolnit zobrazení streamu sdílení obrazovky.
Návraty
Promise<void>
Poznámky
Tato metoda je implementována pro kompozitní
Zděděno zCallWithChatAdapterManagement.disposeScreenShareStreamView
disposeStreamView(string, VideoStreamOptions)
Vyřaďte zobrazení HTML pro datový proud.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>
Parametry
- remoteUserId
-
string
ID účastníka, který se má vykreslit, nechte ho nedefinovaný a odstraňte zobrazení místní kamery.
- options
- VideoStreamOptions
Možnosti pro řízení vykreslování streamů videa <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Návraty
Promise<void>
Poznámky
Tato metoda je implementována pro složené.
disposeTogetherModeStreamView()
Uvolněte zobrazení html pro datový proud togethermode.
function disposeTogetherModeStreamView(): Promise<void>
Návraty
Promise<void>
Poznámky
Tato metoda je implementována pro složené
Zděděno zCallWithChatAdapterManagement.disposeTogetherModeStreamView
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
Parametry
- resourceDetails
- ResourceDetails
Návraty
Promise<void>
Zděděno zCallWithChatAdapterManagement.downloadResourceToCache
fetchInitialData()
Načtěte počáteční stav adaptéru chatu.
Provede minimální načtení potřebné pro metody ChatComposite a rozhraní API.
function fetchInitialData(): Promise<void>
Návraty
Promise<void>
getState()
Získání aktuálního stavu
function getState(): CallWithChatAdapterState
Návraty
zděděno zAdapterState.getState
holdCall()
Umístí hovor do localholdu.
function holdCall(): Promise<void>
Návraty
Promise<void>
joinCall(boolean)
Upozornění
Toto rozhraní API je teď zastaralé.
Use joinCall(options?:JoinCallOptions) instead.
Připojte se k hovoru s mikrofonem, který je zpočátku zapnutý nebo vypnutý.
function joinCall(microphoneOn?: boolean): undefined | Call
Parametry
- microphoneOn
-
boolean
Jestli je mikrofon původně povolený
Návraty
undefined | Call
joinCall(JoinCallOptions)
Připojte se k hovoru pomocí panelu možností pro nastavení výchozího stavu mikrofonu/kamery při připojení k hovoru true = zapnutí zařízení při připojování k hovoru false = vypnutí zařízení při připojování k hovoru "ponechat"/undefined = zachovat stav zařízení před voláním
function joinCall(options?: JoinCallOptions): undefined | Call
Parametry
- options
- JoinCallOptions
Parametr pro počáteční zapnutí/vypnutí mikrofonu/kamery/použití stavu před vyvoláním.
Návraty
undefined | Call
leaveCall(boolean)
Nechte hovor.
function leaveCall(forEveryone?: boolean): Promise<void>
Parametry
- forEveryone
-
boolean
Zda odebrat všechny účastníky při odjezdu
Návraty
Promise<void>
loadPreviousChatMessages(number)
Načtěte další předchozí zprávy v historii vlákna chatu.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
Parametry
- messagesToLoad
-
number
Návraty
Promise<boolean>
Poznámky
Tato metoda se obvykle používá k řízení přírůstkového načítání nebo nekonečného posouvání.
zděděno zCallWithChatAdapterManagement.loadPreviousChatMessages
lowerHand()
Spodní ruka pro místního uživatele.
function lowerHand(): Promise<void>
Návraty
Promise<void>
mute()
Ztlumte aktuálního uživatele během hovoru nebo zakažte mikrofon místně.
function mute(): Promise<void>
Návraty
Promise<void>
zděděno zCallWithChatAdapterManagement.mute
muteAllRemoteParticipants()
Ztlumení účastníka
function muteAllRemoteParticipants(): Promise<void>
Návraty
Promise<void>
Zděděno zCallWithChatAdapterManagement.muteAllRemoteParticipants
muteParticipant(string)
Ztlumení účastníka
function muteParticipant(userId: string): Promise<void>
Parametry
- userId
-
string
Návraty
Promise<void>
off("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function off(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parametry
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("callEnded", CallEndedListener)
function off(event: "callEnded", listener: CallEndedListener)
Parametry
- event
-
"callEnded"
- listener
- CallEndedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("callError", (e: AdapterError) => void)
function off(event: "callError", listener: (e: AdapterError) => void)
Parametry
- event
-
"callError"
- listener
-
(e: AdapterError) => void
zděděno zCallWithChatAdapterSubscriptions.off
off("callIdChanged", CallIdChangedListener)
function off(event: "callIdChanged", listener: CallIdChangedListener)
Parametry
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("callParticipantsJoined", ParticipantsJoinedListener)
function off(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parametry
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("callParticipantsLeft", ParticipantsLeftListener)
function off(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parametry
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
zděděno zCallWithChatAdapterSubscriptions.off
off("capabilitiesChanged", CapabilitiesChangedListener)
function off(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parametry
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("captionsReceived", CaptionsReceivedListener)
function off(event: "captionsReceived", listener: CaptionsReceivedListener)
Parametry
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("chatError", (e: AdapterError) => void)
function off(event: "chatError", listener: (e: AdapterError) => void)
Parametry
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
zděděno zCallWithChatAdapterSubscriptions.off
off("chatInitialized", ChatInitializedListener)
function off(event: "chatInitialized", listener: ChatInitializedListener)
Parametry
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("chatParticipantsAdded", ParticipantsAddedListener)
function off(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parametry
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("chatParticipantsRemoved", ParticipantsRemovedListener)
function off(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parametry
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("displayNameChanged", DisplayNameChangedListener)
function off(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parametry
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function off(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parametry
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function off(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parametry
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function off(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parametry
- event
-
"isLocalScreenSharingActiveChanged"
zděděno zCallWithChatAdapterSubscriptions.off
off("isMutedChanged", IsMutedChangedListener)
function off(event: "isMutedChanged", listener: IsMutedChangedListener)
Parametry
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("isSpeakingChanged", IsSpeakingChangedListener)
function off(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parametry
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function off(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parametry
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("messageDeleted", MessageReceivedListener)
function off(event: "messageDeleted", listener: MessageReceivedListener)
Parametry
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("messageEdited", MessageReceivedListener)
function off(event: "messageEdited", listener: MessageReceivedListener)
Parametry
- event
-
"messageEdited"
- listener
- MessageReceivedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("messageRead", MessageReadListener)
function off(event: "messageRead", listener: MessageReadListener)
Parametry
- event
-
"messageRead"
- listener
- MessageReadListener
zděděno zCallWithChatAdapterSubscriptions.off
off("messageReceived", MessageReceivedListener)
function off(event: "messageReceived", listener: MessageReceivedListener)
Parametry
- event
-
"messageReceived"
- listener
- MessageReceivedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("messageSent", MessageReceivedListener)
function off(event: "messageSent", listener: MessageReceivedListener)
Parametry
- event
-
"messageSent"
- listener
- MessageReceivedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("realTimeTextReceived", RealTimeTextReceivedListener)
function off(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parametry
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
zděděno zCallWithChatAdapterSubscriptions.off
off("selectedMicrophoneChanged", PropertyChangedEvent)
function off(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
zděděno zCallWithChatAdapterSubscriptions.off
off("selectedSpeakerChanged", PropertyChangedEvent)
function off(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
zděděno zCallWithChatAdapterSubscriptions.off
off("spotlightChanged", SpotlightChangedListener)
function off(event: "spotlightChanged", listener: SpotlightChangedListener)
Parametry
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
zděděno zCallWithChatAdapterSubscriptions.off
offStateChange((state: CallWithChatAdapterState) => void)
Zruší odběr obslužné rutiny událostí stateChanged.
function offStateChange(handler: (state: CallWithChatAdapterState) => void)
Parametry
- handler
-
(state: CallWithChatAdapterState) => void
zděděno zAdapterState.offStateChange
on("breakoutRoomsUpdated", BreakoutRoomsUpdatedListener)
function on(event: "breakoutRoomsUpdated", listener: BreakoutRoomsUpdatedListener)
Parametry
- event
-
"breakoutRoomsUpdated"
- listener
- BreakoutRoomsUpdatedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("callEnded", CallEndedListener)
function on(event: "callEnded", listener: CallEndedListener)
Parametry
- event
-
"callEnded"
- listener
- CallEndedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("callError", (e: AdapterError) => void)
function on(event: "callError", listener: (e: AdapterError) => void)
Parametry
- event
-
"callError"
- listener
-
(e: AdapterError) => void
zděděno zCallWithChatAdapterSubscriptions.on
on("callIdChanged", CallIdChangedListener)
function on(event: "callIdChanged", listener: CallIdChangedListener)
Parametry
- event
-
"callIdChanged"
- listener
- CallIdChangedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("callParticipantsJoined", ParticipantsJoinedListener)
function on(event: "callParticipantsJoined", listener: ParticipantsJoinedListener)
Parametry
- event
-
"callParticipantsJoined"
- listener
- ParticipantsJoinedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("callParticipantsLeft", ParticipantsLeftListener)
function on(event: "callParticipantsLeft", listener: ParticipantsLeftListener)
Parametry
- event
-
"callParticipantsLeft"
- listener
- ParticipantsLeftListener
zděděno zCallWithChatAdapterSubscriptions.on
on("capabilitiesChanged", CapabilitiesChangedListener)
function on(event: "capabilitiesChanged", listener: CapabilitiesChangedListener)
Parametry
- event
-
"capabilitiesChanged"
- listener
- CapabilitiesChangedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("captionsReceived", CaptionsReceivedListener)
function on(event: "captionsReceived", listener: CaptionsReceivedListener)
Parametry
- event
-
"captionsReceived"
- listener
- CaptionsReceivedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("chatError", (e: AdapterError) => void)
function on(event: "chatError", listener: (e: AdapterError) => void)
Parametry
- event
-
"chatError"
- listener
-
(e: AdapterError) => void
zděděno zCallWithChatAdapterSubscriptions.on
on("chatInitialized", ChatInitializedListener)
function on(event: "chatInitialized", listener: ChatInitializedListener)
Parametry
- event
-
"chatInitialized"
- listener
- ChatInitializedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("chatParticipantsAdded", ParticipantsAddedListener)
function on(event: "chatParticipantsAdded", listener: ParticipantsAddedListener)
Parametry
- event
-
"chatParticipantsAdded"
- listener
- ParticipantsAddedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("chatParticipantsRemoved", ParticipantsRemovedListener)
function on(event: "chatParticipantsRemoved", listener: ParticipantsRemovedListener)
Parametry
- event
-
"chatParticipantsRemoved"
- listener
- ParticipantsRemovedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("displayNameChanged", DisplayNameChangedListener)
function on(event: "displayNameChanged", listener: DisplayNameChangedListener)
Parametry
- event
-
"displayNameChanged"
- listener
- DisplayNameChangedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("isCaptionLanguageChanged", IsCaptionLanguageChangedListener)
function on(event: "isCaptionLanguageChanged", listener: IsCaptionLanguageChangedListener)
Parametry
- event
-
"isCaptionLanguageChanged"
- listener
- IsCaptionLanguageChangedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("isCaptionsActiveChanged", IsCaptionsActiveChangedListener)
function on(event: "isCaptionsActiveChanged", listener: IsCaptionsActiveChangedListener)
Parametry
- event
-
"isCaptionsActiveChanged"
- listener
- IsCaptionsActiveChangedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("isLocalScreenSharingActiveChanged", IsLocalScreenSharingActiveChangedListener)
function on(event: "isLocalScreenSharingActiveChanged", listener: IsLocalScreenSharingActiveChangedListener)
Parametry
- event
-
"isLocalScreenSharingActiveChanged"
zděděno zCallWithChatAdapterSubscriptions.on
on("isMutedChanged", IsMutedChangedListener)
function on(event: "isMutedChanged", listener: IsMutedChangedListener)
Parametry
- event
-
"isMutedChanged"
- listener
- IsMutedChangedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("isSpeakingChanged", IsSpeakingChangedListener)
function on(event: "isSpeakingChanged", listener: IsSpeakingChangedListener)
Parametry
- event
-
"isSpeakingChanged"
- listener
- IsSpeakingChangedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("isSpokenLanguageChanged", IsSpokenLanguageChangedListener)
function on(event: "isSpokenLanguageChanged", listener: IsSpokenLanguageChangedListener)
Parametry
- event
-
"isSpokenLanguageChanged"
- listener
- IsSpokenLanguageChangedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("messageDeleted", MessageReceivedListener)
function on(event: "messageDeleted", listener: MessageReceivedListener)
Parametry
- event
-
"messageDeleted"
- listener
- MessageReceivedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("messageEdited", MessageReceivedListener)
function on(event: "messageEdited", listener: MessageReceivedListener)
Parametry
- event
-
"messageEdited"
- listener
- MessageReceivedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("messageRead", MessageReadListener)
function on(event: "messageRead", listener: MessageReadListener)
Parametry
- event
-
"messageRead"
- listener
- MessageReadListener
zděděno zCallWithChatAdapterSubscriptions.on
on("messageReceived", MessageReceivedListener)
function on(event: "messageReceived", listener: MessageReceivedListener)
Parametry
- event
-
"messageReceived"
- listener
- MessageReceivedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("messageSent", MessageReceivedListener)
function on(event: "messageSent", listener: MessageReceivedListener)
Parametry
- event
-
"messageSent"
- listener
- MessageReceivedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("realTimeTextReceived", RealTimeTextReceivedListener)
function on(event: "realTimeTextReceived", listener: RealTimeTextReceivedListener)
Parametry
- event
-
"realTimeTextReceived"
- listener
- RealTimeTextReceivedListener
zděděno zCallWithChatAdapterSubscriptions.on
on("selectedMicrophoneChanged", PropertyChangedEvent)
function on(event: "selectedMicrophoneChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"selectedMicrophoneChanged"
- listener
- PropertyChangedEvent
zděděno zCallWithChatAdapterSubscriptions.on
on("selectedSpeakerChanged", PropertyChangedEvent)
function on(event: "selectedSpeakerChanged", listener: PropertyChangedEvent)
Parametry
- event
-
"selectedSpeakerChanged"
- listener
- PropertyChangedEvent
zděděno zCallWithChatAdapterSubscriptions.on
on("spotlightChanged", SpotlightChangedListener)
function on(event: "spotlightChanged", listener: SpotlightChangedListener)
Parametry
- event
-
"spotlightChanged"
- listener
- SpotlightChangedListener
zděděno zCallWithChatAdapterSubscriptions.on
onReactionClick(Reaction)
Odeslat reakci na probíhající schůzku.
function onReactionClick(reaction: Reaction): Promise<void>
Parametry
- reaction
- Reaction
Hodnota typu <xref:%40azure%2Fcommunication-calling%23Reaction>
Návraty
Promise<void>
onStateChange((state: CallWithChatAdapterState) => void)
Přihlásí obslužnou rutinu k událostem stateChanged.
function onStateChange(handler: (state: CallWithChatAdapterState) => void)
Parametry
- handler
-
(state: CallWithChatAdapterState) => void
zděděno zAdapterState.onStateChange
queryCameras()
Zadejte dotaz na dostupná zařízení fotoaparátu.
function queryCameras(): Promise<VideoDeviceInfo[]>
Návraty
Promise<VideoDeviceInfo[]>
Pole informačních entit videoza zařízení <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo>
Poznámky
Tato metoda by se měla volat po zadání metody askDevicePermission()
queryMicrophones()
Zadejte dotaz na dostupná mikrofonní zařízení.
function queryMicrophones(): Promise<AudioDeviceInfo[]>
Návraty
Promise<AudioDeviceInfo[]>
Pole entit informací o zvukových zařízeních <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Poznámky
Tato metoda by se měla volat po zadání metody askDevicePermission()
querySpeakers()
Zadejte dotaz na dostupná mikrofonní zařízení.
function querySpeakers(): Promise<AudioDeviceInfo[]>
Návraty
Promise<AudioDeviceInfo[]>
Pole entit informací o zvukových zařízeních <xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo>
Poznámky
Tato metoda by se měla volat po zadání metody askDevicePermission()
raiseHand()
Zvedněte ruku pro místního uživatele.
function raiseHand(): Promise<void>
Návraty
Promise<void>
removeParticipant(CommunicationIdentifier)
Odeberte účastníka z hovoru.
function removeParticipant(participant: CommunicationIdentifier): Promise<void>
Parametry
- participant
- CommunicationIdentifier
<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> účastníka, který má být odstraněn
Návraty
Promise<void>
removeParticipant(string)
Odeberte účastníka z hovoru.
function removeParticipant(userId: string): Promise<void>
Parametry
- userId
-
string
ID uživatele účastníka, který chcete odebrat.
Návraty
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
Parametry
- resourceDetails
- ResourceDetails
Zděděno zCallWithChatAdapterManagement.removeResourceFromCache
resumeCall()
Obnoví volání ze stavu LocalHold.
function resumeCall(): Promise<void>
Návraty
Promise<void>
returnFromBreakoutRoom()
Návrat k původnímu volání breakout room
function returnFromBreakoutRoom(): Promise<void>
Návraty
Promise<void>
Zděděno zCallWithChatAdapterManagement.returnFromBreakoutRoom
sendMessage(string, SendMessageOptions)
Odešle zprávu ve vlákně.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
Parametry
- content
-
string
- options
- SendMessageOptions
Návraty
Promise<void>
sendReadReceipt(string)
Odešle potvrzení o přečtení zprávy.
function sendReadReceipt(chatMessageId: string): Promise<void>
Parametry
- chatMessageId
-
string
Návraty
Promise<void>
sendTypingIndicator()
Odešlete do vlákna indikátor psaní.
function sendTypingIndicator(): Promise<void>
Návraty
Promise<void>
setCamera(VideoDeviceInfo, VideoStreamOptions)
Nastavte kameru tak, aby se používala při hovoru.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>
Parametry
- sourceInfo
- VideoDeviceInfo
Vyberte zařízení fotoaparátu, které chcete vybrat, vyberte jedno vrácené queryCameras
- options
- VideoStreamOptions
Možnosti řízení, jak se stream fotoaparátu vykresluje <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Návraty
Promise<void>
setCaptionLanguage(string)
Funkce pro nastavení jazyka titulků
function setCaptionLanguage(language: string): Promise<void>
Parametry
- language
-
string
Jazyk nastavený pro titulek
Návraty
Promise<void>
setMicrophone(AudioDeviceInfo)
Nastavte mikrofon tak, aby se používal při hovoru.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>
Parametry
- sourceInfo
- AudioDeviceInfo
Výběr zařízení mikrofonu, výběr zařízení vrácený dotazemMicrophones
Návraty
Promise<void>
setSpeaker(AudioDeviceInfo)
Nastavte reproduktor, který se má použít při hovoru.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>
Parametry
- sourceInfo
- AudioDeviceInfo
Zařízení mluvčího, které chcete zvolit, vyberte jeden vrácený dotazYSpeakers
Návraty
Promise<void>
setSpokenLanguage(string)
Funkce pro nastavení mluveného jazyka
function setSpokenLanguage(language: string): Promise<void>
Parametry
- language
-
string
Mluvený jazyk
Návraty
Promise<void>
setTogetherModeSceneSize(number, number)
Přepočítejte polohy sedadel pro režim společně.
function setTogetherModeSceneSize(width: number, height: number)
Parametry
- width
-
number
Šířka kontejneru
- height
-
number
Výška kontejneru
Poznámky
Tato metoda je implementována pro složené
Zděděno zCallWithChatAdapterManagement.setTogetherModeSceneSize
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
Zahajte hovor.
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call
Parametry
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
Pole <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> má být voláno
- options
- StartCallOptions
Návraty
undefined | Call
startCall(string[], StartCallOptions)
Zahajte hovor.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
Parametry
- participants
-
string[]
Pole ID účastníků, ke které se chcete připojit
- options
- StartCallOptions
Návraty
undefined | Call
startCamera(VideoStreamOptions)
Spusťte kameru.
Tato metoda začne vykreslovat zobrazení místní kamery, když volání není aktivní.
function startCamera(options?: VideoStreamOptions): Promise<void>
Parametry
- options
- VideoStreamOptions
Možnosti pro řízení vykreslování streamů videa <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
Návraty
Promise<void>
startCaptions(StartCaptionsAdapterOptions)
Funkce pro začátek titulků
function startCaptions(options?: StartCaptionsAdapterOptions): Promise<void>
Parametry
- options
- StartCaptionsAdapterOptions
Volby pro úvodní titulky
Návraty
Promise<void>
startNoiseSuppressionEffect()
Spusťte efekt potlačení šumu.
function startNoiseSuppressionEffect(): Promise<void>
Návraty
Promise<void>
Zděděno zCallWithChatAdapterManagement.startNoiseSuppressionEffect
startScreenShare()
Během hovoru začněte sdílet obrazovku.
function startScreenShare(): Promise<void>
Návraty
Promise<void>
startSpotlight(string[])
Začněte v centru pozornosti
function startSpotlight(userIds?: string[]): Promise<void>
Parametry
- userIds
-
string[]
Návraty
Promise<void>
startTogetherMode()
Spusťte režim společně.
function startTogetherMode(): Promise<void>
Návraty
Promise<void>
Poznámky
Tato metoda je implementována pro složené
startVideoBackgroundEffect(VideoBackgroundEffect)
Spusťte efekt pozadí videa.
function startVideoBackgroundEffect(videoBackgroundEffect: VideoBackgroundEffect): Promise<void>
Parametry
- videoBackgroundEffect
- VideoBackgroundEffect
Návraty
Promise<void>
Zděděno zCallWithChatAdapterManagement.startVideoBackgroundEffect
stopAllSpotlight()
Zastavte všechna světla reflektorů
function stopAllSpotlight(): Promise<void>
Návraty
Promise<void>
stopCamera()
Zastavte kameru.
Tato metoda přestane vykreslovat zobrazení místní kamery, pokud volání není aktivní.
function stopCamera(): Promise<void>
Návraty
Promise<void>
stopCaptions(StopCaptionsAdapterOptions)
Funkce pro zastavení titulků
function stopCaptions(options?: StopCaptionsAdapterOptions): Promise<void>
Parametry
- options
- StopCaptionsAdapterOptions
Návraty
Promise<void>
stopNoiseSuppressionEffect()
Spusťte efekt potlačení šumu.
function stopNoiseSuppressionEffect(): Promise<void>
Návraty
Promise<void>
Zděděno zCallWithChatAdapterManagement.stopNoiseSuppressionEffect
stopScreenShare()
Přestaňte sdílet obrazovku.
function stopScreenShare(): Promise<void>
Návraty
Promise<void>
stopSpotlight(string[])
Zastavte reflektor
function stopSpotlight(userIds?: string[]): Promise<void>
Parametry
- userIds
-
string[]
Návraty
Promise<void>
stopVideoBackgroundEffects()
Zastavte efekt pozadí videa.
function stopVideoBackgroundEffects(): Promise<void>
Návraty
Promise<void>
Zděděno zCallWithChatAdapterManagement.stopVideoBackgroundEffects
submitSurvey(CallSurvey)
Odeslání výsledku průzkumu na konci hovoru
function submitSurvey(survey: CallSurvey): Promise<undefined | CallSurveyResponse>
Parametry
- survey
- CallSurvey
Návraty
Promise<undefined | CallSurveyResponse>
unmute()
Zrušte ztlumení aktuálního uživatele během hovoru nebo povolte mikrofon místně.
function unmute(): Promise<void>
Návraty
Promise<void>
zděděno zCallWithChatAdapterManagement.unmute
updateBackgroundPickerImages(VideoBackgroundImage[])
Přepište obrazy pro výběr pozadí, aby se nahradilo pozadí.
function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])
Parametry
- backgroundImages
Pole vlastních obrázků na pozadí.
Zděděno zCallWithChatAdapterManagement.updateBackgroundPickerImages
updateMessage(string, string, Record<string, string>)
Aktualizujte obsah zprávy.
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>
Parametry
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
Návraty
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
Aktualizace vybraného efektu pozadí videa
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
Parametry
- selectedVideoBackground
- VideoBackgroundEffect
Zděděno zCallWithChatAdapterManagement.updateSelectedVideoBackgroundEffect