DCV 모듈 - Amazon DCV
메서드Members유형 및 콜백 정의

기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.

DCV 모듈

DCV 프로토콜의 클라이언트 측을 구현하는 모듈입니다.

메서드

인증(authParams) → {Authentication}

지정된 Amazon DCV 서버 엔드포인트에 대한 인증 프로세스를 시작합니다.

파라미터:

명칭 유형 설명
url 문자열 실행 중인 Amazon DCV 서버의 호스트 이름 및 포트 형식은 다음과 같습니다. https://dcv_host_address:port 예를 들어 https://my-dcv-server:8443입니다.
authenticationToken 문자열 인증에 사용할 인증 토큰입니다.
callbacks authenticationCallbacks 인증 프로세스 중에 직접적으로 호출할 수 있는 콜백입니다.

반환 형식:

- Authentication 객체입니다.

유형

인증

connect(config) → {Promise.<Connection>|Promise.<{code: ConnectionErrorCode, message: string}>}

지정된 Amazon DCV 서버 엔드포인트에 연결합니다. 연결이 성공하면 Connection 객체를 반환합니다. 연결에 실패하면 error 객체가 반환됩니다.

파라미터:

명칭 유형 설명
config ConnectionConfig ConnectionConfig 객체입니다.

반환 형식:

- Connection 객체 또는 error 객체

유형

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

setLogHandler(handler) → {void}

사용자 지정 로그 핸들러 함수를 설정합니다. 기본 로그 핸들러를 재정의하면 브라우저 콘솔로 디버깅할 때 기존 로그 항목 위치가 손실됩니다.

파라미터:

명칭 유형 설명
handler 함수 사용자 지정 로그 핸들러 함수입니다. 핸들러 함수에는 level(숫자), levelName(문자열), domain(문자열) 및 message(문자열)가 포함됩니다.

반환 형식:

유형

void

setLogLevel(level) → {void}

로그 수준을 설정합니다. 이는 기본 로그 핸들러를 사용하는 경우에만 필요합니다.

파라미터:

명칭 유형 설명
level LogLevel 사용할 로그 수준입니다.

반환 형식:

유형

void

Members

(상수) AudioError :AudioErrorCode

AudioError 코드는 열거형입니다.

유형: 

(상수) AuthenticationError :AuthenticationErrorCode

AuthenticationError 코드는 열거형입니다.

유형: 

(상수) ChannelError :ChannelErrorCode

ChannelError 코드는 열거형입니다.

유형: 

(상수) ClosingReasonError :ClosingReasonErrorCode

ClosingReasonError 코드는 열거형입니다.

유형: 

(상수) ConnectionError :ConnectionErrorCode

ConnectionError 코드는 열거형입니다.

유형: 

(상수) CustomChannelError :CustomChannelErrorCode

CustomChannelError 코드는 열거형입니다.

유형: 

(상수) DisplayConfigError :DisplayConfigErrorCode

DisplayConfigError 코드는 열거형입니다.

유형: 

(상수) FileStorageError :FileStorageErrorCode

FileStorageError 코드는 열거형입니다.

유형: 

(상수) LogLevel :LogLevel

사용 가능한 SDK 로그 수준입니다.

유형: 

(상수) MultiMonitorError :MultiMonitorErrorCode

MultiMonitorError 코드는 열거형입니다.

유형: 

(상수) ResolutionError :ResolutionErrorCode

ResolutionError 코드는 열거형입니다.

유형: 

(상수) TimezoneRedirectionError :TimezoneRedirectionErrorCode

TimezoneRedirectionError 코드는 열거형입니다.

유형: 

(상수) TimezoneRedirectionSetting :TimezoneRedirectionSettingCode

TimezoneRedirectionSetting 코드는 열거형입니다.

유형: 

(상수) TimezoneRedirectionStatus :TimezoneRedirectionStatusCode

TimezoneRedirectionStatus 코드는 열거형입니다.

유형: 

(상수) version

major, minor, patch, revision, extended, versionStr이 포함된 Amazon DCV 버전입니다.

속성:

