연결 클래스

dcv 모듈의 connect 메서드를 호출하여 얻은 연결 클래스입니다. 사용 방법을 보여주는 예제는 시작하기 섹션을 참조하세요.

메서드

나열

• attachDisplay(win, displayConf) → {Promise.<number>|Promise.<{code: MultiMonitorErrorCode, message: string}>}
• captureClipboardEvents(활성화, 성공, displayId) → {void}
• detachDisplay(displayId) → {void}
• disconnect() → {void}
• disconnectCollaborator(connectionId) → {void}
• enableDisplayQuality업데이트(활성화) → {void}
• enableHighPixel밀도(활성화) → {void}
• enableTimezoneRedirection(활성화) → {Promise|Promise.<{code: TimezoneRedirectionErrorCode, message: string}>}
• enterRelativeMouse모드() → {void}
• getConnectedDevices() → {Promise.<배열.<MediaDeviceInfo>>|약속.<{message: string}>}
• getFileExplorer() → {Promise.<filestorage >|Promise.<{code: ChannelErrorCode, message: string}>}
• getServerInfo() → {serverInfo}
• getScreenshot() → {Promise|Promise.<{code: ScreenshotErrorCode, message: string}>}
• getStats() → {stats }
• latchModifierKey(키, 위치, isDown) → {boolean}
• openChannel(이름, authToken, 콜백, 네임스페이스) → {Promise|Promise.<{code: ChannelErrorCode, message: string}>}
• queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>}
• registerKeyboardShortcuts(바로 가기) → {void}
• requestDisplayConfig(highColorAccuracy) → {Promise|Promise.<{code: DisplayConfigErrorCode, message: string}>}
• requestDisplayLayout(레이아웃) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
• requestResolution(너비, 높이) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}
• sendKeyboardEvent(이벤트) → {boolean}
• sendKeyboardShortcut(바로 가기) → {void}
• setDisplayQuality(최소, 최대) → {void}
• setDisplayScale(scaleRatio, displayId) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} (DEPRECATED)
• setKeyboardQuirks(쿼크) → {void}
• setMaxDisplay해상도(maxWidth, maxHeight) → {void}
• setMicrophone(활성화) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}
• setMinDisplay해상도(minWidth, minHeight) → {void}
• setUploadBandwidth(값) → {number}
• setVolume(볼륨) → {void}
• setMicrophone(활성화, deviceId) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}
• setWebcam(활성화, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message: string}>}
• syncClipboards() → {boolean}

attachDisplay(win, displayConf) → {Promise.<number>|Promise.<{code: MultiMonitorErrorCode, message: string}>}

특정 디스플레이를 창에 연결합니다. 메인 디스플레이는 연결할 수 없습니다. 성공할 경우 함수는 displayId를 반환합니다.

파라미터:

명칭	유형	설명
win	객체	디스플레이가 연결되어야 하는 창입니다.
displayConf	객체	디스플레이의 구성입니다. 명칭 유형 속성 설명 displayId number <optional> 디스플레이의 ID입니다. displayDivName 디스플레이 div의 이름입니다.

반환 형식:

Promise를 반환합니다. 거부되면 promise는 오류 객체를 반환합니다.

유형

Promise.<number> | Promise.<{code: MultiMonitorErrorCode, message: string}>

captureClipboardEvents(활성화, 성공, displayId) → {void}

copy-paste 이벤트 수신을 시작하거나 중지합니다. 대화형 클립보드의 경우(항상 붙여넣기인 경우) copy/paste 이벤트 수신을 시작해야 합니다. 필요한 경우에만 수신을 시작하고 중지하는 것이 유용할 수 있습니다(예: 모달이 표시될 때).

파라미터:

명칭	유형	속성	설명
enabled	boolean		이벤트 수신을 시작하려면 true를 지정합니다. 이벤트 수신을 중지하려면 false를 지정합니다.
win	객체	<optional>	이벤트를 수신할 창입니다. 이 정보가 생략될 경우에는 기본 창이 사용됩니다.
displayId	number	<optional>	이벤트를 수신해야 하는 디스플레이의 ID입니다. 이 정보가 생략될 경우에는 기본 디스플레이 창이 사용됩니다.

반환 형식:

