StatefulCallClient interface

Paket:

@azure/communication-react

CallClient <xref:%40azure%2Fcommunication-calling%23CallClient> durum bilgisi olan şekilde kullanılmasına izin veren yöntemleri tanımlar. Arabirim, proksied durumuna erişim sağlar ve ayrıca durum değişikliği olayları için bir işleyici kaydetmeye izin verir. Durum tanımı için bkz. CallClientState.

Durum değişikliği olayları şunlara göre yönlendirilir:

• <xref:%40azure%2Fcommunication-calling%23DeviceManager> API'lerinden döndürülen veriler.
• <xref:%40azure%2Fcommunication-calling%23CallAgent> API'lerinden döndürülen veriler.
• Çeşitli Azure iletişim çağırma nesnelerine otomatik olarak eklenen dinleyiciler:
  • CallAgent 'incomingCall'
  • CallAgent 'callsUpdated'
  • DeviceManager 'videoDevicesUpdated'
  • DeviceManager 'audioDevicesUpdated
  • DeviceManager 'selectedMicrophoneChanged'
  • DeviceManager 'selectedSpeakerChanged'
  • 'stateChanged' çağrısı
  • 'idChanged' çağrısı
  • 'isMutedChanged' çağrısı
  • 'isScreenSharingOnChanged' çağrısı
  • 'remoteParticipantsUpdated' çağrısı
  • 'localVideoStreamsUpdated' çağrısı
  • GelenArama 'callEnded'
  • RemoteParticipant 'stateChanged'
  • RemoteParticipant 'isMutedChanged'
  • RemoteParticipant 'displayNameChanged'
  • RemoteParticipant 'isSpeakingChanged'
  • RemoteParticipant 'videoStreamsUpdated'
  • RemoteVideoStream 'isAvailableChanged'
  • TranscriptionCallFeature 'isTranscriptionActiveChanged'
  • RecordingCallFeature 'isRecordingActiveChanged'
  • LocalRecordingCallFeature 'isLocalRecordingActiveChanged'
  • RaiseHandCallFeature 'yükseltilmiş El Olayı'
  • RaiseHandCallFeature 'loweredHandEvent'
  • PPTLiveCallFeature 'isAciveChanged'
  • ReactionCallFeature 'reaksiyon'

Extends

CallClient

Yöntemler

createCallAgent([tokenCredential, options])	CallAgent, çağrıları işlemek için kullanılır. CallAgent'ı oluşturmak için SDK'dan sağlanan bir CommunicationTokenCredential nesnesi geçirin. CallClient aynı anda yalnızca bir etkin CallAgent örneğine sahip olabilir. Yeni bir CallAgent oluşturmak için yeni bir CallClient örneği oluşturabilirsiniz. CallClient'ın geçerli etkin CallAgent'ını atabilir ve yeni bir CallAgent oluşturmak için CallClient'ın createCallAgent() yöntemini yeniden çağırabilirsiniz.
createTeamsCallAgent([tokenCredential, options])	TeamsCallAgent, çağrıları işlemek için kullanılır. TeamsCallAgent'ı oluşturmak için SDK'dan sağlanan bir CommunicationTokenCredential nesnesi geçirin. CallClient aynı anda yalnızca bir etkin TeamsCallAgent örneğine sahip olabilir. Yeni bir TeamsCallAgent oluşturmak için yeni bir CallClient örneği oluşturabilirsiniz. CallClient'ın geçerli etkin TeamsCallAgent'ını atabilir ve yeni bir TeamsCallAgent oluşturmak için CallClient'ın createTeamsCallAgent() yöntemini yeniden çağırabilirsiniz.
createView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState, CreateViewOptions)	RemoteVideoStreamState veya LocalVideoStreamState işler ve sonuçta elde edilen VideoStreamRendererViewState ilgili RemoteVideoStreamState altında veya LocalVideoStreamState veya durumunda ayrılmamış görünüm olarak depolar. Arka planda <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>arar. Senaryo 1: RemoteVideoStreamState İşleme CallId gereklidir, participantId gereklidir ve RemoteVideoStreamState türünde akış gereklidir Sonuçta elde edilen VideoStreamRendererViewState verilen callId ve participantId CallClientState içinde depolanır Senaryo 2: Bir çağrı için LocalVideoStreamState İşleme CallId gereklidir, participantId tanımsız olmalıdır ve LocalVideoStreamState türünde bir akış gereklidir. <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams> zaten <xref:%40azure%2Fcommunication-calling%23Call.startVideo>kullanılarak başlatılmalıdır. Sonuçta elde edilen VideoStreamRendererViewState, CallClientStateiçindeki verilen callId localVideoStreams depolanır. Senaryo 2: Bir çağrının parçası olmayan LocalVideoStreamState'i İşleme (yerel önizleme için örnek işleme kamerası) CallId tanımsız olmalı, participantId tanımsız olmalı ve LocalVideoStreamState türünde akış gereklidir. Elde edilen VideoStreamRendererViewState, <xref:CallClientState.deviceManager.unparentedViews>'de verilen LocalVideoStreamState altında depolanır
disposeView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState)	Bir RemoteVideoStreamState veya LocalVideoStreamState işlemeyi durdurur ve <xref:VideoStreamRendererView> veya uygun CallClientState veya uygun <xref:LocalVideoStream>RemoteVideoStreamState<xref:CallClientState.deviceManager.unparentedViews> kaldırır <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>. Kaynakları düzgün bir şekilde temizlemek için disposeView'un önemli olması. Senaryo 1: Dispose RemoteVideoStreamState CallId gereklidir, participantId gereklidir ve RemoteVideoStreamState türünde akış gereklidir Senaryo 2: Çağrı için LocalVideoStreamState'i atma CallId gereklidir, participantId tanımsız olmalıdır ve LocalVideoStreamState türünde bir akış gereklidir. Senaryo 2: Bir çağrının parçası olmayan LocalVideoStreamState'i atma CallId tanımsız olmalı, participantId tanımsız olmalı ve LocalVideoStreamState türünde akış gereklidir. LocalVideoStreamState, createView'a geçirilen özgün eyalet olmalıdır.
getState()	CallClient <xref:%40azure%2Fcommunication-calling%23CallClient>'dan CallClientState CallClientStateolarak ara sunucu olarak kullanabileceğimiz tüm durumu tutar.
offStateChange((state: CallClientState) => void)	'stateChanged' olaylarının kaydını kaldırmaya izin verir.
onStateChange((state: CallClientState) => void)	bir işleyicinin 'stateChanged' olayları için kaydedilmesine izin verir.