명칭 유형 설명
major 정수 메이저 버전 번호
minor 정수 마이너 버전 번호
patch 정수 패치 버전 번호
revision 정수 개정 번호
extended 문자열 확장된 문자열
versionStr 문자열 메이저, 마이너, 패치 및 개정 번호를 major.minor.patch+build.revision 양식으로 연결

(상수) ScreenshotError :ScreenshotErrorCode

ScreenshotError 코드는 열거형입니다.

유형: 

(상수) WebcamError :WebcamErrorCode

WebcamError 코드는 열거형입니다.

유형: 

유형 및 콜백 정의

AudioErrorCode

DCV 모듈에서 사용할 수 있는 AudioError 코드 열거형

  • SETTING_AUDIO_FAILED

  • CHANNEL_NOT_AVAILABLE

유형: 

  • 숫자

authenticationCallbacks

인증 콜백

유형: 

  • 객체

속성:

명칭 유형 설명
promptCredentials authPromptCredentialsCallback 사용자에게 자격 증명이 요청될 때 직접적으로 호출되는 콜백 함수입니다.
error authErrorCallback 인증 실패 시 직접적으로 호출되는 콜백 함수입니다.
success authSuccessCallback 인증 성공 시 직접적으로 호출되는 콜백 함수입니다.
httpExtraSearchParamsCallback httpExtraSearchParamsCallback 요청을 시작하기 전에 인증 URL에 사용자 지정 쿼리 파라미터를 주입하기 위해 authenticate 메서드에서 호출할 콜백 함수입니다. 또한 connect 메서드에서 DCV 서버에 대한 WebSocket 연결을 설정할 때 사용되는 URL을 사용자 지정할 수 있습니다.

AuthenticationErrorCode

DCV 모듈에서 사용할 수 있는 AuthenticationError 코드 열거형

  • INVALID_MESSAGE

  • UNKNOWN_AUTH_MODE

  • SESSION_NOT_AVAILABLE

  • NO_SESSIONS

  • WRONG_CREDENTIALS

  • SASL_CHALLENGE

  • SASL_AUTH_MECHANISM

  • FAILED_COMMUNICATION

  • AUTHENTICATION_REJECTED

  • GENERIC_ERROR

  • WRONG_CREDENTIALS_FORMAT

  • WRONG_CREDENTIALS_TYPE

  • UNREQUESTED_CREDENTIALS

  • MISSING_CREDENTIAL

유형: 

  • 숫자

authErrorCallback(authentication, error)

인증 실패 시 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
authentication 인증 Authentication 객체입니다.
error 객체 인증 프로세스에서 발생한 error 객체입니다.
명칭 유형 설명
code AuthenticationErrorCode 오류 코드입니다.
message 문자열 오류 메시지입니다.

authPromptCredentialsCallback(authentication, challenge)

사용자에게 자격 증명이 요청될 때 직접적으로 호출되는 콜백 함수입니다. 사용자는 요청된 자격 증명을 제공하여 챌린지에 답해야 합니다.

파라미터:

명칭 유형 설명
authentication 인증 Authentication 객체입니다.
challenge 객체 챌린지입니다.
명칭 유형 설명
requiredCredentials Array.<Object> 요청된 자격 증명 객체의 배열입니다.
명칭 유형 설명
name 문자열 요청된 자격 증명의 이름입니다.
type 문자열 요청된 자격 증명의 유형입니다.

authSuccessCallback(authentication, authenticationData)

인증 성공 시 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
authentication 인증 Authentication 객체입니다.
authenticationData Array.<Object> Amazon DCV 세션 ID 및 인증 토큰이 포함된 객체 배열입니다.
명칭 유형 설명
sessionId 문자열 Amazon DCV 세션 ID입니다.
authToken 문자열 Amazon DCV 세션의 인증 토큰입니다.

채널

지정할 수 있는 사용 가능한 채널입니다.

유형: 

  • "clipboard" | "display" | "input" | "audio" | "filestorage"

ChannelErrorCode

DCV 모듈에서 사용할 수 있는 ChannelError 코드 열거형

  • ALREADY_OPEN

  • INITIALIZATION_FAILED

  • REJECTED

유형: 

  • 숫자

clipboardEventCallback(event)