유형

void

detachDisplay(displayId) → {void}

특정 디스플레이를 분리합니다. 메인 디스플레이는 분리할 수 없습니다.

파라미터:

명칭	유형	설명
displayId	number	분리할 디스플레이의 ID입니다.

반환 형식:

유형

void

disconnect() → {void}

Amazon DCV 서버에서 연결을 해제하고 연결을 닫습니다.

반환 형식:

유형

void

disconnectCollaborator(connectionId) → {void}

제공된 연결 ID(Amazon DCV Web Client SDK 버전 1.1.0 이후)에 연결된 공동 작업자의 연결 해제를 요청합니다.

파라미터:

명칭	유형	설명
connectionId	boolean	해제될 연결의 ID입니다.

반환 형식:

유형

void

enableDisplayQuality업데이트(활성화) → {void}

업데이트를 수신하지 않는 스트리밍 영역의 디스플레이 품질 업데이트를 활성화하거나 비활성화합니다. 디스플레이 품질 업데이트를 비활성화하면 대역폭 사용량이 줄어들지만 디스플레이 품질도 떨어집니다.

파라미터:

명칭	유형	설명
enable	boolean	디스플레이 품질 업데이트를 활성화하려면 true를 지정합니다. 디스플레이 품질 업데이트를 비활성화하려면 false를 지정합니다.

반환 형식:

유형

void

enableHighPixel밀도(활성화) → {void}

클라이언트에서 높은 픽셀 밀도를 활성화 또는 비활성화합니다.

파라미터:

명칭	유형	설명
enable	boolean	높은 픽셀 밀도를 활성화해야 하는지 여부.

반환 형식:

유형

void

enableTimezoneRedirection(활성화) → {Promise|Promise.<{code: TimezoneRedirectionErrorCode, message: string}>}

시간대 리디렉션을 사용하거나 사용하지 않도록 설정합니다. 활성화되면 클라이언트는 서버 데스크톱 시간대가 클라이언트 시간대와 일치하도록 서버에 요청합니다.

파라미터:

명칭	유형	설명
enable	boolean	시간대 리디렉션을 활성화하려면 true를 지정합니다. 시간대 리디렉션을 비활성화하려면 false를 지정합니다.

반환 형식:

Promise를 반환합니다. 거부되면 promise는 오류 객체를 반환합니다.

유형

Promise.<number> | Promise.<{code: TimezoneRedirectionErrorCode, message: string}>

enterRelativeMouse모드() → {void}

상대 마우스 모드를 활성화합니다.

반환 형식:

유형

void

getConnectedDevices() → {Promise.<배열.<MediaDeviceInfo>>|약속.<{message: string}>}

클라이언트 컴퓨터에 연결된 미디어 디바이스 목록을 요청합니다.

반환 형식:

성공하면 MediaDeviceInfo 객체 배열로 확인되는 Promise를 반환합니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/를 참조하세요MediaDeviceInfo. 거부되면 promise는 오류 객체를 반환합니다.

유형

약속.<배열.<MediaDeviceInfo>> | Promise.<{message: string}>

getFileExplorer() → {Promise.<filestorage >|Promise.<{code: ChannelErrorCode, message: string}>}

Amazon DCV 서버의 파일 스토리지를 관리할 객체를 가져옵니다.

반환 형식:

Promise를 반환합니다. 요청이 이행되면 파일 탐색기 객체로, 거부되면 오류 객체로 확인됩니다.

유형

Promise.<filestorage > | Promise.<{code: ChannelErrorCode, message: string}>

getServerInfo() → {serverInfo}

Amazon DCV 서버에 대한 정보를 가져옵니다.

반환 형식:

서버 소프트웨어에 대한 정보입니다.

유형

serverInfo

getScreenshot() → {Promise|Promise.<{code: ScreenshotErrorCode, message: string}>}

원격 데스크톱의 스크린샷을 PNG 형식으로 검색합니다. 스크린샷은 screenshotCallback 관찰자에 반환됩니다. null는 실패할 경우 대신 반환됩니다.

반환 형식:

요청이 처리되면 확인되는 promise입니다. 거부되면 오류 객체가 수신됩니다.

유형

Promise | Promise.<{code: ScreenshotErrorCode, message: string}>

