翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

# 接続クラス
<a name="connection-class"></a>

`dcv` モジュールの [`connect` メソッド](dcv-module.md#connect)を呼び出すと得られる接続クラス。使用方法を示した例については「[開始方法](establish-connection.md#auth-conn)」セクションを参照してください。

**Topics**
+ [方法](#methods)

## 方法
<a name="methods"></a>

**Topics**
+ [attachDisplay(win, displayConf) → \$1Promise.<number>\$1Promise.<\$1code: [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode), message: string\$1>\$1](#attachDisplay)
+ [captureClipboardEvents(enabled, win, displayId) → \$1void\$1](#captureClipboardEvents)
+ [detachDisplay(displayId) → \$1void\$1](#detachDisplay)
+ [disconnect() → \$1void\$1](#disconnect)
+ [disconnectCollaborator(connectionId) → \$1void\$1](#disconnectCollaborator)
+ [enableDisplayQualityUpdates(enable) → \$1void\$1](#enableDisplayQualityUpdates)
+ [enableHighPixelDensity(enable) → \$1void\$1](#enableHighPixelDensity)
+ [enableTimezoneRedirection(enable) → \$1Promise\$1Promise.<\$1code: [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode), message: string\$1>\$1](#enableTimezoneRedirection)
+ [enterRelativeMouseMode() → \$1void\$1](#enterRelativeMouseMode)
+ [getConnectedDevices() → \$1Promise.<Array.<MediaDeviceInfo>>\$1Promise.<\$1message: string\$1>\$1](#getConnectedDevices)
+ [getFileExplorer() → \$1Promise.<[filestorage](dcv-module.md#filestorage)>\$1Promise.<\$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), message: string\$1>\$1](#getFileExplorer)
+ [getServerInfo() → \$1[serverInfo](dcv-module.md#serverInfo)\$1](#getServerInfo)
+ [getScreenshot() → \$1Promise\$1Promise.<\$1code: [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode), message: string\$1>\$1](#getScreenshot)
+ [getStats() → \$1[stats](dcv-module.md#stats)\$1](#getStats)
+ [latchModifierKey(key, location, isDown) → \$1boolean\$1](#latchModifierKey)
+ [openChannel(name, authToken, callbacks, namespace) → \$1Promise\$1Promise.<\$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), message: string\$1>\$1](#openChannel)
+ [queryFeature(featureName) → \$1Promise.<\$1enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean\$1>\$1Promise.<\$1message: string\$1>\$1](#queryFeature)
+ [registerKeyboardShortcuts(shortcuts) → \$1void\$1](#registerKeyboardShortcuts)
+ [requestDisplayConfig(highColorAccuracy) → \$1Promise\$1Promise.<\$1code: [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode), message: string\$1>\$1](#requestDisplayConfig)
+ [requestDisplayLayout(layout) → \$1Promise\$1Promise.<\$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), message: string\$1>\$1](#requestDisplayLayout)
+ [requestResolution(width, height) → \$1Promise\$1Promise.<\$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), message: string\$1>\$1](#requestResolution)
+ [sendKeyboardEvent(event) → \$1boolean\$1](#sendKeyboardEvent)
+ [sendKeyboardShortcut(shortcut) → \$1void\$1](#sendKeyboardShortcut)
+ [setDisplayQuality(min, maxopt) → \$1void\$1](#setDisplayQuality)
+ [setDisplayScale(scaleRatio, displayId) → \$1Promise\$1Promise.<\$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), message: string\$1>\$1 (DEPRECATED)](#setDisplayScale)
+ [setKeyboardQuirks(quirks) → \$1void\$1](#setKeyboardQuirks)
+ [setMaxDisplayResolution(maxWidth, maxHeight) → \$1void\$1](#setMaxDisplayResolution)
+ [setMicrophone(enable) → \$1Promise\$1Promise.<\$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode), message: string\$1>\$1](#setMicrophone)
+ [setMinDisplayResolution(minWidth, minHeight) → \$1void\$1](#setMinDisplayResolution)
+ [setUploadBandwidth(value) → \$1number\$1](#setUploadBandwidth)
+ [setVolume(volume) → \$1void\$1](#setVolume)
+ [setMicrophone(enable, deviceId) → \$1Promise\$1Promise.<\$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode), message: string\$1>\$1](#setMicrophone)
+ [setWebcam(enable, deviceId) → \$1Promise\$1Promise.<\$1code: [WebcamErrorCode](dcv-module.md#WebcamErrorCode), message: string\$1>\$1](#setWebcam)
+ [syncClipboards() → \$1boolean\$1](#syncClipboards)

### attachDisplay(win, displayConf) → \$1Promise.<number>\$1Promise.<\$1code: [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode), message: string\$1>\$1
<a name="attachDisplay"></a>

 特定のディスプレイをウィンドウにアタッチします。メインディスプレイはアタッチできません。成功すると、関数が `displayId` を返します。

#### パラメータ :
<a name="parameters-1"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  名前  |  型  |  属性  |  説明  | 
| --- | --- | --- | --- | 
|  win  |  オブジェクト  |  ディスプレイをアタッチする必要があるウィンドウ。 | 
|  displayConf  |  オブジェクト  |  ディスプレイの設定。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/dcv/latest/websdkguide/connection-class.html)  | 
|  displayId  |  数値  |  <optional>  |  ディスプレイの ID。 | 
|  displayDivName  |   |   |  ディスプレイ div の名前。 | 

#### 戻り値:
<a name="returns"></a>

 Promise。拒否された場合、プロミスがエラーオブジェクトを返します。

 タイプ   
 Promise.<number> \$1 Promise.<\$1code: [MultiMonitorErrorCode](dcv-module.md#MultiMonitorErrorCode), message: string\$1> 

### captureClipboardEvents(enabled, win, displayId) → \$1void\$1
<a name="captureClipboardEvents"></a>

 コピー/貼り付けイベントのリッスンを開始または停止します。インタラクティブなクリップボード (貼り付けの場合は常時) の場合、コピー/貼り付けイベントのリッスンを開始する必要があります。例えばモーダルが表示されている場合など、必要なときにのみ、リッスンを開始および停止すると便利です。

#### パラメータ :
<a name="parameters-2"></a>


|  名前  |  型  |  属性  |  説明  | 
| --- | --- | --- | --- | 
|  enabled  |  ブール型  |   |  イベントのリッスンを開始するには、true を指定します。イベントのリッスンを停止するには、false を指定します。 | 
|  win  |  オブジェクト  |  <optional>  |  イベントをリッスンするウィンドウ。省略した場合、デフォルトのウィンドウが使用されます。 | 
|  displayId  |  数値  |  <optional>  |  イベントをリッスンするディスプレイの ID。省略した場合、デフォルトのウィンドウディスプレイが使用されます。 | 

#### 戻り値:
<a name="returns-1"></a>

 タイプ   
 void 

### detachDisplay(displayId) → \$1void\$1
<a name="detachDisplay"></a>

 特定のディスプレイをデタッチします。メインディスプレイはデタッチできません。

#### パラメータ :
<a name="parameters-3"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  displayId  |  数値  |  デタッチするディスプレイの ID。 | 

#### 戻り値:
<a name="returns-2"></a>

 タイプ   
 void 

### disconnect() → \$1void\$1
<a name="disconnect"></a>

 Amazon DCV サーバーから切断して接続を閉じます。

#### 戻り値:
<a name="returns-3"></a>

 タイプ   
 void 

### disconnectCollaborator(connectionId) → \$1void\$1
<a name="disconnectCollaborator"></a>

 指定された接続 ID で接続しているコラボレーターの切断を要求します (Amazon DCV ウェブクライアント SDK バージョン 1.1.0 以降)。

#### パラメータ :
<a name="parameters-4"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  connectionId  |  ブール型  |  切断される接続の ID。 | 

#### 戻り値:
<a name="returns-4"></a>

 タイプ   
 void 

### enableDisplayQualityUpdates(enable) → \$1void\$1
<a name="enableDisplayQualityUpdates"></a>

 更新を受けないストリーミングエリアの表示品質の更新を有効または無効にします。表示品質の更新を無効にすると、帯域幅の使用量は減少しますが、表示品質も低下します。

#### パラメータ :
<a name="parameters-5"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  enable  |  ブール型  |  表示品質の更新を有効にするには、true を指定します。表示品質の更新を無効にするには、false を指定します。 | 

#### 戻り値:
<a name="returns-5"></a>

 タイプ   
 void 

### enableHighPixelDensity(enable) → \$1void\$1
<a name="enableHighPixelDensity"></a>

 クライアントで高ピクセル密度を有効または無効にします。

#### パラメータ :
<a name="parameters-5"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  enable  |  ブール型  |  高ピクセル密度を有効にするかどうか。 | 

#### 戻り値:
<a name="returns-5"></a>

 タイプ   
 void 

### enableTimezoneRedirection(enable) → \$1Promise\$1Promise.<\$1code: [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode), message: string\$1>\$1
<a name="enableTimezoneRedirection"></a>

 タイムゾーンリダイレクトを有効または無効にします。有効にすると、クライアントはサーバーのデスクトップタイムゾーンをクライアントのタイムゾーンと一致させるようにサーバーに要求します。

#### パラメータ :
<a name="parameters-5"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  enable  |  ブール型  |  タイムゾーンリダイレクトを有効にするには、true を指定します。タイムゾーンリダイレクトを無効にするには、false を指定します。 | 

#### 戻り値:
<a name="returns-5"></a>

 Promise。拒否された場合、プロミスがエラーオブジェクトを返します。

 タイプ   
 Promise.<number> \$1 Promise.<\$1code: [TimezoneRedirectionErrorCode](dcv-module.md#TimezoneRedirectionErrorCode), message: string\$1> 

### enterRelativeMouseMode() → \$1void\$1
<a name="enterRelativeMouseMode"></a>

 相対マウスモードを有効にします。

#### 戻り値:
<a name="returns65"></a>

 タイプ   
 void 

### getConnectedDevices() → \$1Promise.<Array.<MediaDeviceInfo>>\$1Promise.<\$1message: string\$1>\$1
<a name="getConnectedDevices"></a>

 クライアントコンピュータに接続されているメディアデバイスのリストをリクエストします。

#### 戻り値:
<a name="returns-7"></a>

 成功した場合、解決する Promise を MediaDeviceInfo オブジェクトの配列に返します。詳細については、https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo を参照してください。拒否された場合、プロミスがエラーオブジェクトを返します。

 タイプ   
 Promise.<Array.<MediaDeviceInfo>> \$1 Promise.<\$1message: string\$1> 

### getFileExplorer() → \$1Promise.<[filestorage](dcv-module.md#filestorage)>\$1Promise.<\$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), message: string\$1>\$1
<a name="getFileExplorer"></a>

 Amazon DCV サーバーのファイルストレージを管理するためにオブジェクトを取得します。

#### 戻り値:
<a name="returns-8"></a>

 Promise。満たされた場合はファイルエクスプローラーオブジェクト、拒否された場合はエラーオブジェクトに対して、解決するプロミスを返します。

 タイプ   
 Promise.<[filestorage](dcv-module.md#filestorage)> \$1 Promise.<\$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), message: string\$1> 

### getServerInfo() → \$1[serverInfo](dcv-module.md#serverInfo)\$1
<a name="getServerInfo"></a>

 Amazon DCV サーバーに関する情報を取得します。

#### 戻り値:
<a name="returns-9"></a>

 サーバーソフトウェアに関する情報。

 タイプ   
 [serverInfo](dcv-module.md#serverInfo) 

### getScreenshot() → \$1Promise\$1Promise.<\$1code: [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode), message: string\$1>\$1
<a name="getScreenshot"></a>

 リモートデスクトップのスクリーンショットを PNG 形式で取得します。スクリーンショットは [ScreenshotCallback](dcv-module.md#screenshotCallback) オブザーバーに返されます。失敗した場合は代わりに `null` が返されます。

#### 戻り値:
<a name="returns-30"></a>

 リクエストが処理されたら解決する Promise。拒否された場合、エラーオブジェクトが送られます。

 タイプ   
 Promise \$1 Promise.<\$1code: [ScreenshotErrorCode](dcv-module.md#ScreenshotErrorCode), message: string\$1> 

### getStats() → \$1[stats](dcv-module.md#stats)\$1
<a name="getStats"></a>

 Amazon DCV サーバーに関する統計を取得します。

#### 戻り値:
<a name="returns-10"></a>

 ストリーミング統計に関する情報。

 タイプ   
 [stats](dcv-module.md#stats) 

### latchModifierKey(key, location, isDown) → \$1boolean\$1
<a name="latchModifierKey"></a>

 許可された修飾子に対する単一のキーボード `keydown` または `keyup` を送信します。

#### パラメータ :
<a name="parameters-6"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  key  |  Control \$1 Alt \$1 AltGraph \$1 Meta \$1 OS \$1 Shift  |  送信するキー。 | 
|  location  |  KeyboardEvent.location  |  キーの場所。詳細については、https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/location を参照してください。 | 
|  isDown  |  boolean  |  挿入するキーイベントがキーダウン (true) またはキーアップ (false) である場合。 | 

#### 戻り値:
<a name="returns-11"></a>

 リクエストされた組み合わせが有効な場合、関数が `true` を返し、それ以外の場合は `false` を返します。

 タイプ   
 boolean 

### openChannel(name, authToken, callbacks, namespace) → \$1Promise\$1Promise.<\$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), message: string\$1>\$1
<a name="openChannel"></a>

 カスタムデータチャンネルが Amazon DCV サーバーで作成された場合にそのチャネルを接続で開きます。

#### パラメータ :
<a name="parameters-7"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  name  |  string  |  チャネルの名前。 | 
|  authToken  |  string  |  チャンネルへの接続に使用する認証トークン。 | 
|  callbacks  |  オブジェクト  |  呼び出す onMessage と onClose コールバック関数。 | 
|  namespace  |  string  |  データチャネルの名前空間。Amazon DCV ウェブクライアント SDK 1.2.0 および Amazon DCV サーバー 2022.1 以降で使用できます。 | 

#### 戻り値:
<a name="returns-12"></a>

 Promise。拒否された場合、エラーオブジェクトが送られます。

 タイプ   
 Promise \$1 Promise.<\$1code: [ChannelErrorCode](dcv-module.md#ChannelErrorCode), message: string\$1> 

### queryFeature(featureName) → \$1Promise.<\$1enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean\$1>\$1Promise.<\$1message: string\$1>\$1
<a name="queryFeature"></a>

 特定の Amazon DCV サーバー機能のステータスについてクエリを行います。

#### パラメータ :
<a name="parameters-8"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  featureName  |  [機能](dcv-module.md#feature)  |  クエリを行う機能の名前。 | 

#### 戻り値:
<a name="returns-13"></a>

 Promise。解決すると、関数は常に `enabled` プロパティを含む `status` オブジェクトを返し、場合によっては他のプロパティも返します。拒否された場合、関数が `error` オブジェクトを返します。

 タイプ   
 \$1Promise.<\$1enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean\$1> \$1 Promise.<\$1message: string\$1> 

### registerKeyboardShortcuts(shortcuts) → \$1void\$1
<a name="registerKeyboardShortcuts"></a>

 キーボードショートカットを登録します。

#### パラメータ :
<a name="parameters-9"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  shortcuts  |  Array.<Object>  |  登録するキーとマッピングの配列。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/dcv/latest/websdkguide/connection-class.html)  | 
|  sequence  |  Array.<Object>  |  登録するキーボードショートカット。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/dcv/latest/websdkguide/connection-class.html)  | 
|  output  |  Array.<Object>  |  ショートカットによって実行される意図されたアクション。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/dcv/latest/websdkguide/connection-class.html)  | 
|  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 を参照してください。 | 
|  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 を参照してください。 | 

#### 戻り値:
<a name="returns-14"></a>

 タイプ   
 void 

### requestDisplayConfig(highColorAccuracy) → \$1Promise\$1Promise.<\$1code: [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode), message: string\$1>\$1
<a name="requestDisplayConfig"></a>

 Amazon DCV サーバーから更新されたディスプレイ設定をリクエストします。Amazon DCV ウェブクライアント SDK 1.1.0 および Amazon DCV サーバー 2022.0 以降で使用できます。

#### パラメータ :
<a name="parameters-10"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  highColorAccuracy  |  ブール型  |  高い色精度を要求すべきかどうか。 | 

#### 戻り値:
<a name="returns-15"></a>

 Promise。拒否された場合、プロミスがエラーオブジェクトを返します。

 タイプ   
 Promise \$1 Promise.<\$1code: [DisplayConfigErrorCode](dcv-module.md#DisplayConfigErrorCode), message: string\$1> 

### requestDisplayLayout(layout) → \$1Promise\$1Promise.<\$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), message: string\$1>\$1
<a name="requestDisplayLayout"></a>

 接続の更新済みディスプレイレイアウトをリクエストします。

#### パラメータ :
<a name="parameters-11"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  layout  |  Array.<[Monitor](dcv-module.md#Monitor)>  |  レイアウト内のリクエストされたディスプレイ。 | 

#### 戻り値:
<a name="returns-16"></a>

 Promise。拒否された場合、エラーオブジェクトが送られます。

 タイプ   
 Promise \$1 Promise.<\$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), message: string\$1> 

### requestResolution(width, height) → \$1Promise\$1Promise.<\$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), message: string\$1>\$1
<a name="requestResolution"></a>

 Amazon DCV サーバーから更新されたディスプレイ解像度をリクエストします。

#### パラメータ :
<a name="parameters-12"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  width  |  数値  |  リクエストする幅 (ピクセル)。許容される最小値は 0 です。 | 
|  height  |  数値  |  リクエストする高さ (ピクセル)。許容される最小値は 0 です。 | 

#### 戻り値:
<a name="returns-17"></a>

 Promise。拒否された場合、プロミスがエラーオブジェクトを返します。

 タイプ   
 Promise \$1 Promise.<\$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), message: string\$1> 

### sendKeyboardEvent(event) → \$1boolean\$1
<a name="sendKeyboardEvent"></a>

 キーボードショートカットイベントを送信します。キーボードイベントの詳細については、[https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent) を参照してください。有効なキーボードイベントには、`keydown`、`keypress`、`keyup` が含まれます。キーボードイベントの詳細については、[https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent\$1events](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events) を参照してください。

#### パラメータ :
<a name="parameters-13"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  event  |  KeyboardEvent  |  送信するキーボードイベント。 | 

#### 戻り値:
<a name="returns-18"></a>

 イベントが有効でない場合、関数が `false` を返します。イベントが有効である場合、関数が `true` を返します。

 タイプ   
 boolean 

### sendKeyboardShortcut(shortcut) → \$1void\$1
<a name="sendKeyboardShortcut"></a>

 キーボードショートカットを送信します。この関数を使用して、完全な `keydown` シーケンスまたは `keyup` シーケンスを送信します。例えば、Ctrl\$1Alt \$1 Del を送信すると、全てのキーに対して `keydown` イベントが送信され、続いて `keyup` イベントが送信されます。単一のキーを送信したい場合であってもこの関数を使用してください。

#### パラメータ :
<a name="parameters-14"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  shortcut  |  Array.<Object>  |  送信するキーの配列。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/dcv/latest/websdkguide/connection-class.html)  | 
|  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 を参照してください。 | 

#### 戻り値:
<a name="returns-19"></a>

 タイプ   
 void 

### setDisplayQuality(min, maxopt) → \$1void\$1
<a name="setDisplayQuality"></a>

 接続に使用する画質を設定します。有効範囲は `0`～`100` で、`1` が最低画質、`100` が最高画質になります。現在の値を維持するには `0` を指定します。

#### パラメータ :
<a name="parameters-15"></a>


|  名前  |  型  |  属性  |  説明  | 
| --- | --- | --- | --- | 
|  min  |  数値  |   |  最低画質。 | 
|  max  |  数値  |  <optional>  |  最高画質。 | 

#### 戻り値:
<a name="returns-20"></a>

 タイプ   
 void 

### setDisplayScale(scaleRatio, displayId) → \$1Promise\$1Promise.<\$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), message: string\$1>\$1 (DEPRECATED)
<a name="setDisplayScale"></a>

 バージョン 1.3.0 以降は非推奨です。もうディスプレイのスケールを設定する必要はなくなりました。マウス座標は内部で自動的に管理されます。

 クライアント側でディスプレイのスケーリングが行われたことを Amazon DCV に通知します。これを使用して、クライアントの表示比率に合わせてマウスイベントのスケーリングを行う必要があることをサーバーに通知します。

#### パラメータ :
<a name="parameters-16"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  scaleRatio  |  float  |  使用するスケーリング比率。厳密に正の数である必要があります。 | 
|  displayId  |  数値  |  スケーリングを行うディスプレイの ID。 | 

#### 戻り値:
<a name="returns-21"></a>

 Promise。拒否された場合、プロミスがエラーオブジェクトを返します。

 タイプ   
 Promise \$1 Promise.<\$1code: [ResolutionErrorCode](dcv-module.md#ResolutionErrorCode), message: string\$1> 

### setKeyboardQuirks(quirks) → \$1void\$1
<a name="setKeyboardQuirks"></a>

 クライアントコンピュータのキーボード特異性を設定します。

#### パラメータ :
<a name="parameters-17"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  quirks  |  オブジェクト  |  有効または無効にするキーボード特異性。[\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/ja_jp/dcv/latest/websdkguide/connection-class.html)  | 
|  macOptionToAlt  |  ブール型  |  macOS の Option キーを Alt にマップするには、true を指定します。それ以外の場合は、falseを指定します。 | 
|  macCommandToControl  |  boolean  |  macOS の Command キーを Ctrl にマップするには、true を指定します。それ以外の場合は、falseを指定します。 | 

#### 戻り値:
<a name="returns-22"></a>

 タイプ   
 void 

### setMaxDisplayResolution(maxWidth, maxHeight) → \$1void\$1
<a name="setMaxDisplayResolution"></a>

 接続に使用する最高表示解像度を設定します。

#### パラメータ :
<a name="parameters-18"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  maxWidth  |  数値  |  最大表示幅 (ピクセル)。許容される最小値は 0 です。 | 
|  maxHeight  |  数値  |  最大表示高さ (ピクセル)。許容される最小値は 0 です。 | 

#### 戻り値:
<a name="returns-23"></a>

 タイプ   
 void 

### setMicrophone(enable) → \$1Promise\$1Promise.<\$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode), message: string\$1>\$1
<a name="setMicrophone"></a>

 マイクを有効または無効にします。

#### パラメータ :
<a name="parameters-19"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  enable  |  ブール型  |  マイクを有効にするには、true を指定します。マイクを無効にするには、false を指定します。 | 

#### 戻り値:
<a name="returns-24"></a>

 Promise。拒否された場合、プロミスがエラーオブジェクトを返します。

 タイプ   
 Promise \$1 Promise.<\$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode), message: string\$1> 

### setMinDisplayResolution(minWidth, minHeight) → \$1void\$1
<a name="setMinDisplayResolution"></a>

 接続に使用する最低表示解像度を設定します。アプリケーションによっては、最低表示解像度が必要になる場合があります。必要な最低解像度がクライアントでサポートされている最高解像度よりも大きい場合は、サイズ変更戦略が使用されます。この関数は慎重に使用してください。サイズ変更戦略により、マウスとタッチ入力システムの精度が低下する可能性があります。

#### パラメータ :
<a name="parameters-20"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  minWidth  |  数値  |  最小表示幅 (ピクセル)。許容される最小値は 0 です。 | 
|  minHeight  |  数値  |  最小表示高さ (ピクセル)。許容される最小値は 0 です。 | 

#### 戻り値:
<a name="returns-25"></a>

 タイプ   
 void 

### setUploadBandwidth(value) → \$1number\$1
<a name="setUploadBandwidth"></a>

 Amazon DCV サーバーへのファイルのアップロードに使用する最大帯域幅を設定します。

#### パラメータ :
<a name="parameters-21"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  value  |  数値  |  アップストリーム帯域幅の上限 (kbps)。有効範囲は 1024～102400 kbps です。 | 

#### 戻り値:
<a name="returns-26"></a>

 - 設定された帯域幅限界。サーバーでファイルストレージ機能が無効になっている場合は `null`。

 タイプ   
 数値 

### setVolume(volume) → \$1void\$1
<a name="setVolume"></a>

 オーディオに使用するボリュームレベルを設定します。有効範囲は 0～100 で、0 が最小ボリューム、100 が最高ボリュームです。

#### パラメータ :
<a name="parameters-22"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  volume  |  数値  |  使用するボリュームレベル。 | 

#### 戻り値:
<a name="returns-27"></a>

 タイプ   
 void 

### setMicrophone(enable, deviceId) → \$1Promise\$1Promise.<\$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode), message: string\$1>\$1
<a name="setMicrophone"></a>

 (実験的 - 将来変更される可能性があります) マイクを有効または無効にします。

#### パラメータ :
<a name="parameters-23"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  enable  |  ブール型  |  マイクを有効にするには、true を指定します。マイクを無効にするには、false を指定します。 | 
|  deviceId  |  string  |  マイクのデバイス ID。deviceId が指定されていない場合は、default deviceId が使用されます。 | 

#### 戻り値:
<a name="returns-28"></a>

 Promise。拒否された場合、プロミスがエラーオブジェクトを返します。

 タイプ   
 Promise \$1 Promise.<\$1code: [AudioErrorCode](dcv-module.md#AudioErrorCode), message: string\$1> 

### setWebcam(enable, deviceId) → \$1Promise\$1Promise.<\$1code: [WebcamErrorCode](dcv-module.md#WebcamErrorCode), message: string\$1>\$1
<a name="setWebcam"></a>

 ウェブカメラを有効または無効にします。

#### パラメータ :
<a name="parameters-23"></a>


|  名前  |  型  |  説明  | 
| --- | --- | --- | 
|  enable  |  ブール型  |  ウェブカメラを有効にするには true を指定します。ウェブカメラを無効にするには false を指定します。 | 
|  deviceId  |  string  |  ウェブカメラのデバイス ID。 | 

#### 戻り値:
<a name="returns-28"></a>

 Promise は、成功した場合、アタッチ/デタッチされたウェブカメラのデバイス ID に対する解決策を見つけます。拒否された場合、プロミスがエラーオブジェクトを返します。

 タイプ   
 Promise.<string> \$1 Promise.<\$1code: [WebcamErrorCode](dcv-module.md#WebcamErrorCode), message: string\$1> 

### syncClipboards() → \$1boolean\$1
<a name="syncClipboards"></a>

 ローカルクライアントクリップボードとリモート Amazon DCV サーバークリップボードを同期します。自動コピーがブラウザでサポートされている必要があります。

#### 戻り値:
<a name="returns-29"></a>

 クリップボードが同期されている場合、関数が `true` を返します。クリップボードが同期されていない場合、またはブラウザで自動コピーがサポートされていない場合、関数が `false` を返します。

 タイプ   
 boolean