clipboardEvent가 생성될 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
event 객체 클립보드 이벤트에 대한 정보입니다.
명칭 유형 속성 설명
name established | copy | paste | dataSizeAlert | autoCopyDone | newDataAvailable | autoPasteDone | remoteError | pasteAvailableData 항상 존재합니다. 이벤트의 이름입니다.
clipboardData Object | string 클립보드의 데이터입니다.
autoCopy boolean <optional> 세션 클립보드에서 로컬 클라이언트 클립보드로의 자동 복사가 활성화되는지 여부를 나타냅니다.
maxDataSize 숫자 <optional> 클립보드에 넣을 수 있는 최대 데이터 양입니다.
error 문자열 <optional> 오류 정보입니다(해당하는 경우).

ClosingReasonErrorCode

DCV 모듈에서 사용할 수 있는 ClosingReasonError 열거형

  • TRANSPORT_ERROR

  • NO_ERROR

  • GENERIC_ERROR

  • INTERNAL_SERVER_ERROR

  • PROTOCOL_ERROR

  • AUTHORIZATION_DENIED

  • AUTHORIZATION_REVOKED

  • ACCESS_REJECTED

  • IDLE_TIMEOUT_EXPIRED

  • DISCONNECT_BY_OWNER

  • DISCONNECT_BY_USER

  • EVICTED

  • EXTERNAL_PROTOCOL_CONNECTION_EVICTED

  • DISCONNECTION_REQUESTED

유형: 

  • 숫자

Colorspace

지정할 수 있는 사용 가능한 색상 공간입니다.

유형: 

  • "RGB" | "YUV_REC601" | "YUV_REC709"

connectionCallbacks

연결 오류 발생 시 직접적으로 호출할 수 있는 콜백입니다.

유형: 

  • 객체

속성:

명칭 유형 설명
disconnect disconnectCallback 연결이 종료될 때 직접적으로 호출되는 콜백 함수입니다.
displayLayout displayLayoutCallback 디스플레이 레이아웃 또는 해상도가 변경될 때 직접적으로 호출되는 콜백 함수입니다.
displayAvailability displayAvailabilityCallback 디스플레이 가용성이 변경될 때 직접적으로 호출되는 콜백 함수입니다.
firstFrame firstFrameCallback Amazon DCV 서버에서 첫 프레임을 수신하면 콜백 함수가 직접적으로 호출됩니다.
filePrinted filePrintedCallback Amazon DCV 서버에 파일이 인쇄될 때 직접적으로 호출되는 콜백 함수입니다.
fileDownload fileDownloadCallback Amazon DCV 서버에서 파일을 다운로드할 준비가 완료되면 직접적으로 호출되는 콜백 함수입니다.
dataChannel dataChannelCallback Amazon DCV 서버가 데이터 채널의 가용성에 대한 알림을 보낼 때 직접적으로 호출되는 콜백 함수입니다.
licenseNotification licenseNotificationCallback Amazon DCV 서버가 라이선스 상태에 대한 알림을 보낼 때 직접적으로 호출되는 콜백 함수입니다.
idleWarningNotification idleWarningNotificationCallback Amazon DCV 서버가 유휴 타임아웃 경고를 보낼 때 직접적으로 호출되는 콜백 함수입니다.
collaboratorList collaboratorListCallback Amazon DCV 서버가 공동 작업자 목록을 전송할 때 직접적으로 호출되는 콜백 함수입니다(Amazon DCV 웹 클라이언트 SDK 버전 1.1.0부터).
qualityIndicatorState qualityIndicatorStateCallback 연결 품질 표시기의 상태가 변경될 때 직접적으로 호출되는 콜백 함수입니다.
filestorageEnabled filestorageEnabledCallback 파일 스토리지가 활성화되거나 비활성화될 때 직접적으로 호출되는 콜백 함수입니다.
featuresUpdate featuresUpdateCallback 기능 상태가 변경될 때 직접적으로 호출되는 콜백 함수입니다.
clipboardEvent clipboardEventCallback clipboardEvent가 생성될 때 직접적으로 호출되는 콜백 함수입니다.
deviceChangeEvent deviceChangeEventCallback deviceChange 이벤트가 트리거될 때 직접적으로 호출되는 콜백 함수입니다.
screenshot screenshotCallback screenshot을 사용할 수 있을 때 직접적으로 호출되는 콜백 함수입니다.
httpExtraSearchParamsCallback httpExtraSearchParamsCallback Amazon DCV 서버에 WebSocket 연결을 설정할 때 URL을 사용자 지정하기 위해 호출할 콜백 함수입니다. SDK가 요청을 보내기 전에이 콜백을 authenticate 메서드와 함께 사용하여 인증 URL에 쿼리 파라미터를 동적으로 추가할 수도 있습니다.
httpExtraHeadersCallback httpExtraHeadersCallback 연결 설정 중에 HTTP 요청에 사용자 지정 헤더를 추가하기 위해 호출할 콜백 함수입니다.