getStats() → {stats }

Amazon DCV 서버에 대한 통계를 가져옵니다.

반환 형식:

스트리밍 통계에 대한 정보입니다.

유형

stats

latchModifierKey(키, 위치, isDown) → {boolean}

허용된 보조 키에 대해 단일 키보드 keydown 또는 keyup 이벤트를 전송합니다.

파라미터:

명칭	유형	설명
key	제어 | 대체 | AltGraph | 메타 | OS | 교대	전송할 키입니다.
location	KeyboardEvent.location	키의 위치입니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location을 참조하세요.
isDown	boolean	삽입할 키 이벤트가 keydown(true) 또는 keyup(false)인 경우입니다.

반환 형식:

요청된 조합이 유효한 경우 함수는 true를 반환하고 그렇지 않으면 false를 반환합니다.

유형

boolean

openChannel(이름, authToken, 콜백, 네임스페이스) → {Promise|Promise.<{code: ChannelErrorCode, message: string}>}

Amazon DCV Server에서 생성된 경우 연결에서 사용자 지정 데이터 채널을 엽니다.

파라미터:

명칭	유형	설명
name	문자열	채널의 이름입니다.
authToken	문자열	채널 연결에 사용할 인증 토큰입니다.
callbacks	객체	onMessage 및 onClose 콜백은 호출할 함수입니다.
namespace	문자열	채널의 네임스페이스입니다. Amazon DCV Web Client SDK 1.2.0 및 Amazon DCV Server 2022.1 이후 사용 가능합니다.

반환 형식:

Promise를 반환합니다. 거부되면 오류 객체가 수신됩니다.

유형

약속 | 약속.<{code: ChannelErrorCode, message: string}>

queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>}

특정 Amazon DCV 서버 기능의 상태를 쿼리합니다.

파라미터:

명칭	유형	설명
featureName	feature	쿼리할 기능의 이름입니다.

반환 형식:

Promise를 반환합니다. 값이 확인되면 함수는 항상 enabled 속성을 포함하는 status 객체를 반환하며, 다른 속성도 포함할 수 있습니다. 거부되면 함수는 error 객체를 반환합니다.

유형

{Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}> | Promise.<{message: string}>

registerKeyboardShortcuts(바로 가기) → {void}

키보드 단축키를 등록합니다.

파라미터:

명칭	유형	설명
shortcuts	Array.<Object>	등록할 키와 매핑의 배열입니다. 명칭 유형 설명 sequence Array.<Object> 등록할 키보드 단축키입니다. 명칭 유형 설명 key KeyboardEvent.key 사용자가 누른 키의 값입니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key를 참조하세요. location KeyboardEvent.location 전송할 키의 배열입니다. 키보드의 키 위치입니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location을 참조하세요. output Array.<Object> 단축키를 사용하여 수행할 의도된 동작입니다. 명칭 유형 설명 key KeyboardEvent.key 사용자가 누른 키의 값입니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key를 참조하세요. location KeyboardEvent.location 전송할 키의 배열입니다. 키보드의 키 위치입니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location을 참조하세요.

반환 형식:

유형

void

requestDisplayConfig(highColorAccuracy) → {Promise|Promise.<{code: DisplayConfigErrorCode, message: string}>}

Amazon DCV Server에서 업데이트된 디스플레이 구성을 요청합니다. Amazon DCV Web Client SDK 1.1.0 및 Amazon DCV Server 2022.0 이후 사용 가능합니다.

파라미터:

명칭	유형	설명
highColorAccuracy	boolean	높은 색상 정확도를 요청해야 하는지 여부입니다.

반환 형식:

Promise를 반환합니다. 거부되면 promise는 오류 객체를 반환합니다.

유형

약속 | 약속.<{code: DisplayConfigErrorCode, message: string}>

requestDisplayLayout(레이아웃) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}

연결을 위한 업데이트된 디스플레이 레이아웃을 요청합니다.

파라미터:

명칭	유형	설명
layout	Array.<Monitor>	레이아웃에 요청된 디스플레이입니다.

반환 형식:

Promise를 반환합니다. 거부되면 오류 객체가 수신됩니다.

유형

약속 | 약속.<{code: ResolutionErrorCode, message: string}>

