> 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/live-streaming.md).

# LIVE Streaming

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

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

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

* **新ドキュメント（最新版）**：[セキュアライブ視聴 URL 生成 (JWT)](https://docs.kollus.com/ja/dev-guide/live/player/jwt/)
* **提供終了のご案内**：本ドキュメントは2026年11月5日をもって公開を終了いたします。
  {% endhint %}

### Kollus Live Player 呼出方法 <a href="#livestreamingkollusliveplayer-hu-chu-fang-fa" id="livestreamingkollusliveplayer-hu-chu-fang-fa"></a>

Kollus Live Playerを呼出すURLを生成する方法は2つあります。

#### 公開チャンネル :

* チャンネル公開有無設定を"公開"にした場合、公開チャンネルとして設定されます。
* 公開chがんネルの場合、誰でも呼出ができるVideo gateway linkが生成されます。
* Video gateway linkはチャンネルモニタリングページから確認してください。

<figure><img src="https://1521757062-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FEecKUA6wx5AYrn8vpxDR%2Fuploads%2FNv4Lfde19Wy2JZqJWCaP%2Fimage%20(8).png?alt=media&amp;token=8aef3dc2-3fac-44b3-bb41-a9378d35f93c" alt=""><figcaption></figcaption></figure>

#### 非公開チャンネル :

* 非公開チャンネルはJWTを使用してチャンネルに適用したい運用ポリシーに合うURLを生成・呼出することができます。
* JWT Payloadは以下の JWT(Json Web Token) PAYLOAD SPEC を参考にしてください。

#### &#x20;非公開チャンネル URL 形式&#x20;

Kollus Live URL 形式

```
https://v-live-jp.kollus.com/s?jwt={JWT_TOKEN}&custom_key={ユーザーキー}
```

#### Webページに適用する方法&#x20;

取得した URLをブラウザのアドレス欄に入力するか、もしくは iframe タグを使用してHTMLページに埋め込みしてください。

iframe 適用方法

```
<iframe src="{ライブプレイヤーアドレス}" allow="autoplay;encrypted-media;fullscreen" allowfullscreen="" webkitallowfullscreen="" mozallowfullscreen="" ></iframe>
```

### JWT(Json Web Token) PAYLOAD SPEC <a href="#livestreaming-jwt-jsonwebtoken-payloadspec" id="livestreaming-jwt-jsonwebtoken-payloadspec"></a>

#### JWT paylod 形式

```
{
    "client_user_id": "CLIENT_USER_ID",
    "client_user_name": "CLIENT_USER_NAME",
    "video_watermarking_code_policy": {
                "code_kind":"client_user_id",
                "font_size":7,
                "font_color":"FFFFFF",
                "show_time":1,
                "hide_time":500,
                "alpha":50,
                "enable_html5_player": false
      },
    "client_user_image": "CLIENT_USER_IMAGE",
    "expire_time": EXPIRE_TIME,
    "play_expt": PLAY_EXPT_TIME,
    "live_media_channel_key": "LIVE_MEDIA_CHANNEL_KEY",
    "live_media_profile_key": "LIVE_MEDIA_PROFILE_KEY",
    "title": "TITLE",
    "chatting_policy": {
        "is_visible": true,
        "is_admin": false,
        "position": "right"
    }
	"chat_font_url": "CHAT_FONT_URL",
	"chat_font_name": "CHAT_FONT_NAME",
	"chat_font_weight": "700",
	"chat_font_color": "ffffff",
	"chat_background_color": "333333",
	"chat_tab_font_color": "00ff00",
	"chat_tab_background_color": "777777"
}


```

#### **PAYLOAD 詳細説明**

<table data-header-hidden><thead><tr><th></th><th width="131"></th><th width="132"></th><th></th><th data-hidden></th><th data-hidden></th></tr></thead><tbody><tr><td>名称</td><td>Datatype</td><td>必須有無</td><td>内容</td><td>備考</td><td></td></tr><tr><td><strong>client_user_id (or cuid)</strong></td><td>String</td><td>必須</td><td>コンテンツにアクセスするサービス利用者の会員ID</td><td><br></td><td></td></tr><tr><td><strong>client_user_name</strong></td><td>String</td><td>選択</td><td>チャットを使用する際、ハンドルネームとして表示</td><td><br></td><td></td></tr><tr><td><strong>client_user_image</strong></td><td>String</td><td>選択</td><td>チャットを使用する際、ハンドルネームの表示するイメージURL<br>httpsのみ対応</td><td><br></td><td></td></tr><tr><td><strong>expire_time(or expt)</strong></td><td>Integer</td><td>必須</td><td><p>JWTの有効期限 Unix timestamp 形式で入力</p><p>顧客側サーバーと時間が正確に一致しない可能性があるため、有効期限の効力に1分くらいの差が発生する可能性があります。</p></td><td><br></td><td></td></tr><tr><td><strong>play_expt</strong> </td><td>Integer</td><td>選択 (基本値: 現在時刻から48時間)</td><td>ストリーミングにアクセス出来る有効期限 </td><td><br></td><td></td></tr><tr><td><strong>live_media_channel_key (or lmckey)</strong></td><td>String</td><td>必須</td><td>再生するライブチャンネルキー</td><td><br></td><td></td></tr><tr><td><strong>live_media_profile_key(or lmpf)</strong></td><td>String</td><td>選択<br>(基本値: null)</td><td><p>ライブチャンネルのプロファイルの中で一つを強制指定する場合使用</p><p>入力しない場合ABRで動作します。 </p></td><td><br></td><td></td></tr><tr><td><p><strong>title</strong></p><p>(TITLE)</p></td><td>String</td><td><p>選択</p><p>(基本値: null)</p></td><td>コンテンツタイトルを代替する文字列</td><td><br></td><td></td></tr><tr><td><strong>chatting_policy</strong>　is_visible</td><td>boolean</td><td><p>選択</p><p>(基本値: true)</p></td><td>チャットウィンドウが開始する</td><td>チャットウィンドウを表示するか、しないか</td><td><br></td></tr><tr><td><strong>chatting_policy</strong>　<br>is_admin</td><td>boolean</td><td><p>選択</p><p>(基本値: false)</p></td><td>チャットルームの管理者であるか、ないか</td><td><br></td><td></td></tr><tr><td><strong>chatting_policy</strong>　<br>position</td><td>string</td><td><p>選択</p><p>(基本値: bottom)</p></td><td><p>チャットウィンドウの位置を指定 (Chatrollのみ使用可能)</p><p>bottom | left | right</p></td><td><br></td><td></td></tr><tr><td><strong>video_watermaking_code_policy</strong><br>code_kind</td><td>String</td><td>選択</td><td>"client_user_id"を除外した他のStringの場合そのまま出力</td><td></td><td></td></tr><tr><td><strong>video_watermaking_code_policy</strong><br>alpha</td><td>Integer</td><td>選択(基本値: 200)</td><td>ビデオウォーターマーキングコードのalpha値を定義 (16進数 0~255)</td><td><br></td><td></td></tr><tr><td><strong>video_watermaking_code_policy</strong><br>font_size</td><td>Integer</td><td>選択(基本値: 7)</td><td>ビデオウォーターマーキングコードのfont-size値を定義 (単位: px)</td><td><br></td><td></td></tr><tr><td><strong>video_watermaking_code_policy</strong><br>font_color</td><td>String</td><td>選択(基本値: 'FFFFFF')</td><td>ビデオウォーターマーキングコードのfont-color値を定義</td><td><br></td><td></td></tr><tr><td><strong>video_watermaking_code_policy</strong><br>show_time</td><td>Integer</td><td>選択(基本値:1)</td><td>ビデオウォーターマーキングコードの表示時間 (単位: 秒)</td><td><br></td><td></td></tr><tr><td><strong>video_watermaking_code_policy</strong><br>hide_time</td><td>Integer</td><td>選択(基本値:60)</td><td>ビデオウォーターマーキングコードが表示されてから非表示になるまでの時間 (単位: 秒)</td><td><br></td><td></td></tr><tr><td><strong>video_watermaking_code_policy</strong><br>enable_html5_player</td><td>Boolean</td><td>選択(基本値:false)</td><td>ビデオウォーターマーキングコードのHTML5 Player使用有無</td><td><br></td><td></td></tr><tr><td><strong>chat_font_url</strong></td><td>String</td><td>選択</td><td>1個のウェブフォント URL (Multiple URL 対応無し、拡張子別ブラウザ相違 </td><td></td><td></td></tr><tr><td><strong>chat_font_name</strong></td><td>String</td><td>選択</td><td><p>30文字以下, 韓・</p><p>中・日・英無関、内部chat_font_url 内部と不一致可能 (一致推奨)</p></td><td></td><td></td></tr><tr><td><strong>chat_font_weight</strong></td><td>String</td><td>選択</td><td>chat_font_url が含んだweightのみ可能 (以外は設定しても適用無し)</td><td></td><td></td></tr><tr><td><strong>chat_font_color</strong></td><td>String</td><td>選択</td><td>チャットのfont_colorを定義します。6桁進数</td><td></td><td></td></tr><tr><td><strong>chat_background_color</strong></td><td>String</td><td>選択</td><td>チャット background_color 値を定義する。6桁 16進数</td><td></td><td></td></tr><tr><td><strong>chat_tab_font_color</strong></td><td>String</td><td>選択</td><td>チャット tab_font_color値ｗお定義する。6桁 16進数</td><td></td><td></td></tr><tr><td><strong>chat_tab_background_color</strong></td><td>String</td><td>選択</td><td>チャット tab_background_color 値ｗお定義する。6桁 16進数</td><td></td><td></td></tr></tbody></table>