ConnectionConfig

Amazon DCV 연결을 위한 구성입니다.

유형: 

  • 객체

속성:

명칭 유형 설명
url 문자열 실행 중인 Amazon DCV 서버의 호스트 이름 및 포트 형식은 다음과 같습니다. https://dcv_host_address:port 예를 들어 https://my-dcv-server:8443입니다.
sessionId 문자열 Amazon DCV 세션 ID입니다.
authToken 문자열 서버에 연결할 때 사용할 인증 토큰입니다.
baseUrl 문자열 SDK 파일을 로드할 절대 또는 상대 URL입니다.
resourceBaseUrl 문자열 DCV 리소스에 액세스할 수 있는 절대 또는 상대 URL입니다.
enabledChannels Array.<Channel> 활성화할 수 있는 채널 목록을 나타냅니다. 지정되지 않거나 빈 배열이 제공되면 사용 가능한 모든 채널이 기본값으로 설정됩니다.
losslessColorspace Colorspace 사용할 색상 공간을 나타냅니다. 지정하지 않으면 기본적으로 “RGB”로 설정됩니다.
divId 문자열 SDK가 원격 스트림으로 캔버스를 생성해야 하는 HTML DOM의 div 객체 ID입니다.
volumeLevel 정수 선호하는 볼륨 수준입니다. 값의 범위는 0~100입니다.
clipboardAutoSync boolean 호환되는 웹 브라우저에 대해 Amazon DCV 세션 클립보드에서 로컬 클라이언트 클립보드로의 자동 복사를 활성화할지 여부를 나타냅니다.
dynamicAudioTuning boolean 연결이 설정되었을 때 Amazon DCV 서버 오디오 설정을 기반으로 오디오를 동적으로 조정할지 여부를 나타냅니다.
clientHiDpiScaling boolean 클라이언트의 DPI에 따라 캔버스 크기를 조정할지 여부를 나타냅니다.
highColorAccuracy boolean 가능한 경우 높은 색상 정확도를 사용해야 하는지 여부를 나타냅니다. 지정하지 않으면 기본적으로 false로 설정됩니다.
enableWebCodecs 불 가능한 경우 WebCodecs를 사용해야 하는지 여부를 나타냅니다. 지정하지 않으면 기본적으로 false으로 설정됩니다.
observers connectionCallbacks 연결과 관련된 이벤트를 직접적으로 호출하는 콜백 함수입니다.
callbacks connectionCallbacks observers 속성과 동일하지만 각 콜백에는 Connection 객체가 첫 번째 파라미터로 포함됩니다.

ConnectionErrorCode

DCV 모듈에서 사용할 수 있는 ConnectionError 코드 열거형

  • ALREADY_OPEN

  • INVALID_CONFIG

  • INITIALIZATION_FAILED

  • REJECTED

  • MAIN_CHANNEL_ALREADY_OPEN

  • GENERIC_ERROR (DCV 서버 2021.0부터)

  • INTERNAL_SERVER_ERROR (DCV 서버 2021.0부터)

  • AUTHENTICATION_FAILED (DCV 서버 2021.0부터)

  • PROTOCOL_ERROR (DCV 서버 2021.0부터)

  • INVALID_SESSION_ID (DCV 서버 2021.0부터)

  • INVALID_CONNECTION_ID (DCV 서버 2021.0부터)

  • CONNECTION_LIMIT_REACHED (DCV 서버 2021.0부터)

  • SERVER_UNREACHABLE (DCV 서버 2022.1부터)

  • GATEWAY_BUSY

  • UNSUPPORTED_CREDENTIAL(DCV 서버 2022.2부터)

  • TRANSPORT_ERROR

