> For the complete documentation index, see [llms.txt](https://catenoid-support.gitbook.io/kollus-dev-jp/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://catenoid-support.gitbook.io/kollus-dev-jp/kollus-vg-controller/mesoddo-1.md).

# 画面メソッド

{% hint style="info" icon="bullhorn" %}

## 新しいKollus Docsサイトにて、本ドキュメントの最新バージョンをご確認いただけます。

本ドキュメントは旧バージョンです。より正確で最新の情報は、以下の新しいリンク先よりご確認ください。

* **新ドキュメント（最新版）**：[Web Player Controller](https://docs.kollus.com/ja/dev-guide/vod/player/web-player-controller/)
* **提供終了のご案内**：本ドキュメントは2026年11月5日をもって公開を終了いたします。
  {% endhint %}

### **set\_screen()** 

**対象プレイヤータイプ：v3,v4**

> 全体画面をOn/Offします。On/Offはスイッチ方式で作動します。(呼出す度に状態が変更)
>
> Flash Player 対応不可
>
> IE, Firefox対応不可

**Parameters:**

* No parameter

**Return:**

* No return

### **set\_fullscreen\_element (element)**

**対象プレイヤータイプ：v3,v4**

> Fullscreenオブジェクトを直接設定します。通常、VGを囲んでいるIFrameエレメントを設定し、VG-Controllerを通じたFullscreen機能は、PlayerではなくVg-Controllerクライアントで実行されます。

**Parameters:**

* **element**`String`Fullscreenを適用するTarget HTML Element ID

**Return:**

* No return

### **get\_screen()**

**対象プレイヤータイプ：v3,v4**

> 現在画面モードをリターン：set\_screenの対応有無(V2, V3, V4 Player)に関係なくget\_screen関数は全てのPlayerから画面モードをリターンします。
>
> 全体画面Off : windowed
>
> 全体画面On : fullscreen

**Parameters:**

* No parameter

**Return:**

* `String` リターンされる現在の画面モード：windowed, fullscreenのいずれかの値

### **set\_video\_visibility (visibility)**

**対象プレイヤータイプ：v3,v4**

> Video画面を非表示または非表示を解除します。 (Audioには影響しません。)パラメータでtrueを与えると非表示、falseを与えると非表示です。

**Parameters:**

* visibility BOOLEANVideo 非表示可否

**Return:**

* No return

### **get\_video\_visibility (visibility)**

**対象プレイヤータイプ：v3,v4**

> 設定されたVideo非表示可否をリターン

**Parameters:**

* No parameter

**Return:**

* BOOLEANVideo 非表示可否

### **enable\_fullscreen\_button ()**

**対象プレイヤータイプ：v3,v4**

> プレイヤー内部のfullscreen buttonを有効化させます。(IE10以下はウェブブラウザでfullscreen機能を対応していないため、該当ウェブブラウザでは自動的にfullscreenbuttonが無効になっている状態で表示されます。

**Parameters:**

* No parameter

**Return**:

* No return

### **set\_ratio(type)** 

> 画面拡大モード変更

**Parameters:**

* type STRING contain, fill, enlargement中一つの値のみ
  * contain : 比率に合わせて埋めます。
  * fill : 全画面に合わせて埋めます。
  * enlargement : 縦の高さをいっぱいに合わせます。左右にスクロールできます。

**Return:**

* No return

### **set\_vr\_overlay (options) v4**

**対象プレイヤータイプ：v3,v4**

> iOSでVRコンテンツを実装する際に、DeviceMotion権限を取得する必要があります。 iOSデバイスでは、DeviceMotion権限を取得するために、Native CodeであるDeviceMotionEvent.requestPermissionメソッドを呼び出す必要があります。 
>
> User Action(Touch)が必要ですので、iframeオブジェクトの上にTouch Eventを受け取るための任意のオブジェクトが必要です。
>
>  VG-Controller Clientを初期化した後、このメソッドを呼び出すと、VG-Controller Client内で自動的にTouchEventオブジェクトが生成され、権限を取得できるように準備されます。

```
var controller = new VgControllerClient({
  target_window: player.contentWindow
});
controller.set_vr_overlay({
  target_element: document.getElementById('player').parentElement,
  permission_request_help_message: 'Custom Info Message'
});
```

* Known Issue

iOS 13.4バージョンでは、権限を取得してもDeviceMotionのrotationRateの値が正常に生成されないエラーが発生します。

**Parameters:**

* options `OBJECT`<br>
  * target\_element (必須)
    * 任意のTouch Eventオブジェクトを生成するためのDom Element です。iframeオブジェクトの親Element を指定する必要があります。&#x20;
    * (重要）iframeオブジェクトの親Elementは、positionの値がrelativeまたはabsoluteである必要があります。
  * permission\_request\_help\_message
    * 前回DeviceMotion Permissionを実行したことがある場合、ブラウザのデータストレージにその値が保存されます。もしPremissionをキャンセルした場合、キャンセル状態で保存されているため、requestPermissionを実行できません。この状況に関する案内メッセージを設定します。設定しない場合、デフォルトで以下のように表示されます。
    * 動作及び方向に関する権限がないためザイロ機能が有効になりません。設定 > Safari > 詳細 > ウェブサイトデータからデータを削除して、再試行してください。

**Return:**

* No return