Devralınan Yöntemler

dispose()	İlişkili aygıt yöneticisini ve ilişkili çağrı aracısını da atan bu CallClient'ı atar.
feature<TFeature>(CallClientFeatureFactory<TFeature>)	Genişletilmiş API ile başlatılan ve notlaştırılmış bir Özellik nesnesi alır. Bu paketteki tüm kullanılabilir genişletilmiş çağrı istemcisi özellikleri için Features.* nesnesini denetleyin.
getDeviceManager()	DeviceManager, kameralar, mikrofonlar ve hoparlörler gibi medya cihazlarını işlemek için kullanılır.

Yöntem Ayrıntıları

createCallAgent([tokenCredential, options])

CallAgent, çağrıları işlemek için kullanılır. CallAgent'ı oluşturmak için SDK'dan sağlanan bir CommunicationTokenCredential nesnesi geçirin.

• CallClient aynı anda yalnızca bir etkin CallAgent örneğine sahip olabilir.
• Yeni bir CallAgent oluşturmak için yeni bir CallClient örneği oluşturabilirsiniz.
• CallClient'ın geçerli etkin CallAgent'ını atabilir ve yeni bir CallAgent oluşturmak için CallClient'ın createCallAgent() yöntemini yeniden çağırabilirsiniz.

function createCallAgent(args: [tokenCredential, options]): Promise<DeclarativeCallAgent>

Parametreler

args

[tokenCredential, options]

Döndürülenler

Promise<DeclarativeCallAgent>

createTeamsCallAgent([tokenCredential, options])

TeamsCallAgent, çağrıları işlemek için kullanılır. TeamsCallAgent'ı oluşturmak için SDK'dan sağlanan bir CommunicationTokenCredential nesnesi geçirin.

• CallClient aynı anda yalnızca bir etkin TeamsCallAgent örneğine sahip olabilir.
• Yeni bir TeamsCallAgent oluşturmak için yeni bir CallClient örneği oluşturabilirsiniz.
• CallClient'ın geçerli etkin TeamsCallAgent'ını atabilir ve yeni bir TeamsCallAgent oluşturmak için CallClient'ın createTeamsCallAgent() yöntemini yeniden çağırabilirsiniz.

function createTeamsCallAgent(args: [tokenCredential, options]): Promise<DeclarativeTeamsCallAgent>

Parametreler

args

[tokenCredential, options]

Döndürülenler

Promise<DeclarativeTeamsCallAgent>

createView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState, CreateViewOptions)

RemoteVideoStreamState veya LocalVideoStreamState işler ve sonuçta elde edilen VideoStreamRendererViewState ilgili RemoteVideoStreamState altında veya LocalVideoStreamState veya durumunda ayrılmamış görünüm olarak depolar. Arka planda <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.createView>arar.

Senaryo 1: RemoteVideoStreamState İşleme

• CallId gereklidir, participantId gereklidir ve RemoteVideoStreamState türünde akış gereklidir
• Sonuçta elde edilen VideoStreamRendererViewState verilen callId ve participantId CallClientState içinde depolanır

Senaryo 2: Bir çağrı için LocalVideoStreamState İşleme

• CallId gereklidir, participantId tanımsız olmalıdır ve LocalVideoStreamState türünde bir akış gereklidir.

• <xref:%40azure%2Fcommunication-calling%23Call.localVideoStreams> zaten <xref:%40azure%2Fcommunication-calling%23Call.startVideo>kullanılarak başlatılmalıdır.

• Sonuçta elde edilen VideoStreamRendererViewState, CallClientStateiçindeki verilen callId localVideoStreams depolanır.

