CallAdapterCallOperations interface

패키지:

@azure/communication-react

현재 호출을 관리하기 위한 기능입니다.

속성

sendRealTimeText

실시간 문자 메시지 보내기

메서드

addParticipant(CommunicationUserIdentifier)
addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)	통화에 참가자를 추가합니다.
createStreamView(string, VideoStreamOptions)	스트림에 대한 html 뷰를 만듭니다.
createTogetherModeStreamView(TogetherModeStreamOptions)	스트림에 대한 html 뷰를 만듭니다.
disposeLocalVideoStreamView()	로컬 비디오 스트림에 대한 html 뷰 삭제
disposeRemoteVideoStreamView(string)	원격 비디오 스트림에 대한 html 뷰 삭제
disposeScreenShareStreamView(string)	화면 공유 스트림에 대한 html 뷰 삭제
disposeStreamView(string, VideoStreamOptions)	스트림에 대한 html 뷰를 삭제합니다.
disposeTogetherModeStreamView()	스트림에 대한 html 뷰를 삭제합니다.
forbidAudio(string[])	사용자 ID로 Teams 모임 참석자 오디오를 금지합니다.
forbidOthersAudio()	Teams 모임 오디오를 금지합니다.
forbidOthersVideo()	Teams 모임 비디오를 금지합니다.
forbidVideo(string[])	사용자 ID로 Teams 모임 참석자 비디오를 금지합니다.
holdCall()	통화를 보류합니다.
leaveCall(boolean)	통화 나가기
lowerHand()	현재 사용자의 하한손
mute()	통화 중에 현재 사용자를 음소거하거나 로컬로 마이크를 사용하지 않도록 설정
muteAllRemoteParticipants()	모든 참가자 음소거
muteParticipant(string)	참가자 음소거
onReactionClick(Reaction)	반응 이모티콘 보내기
permitAudio(string[])	사용자 ID로 Teams 모임 참석자 오디오를 허용합니다.
permitOthersAudio()	Teams 모임 오디오를 허용합니다.
permitOthersVideo()	Teams 모임 비디오를 허용합니다.
permitVideo(string[])	사용자 ID로 Teams 모임 참석자 오디오를 허용합니다.
raiseHand()	현재 사용자를 위해 손 듭니다.
removeParticipant(CommunicationIdentifier)	통화에서 참가자를 제거합니다.
removeParticipant(string)	통화에서 참가자를 제거합니다.
resumeCall()	상태에서 호출을 LocalHold 다시 시작합니다.
returnFromBreakoutRoom()	소회의실의 원점 호출로 돌아가기
sendDtmfTone(DtmfTone)	1:1 PSTN 통화에서 다른 참가자에게 DTMF 신호음 보내기
setCaptionLanguage(string)	캡션 언어를 설정하는 기능
setSpokenLanguage(string)	음성 언어를 설정하는 기능
setTogetherModeSceneSize(number, number)	함께 모드의 좌석 위치를 다시 계산합니다.
startCamera(VideoStreamOptions)	카메라 시작 이 메서드는 호출이 활성화되지 않은 경우 로컬 카메라 보기 렌더링을 시작합니다.
startCaptions(StartCaptionsAdapterOptions)	캡션을 시작하는 기능
startNoiseSuppressionEffect()	노이즈 억제 효과를 시작합니다.
startScreenShare()	통화 중에 화면 공유를 시작합니다.
startSpotlight(string[])	사용자 ID로 로컬 및 원격 참가자에 대한 스포트라이트를 시작합니다. 사용자 ID 배열이 전달되지 않으면 로컬 참가자에 대해 작업이 수행됩니다.
startTogetherMode()	함께 시작 모드.
startVideoBackgroundEffect(VideoBackgroundEffect)	비디오 배경 효과를 시작합니다.
stopAllSpotlight()	모든 스포트라이트 중지
stopCamera()	카메라 중지 이 메서드는 호출이 활성화되지 않은 경우 로컬 카메라 보기 렌더링을 중지합니다.
stopCaptions(StopCaptionsAdapterOptions)	캡션을 중지하는 기능
stopNoiseSuppressionEffect()	노이즈 억제 효과를 중지합니다.
stopScreenShare()	화면 공유 중지
stopSpotlight(string[])	사용자 ID로 로컬 및 원격 참가자에 대한 스포트라이트를 중지합니다. 사용자 ID 배열이 전달되지 않으면 로컬 참가자에 대해 작업이 수행됩니다.
stopVideoBackgroundEffects()	비디오 배경 효과를 중지합니다.
submitSurvey(CallSurvey)	통화 종료 설문조사 결과 보내기
unmute()	통화 중에 현재 사용자 음소거를 해제하거나 마이크를 로컬로 사용하도록 설정
updateBackgroundPickerImages(VideoBackgroundImage[])	배경 교체 효과를 위해 배경 선택기 이미지를 재정의합니다.
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)	선택한 비디오 배경 효과를 업데이트합니다.

속성 세부 정보

sendRealTimeText

실시간 문자 메시지 보내기

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

속성 값

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

메서드 세부 정보

addParticipant(CommunicationUserIdentifier)

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

