CallWithChatAdapterManagement interface
채팅을 사용하여 현재 통화를 관리하는 기능입니다.
속성
| forbid |
지정된 사용자 ID에 대한 오디오를 금지합니다. |
| forbid |
로컬 사용자를 제외한 Teams 모임 참석자의 오디오를 금지합니다. |
| forbid |
로컬 사용자를 제외한 Teams 모임 참석자의 비디오를 금지합니다. |
| forbid |
지정된 사용자 ID에 대한 비디오를 금지합니다. |
| permit |
지정된 사용자 ID에 대한 오디오를 허용합니다. |
| permit |
로컬 사용자를 제외한 Teams 모임 참석자에 대한 오디오를 허용합니다. |
| permit |
로컬 사용자를 제외한 Teams 모임 참석자에게 비디오를 허용합니다. |
| permit |
지정된 사용자 ID에 대한 비디오를 허용합니다. |
| send |
1:1 통화에서 통화의 다른 참가자에게 DTMF 신호음 보내기 |
| send |
실시간 문자 메시지 보내기 |
메서드
속성 세부 정보
forbidAudio
지정된 사용자 ID에 대한 오디오를 금지합니다.
forbidAudio: (userIds: string[]) => Promise<void>
속성 값
(userIds: string[]) => Promise<void>
forbidOthersAudio
로컬 사용자를 제외한 Teams 모임 참석자의 오디오를 금지합니다.
forbidOthersAudio: () => Promise<void>
속성 값
() => Promise<void>
forbidOthersVideo
로컬 사용자를 제외한 Teams 모임 참석자의 비디오를 금지합니다.
forbidOthersVideo: () => Promise<void>
속성 값
() => Promise<void>
forbidVideo
지정된 사용자 ID에 대한 비디오를 금지합니다.
forbidVideo: (userIds: string[]) => Promise<void>
속성 값
(userIds: string[]) => Promise<void>
permitAudio
지정된 사용자 ID에 대한 오디오를 허용합니다.
permitAudio: (userIds: string[]) => Promise<void>
속성 값
(userIds: string[]) => Promise<void>
permitOthersAudio
로컬 사용자를 제외한 Teams 모임 참석자에 대한 오디오를 허용합니다.
permitOthersAudio: () => Promise<void>
속성 값
() => Promise<void>
permitOthersVideo
로컬 사용자를 제외한 Teams 모임 참석자에게 비디오를 허용합니다.
permitOthersVideo: () => Promise<void>
속성 값
() => Promise<void>
permitVideo
지정된 사용자 ID에 대한 비디오를 허용합니다.
permitVideo: (userIds: string[]) => Promise<void>
속성 값
(userIds: string[]) => Promise<void>
sendDtmfTone
1:1 통화에서 통화의 다른 참가자에게 DTMF 신호음 보내기
public sendDtmfTone: (dtmfTone: DtmfTone) => Promise<void>
속성 값
(dtmfTone: DtmfTone) => Promise<void>
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>
askDevicePermission(PermissionConstraints)
디바이스의 사용 권한을 요청합니다.
function askDevicePermission(constrain: PermissionConstraints): Promise<DeviceAccess>
매개 변수
- constrain
- PermissionConstraints
로컬 디바이스 <xref:%40azure%2Fcommunication-calling%23PermissionConstraints> 액세스에 대한 제약 조건 정의
반환
Promise<DeviceAccess>
설명
사용 권한이 아직 부여되지 않은 경우 브라우저 권한 창이 나타납니다.
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)
togethermode 스트림에 대한 html 뷰를 만듭니다.
function createTogetherModeStreamView(options?: TogetherModeStreamOptions): Promise<void | TogetherModeStreamViewResult>
매개 변수
- options
- TogetherModeStreamOptions
비디오 스트림을 렌더링하는 방법을 제어하는 옵션 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
반환
Promise<void | TogetherModeStreamViewResult>
설명
이 메서드는 복합에 대해 구현됩니다.
deleteMessage(string)
스레드에서 메시지를 삭제합니다.
function deleteMessage(messageId: string): Promise<void>
매개 변수
- messageId
-
string
반환
Promise<void>
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)
스트림에 대한 html 뷰를 삭제합니다.
function disposeStreamView(remoteUserId?: string, options?: VideoStreamOptions): Promise<void>
매개 변수
- remoteUserId
-
string
렌더링할 참가자의 ID이며, 로컬 카메라 보기를 삭제하도록 정의되지 않은 상태로 둡니다.
- options
- VideoStreamOptions
비디오 스트림을 렌더링하는 방법을 제어하는 옵션 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
반환
Promise<void>
설명
이 메서드는 복합에 대해 구현됩니다.
disposeTogetherModeStreamView()
togethermode 스트림에 대한 html 뷰를 삭제합니다.
function disposeTogetherModeStreamView(): Promise<void>
반환
Promise<void>
설명
이 메서드는 복합에 대해 구현됩니다.
downloadResourceToCache(ResourceDetails)
function downloadResourceToCache(resourceDetails: ResourceDetails): Promise<void>
매개 변수
- resourceDetails
- ResourceDetails
반환
Promise<void>
fetchInitialData()
채팅 어댑터의 초기 상태를 가져옵니다.
ChatComposite 및 API 메서드에 필요한 최소 인출을 수행합니다.
function fetchInitialData(): Promise<void>
반환
Promise<void>
holdCall()
통화를 로컬 홀드에 넣습니다.
function holdCall(): Promise<void>
반환
Promise<void>
joinCall(boolean)
경고
이 API는 이제 사용되지 않습니다.
Use joinCall(options?:JoinCallOptions) instead.
처음에 마이크를 켜거나 끄면 통화에 참가합니다.
function joinCall(microphoneOn?: boolean): undefined | Call
매개 변수
- microphoneOn
-
boolean
마이크를 처음 사용할 수 있는지 여부
반환
undefined | Call
joinCall(JoinCallOptions)
참가 할 때 마이크 / 카메라 초기 상태를 설정하기 위해 옵션 가방으로 통화에 참여하십시오 전화 참 = 참여할 때 장치 켜기 전화 false = 통화 참여시 장치 끄기 'keep'/ undefined = 장치 유지'사전 통화 상태
function joinCall(options?: JoinCallOptions): undefined | Call
매개 변수
- options
- JoinCallOptions
param 마이크/카메라를 초기에 켜기/끄기/사용 사전 호출 상태로 설정합니다.
반환
undefined | Call
leaveCall(boolean)
통화를 둡니다.
function leaveCall(forEveryone?: boolean): Promise<void>
매개 변수
- forEveryone
-
boolean
떠날 때 모든 참가자를 제거할지 여부
반환
Promise<void>
loadPreviousChatMessages(number)
채팅 스레드 기록에 이전 메시지를 더 로드합니다.
function loadPreviousChatMessages(messagesToLoad: number): Promise<boolean>
매개 변수
- messagesToLoad
-
number
반환
Promise<boolean>
설명
이 메서드는 일반적으로 증분 인출/무한 스크롤을 제어하는 데 사용됩니다.
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
반환
Promise<void>
onReactionClick(Reaction)
진행 중인 회의에 반응을 보냅니다.
function onReactionClick(reaction: Reaction): Promise<void>
매개 변수
- reaction
- Reaction
type의 값 <xref:%40azure%2Fcommunication-calling%23Reaction>
반환
Promise<void>
queryCameras()
사용 가능한 카메라 디바이스를 쿼리합니다.
function queryCameras(): Promise<VideoDeviceInfo[]>
반환
Promise<VideoDeviceInfo[]>
비디오 디바이스 정보 엔터티 <xref:%40azure%2Fcommunication-calling%23VideoDeviceInfo> 배열
설명
askDevicePermission() 후에 이 메서드를 호출해야 합니다.
queryMicrophones()
사용 가능한 마이크 디바이스를 쿼리합니다.
function queryMicrophones(): Promise<AudioDeviceInfo[]>
반환
Promise<AudioDeviceInfo[]>
<xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo> 오디오 디바이스 정보 엔터티 배열
설명
askDevicePermission() 후에 이 메서드를 호출해야 합니다.
querySpeakers()
사용 가능한 마이크 디바이스를 쿼리합니다.
function querySpeakers(): Promise<AudioDeviceInfo[]>
반환
Promise<AudioDeviceInfo[]>
<xref:%40azure%2Fcommunication-calling%23AudioDeviceInfo> 오디오 디바이스 정보 엔터티 배열
설명
askDevicePermission() 후에 이 메서드를 호출해야 합니다.
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
제거할 참가자의 UserId입니다.
반환
Promise<void>
removeResourceFromCache(ResourceDetails)
function removeResourceFromCache(resourceDetails: ResourceDetails)
매개 변수
- resourceDetails
- ResourceDetails
resumeCall()
LocalHold 상태에서 호출을 다시 시작합니다.
function resumeCall(): Promise<void>
반환
Promise<void>
returnFromBreakoutRoom()
소회의실의 원점 호출로 돌아가기
function returnFromBreakoutRoom(): Promise<void>
반환
Promise<void>
sendMessage(string, SendMessageOptions)
스레드에서 메시지를 보냅니다.
function sendMessage(content: string, options?: SendMessageOptions): Promise<void>
매개 변수
- content
-
string
- options
- SendMessageOptions
반환
Promise<void>
sendReadReceipt(string)
메시지에 대한 읽음 확인 메시지를 보냅니다.
function sendReadReceipt(chatMessageId: string): Promise<void>
매개 변수
- chatMessageId
-
string
반환
Promise<void>
sendTypingIndicator()
스레드에서 입력 표시기를 보냅니다.
function sendTypingIndicator(): Promise<void>
반환
Promise<void>
setCamera(VideoDeviceInfo, VideoStreamOptions)
통화에 사용할 카메라를 설정합니다.
function setCamera(sourceInfo: VideoDeviceInfo, options?: VideoStreamOptions): Promise<void>
매개 변수
- sourceInfo
- VideoDeviceInfo
카메라 디바이스를 선택하여 쿼리Cameras 반환된 디바이스를 선택합니다.
- options
- VideoStreamOptions
카메라 스트림을 렌더링하는 방법을 제어하는 옵션 <xref:%40azure%2Fcommunication-calling%23VideoStreamOptions>
반환
Promise<void>
setCaptionLanguage(string)
캡션 언어를 설정하는 기능
function setCaptionLanguage(language: string): Promise<void>
매개 변수
- language
-
string
캡션에 설정된 언어
반환
Promise<void>
setMicrophone(AudioDeviceInfo)
통화에 사용할 마이크를 설정합니다.
function setMicrophone(sourceInfo: AudioDeviceInfo): Promise<void>
매개 변수
- sourceInfo
- AudioDeviceInfo
마이크 디바이스를 선택하여 queryMicrophones 반환된 디바이스를 선택합니다.
반환
Promise<void>
setSpeaker(AudioDeviceInfo)
통화에 사용할 화자를 설정합니다.
function setSpeaker(sourceInfo: AudioDeviceInfo): Promise<void>
매개 변수
- sourceInfo
- AudioDeviceInfo
선택할 스피커 디바이스, querySpeakers 반환된 디바이스 선택
반환
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
컨테이너의 높이
설명
이 메서드는 복합에 대해 구현됩니다.
startCall((CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], StartCallOptions)
통화를 시작합니다.
function startCall(participants: (CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[], options?: StartCallOptions): undefined | Call
매개 변수
- participants
-
(CommunicationUserIdentifier | PhoneNumberIdentifier | MicrosoftTeamsUserIdentifier | MicrosoftTeamsAppIdentifier | UnknownIdentifier)[]
호출할 배열 <xref:%40azure%2Fcommunication-common%23CommunicationIdentifier> 입니다.
- options
- StartCallOptions
반환
undefined | Call
startCall(string[], StartCallOptions)
통화를 시작합니다.
function startCall(participants: string[], options?: StartCallOptions): undefined | Call
매개 변수
- participants
-
string[]
참가할 참가자 ID의 배열입니다.
- options
- StartCallOptions
반환
undefined | Call
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[])
스포트라이트 시작
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[])
스포트라이트 중지
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
사용자 지정 배경 이미지의 배열입니다.
updateMessage(string, string, Record<string, string>)
메시지 콘텐츠를 업데이트합니다.
function updateMessage(messageId: string, content: string, options?: Record<string, string>): Promise<void>
매개 변수
- messageId
-
string
- content
-
string
- options
-
Record<string, string>
반환
Promise<void>
updateSelectedVideoBackgroundEffect(VideoBackgroundEffect)
선택한 비디오 배경 효과 업데이트
function updateSelectedVideoBackgroundEffect(selectedVideoBackground: VideoBackgroundEffect)
매개 변수
- selectedVideoBackground
- VideoBackgroundEffect