유형: 

  • 숫자

createDirectory(path)

파라미터:

명칭 유형 설명
path 문자열 디렉터리를 만들려는 서버의 절대 경로입니다. 대상 디렉터리의 이름도 포함해야 합니다.

CustomChannelErrorCode

DCV 모듈에서 사용할 수 있는 CustomChannelError 코드 열거형

  • TRANSPORT_ERROR

유형: 

  • 숫자

dataChannelCallback(info)

Amazon DCV 서버가 데이터 채널의 가용성에 대한 알림을 보낼 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
info 객체 데이터 채널에 대한 정보입니다.
명칭 유형 설명
name 문자열 데이터 채널의 이름입니다.
token 문자열 데이터 채널의 인증 토큰입니다.

deleteFile(path)

파라미터:

명칭 유형 설명
path 문자열 삭제하려는 파일을 식별하는 서버의 절대 경로입니다.

deviceChangeEventCallback()

deviceChange 이벤트가 트리거될 때 직접적으로 호출되는 콜백 함수입니다.

disconnectCallback(reason)

연결이 종료될 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
reason 객체 연결이 해제된 이유입니다.
명칭 유형 설명
code 숫자 이유 코드입니다.
message 문자열 이유 메시지입니다.

displayAvailabilityCallback(status, displayId)

디스플레이 가용성이 변경될 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
status 객체 디스플레이의 상태입니다.
명칭 유형 설명
enabled boolean 디스플레이가 활성화되어 있는지 여부를 나타냅니다.
closed boolean 디스플레이가 종료되었는지 여부를 나타냅니다.
displayId 숫자 디스플레이에 대한 식별자입니다.

DisplayConfigErrorCode

DCV 모듈에서 사용할 수 있는 DisplayConfigError 코드 열거형

  • INVALID_ARGUMENT

  • UNSUPPORTED_OPERATION

  • NO_CHANNEL

유형: 

  • 숫자

displayLayoutCallback(serverWidth, serverHeight, heads)

디스플레이 레이아웃 또는 해상도가 변경될 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
serverWidth 숫자 기본 디스플레이의 너비(픽셀 단위)입니다.
serverHeight 숫자 기본 디스플레이의 높이(픽셀 단위)입니다.
heads Array.<Monitor> Amazon DCV 서버에서 지원하는 디스플레이 헤드입니다.

feature

기능 값입니다.

  • display - 단일 디스플레이 비디오 스트림의 사용 가능 여부를 나타냅니다.

  • display-multi - 다중 디스플레이 비디오 스트림의 사용 가능 여부를 나타냅니다.

  • high-color-accuracy - 높은 색상 정확도의 사용 가능 여부를 나타냅니다(Amazon DCV 웹 클라이언트 SDK 버전 1.1.0부터).

  • mouse - 마우스 기능의 사용 가능 여부를 나타냅니다.

  • keyboard - 키보드 기능의 사용 가능 여부를 나타냅니다.

  • keyboard-sas - SAS 시퀀스(Control + Alt + Delete) 기능의 사용 가능 여부를 나타냅니다.

  • relative-mouse - 상대 마우스 모드의 사용 가능 여부를 나타냅니다.

  • clipboard-copy - Amazon DCV 서버에서 클라이언트로의 클립보드 복사 기능 사용 가능 여부를 나타냅니다.

  • clipboard-paste - 클라이언트에서 Amazon DCV 서버로의 클립보드 복사 기능 사용 가능 여부를 나타냅니다.

  • audio-in - 마이크를 사용한 오디오 입력 기능의 사용 가능 여부를 나타냅니다.

  • audio-out - 오디오 재생 기능의 사용 가능 여부를 나타냅니다.

  • webcam - 웹캠 스트리밍 기능의 사용 가능 여부를 나타냅니다.

  • file-download - Amazon DCV 서버에서 클라이언트로의 파일 다운로드 기능 사용 가능 여부를 나타냅니다.

  • file-upload - 클라이언트에서 Amazon DCV 서버로의 파일 업로드 기능 사용 가능 여부를 나타냅니다.

  • timezone-redirection - 시간대 리디렉션 기능의 사용 가능 여부를 나타냅니다(Amazon DCV 웹 클라이언트 SDK 버전 1.3.0부터).