requestResolution(너비, 높이) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>}

Amazon DCV 서버에서 업데이트된 디스플레이 해상도를 요청합니다.

파라미터:

명칭	유형	설명
width	number	요청할 너비(픽셀 단위)입니다. 허용되는 최소값은 0입니다.
height	number	요청할 높이(픽셀 단위)입니다. 허용되는 최소값은 0입니다.

반환 형식:

Promise를 반환합니다. 거부되면 promise는 오류 객체를 반환합니다.

유형

약속 | 약속.<{code: ResolutionErrorCode, message: string}>

sendKeyboardEvent(이벤트) → {boolean}

키보드 단축키 이벤트를 전송합니다. 키보드 이벤트에 대한 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent를 참조하세요. 유효한 키보드 이벤트에는 keydown, keypress, keyup 등이 포함됩니다. 이러한 이벤트에 대한 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events 를 참조하세요.

파라미터:

명칭	유형	설명
event	KeyboardEvent	전송할 키보드 이벤트입니다.

반환 형식:

이벤트가 유효하지 않으면 함수는 false를 반환합니다. 이벤트가 유효하면 함수는 true를 반환합니다.

유형

boolean

sendKeyboardShortcut(바로 가기) → {void}

키보드 단축키를 전송합니다. 전체 keydown 또는 keyup 시퀀스를 전송하려면 이 함수를 사용하세요. 예를 들어 Ctrl + Alt + Del을 전송하면 모든 키에 대한 keydown 이벤트와 keyup 이벤트가 차례로 전송됩니다. 단일 키를 전송하려는 경우에도 이 함수를 사용하세요.

파라미터:

명칭	유형	설명
shortcut	Array.<Object>	전송할 키의 배열입니다. 명칭 유형 설명 key KeyboardEvent.key 사용자가 누른 키의 값입니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key를 참조하세요. location KeyboardEvent.location 전송할 키의 배열입니다. 키보드의 키 위치입니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location을 참조하세요.

반환 형식:

유형

void

setDisplayQuality(최소, 최대) → {void}

연결에 사용할 이미지 품질을 설정합니다. 유효 범위는 0~100이며, 1이 최저 이미지 품질이고 100는 최고 이미지 품질입니다. 현재 값을 유지하려면 0을 지정합니다.

파라미터:

명칭	유형	속성	설명
min	number		최소 이미지 품질입니다.
max	number	<optional>	최대 이미지 품질입니다.

반환 형식:

유형

void

setDisplayScale(scaleRatio, displayId) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} (DEPRECATED)

버전 1.3.0부터는 사용되지 않습니다. 더 이상 디스플레이 배율을 설정할 필요가 없습니다. 마우스 좌표는 내부적으로 자동으로 관리됩니다.

Amazon에 클라이언트 측에서 디스플레이가 조정DCV되었음을 알립니다. 이를 사용하여 클라이언트의 디스플레이 비율에 맞게 마우스 이벤트의 크기를 조정해야 함을 서버에 알릴 수 있습니다.

파라미터:

명칭	유형	설명
scaleRatio	float	사용할 조정 비율입니다. 반드시 양수여야 합니다.
displayId	number	조정할 디스플레이의 ID입니다.

반환 형식:

Promise를 반환합니다. 거부되면 promise는 오류 객체를 반환합니다.

유형

약속 | 약속.<{code: ResolutionErrorCode, message: string}>

setKeyboardQuirks(쿼크) → {void}

클라이언트 컴퓨터에 키보드 쿼크를 설정합니다.

파라미터:

명칭	유형	설명
quirks	객체	사용하거나 사용하지 않을 키보드 쿼크입니다. 명칭 유형 설명 macOptionToAlt boolean macOS에서 Option 키를 Alt로 매핑하려면 true로 지정합니다. 아닌 경우에는 false로 지정합니다. macCommandToControl boolean macOS에서 Command 키를 Ctrl로 매핑하려면 true로 지정합니다. 아닌 경우에는 false로 지정합니다.

반환 형식:

유형

void

setMaxDisplay해상도(maxWidth, maxHeight) → {void}

연결에 사용할 최대 디스플레이 해상도를 설정합니다.

파라미터:

