Call interface

이 통화에 대한 정보를 가져옵니다.

info: CallInfo

속성 값

이 호출이 종료된 방법을 나타내는 코드/하위 코드가 포함되어 있습니다.

callEndReason?: CallEndReason

속성 값

CallCommon.callEndReason 상속된

이 호출이 들어오는 경우 호출자 정보입니다.

callerInfo: CallerInfo

속성 값

CallCommon.callerInfo 상속된

수신 또는 발신에 관계없이 호출 방향을 가져옵니다.

direction: CallDirection

속성 값

CallCommon.direction 상속된

이 호출의 고유 ID를 가져옵니다.

id: string

속성 값

CallCommon.id 상속된

로컬 사용자가 들어오는 오디오를 음소거했는지 여부입니다.

isIncomingAudioMuted: boolean

속성 값

CallCommon.isIncomingAudioMuted 상속된

로컬 비디오가 켜지는지 여부입니다.

isLocalVideoStarted: boolean

속성 값

CallCommon.isLocalVideoStarted 상속된

로컬 사용자가 음소거되었는지, 로컬로 또는 원격으로 음소거되는지 여부입니다.

isMuted: boolean

속성 값

CallCommon.isMuted 상속된

화면 공유가 켜지는지 여부입니다.

isScreenSharingOn: boolean

속성 값

CallCommon.isScreenSharingOn 상속된

호출 개체의 종류를 가져옵니다.

kind: CallKind

속성 값

CallCommon.kind 상속된

Teams 모임 로비를 가져옵니다.

lobby: Lobby

속성 값

CallCommon.lobby 상속된

통화 중 다른 참가자에게 전송되는 로컬 오디오 스트림의 컬렉션입니다.

localAudioStreams: readonly LocalAudioStream[]

속성 값

CallCommon.localAudioStreams 상속된

통화 중 다른 참가자에게 전송되는 로컬 비디오 스트림의 컬렉션입니다.

localVideoStreams: readonly LocalVideoStream[]

속성 값

CallCommon.localVideoStreams 상속된

통화에서 수신되는 원격 오디오 스트림의 컬렉션입니다.

remoteAudioStreams: readonly RemoteAudioStream[]

속성 값

CallCommon.remoteAudioStreams 상속된

이 호출의 원격 참가자 컬렉션입니다. 100명 이상의 참가자와 통화하는 경우 미디어 활성 참가자만 이 컬렉션에 있습니다.

remoteParticipants: readonly RemoteParticipant[]

속성 값

CallCommon.remoteParticipants 상속된

통화에서 로컬 사용자의 역할을 가져옵니다.

role: ParticipantRole

속성 값

CallCommon.role 상속된

이 호출의 상태를 가져옵니다.

state: CallState

속성 값

CallCommon.state 상속된

이 호출의 총 참가자 수입니다.

totalParticipantCount: number

속성 값

CallCommon.totalParticipantCount 상속된

이 통화에 참가자를 추가합니다.

function addParticipant(identifier: CommunicationUserIdentifier | MicrosoftTeamsUserIdentifier): RemoteParticipant

매개 변수

반환

성공적으로 추가된 참가자와 연결된 RemoteParticipant 개체입니다.

이 통화에 참가자를 추가합니다.

function addParticipant(identifier: CommunicationUserIdentifier, options?: AddCommunicationUserOptions): RemoteParticipant

매개 변수

반환

성공적으로 추가된 참가자와 연결된 RemoteParticipant 개체입니다.

이 통화에 Teams 앱을 추가합니다.

function addParticipant(identifier: MicrosoftTeamsAppIdentifier | UnknownIdentifier): RemoteParticipant

매개 변수

반환

성공적으로 추가된 Teams 앱과 연결된 RemoteParticipant 개체입니다.

이 통화에 참가자를 추가합니다.

function addParticipant(identifier: MicrosoftTeamsUserIdentifier, options: AddMicrosoftTeamsUserOptions): RemoteParticipant

매개 변수

반환

성공적으로 추가된 참가자와 연결된 RemoteParticipant 개체입니다.