매개 변수

participant

CommunicationUserIdentifier

반환

Promise<void>

addParticipant(PhoneNumberIdentifier, AddPhoneNumberOptions)

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

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

매개 변수

participant

PhoneNumberIdentifier

options

AddPhoneNumberOptions

반환

Promise<void>

createStreamView(string, VideoStreamOptions)

스트림에 대한 html 뷰를 만듭니다.

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

매개 변수

remoteUserId

string

렌더링할 참가자의 ID를 정의되지 않은 상태로 두고 로컬 카메라 보기를 만듭니다.

options

VideoStreamOptions

비디오 스트림을 렌더링하는 방법을 제어하는 옵션 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

반환

Promise<void | CreateVideoStreamViewResult>

설명

이 메서드는 복합에 대해 구현됩니다.

createTogetherModeStreamView(TogetherModeStreamOptions)

스트림에 대한 html 뷰를 만듭니다.

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

매개 변수

options

TogetherModeStreamOptions

비디오 스트림을 렌더링하는 방법을 제어하는 옵션 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

반환

Promise<void | TogetherModeStreamViewResult>

설명

이 메서드는 복합에 대해 구현됩니다.

disposeLocalVideoStreamView()

로컬 비디오 스트림에 대한 html 뷰 삭제

function disposeLocalVideoStreamView(): Promise<void>

반환

Promise<void>

disposeRemoteVideoStreamView(string)

원격 비디오 스트림에 대한 html 뷰 삭제

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

매개 변수

remoteUserId

string

삭제할 참가자의 ID입니다.

반환

Promise<void>

disposeScreenShareStreamView(string)

화면 공유 스트림에 대한 html 뷰 삭제

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

매개 변수

remoteUserId

string

화면 공유 스트림 보기를 처리할 참가자의 ID입니다.

반환

Promise<void>

설명

이 메서드는 복합에 대해 구현됩니다

disposeStreamView(string, VideoStreamOptions)

경고

이 API는 이제 사용되지 않습니다.

Use disposeRemoteVideoStreamView, disposeLocalVideoStreamView and disposeRemoteVideoStreamView instead.

스트림에 대한 html 뷰를 삭제합니다.

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

매개 변수

remoteUserId

string

렌더링할 참가자의 ID이며, 로컬 카메라 보기를 삭제하도록 정의되지 않은 상태로 둡니다.

options

VideoStreamOptions

비디오 스트림을 렌더링하는 방법을 제어하는 옵션 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

반환

Promise<void>

설명

이 메서드는 복합에 대해 구현됩니다.

disposeTogetherModeStreamView()

스트림에 대한 html 뷰를 삭제합니다.

function disposeTogetherModeStreamView(): Promise<void>

반환

Promise<void>

설명

이 메서드는 복합에 대해 구현됩니다.

forbidAudio(string[])

사용자 ID로 Teams 모임 참석자 오디오를 금지합니다.

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

매개 변수

userIds

string[]

반환

Promise<void>

forbidOthersAudio()

Teams 모임 오디오를 금지합니다.

function forbidOthersAudio(): Promise<void>

반환

Promise<void>

forbidOthersVideo()

Teams 모임 비디오를 금지합니다.

function forbidOthersVideo(): Promise<void>

반환

Promise<void>

forbidVideo(string[])

사용자 ID로 Teams 모임 참석자 비디오를 금지합니다.

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

매개 변수

userIds

string[]

반환

Promise<void>

holdCall()

통화를 보류합니다.

function holdCall(): Promise<void>

반환

Promise<void>

leaveCall(boolean)

통화 나가기

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

매개 변수

forEveryone

boolean

떠날 때 모든 참가자를 제거할지 여부

반환

Promise<void>

lowerHand()

현재 사용자의 하한손

function lowerHand(): Promise<void>

반환

Promise<void>

mute()

통화 중에 현재 사용자를 음소거하거나 로컬로 마이크를 사용하지 않도록 설정

function mute(): Promise<void>

반환

Promise<void>

muteAllRemoteParticipants()

모든 참가자 음소거

function muteAllRemoteParticipants(): Promise<void>

반환

Promise<void>

muteParticipant(string)

참가자 음소거

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

매개 변수

userId

string

음소거할 참가자의 ID입니다.

반환

Promise<void>

onReactionClick(Reaction)

반응 이모티콘 보내기

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

매개 변수

reaction

Reaction

반환

Promise<void>

permitAudio(string[])

사용자 ID로 Teams 모임 참석자 오디오를 허용합니다.

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

매개 변수

userIds

string[]

반환

Promise<void>

permitOthersAudio()

Teams 모임 오디오를 허용합니다.

function permitOthersAudio(): Promise<void>

반환

Promise<void>

permitOthersVideo()

Teams 모임 비디오를 허용합니다.

function permitOthersVideo(): Promise<void>

반환

Promise<void>

permitVideo(string[])

사용자 ID로 Teams 모임 참석자 오디오를 허용합니다.

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

매개 변수

userIds

string[]

반환

Promise<void>

raiseHand()

현재 사용자를 위해 손 듭니다.