명칭	유형	설명
maxWidth	number	최대 디스플레이 너비(픽셀 단위)입니다. 허용되는 최소값은 0입니다.
maxHeight	number	최대 디스플레이 높이(픽셀 단위)입니다. 허용되는 최소값은 0입니다.

반환 형식:

유형

void

setMicrophone(활성화) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}

마이크를 사용하거나 사용하지 않도록 설정합니다.

파라미터:

명칭	유형	설명
enable	boolean	마이크를 활성화하려면 true로 지정합니다. 마이크를 비활성화하려면 false로 지정합니다.

반환 형식:

Promise를 반환합니다. 거부되면 promise는 오류 객체를 반환합니다.

유형

약속 | 약속.<{code: AudioErrorCode, message: string}>

setMinDisplay해상도(minWidth, minHeight) → {void}

연결에 사용할 최소 디스플레이 해상도를 설정합니다. 일부 애플리케이션에는 최소 디스플레이 해상도가 필요할 수 있습니다. 필요한 최소 해상도가 클라이언트에서 지원하는 최대 해상도보다 큰 경우 크기 조정 전략이 사용됩니다. 이 함수는 주의해서 사용하세요. 크기 조정 전략으로 인해 마우스 및 터치 입력 시스템의 정확도가 떨어질 수 있습니다.

파라미터:

명칭	유형	설명
minWidth	number	최소 디스플레이 너비(픽셀 단위)입니다. 허용되는 최소값은 0입니다.
minHeight	number	최소 디스플레이 높이(픽셀 단위)입니다. 허용되는 최소값은 0입니다.

반환 형식:

유형

void

setUploadBandwidth(값) → {number}

Amazon DCV 서버에 파일을 업로드하는 데 사용할 최대 대역폭을 설정합니다.

파라미터:

명칭	유형	설명
value	number	최대 대역폭 제한(Kbps)입니다. 유효 범위는 1,024kbp~102,400kbps입니다.

반환 형식:

- 설정된 대역폭 제한입니다. 서버에서 파일 저장 기능이 비활성화된 경우 null입니다.

유형

number

setVolume(볼륨) → {void}

오디오에 사용할 볼륨 레벨을 설정합니다. 유효 범위는 0~100이며, 0은 가장 낮은 음량이고 100은 가장 높은 음량입니다.

파라미터:

명칭	유형	설명
volume	number	사용할 볼륨 수준입니다.

반환 형식:

유형

void

setMicrophone(활성화, deviceId) → {Promise|Promise.<{code: AudioErrorCode, message: string}>}

[실험 - 향후 변경될 수 있음] 마이크를 활성화 또는 비활성화합니다.

파라미터:

명칭	유형	설명
enable	boolean	마이크를 활성화하려면 true로 지정합니다. 마이크를 비활성화하려면 false로 지정합니다.
deviceId	문자열	마이크의 디바이스 ID입니다. 아니요 deviceId 를 입력하면 default deviceId 이 사용됩니다.

반환 형식:

Promise를 반환합니다. 거부되면 promise는 오류 객체를 반환합니다.

유형

약속 | 약속.<{code: AudioErrorCode, message: string}>

setWebcam(활성화, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message: string}>}

웹캠을 활성화 또는 비활성화합니다.

파라미터:

명칭	유형	설명
enable	boolean	웹캠을 활성화하려면 true를 지정합니다. 웹캠을 비활성화하려면 false를 지정합니다.
deviceId	문자열	웹캠의 디바이스 ID입니다.

반환 형식:

성공하면 가 연결/디테이크된 웹캠 로 해결된다고 약속합니다deviceId. 거부되면 promise는 오류 객체를 반환합니다.

유형

Promise.<string> | Promise.<{code: WebcamErrorCode, message: string}>

syncClipboards() → {boolean}

로컬 클라이언트 클립보드를 원격 Amazon DCV 서버 클립보드와 동기화합니다. 브라우저에서 자동 복사를 지원해야 합니다.

반환 형식:

클립보드가 동기화되어 있는 경우 함수는 true를 반환합니다. 클립보드가 동기화되지 않았거나 브라우저가 자동 복사를 지원하지 않는 경우 함수는 false를 반환합니다.

유형

boolean