유형: 

  • 문자열

featuresUpdateCallback(featuresList)

기능 상태가 변경될 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
featuresList Array.<feature> 변경된 기능의 목록입니다.

fileDownloadCallback(fileResource)

Amazon DCV 서버에서 파일을 다운로드할 준비가 완료되면 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
fileResource 객체 다운로드할 준비가 된 파일에 대한 정보입니다.
명칭 유형 설명
id 문자열 파일의 식별자입니다.
url 문자열 파일을 다운로드할 때 사용할 URL입니다.
domain 문자열 리소스 도메인입니다.
token 문자열 파일을 다운로드하는 데 사용할 인증 토큰입니다. 토큰은 URL에도 포함되어 있습니다.

filePrintedCallback(printResource)

Amazon DCV 서버에 파일이 인쇄될 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
printResource 객체 인쇄된 파일에 대한 정보입니다.
명칭 유형 설명
id 문자열 인쇄된 파일의 식별자입니다.
url 문자열 인쇄된 파일을 다운로드할 때 사용할 URL입니다.
domain 문자열 리소스 도메인입니다. 이 경우 printer입니다.
token 문자열 인쇄된 파일을 다운로드하는 데 사용할 인증 토큰입니다. 토큰은 URL에도 포함되어 있습니다.

filestorage

파일 시스템에서 작업을 탐색하고 수행할 수 있는 객체입니다.

유형: 

  • 객체

속성:

명칭 유형 설명
list list 서버의 제공된 경로에 있는 항목(파일 및 디렉터리)을 나열할 수 있는 함수입니다.
createDirectory createDirectory 서버의 지정된 경로에 디렉터리를 생성할 수 있는 함수입니다.
retrieveFile retrieveFile 서버의 지정된 경로에 있는 파일을 로컬로 다운로드할 수 있는 함수입니다.
deleteFile deleteFile 서버의 지정된 경로에 있는 파일을 삭제할 수 있는 함수입니다.
renameFile renameFile 지정된 소스 경로에서 지정된 대상 경로로 파일 이름을 바꿀 수 있는 함수입니다.
renameDirectory renameDirectory 지정된 소스 경로에서 절대 대상 경로로 디렉터리 이름을 바꿀 수 있는 함수입니다.
storeFile storeFile 서버의 제공된 경로에 로컬 파일을 업로드할 수 있는 함수입니다.

filestorageEnabledCallback(enabled)

파일 스토리지가 활성화될 때 직접적으로 호출되는 콜백 함수입니다. Internet Explorer 11의 지연 채널에만 해당합니다.

파라미터:

명칭 유형 설명
enabled boolean 파일 스토리지를 활성화할지 여부를 나타냅니다.

FileStorageErrorCode

DCV 모듈에서 사용할 수 있는 FileStorageError 코드 열거형

  • CANCELLED

  • ABORTED

  • INVALID_ARGUMENT

  • NOT_IMPLEMENTED

  • ERROR

  • ALREADY_EXIST

  • NOT_FOUND

유형: 

  • 숫자

firstFrameCallback(resizeEnabled, relativeMouseModeEnabled, displayId)

Amazon DCV 서버에서 첫 프레임을 수신하면 콜백 함수가 직접적으로 호출됩니다. 각 디스플레이마다 발생합니다.

파라미터:

명칭 유형 설명
resizeEnabled boolean 서버가 클라이언트 디스플레이 레이아웃 크기 조정을 지원하는지 여부를 나타냅니다.
relativeMouseModeEnabled boolean 서버가 상대 마우스 모드를 지원하는지 여부를 나타냅니다.
displayId 숫자 디스플레이에 대한 식별자입니다.

idleWarningNotificationCallback(disconnectionDateTime)

Amazon DCV 서버가 유휴 타임아웃 경고를 보낼 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
disconnectionDateTime 날짜 연결 해제 날짜 및 시간입니다.

collaboratorListCallback(collaborators)

