CallAdapterCallOperations interface

Paket:

@azure/communication-react

Geçerli çağrıyı yönetme işlevselliği.

Özellikler

sendRealTimeText

Gerçek zamanlı metin gönder

Yöntemler

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	Aramaya bir katılımcı ekleyin.
createStreamView(string, VideoStreamOptions)	Akış için html görünümünü oluşturun.
createTogetherModeStreamView(TogetherModeStreamOptions)	Akış için html görünümünü oluşturun.
disposeLocalVideoStreamView()	Yerel bir video akışı için html görünümünü atma
disposeRemoteVideoStreamView(string)	Uzak video akışı için html görünümünü atma
disposeScreenShareStreamView(string)	Ekran paylaşımı akışı için html görünümünü atma
disposeStreamView(string, VideoStreamOptions)	Bir akış için html görünümünü atın.
disposeTogetherModeStreamView()	Bir akış için html görünümünü atın.
forbidAudio(string[])	Teams toplantı katılımcılarının kullanıcı kimliklerine göre ses çıkarmasını yasaklayın.
forbidOthersAudio()	Teams toplantı sesini yasaklayın.
forbidOthersVideo()	Teams toplantı videosunu yasaklayın.
forbidVideo(string[])	Teams toplantı katılımcılarının videosunu kullanıcı kimliklerine göre yasaklayın.
holdCall()	Çağrıyı bekletir.
leaveCall(boolean)	Aramayı bırakın
lowerHand()	mevcut kullanıcı için alt el
mute()	Arama sırasında geçerli kullanıcının sesini kapatma veya mikrofonu yerel olarak devre dışı bırakma
muteAllRemoteParticipants()	Tüm katılımcıların sesini kapatma
muteParticipant(string)	Katılımcının sesini kapatma
onReactionClick(Reaction)	Tepki emojisi gönder
permitAudio(string[])	Teams toplantı katılımcılarının kullanıcı kimliklerine göre ses çıkarmasına izin verin.
permitOthersAudio()	Teams toplantı sesine izin verin.
permitOthersVideo()	Teams toplantı videosuna izin verin.
permitVideo(string[])	Teams toplantı katılımcılarının kullanıcı kimliklerine göre ses çıkarmasına izin verin.
raiseHand()	Mevcut kullanıcı için el kaldırın
removeParticipant(CommunicationIdentifier)	Bir katılımcıyı aramadan kaldırın.
removeParticipant(string)	Bir katılımcıyı aramadan kaldırın.
resumeCall()	Çağrıyı bir LocalHold durumdan sürdürür.
returnFromBreakoutRoom()	Grup oturumu odasının başlangıç çağrısına dön
sendDtmfTone(DtmfTone)	1:1 PSTN çağrısında başka bir katılımcıya dtmf tonu gönderme
setCaptionLanguage(string)	Altyazı dilini ayarlama işlevi
setSpokenLanguage(string)	Konuşma dilini ayarlama işlevi
setTogetherModeSceneSize(number, number)	Birlikte modu için oturma pozisyonlarını yeniden hesaplayın.
startCamera(VideoStreamOptions)	Kamerayı başlatma Arama etkin olmadığında bu yöntem yerel kamera görünümünü işlemeye başlar
startCaptions(StartCaptionsAdapterOptions)	Altyazı Başlatma İşlevi
startNoiseSuppressionEffect()	Gürültü bastırma efektini başlatın.
startScreenShare()	Arama sırasında ekranı paylaşmaya başlayın.
startSpotlight(string[])	Yerel ve uzak katılımcılar için kullanıcı kimliklerine göre spot ışığı başlatın. Herhangi bir kullanıcı kimliği dizisi geçirilmezse, yerel katılımcı üzerinde eylem gerçekleştirilir.
startTogetherMode()	Birlikte Başlat modu.
startVideoBackgroundEffect(VideoBackgroundEffect)	Video arka plan efektini başlatın.
stopAllSpotlight()	Tüm spot ışıklarını durdur
stopCamera()	Kamerayı durdurma Arama etkin olmadığında bu yöntem yerel kamera görünümünü işlemeyi durdurur
stopCaptions(StopCaptionsAdapterOptions)	Altyazıları durdurma işlevi
stopNoiseSuppressionEffect()	Gürültü bastırma efektini durdurun.
stopScreenShare()	Ekranı paylaşmayı durdurma
stopSpotlight(string[])	Yerel ve uzak katılımcılar için kullanıcı kimliklerine göre spot ışığını durdurun. Herhangi bir kullanıcı kimliği dizisi geçirilmezse, yerel katılımcı üzerinde eylem gerçekleştirilir.
stopVideoBackgroundEffects()	Video arka plan efektini durdurun.
submitSurvey(CallSurvey)	Çağrı sonu anketi sonucunu gönder
unmute()	Arama sırasında geçerli kullanıcının sesini açma veya mikrofonu yerel olarak etkinleştirme
updateBackgroundPickerImages(VideoBackgroundImage[])	Arka plan değiştirme efekti için arka plan seçici resimlerini geçersiz kılın.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	Seçilen video arka plan efektini güncelleyin.

