> 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/pureiymesoddo.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 %}

### **get\_player\_id ()**

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

> プライヤー固有IDをリターンします。この関数はreadyイベントが呼び出す前までは nullをリターンします。

**Parameters:**

* No parameter

**Return:**

* STRING **プライヤー固有ID**

### **get\_hardware\_id ()** 

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

> ハードウェア固有IDをリターンします。 この関数は readyイベントが呼び出す前まではnulをリターンします。

**Parameters:**

* No parameter

**Return:**

* STRING ハードウェア固有ID

### **get\_player\_type ()**

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

> 現在のプレイヤーTypeをリターンします。 V3, V4いずれかをリターンします。**Parameters:**

* No parameter

**Return:**

* STRING 現在のプレイヤー Type

### **get\_video\_info ()** 

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

> メディアの width, height, bitrate値をリターンします。この関数は readyイベントが呼び出す前まではnullをリターンします。

\
**Parameters:**

* No parameter

**Return:**

* OBJECT width, height, bitrateのpropertyを持つObjectをリターン

### **get\_lms\_data () v4**

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

> 現在まで保存したLMS dataをリターンします。

**Parameters:**

* No parameter

**Return:**

* OBJECT LMS data

### **get\_hls\_frag\_data ()**

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

> hlsのfrag dataを呼び出します。

**Parameters:**

* No parameter

**Return:**

* base\_url STRING M3U8 ファイル呼び出すアドレス
* url STRING TS 파일(メディアファイル)の呼び出すアドレス
* duration INTEGER TS ファイル全体時間
* auto\_level BOOLEAN ABR 可否
* level INTEGER 현재 ビットレートレベル値
* media\_sequence INTEGER メディアシークエンスナンバー
* programdatetime INTEGER Program Date Time
* tag\_list ARRAYTags \[key, value]
* encrypted BOOLEANEncrypt 可否

### **set\_close\_button (enable, fn)**

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

> プレイヤーの右上に閉じるボタンを追加します。 （モバイルプレーヤーで使用します。) 閉じるボタンをクリックすると、コールバック関数を実行します。
>
> * ready event以降に呼び出す必要があります。

**Parameters:**

* enable BOOLEAN 閉じるボタン有効化可否
* fn FUNCTION 閉じるボタンクリック時実行される関数

**Return:**

* No return

### **dispose ()** 

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

> プレイヤーオブジェクトを除去します。

**Parameters:**

* No Parameter

**Return:**

* No return

### **get\_custom\_skin ()**

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

プレイヤーに設定された Custom skin JSON dataをリターンします。

\*readyイベントを受け取った後呼び出してください。

**Parameters:**

* No Parameter

**Return:**

* Object Custom skin JSON data

### **set\_custom\_skin (json\_data)**

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

> プレイヤーにCustom skinを適用します。 json\_data適用例は以下となります。

```
{ 
　　controlbar: { 
　　　　enable: true, 
　　　　backgroundColor: 123123, 
　　　　backgroundAlpha: 0.2,
 progressButton: { 
　　　　enable: false
　 }
 ...
 }
 ... 
}
```

カスタムスキンのJSON仕様については、別途ドキュメントを参照してください。\*readyイベントを受け取った後に呼び出す必要があります。

**Parameters:**

* **json\_data** Object Custom skin JSON data

**Return:**

* No return