Amazon DCV 서버가 공동 작업자 목록을 전송할 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
collaborators Array.<Object> 공동 작업자에 대한 정보가 포함된 객체 목록입니다.
명칭 유형 설명
username 문자열 공동 작업자의 사용자 이름입니다.
owner boolean 공동 작업자가 세션 소유자인지 여부를 나타냅니다.
connectionId 숫자 서버에서 연결에 할당한 ID를 나타냅니다.

licenseNotificationCallback(notification)

Amazon DCV 서버가 라이선스 상태에 대한 알림을 보낼 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
notification 객체 알림입니다.
명칭 유형 설명
product 문자열 DCV 제품입니다.
status 문자열 라이선스의 상태입니다.
message 문자열 메시지입니다.
leftDays 숫자 라이선스가 만료되기까지 남은 일수.
isDemo boolean 라이선스가 데모 라이선스인지 여부를 나타냅니다.
numUnlicensed 숫자 라이선스가 없는 연결 수입니다.
licensingMode 문자열 라이선스 모드입니다.
documentationUrl 문자열 설명서의 URL입니다.

list(path)

파라미터:

명칭 유형 설명
path 문자열 콘텐츠를 나열하려는 서버의 절대 경로입니다.

LogLevel

사용 가능한 SDK 로그 수준입니다.

유형: 

  • TRACE | DEBUG | INFO | WARN | ERROR | SILENT

모니터링

유형: 

  • 객체

속성:

명칭 유형 설명
name 문자열 디스플레이 헤드의 이름입니다.
rect 객체 디스플레이 헤드에 대한 정보입니다.
명칭 유형 설명
x 숫자 디스플레이 헤드의 초기 x 좌표입니다.
y 숫자 디스플레이 헤드의 초기 y 좌표입니다.
width 숫자 디스플레이 헤드의 너비(픽셀 단위)입니다.
height 숫자 디스플레이 헤드의 높이(픽셀 단위)입니다.
primary boolean 디스플레이 헤드가 기본 디스플레이 헤드인지 여부를 나타냅니다. 가능한 경우 원격 운영 체제에서 결정됩니다.
dpi 숫자 디스플레이 헤드의 DPI입니다.

MultiMonitorErrorCode

DCV 모듈에서 사용할 수 있는 MultiMonitorError 코드 열거형

  • NO_DISPLAY_CHANNEL

  • MAX_DISPLAY_NUMBER_REACHED

  • INVALID_ARGUMENT

  • DISPLAY_NOT_OPENED_BY_SERVER

  • REQUEST_TIMEOUT

  • GENERIC_ERROR

  • NO_ERROR

유형: 

  • 숫자

qualityIndicatorStateCallback(state)

연결 품질 표시기의 상태가 변경될 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
state Array.<Object> 연결 품질에 대한 정보입니다.
명칭 유형 설명
name 문자열 지표의 이름입니다.
status NORMAL | WARNING | CRITICAL 상태에 대한 설명입니다.
changed boolean 상태가 변경되었는지 여부를 나타냅니다.

renameDirectory(src, dest)

파라미터:

명칭 유형 설명
src 문자열 이름을 변경하려는 디렉터리를 식별하는 서버의 절대 소스 경로입니다.
dest 문자열 대상 경로와 디렉터리 이름을 지정하는 서버의 절대 대상 경로입니다.

renameFile(src, dest)

파라미터:

명칭 유형 설명
src 문자열 이름을 변경하려는 파일을 식별하는 서버의 절대 소스 경로입니다.
dest 문자열 대상 경로와 파일 이름을 지정하는 서버의 절대 대상 경로입니다.

ResolutionErrorCode

DCV 모듈에서 사용할 수 있는 ResolutionError 코드 열거형

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • NOT_IMPLEMENTED

유형: 

  • 숫자

retrieveFile(path)

파라미터:

명칭 유형 설명
path 문자열 로컬로 다운로드하려는 파일을 식별하는 서버의 절대 경로입니다.

screenshotCallback(screenshot)

스크린샷을 사용할 수 있을 때 직접적으로 호출되는 콜백 함수입니다.

파라미터:

명칭 유형 설명
screenshot byte[] PNG 형식의 스크린샷 버퍼이거나 스크린샷 검색이 실패한 경우 null입니다.