• Senaryo 2: Bir çağrının parçası olmayan LocalVideoStreamState'i İşleme (yerel önizleme için örnek işleme kamerası)

• CallId tanımsız olmalı, participantId tanımsız olmalı ve LocalVideoStreamState türünde akış gereklidir.

• Elde edilen VideoStreamRendererViewState, <xref:CallClientState.deviceManager.unparentedViews>'de verilen LocalVideoStreamState altında depolanır

function createView(callId: undefined | string, participantId: undefined | CommunicationIdentifier, stream: CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState, options?: CreateViewOptions): Promise<undefined | CreateViewResult>

Parametreler

callId

undefined | string

Verilen akış için CallId. Akış herhangi bir çağrının parçası değilse tanımsız olabilir.

participantId

undefined | CommunicationIdentifier

verilen RemoteVideoStreamState ile ilişkili <xref:RemoteParticipant.identifier>. LocalVideoStreamState işlenirse tanımsız olabilir.

stream

CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState

İşlemeye başlamak için LocalVideoStreamState veya RemoteVideoStreamState.

options

CreateViewOptions

<xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer>geçirilen seçenekler.

Döndürülenler

Promise<undefined | CreateViewResult>

disposeView(undefined | string, undefined | CommunicationIdentifier, CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState)

Bir RemoteVideoStreamState veya LocalVideoStreamState işlemeyi durdurur ve <xref:VideoStreamRendererView> veya uygun CallClientState veya uygun <xref:LocalVideoStream>RemoteVideoStreamState<xref:CallClientState.deviceManager.unparentedViews> kaldırır <xref:%40azure%2Fcommunication-calling%23VideoStreamRenderer.dispose>.

Kaynakları düzgün bir şekilde temizlemek için disposeView'un önemli olması.

Senaryo 1: Dispose RemoteVideoStreamState

• CallId gereklidir, participantId gereklidir ve RemoteVideoStreamState türünde akış gereklidir

Senaryo 2: Çağrı için LocalVideoStreamState'i atma

• CallId gereklidir, participantId tanımsız olmalıdır ve LocalVideoStreamState türünde bir akış gereklidir.

• Senaryo 2: Bir çağrının parçası olmayan LocalVideoStreamState'i atma

• CallId tanımsız olmalı, participantId tanımsız olmalı ve LocalVideoStreamState türünde akış gereklidir.

• LocalVideoStreamState, createView'a geçirilen özgün eyalet olmalıdır.

function disposeView(callId: undefined | string, participantId: undefined | CommunicationIdentifier, stream: CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState)

Parametreler

callId

undefined | string

Verilen akış için CallId. Akış herhangi bir çağrının parçası değilse tanımsız olabilir.

participantId

undefined | CommunicationIdentifier

verilen RemoteVideoStreamState ile ilişkili <xref:RemoteParticipant.identifier>. LocalVideoStreamState yok edilirse tanımsız olabilir.

stream

CallFeatureStreamState | RemoteVideoStreamState | LocalVideoStreamState

Atılacak LocalVideoStreamState veya RemoteVideoStreamState.

getState()

CallClient <xref:%40azure%2Fcommunication-calling%23CallClient>'dan CallClientState CallClientStateolarak ara sunucu olarak kullanabileceğimiz tüm durumu tutar.

function getState(): CallClientState

Döndürülenler

CallClientState

offStateChange((state: CallClientState) => void)

'stateChanged' olaylarının kaydını kaldırmaya izin verir.

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

Parametreler

handler

(state: CallClientState) => void

Aboneliği kaldırılacak özgün geri arama.

onStateChange((state: CallClientState) => void)

bir işleyicinin 'stateChanged' olayları için kaydedilmesine izin verir.

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

Parametreler

handler

(state: CallClientState) => void

Durumu almak için geri arama.

Devralınan Yöntemin Ayrıntıları

dispose()

İlişkili aygıt yöneticisini ve ilişkili çağrı aracısını da atan bu CallClient'ı atar.

function dispose(): Promise<void>

Döndürülenler

Promise<void>

Devralınan CallClient.dispose

feature<TFeature>(CallClientFeatureFactory<TFeature>)

Genişletilmiş API ile başlatılan ve notlaştırılmış bir Özellik nesnesi alır. Bu paketteki tüm kullanılabilir genişletilmiş çağrı istemcisi özellikleri için Features.* nesnesini denetleyin.

function feature<TFeature>(factory: CallClientFeatureFactory<TFeature>): TFeature

Parametreler

factory

CallClientFeatureFactory<TFeature>

Genişletilmiş API sağlayan çağrı istemcisi özellik oluşturucusunun fabrikası.

Döndürülenler

TFeature

CallClient.feature Devralındı

getDeviceManager()

DeviceManager, kameralar, mikrofonlar ve hoparlörler gibi medya cihazlarını işlemek için kullanılır.

function getDeviceManager(): Promise<DeviceManager>

Döndürülenler

Promise<DeviceManager>

CallClient.getDeviceManager'dan Devralınan