function raiseHand(): Promise<void>

반환

Promise<void>

removeParticipant(CommunicationIdentifier)

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

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

매개 변수

participant

CommunicationIdentifier

<xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 제거할 참가자의

반환

Promise<void>

removeParticipant(string)

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

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

매개 변수

userId

string

제거할 참가자의 ID

반환

Promise<void>

resumeCall()

상태에서 호출을 LocalHold 다시 시작합니다.

function resumeCall(): Promise<void>

반환

Promise<void>

returnFromBreakoutRoom()

소회의실의 원점 호출로 돌아가기

function returnFromBreakoutRoom(): Promise<void>

반환

Promise<void>

sendDtmfTone(DtmfTone)

1:1 PSTN 통화에서 다른 참가자에게 DTMF 신호음 보내기

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

매개 변수

dtmfTone

DtmfTone

반환

Promise<void>

setCaptionLanguage(string)

캡션 언어를 설정하는 기능

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

매개 변수

language

string

캡션에 설정된 언어

반환

Promise<void>

setSpokenLanguage(string)

음성 언어를 설정하는 기능

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

매개 변수

language

string

음성 언어

반환

Promise<void>

setTogetherModeSceneSize(number, number)

함께 모드의 좌석 위치를 다시 계산합니다.

function setTogetherModeSceneSize(width: number, height: number)

매개 변수

width

number

컨테이너의 너비

height

number

컨테이너의 높이

설명

이 메서드는 복합에 대해 구현됩니다.

startCamera(VideoStreamOptions)

카메라 시작 이 메서드는 호출이 활성화되지 않은 경우 로컬 카메라 보기 렌더링을 시작합니다.

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

매개 변수

options

VideoStreamOptions

비디오 스트림을 렌더링하는 방법을 제어하는 옵션 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>

반환

Promise<void>

startCaptions(StartCaptionsAdapterOptions)

캡션을 시작하는 기능

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

매개 변수

options

StartCaptionsAdapterOptions

시작 캡션에 대한 옵션

반환

Promise<void>

startNoiseSuppressionEffect()

노이즈 억제 효과를 시작합니다.

function startNoiseSuppressionEffect(): Promise<void>

반환

Promise<void>

startScreenShare()

통화 중에 화면 공유를 시작합니다.

function startScreenShare(): Promise<void>

반환

Promise<void>

startSpotlight(string[])

사용자 ID로 로컬 및 원격 참가자에 대한 스포트라이트를 시작합니다. 사용자 ID 배열이 전달되지 않으면 로컬 참가자에 대해 작업이 수행됩니다.

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

매개 변수

userIds

string[]

반환

Promise<void>

startTogetherMode()

함께 시작 모드.

function startTogetherMode(): Promise<void>

반환

Promise<void>

startVideoBackgroundEffect(VideoBackgroundEffect)

비디오 배경 효과를 시작합니다.

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

매개 변수

videoBackgroundEffect

VideoBackgroundEffect

반환

Promise<void>

stopAllSpotlight()

모든 스포트라이트 중지

function stopAllSpotlight(): Promise<void>

반환

Promise<void>

stopCamera()

카메라 중지 이 메서드는 호출이 활성화되지 않은 경우 로컬 카메라 보기 렌더링을 중지합니다.

function stopCamera(): Promise<void>

반환

Promise<void>

stopCaptions(StopCaptionsAdapterOptions)

캡션을 중지하는 기능

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

매개 변수

options

StopCaptionsAdapterOptions

반환

Promise<void>

stopNoiseSuppressionEffect()

노이즈 억제 효과를 중지합니다.

function stopNoiseSuppressionEffect(): Promise<void>

반환

Promise<void>

stopScreenShare()

화면 공유 중지

function stopScreenShare(): Promise<void>

반환

Promise<void>

stopSpotlight(string[])

사용자 ID로 로컬 및 원격 참가자에 대한 스포트라이트를 중지합니다. 사용자 ID 배열이 전달되지 않으면 로컬 참가자에 대해 작업이 수행됩니다.

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

매개 변수

userIds

string[]

반환

Promise<void>

stopVideoBackgroundEffects()

비디오 배경 효과를 중지합니다.

function stopVideoBackgroundEffects(): Promise<void>

반환

Promise<void>

submitSurvey(CallSurvey)

통화 종료 설문조사 결과 보내기

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

매개 변수

survey

CallSurvey

반환

Promise<undefined | CallSurveyResponse>

unmute()

통화 중에 현재 사용자 음소거를 해제하거나 마이크를 로컬로 사용하도록 설정

function unmute(): Promise<void>

반환

Promise<void>

updateBackgroundPickerImages(VideoBackgroundImage[])

배경 교체 효과를 위해 배경 선택기 이미지를 재정의합니다.

function updateBackgroundPickerImages(backgroundImages: VideoBackgroundImage[])

매개 변수

backgroundImages

VideoBackgroundImage[]

사용자 지정 배경 이미지의 배열입니다.

updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)

선택한 비디오 배경 효과를 업데이트합니다.

function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)

매개 변수

selectedVideoBackground

VideoBackgroundEffect