ScreenshotErrorCode

DCV 모듈에서 사용 가능한 ScreenshotError 코드 열거형

  • NO_CHANNEL

  • GENERIC_ERROR

유형: 

  • 숫자

serverInfo

유형: 

  • 객체

속성:

명칭 유형 설명
name 문자열 소프트웨어의 이름입니다.
version 객체 소프트웨어의 버전 번호입니다.
명칭 유형 설명
major 숫자 메이저 버전 번호입니다.
minor 숫자 마이너 버전 번호입니다.
revision 숫자 개정 버전 번호입니다.
os 문자열 운영 체제입니다.
arch 문자열 아키텍처입니다.
hostname 문자열 호스트 이름입니다.

stats

유형: 

  • 객체

속성:

명칭 유형 설명
fps 숫자 현재 초당 프레임입니다.
traffic 숫자 현재 트래픽(비트/초)입니다.
peakTraffic 숫자 연결이 설정된 이후 최대 트래픽(비트/초)입니다.
latency 숫자 현재 지연 시간(밀리초)입니다.
currentChannels 숫자 연결이 설정된 이후 열려 있는 채널 수입니다.
openedChannels 숫자 현재 열려 있는 채널 수입니다.
channelErrors 숫자 오류가 보고된 채널 수입니다.

storeFile(file, dir)

파라미터:

명칭 유형 설명
file 파일 서버에 업로드하려는 파일 객체입니다(자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/File 참조).
dir 문자열 파일을 업로드하려는 서버의 절대 경로입니다.

TimezoneRedirectionErrorCode

DCV 모듈에서 사용할 수 있는 TimezoneRedirectionError 코드 열거형

  • INVALID_ARGUMENT

  • NO_CHANNEL

  • USER_CANNOT_CHANGE

유형: 

  • 숫자

TimezoneRedirectionSettingCode

DCV 모듈에서 사용할 수 있는 TimezoneRedirectionSetting 코드 열거형

  • ALWAYS_OFF

  • ALWAYS_ON

  • CLIENT_DECIDES

유형: 

  • 숫자

TimezoneRedirectionStatusCode

DCV 모듈에서 사용할 수 있는 TimezoneRedirectionStatus 코드 열거형

  • SUCCESS

  • PERMISSION_ERROR

  • GENERIC_ERROR

유형: 

  • 숫자

WebcamErrorCode

DCV 모듈에서 사용할 수 있는 WebcamError 코드 열거형

  • SETTING_WEBCAM_FAILED

  • CHANNEL_NOT_AVAILABLE

유형: 

  • 숫자

httpExtraSearchParamsCallback(메서드, URL, 본문)

인증 및 연결 설정 중에 URLs에 사용자 지정 쿼리 파라미터를 주입하기 위해 호출되는 콜백 함수입니다. 이를 통해 사용자 지정 쿼리 파라미터를 추가하고 AWS 서명 버전 4(SigV4) 서명 값을 추가하여 외부 시스템을 통한 연결을 보호하고 승인하는 기능을 포함한 고급 통합 시나리오를 사용할 수 있습니다.

이 콜백은 Amazon DCV 서버에 대한 WebSocket 연결을 설정할 때 사용되는 URL을 사용자 지정하는 데에도 사용됩니다.

파라미터:

명칭 유형 설명
method 문자열 요청에 사용되는 HTTP 메서드입니다.
url 문자열 요청에 사용할 URL입니다.
body 문자열 요청 본문의 내용

반환 형식:

URLSearchParams URL에 추가할 사용자 지정 쿼리 파라미터가 포함된 객체입니다.

유형

URLSearchParams

httpExtraHeadersCallback(메서드, URL, 본문)

연결 설정 중에 HTTP 요청에 사용자 지정 헤더(예: Authorization)를 삽입하기 위해 호출할 콜백 함수입니다.

파라미터:

명칭 유형 설명
method 문자열 요청에 사용되는 HTTP 메서드입니다.
url 문자열 요청에 사용할 URL입니다.
body 문자열 요청 본문의 내용

반환 형식:

HTTP 요청에 추가할 사용자 지정 헤더를 나타내는 키-값 페어가 포함된 객체입니다.

유형

객체