Özellik Ayrıntıları

sendRealTimeText

Gerçek zamanlı metin gönder

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

Özellik Değeri

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

Yöntem Ayrıntıları

addParticipant(CommunicationUserIdentifier)

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

Parametreler

participant

CommunicationUserIdentifier

Döndürülenler

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

Aramaya bir katılımcı ekleyin.

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

Parametreler

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

Döndürülenler

Promise<void>

createStreamView(string, VideoStreamOptions)

Akış için html görünümünü oluşturun.

function createStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void | CreateVideoStreamViewResult>

Parametreler

remoteUserId

string

İşlenmek üzere katılımcının kimliği, yerel kamera görünümünü oluşturmak için tanımsız bırakın

options

VideoStreamOptions

Video akışlarının nasıl işlendiğini denetleme seçenekleri <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Döndürülenler

Promise<void | CreateVideoStreamViewResult>

Açıklamalar

Bu yöntem bileşik için uygulanır

createTogetherModeStreamView(TogetherModeStreamOptions)

Akış için html görünümünü oluşturun.

function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>

Parametreler

options

TogetherModeStreamOptions

Video akışlarının nasıl işlendiğini denetleme seçenekleri <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Döndürülenler

Promise<void | TogetherModeStreamViewResult>

Açıklamalar

Bu yöntem bileşik için uygulanır

disposeLocalVideoStreamView()

Yerel bir video akışı için html görünümünü atma

function disposeLocalVideoStreamView(): Promise<void>

Döndürülenler

Promise<void>

disposeRemoteVideoStreamView(string)

Uzak video akışı için html görünümünü atma

function disposeRemoteVideoStreamView(remoteUserId: string): Promise<void>

Parametreler

remoteUserId

string

Elden çıkarılacak katılımcının kimliği

Döndürülenler

Promise<void>

disposeScreenShareStreamView(string)

Ekran paylaşımı akışı için html görünümünü atma

function disposeScreenShareStreamView(remoteUserId: string): Promise<void>

Parametreler

remoteUserId

string

Ekran paylaşımı akış görünümünü atacak katılımcının kimliği.

Döndürülenler

Promise<void>

Açıklamalar

Bu yöntem kompozit için uygulanır

disposeStreamView(string, VideoStreamOptions)

Uyarı

Bu API artık kullanım dışıdır.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

Bir akış için html görünümünü atın.

function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>

Parametreler

remoteUserId

string

İşlenmek üzere katılımcının kimliği, yerel kamera görünümünü atmak için tanımsız bırakın

options

VideoStreamOptions

Video akışlarının nasıl işlendiğini denetleme seçenekleri <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Döndürülenler

Promise<void>

Açıklamalar

Bu yöntem bileşik için uygulanır

disposeTogetherModeStreamView()

Bir akış için html görünümünü atın.

function disposeTogetherModeStreamView(): Promise<void>

Döndürülenler

Promise<void>

Açıklamalar

Bu yöntem bileşik için uygulanır

forbidAudio(string[])

Teams toplantı katılımcılarının kullanıcı kimliklerine göre ses çıkarmasını yasaklayın.

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