이 통화에 참가자를 추가합니다.

function addParticipant(identifier: PhoneNumberIdentifier, options?: AddPhoneNumberOptions): RemoteParticipant

매개 변수

반환

성공적으로 추가된 참가자와 연결된 RemoteParticipant 개체입니다.

이 통화에서 참가자를 제거합니다.

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

매개 변수

반환

function dispose()

CallCommon.dispose 상속된

확장 API를 사용하여 초기화되고 기억된 Feature 개체를 검색합니다. 이 패키지에서 사용 가능한 모든 확장 호출 기능에 대한 개체 Features.*를 확인합니다. 예:

const call: Call = ...;
call.feature(Features.Recording).isRecordingActive;
call.feature(Features.Captions).startCaptions('en-us')

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

매개 변수

반환

CallCommon.feature 상속된

전화를 끊습니다.

function hangUp(options?: HangUpOptions): Promise<void>

매개 변수

반환

CallCommon.hangUp 상속된

이 통화를 보류합니다.

function hold(): Promise<void>

반환

CallCommon.hold 상속된

로컬 마이크를 음소거합니다.

function mute(): Promise<void>

반환

CallCommon.mute 상속된

모든 원격 참가자를 음소거합니다.

function muteAllRemoteParticipants(): Promise<void>

반환

CallCommon.muteAllRemoteParticipants 상속된

들어오는 오디오를 음소거합니다.

function muteIncomingAudio(): Promise<void>

반환

CallCommon.muteIncomingAudio 상속된

idChanged 이벤트에 대한 구독 취소 함수입니다.

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

매개 변수

CallCommon.off 상속된

isIncomingAudioMutedChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.off 상속된

isLocalVideoStartedChanged 이벤트에 대한 구독 취소 함수입니다.

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

매개 변수

CallCommon.off 상속된

isMutedChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.off 상속된

isScreenSharingChanged 이벤트에 대한 구독 취소 함수입니다.

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

매개 변수

CallCommon.off 상속된

localAudioStreamsUpdated 이벤트에 대한 구독 취소 함수입니다.