Parametreler

userIds

string[]

Döndürülenler

Promise<void>

forbidOthersAudio()

Teams toplantı sesini yasaklayın.

function forbidOthersAudio(): Promise<void>

Döndürülenler

Promise<void>

forbidOthersVideo()

Teams toplantı videosunu yasaklayın.

function forbidOthersVideo(): Promise<void>

Döndürülenler

Promise<void>

forbidVideo(string[])

Teams toplantı katılımcılarının videosunu kullanıcı kimliklerine göre yasaklayın.

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

Parametreler

userIds

string[]

Döndürülenler

Promise<void>

holdCall()

Çağrıyı bekletir.

function holdCall(): Promise<void>

Döndürülenler

Promise<void>

leaveCall(boolean)

Aramayı bırakın

function leaveCall(forEveryone?: boolean): Promise<void>

Parametreler

forEveryone

boolean

Ayrılırken tüm katılımcıların kaldırılıp kaldırılmayacağı

Döndürülenler

Promise<void>

lowerHand()

mevcut kullanıcı için alt el

function lowerHand(): Promise<void>

Döndürülenler

Promise<void>

mute()

Arama sırasında geçerli kullanıcının sesini kapatma veya mikrofonu yerel olarak devre dışı bırakma

function mute(): Promise<void>

Döndürülenler

Promise<void>

muteAllRemoteParticipants()

Tüm katılımcıların sesini kapatma

function muteAllRemoteParticipants(): Promise<void>

Döndürülenler

Promise<void>

muteParticipant(string)

Katılımcının sesini kapatma

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

Parametreler

userId

string

Sessize alınacak katılımcının kimliği

Döndürülenler

Promise<void>

onReactionClick(Reaction)

Tepki emojisi gönder

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

Parametreler

reaction

Reaction

Döndürülenler

Promise<void>

permitAudio(string[])

Teams toplantı katılımcılarının kullanıcı kimliklerine göre ses çıkarmasına izin verin.

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

Parametreler

userIds

string[]

Döndürülenler

Promise<void>

permitOthersAudio()

Teams toplantı sesine izin verin.

function permitOthersAudio(): Promise<void>

Döndürülenler

Promise<void>

permitOthersVideo()

Teams toplantı videosuna izin verin.

function permitOthersVideo(): Promise<void>

Döndürülenler

Promise<void>

permitVideo(string[])

Teams toplantı katılımcılarının kullanıcı kimliklerine göre ses çıkarmasına izin verin.

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

Parametreler

userIds

string[]

Döndürülenler

Promise<void>

raiseHand()

Mevcut kullanıcı için el kaldırın

function raiseHand(): Promise<void>

Döndürülenler

Promise<void>

removeParticipant(CommunicationIdentifier)

Bir katılımcıyı aramadan kaldırın.

function removeParticipant(participant: CommunicationIdentifier): Promise<void>

Parametreler

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> kaldırılacak katılımcının

Döndürülenler

Promise<void>

removeParticipant(string)

Bir katılımcıyı aramadan kaldırın.

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

Parametreler

userId

string

Kaldırılacak katılımcının kimliği

Döndürülenler

Promise<void>

resumeCall()

Çağrıyı bir LocalHold durumdan sürdürür.

function resumeCall(): Promise<void>

Döndürülenler

Promise<void>

returnFromBreakoutRoom()

Grup oturumu odasının başlangıç çağrısına dön

function returnFromBreakoutRoom(): Promise<void>

Döndürülenler

Promise<void>

sendDtmfTone(DtmfTone)

1:1 PSTN çağrısında başka bir katılımcıya dtmf tonu gönderme

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

Parametreler

dtmfTone

DtmfTone

Döndürülenler

Promise<void>

setCaptionLanguage(string)

Altyazı dilini ayarlama işlevi

function setCaptionLanguage(language: string): Promise<void>

Parametreler

language

string

Altyazı için dil ayarı

Döndürülenler

Promise<void>

setSpokenLanguage(string)

Konuşma dilini ayarlama işlevi

function setSpokenLanguage(language: string): Promise<void>

Parametreler

language

string

Konuşulan dil

Döndürülenler

Promise<void>

setTogetherModeSceneSize(number, number)

Birlikte modu için oturma pozisyonlarını yeniden hesaplayın.

function setTogetherModeSceneSize(width: number, height: number)

Parametreler

width

number

Kabın genişliği

height

number

Kabın yüksekliği

Açıklamalar

Bu yöntem bileşik için uygulanır

startCamera(VideoStreamOptions)

Kamerayı başlatma Arama etkin olmadığında bu yöntem yerel kamera görünümünü işlemeye başlar

function startCamera(options?: VideoStreamOptions): Promise<void>

Parametreler

options

VideoStreamOptions

Video akışlarının nasıl işlendiğini denetleme seçenekleri <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

Döndürülenler

Promise<void>

startCaptions(StartCaptionsAdapterOptions)

Altyazı Başlatma İşlevi

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

Parametreler

options

StartCaptionsAdapterOptions

Başlangıç altyazıları için seçenekler

Döndürülenler

Promise<void>

startNoiseSuppressionEffect()

Gürültü bastırma efektini başlatın.

function startNoiseSuppressionEffect(): Promise<void>

Döndürülenler

Promise<void>

startScreenShare()

Arama sırasında ekranı paylaşmaya başlayın.

function startScreenShare(): Promise<void>

Döndürülenler

Promise<void>

startSpotlight(string[])

Yerel ve uzak katılımcılar için kullanıcı kimliklerine göre spot ışığı başlatın. Herhangi bir kullanıcı kimliği dizisi geçirilmezse, yerel katılımcı üzerinde eylem gerçekleştirilir.

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

Parametreler

userIds

string[]

Döndürülenler

Promise<void>

startTogetherMode()

Birlikte Başlat modu.

function startTogetherMode(): Promise<void>

Döndürülenler

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

Video arka plan efektini başlatın.

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

Parametreler

videoBackgroundEffect

VideoBackgroundEffect

Döndürülenler

Promise<void>

stopAllSpotlight()

Tüm spot ışıklarını durdur

function stopAllSpotlight(): Promise<void>

Döndürülenler

Promise<void>

stopCamera()

Kamerayı durdurma Arama etkin olmadığında bu yöntem yerel kamera görünümünü işlemeyi durdurur

function stopCamera(): Promise<void>

Döndürülenler

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

Altyazıları durdurma işlevi

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

Parametreler

options

StopCaptionsAdapterOptions

Döndürülenler

Promise<void>

stopNoiseSuppressionEffect()

Gürültü bastırma efektini durdurun.

function stopNoiseSuppressionEffect(): Promise<void>

Döndürülenler

Promise<void>

stopScreenShare()

Ekranı paylaşmayı durdurma

function stopScreenShare(): Promise<void>

Döndürülenler

Promise<void>

stopSpotlight(string[])

Yerel ve uzak katılımcılar için kullanıcı kimliklerine göre spot ışığını durdurun. Herhangi bir kullanıcı kimliği dizisi geçirilmezse, yerel katılımcı üzerinde eylem gerçekleştirilir.

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

Parametreler

userIds

string[]

Döndürülenler

Promise<void>

stopVideoBackgroundEffects()

Video arka plan efektini durdurun.

function stopVideoBackgroundEffects(): Promise<void>

Döndürülenler

Promise<void>

submitSurvey(CallSurvey)

Çağrı sonu anketi sonucunu gönder

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

Parametreler

survey

CallSurvey

Döndürülenler

Promise<undefined | CallSurveyResponse>

unmute()

Arama sırasında geçerli kullanıcının sesini açma veya mikrofonu yerel olarak etkinleştirme

function unmute(): Promise<void>

Döndürülenler

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

Arka plan değiştirme efekti için arka plan seçici resimlerini geçersiz kılın.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

Parametreler

backgroundImages

VideoBackgroundImage[]

Özel arka plan görüntüleri dizisi.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

Seçilen video arka plan efektini güncelleyin.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

Parametreler

selectedVideoBackground

VideoBackgroundEffect