function off(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

매개 변수

CallCommon.off 상속된

localVideoStreamsUpdated 이벤트에 대한 구독 취소 함수입니다.

function off(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

매개 변수

CallCommon.off 상속된

mutedByOthers 이벤트에 대한 구독 취소 함수입니다.

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

매개 변수

CallCommon.off 상속된

remoteAudioStreamsUpdated 이벤트에 대한 구독 취소 함수입니다.

function off(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

매개 변수

CallCommon.off 상속된

remoteParticipantsUpdated 이벤트에 대한 구독 취소 함수입니다.

function off(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

매개 변수

CallCommon.off 상속된

roleChanged 이벤트에 대한 구독 취소 함수입니다.

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

매개 변수

CallCommon.off 상속된

stateChanged 이벤트에 대한 구독 취소 함수입니다.

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

매개 변수

CallCommon.off 상속된

totalParticipantCountChanged 이벤트에 대한 unsubscribe 함수입니다.

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

매개 변수

CallCommon.off 상속된

idChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.on에서 상속된

isIncomingAudioMutedChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.on에서 상속된

isLocalVideoStartedChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.on에서 상속된

isMutedChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.on에서 상속된

isScreenSharingChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.on에서 상속된

localAudioStreamsUpdated 이벤트에 대한 Subscribe 함수입니다.

function on(event: "localAudioStreamsUpdated", listener: CollectionUpdatedEvent<LocalAudioStream>)

매개 변수

CallCommon.on에서 상속된

localVideoStreamsUpdated 이벤트에 대한 Subscribe 함수입니다.

function on(event: "localVideoStreamsUpdated", listener: CollectionUpdatedEvent<LocalVideoStream>)

매개 변수

CallCommon.on에서 상속된

mutedByOthers 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.on에서 상속된

remoteAudioStreamsUpdated 이벤트에 대한 Subscribe 함수입니다.

function on(event: "remoteAudioStreamsUpdated", listener: CollectionUpdatedEvent<RemoteAudioStream>)

매개 변수

CallCommon.on에서 상속된

remoteParticipantsUpdated 이벤트에 대한 Subscribe 함수입니다.

function on(event: "remoteParticipantsUpdated", listener: CollectionUpdatedEvent<RemoteParticipant>)

매개 변수

CallCommon.on에서 상속된

roleChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.on에서 상속된

stateChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.on에서 상속된

totalParticipantCountChanged 이벤트에 대한 Subscribe 함수입니다.

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

매개 변수

CallCommon.on에서 상속된

'LocalHold' 상태인 경우 이 호출을 다시 시작합니다.

function resume(): Promise<void>

반환

CallCommon.resume 상속된

DTMF 톤을 보냅니다.

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

매개 변수

반환

CallCommon.sendDtmf 상속된

호출 제약 조건을 설정합니다. 이 메서드는 제공된 값에 따라 최대 제약 조건을 설정합니다. 최종 적용된 제약 조건은 이 메서드에 제공된 값보다 작거나 같습니다. 0 값이 제공되면 해당 제약 조건에 대한 제약 조건이 적용되지 않습니다. 정의되지 않은 값이 제공되면 해당 제약 조건에 사용된 이전 값이 사용됩니다.

function setConstraints(constraints: CallConstraints): Promise<void>

매개 변수

반환

CallCommon.setConstraints 상속된

사용자 지정 오디오를 사용하여 통화에서 오디오를 시작합니다. LocalAudioStream 원본은 MediaStream이어야 합니다.

function startAudio(localAudioStream: LocalAudioStream): Promise<void>

매개 변수

반환

CallCommon.startAudio 상속된

• 통화에서 화면 공유 스트림 보내기를 시작합니다. 브라우저에서 화면, 앱 또는 브라우저 탭을 선택하라는 메시지가 표시됩니다.
• iOS 또는 Android에서는 화면 공유 스트림 전송이 지원되지 않습니다.
• 들어오는 화면 공유 스트림은 iOS 및 Android에서 지원됩니다.

function startScreenSharing(): Promise<void>

반환

CallCommon.startScreenSharing 상속된

• 통화에서 원시 화면 공유 스트림 보내기를 시작합니다.
• iOS 또는 Android에서는 원시 화면 공유 전송이 지원되지 않습니다.
• 들어오는 원시 화면 공유는 iOS 및 Android에서 지원됩니다.

function startScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

매개 변수

반환

CallCommon.startScreenSharing 상속된

통화에서 비디오 스트림 보내기를 시작합니다. 통화의 원격 참가자는 비디오 스트림을 수신하여 UI로 렌더링할 수 있습니다.

function startVideo(localVideoStream: LocalVideoStream): Promise<void>

매개 변수

반환

CallCommon.startVideo 상속된

통화에서 사용자 지정 오디오를 중지하고 디바이스 관리자 기본 오디오 디바이스로 전환합니다.

function stopAudio()

CallCommon.stopAudio 상속된

로컬 화면 공유를 중지합니다.

function stopScreenSharing(): Promise<void>

반환

CallCommon.stopScreenSharing 상속된

로컬 화면 공유를 중지합니다.

function stopScreenSharing(localVideoStream: LocalVideoStream): Promise<void>

매개 변수

반환

CallCommon.stopScreenSharing 상속된

통화에서 비디오 스트림 전송을 중지합니다. CallAgent.startCall() API, CallAgent.join() API, IncomingCall.accept() API 또는 Call.startVideo() API에서 비디오를 시작하는 데 사용된 것과 동일한 LocalVideoStream 개체를 전달해야 합니다.

function stopVideo(localVideoStream: LocalVideoStream): Promise<void>

매개 변수

반환

CallCommon.stopVideo 상속된

로컬 마이크의 음소거를 해제합니다.

function unmute(): Promise<void>

반환

CallCommon.unmute 상속된

들어오는 오디오의 음소거를 해제합니다.

function unmuteIncomingAudio(): Promise<void>

반환

CallCommon.unmuteIncomingAudio 상속된