プレイヤー呼び出しオプション (Query String)

お知らせ

このドキュメントは機械翻訳で作成された下書きであり、現在レビュー中です。機械翻訳の特性上、一部の内容が不正確であったり、韓国語の原文と異なる場合があります。より正確な情報については、韓国語のドキュメントをご参照ください。

このドキュメントでは、再生 URL の末尾に Query String パラメーターを追加して、プレイヤーの動作と UI を細かく制御する方法を説明します。

Query String の形式

再生 URL にパラメーターを追加するルールは以下の通りです。

https://v.jp.kollus.com/{MEDIA_CONTENT_KEY}?{KEY}={VALUE}&{KEY2}={VALUE2}

区切り文字: URL の末尾に ? を付けます。複数のオプションを連結する場合は & を区切り文字として使用します。
フラグ (Flag) 形式: 別途の値 (VALUE) が不要なオプションは、キー (KEY) のみ入力します。（例: ?autoplay&mute）
エンコーディング: パラメーター値に日本語・特殊文字・スペースが含まれる場合は、必ずその値を UTF-8 URL エンコーディング処理して渡してください。

Kollus プレイヤーの種類

Kollus プレイヤーの詳細については、Kollus プレイヤーの種類ドキュメントを参照してください。

表記	プレイヤー名	特徴
v3e	App Player for Windows	インストール型エージェント方式プレイヤー
v3h	HTML5 Player for PC	インストール型 HTML5 エージェント方式プレイヤー
v3	HTML5 Player for PC (Hybrid)	Microsoft Edge または Chrome 45 以上で暗号化コンテンツを再生する際に適用されるハイブリッド HTML5 プレイヤー
v4	HTML5 Player for All	非暗号化コンテンツ専用の非インストール型 HTML5 プレイヤー
v5	Web Player	インストール型と非インストール型の長所を組み合わせた次世代統合 Web プレイヤー
iOS	App Player for iOS	iOS 専用アプリプレイヤー
Android	App Player for Android	Android 専用アプリプレイヤー

全オプション

再生

パラメーター	タイプ	説明	対象プレイヤー
`autoplay (a)`	`null`	自動再生設定（モバイル環境ではデフォルトで有効）	全体
`mute`	`null`	ミュート状態で再生開始	全体
`t`	`integer`	指定した時点（秒）から再生し、続きから再生のポップアップを表示	全体
`s`	`integer`	指定した時点（秒）から再生し、続きから再生のポップアップを表示しない	全体
`title`	`string`	コンテンツタイトルを強制指定	全体
`pf`	`string`	エンコーディングプロファイル（画質）を強制指定	全体

参考

再生オプションの例外: t または s の値が動画の開始・終了 10 秒以内の場合、システムの安定性のため動画の先頭（0 秒）から再生されます。
ブラウザー/プラットフォームの自動再生ポリシー: 最新のブラウザーは、音声付き動画の自動再生をデフォルトでブロックします。詳細は下記の"ブラウザー/プラットフォーム別自動再生ポリシー"を参照してください。

ブラウザー/プラットフォーム別自動再生ポリシー

ブラウザーおよびプラットフォーム	音声なし動画	音声付き動画	備考
Chrome	自動再生を許可	デフォルトでブロック	ユーザーの Media Engagement Index（MEI）が高いか、以前のクリック履歴がある場合にのみ、例外的に自動再生を許可
Edge	自動再生を許可	デフォルトでブロック	ユーザーがブラウザー設定で自動再生を"許可"に変更した場合、自動再生を許可企業環境で管理者がグループポリシー（AutoplayAllowed）を"許可"として展開した場合、自動再生を許可
Safari（macOS）	自動再生を許可	デフォルトでブロック	ユーザーが Safari 設定でウェブサイトごとに自動再生の許可有無を個別に変更可能
iOS（iPhone/iPad）	自動再生を許可（`playsinline` 必須）	デフォルトでブロック	ユーザーが画面を直接タッチ（ジェスチャー）した後にのみ、スクリプトによる再生を許可
Firefox	自動再生を許可	デフォルトでブロック	ユーザーがブラウザー設定で自動再生のブロックおよび許可レベルを変更可能

参考資料

推奨実装ガイドライン

音声付き動画は、ミュート状態での自動再生を開始することを推奨します。その後、ユーザーが自らオーディオを有効化できるよう、ミュート解除ボタンをあわせて提供してください。

ダウンロード

パラメーター	タイプ	説明	対象プレイヤー
`download`	`null`	コンテンツダウンロード機能の有効化	モバイル、v3e、v3h
`mobile_folder_download`	`string`	モバイルダウンロードフォルダーのパスを指定	モバイル
`pc_folder_download`	`string`	PC ダウンロードフォルダーのパスを指定	v3e、v3h
`filename`	`string`	R-link・SR-link 使用時に保存されるファイル名を指定	全体

参考

前提条件: download パラメーターが正常に動作するには、DRM Download Callback の設定が事前に必要です。(参考文書: Callback 連動 - DRM Download Callback)
フォルダーパスの設定: / 記号を使用してサブフォルダーを指定できます。
- 例: folder1/folder2/folder3
エンコーディング: フォルダー名に日本語・特殊文字・スペースが含まれる場合は、必ずその値を UTF-8 URL エンコーディング処理して渡してください。
R-link の有効化: R-link はデフォルトで無効になっています。この機能を有効化するには、営業担当者(jp_sales@catenoid.net) までお問い合わせください。

プレイヤー

パラメーター	タイプ	説明	対象プレイヤー
`player_version (pv)`	`string`	プレイヤーを指定 `v3h`: HTML5 Player for PC `v3e`: App Player for Windows `v4`: HTML5 Player for All `v5`: Web Player `未指定`: 再生環境に応じて自動適用	PC
`force_exclusive_player`	`null`	非暗号化コンテンツの再生時も PC 用 Kollus セキュアプレイヤーを適用	v3e、v3h
`force_independent_player`	`boolean`	Kollus セキュアプレイヤーを強制適用	v3

コントロールバー

パラメーター	タイプ	説明	対象プレイヤー
`controls_activation`	`string`	コントロールバーの表示ポリシー `auto`: `inactive_time` の設定に従って自動表示・非表示 `always`: 常時表示 `none`: 常時非表示	v3、v4、v5
`show_controls_paused`	`boolean`	一時停止状態でコントロールバーを維持するか（デフォルト値: `false`）	v4
`set_controlbar_progress_only`	`boolean`	プログレスバー (Progress Bar) のみ表示	v4、v5
`transparent_controlbar_layer`	`boolean`	コントロールバーの背景を透明化	v4、v5
`hide_header_display`	`boolean`	ヘッダー領域を非表示	v4、v5

オーバーレイ / ポスター

パラメーター	タイプ	説明	対象プレイヤー
`overlay_button_position`	`string`	オーバーレイボタンの位置 `TR`: 右上 (Top Right) `TL`: 左上 (Top Left) `BR`: 右下 (Bottom Right) `BL`: 左下 (Bottom Left) `未指定`: 中央揃え	v4
`show_poster_ended`	`boolean`	再生終了後にポスターを表示するか（デフォルト値: `false`）	v4
`enable_poster`	`boolean`	ポスターを有効化するか	v4、v5
`enable_spinner_activation`	`boolean`	ローディングアイコンを有効化するか	v4、v5

サムネイル / タイムディスプレイ

パラメーター	タイプ	説明	対象プレイヤー
`enable_thumbnail`	`boolean`	プログレスバーのシーク時にサムネイルプレビューを有効化	v4、v5
`enable_mouse_time_display`	`boolean`	マウスオーバー時にタイムディスプレイを表示	v5

シーク (Seek) / 自動再生

パラメーター	タイプ	説明	対象プレイヤー
`autoplay_after_seek`	`string`	再生位置の移動(Seek)後の再生ポリシー `auto`: 再生中に移動した場合は自動再生、一時停止中に移動した場合は停止を維持 `play`: 移動後すぐに再生 `pause`: 移動後に停止	v4、v5
`disable_autoplay`	`boolean`	自動再生が可能な状況でも当該機能を無効化	v4、v5
`play_at`	`number`	続きから再生する時点を設定	v3

バッファリング / ストリーミング

パラメーター	タイプ	説明	対象プレイヤー
`buffer`	`integer`	バッファリング倍数を設定（2〜10 倍）	v3e、v3h
`frag_load_paused`	`boolean`	一時停止状態で HLS Fragment を読み込むか	v4、v5
`force_custom_header`	`boolean`	HLS 同時接続確認ヘッダー (`X-Kollus-SessionId`) を強制追加	v4、v5
`force_use_credentials`	`boolean`	HLS XHR リクエスト時に `withCredentials` を強制適用	v4、v5

画面制御

パラメーター	タイプ	説明	対象プレイヤー
`force_landscape_fullscreen`	`boolean`	モバイルの全画面再生時に画面の向きを横向きに固定	v4、v5
`force_rotate_fullscreen`	`boolean`	モバイルデバイスを横向きに回転させた際に全画面モードを強制実行	v4、v5
`enable_pip`	`boolean`	PIP (Picture-in-Picture) モードを許可	v3、v4、v5
`pointcolor`	`number`	UI ポイントカラーを変更（HEX、# 除く）	v4、v5
`is_vr`	`boolean`	VR プレイヤーで再生	v4、v5
`is_dvr`	`boolean`	DVR タイムシフトを有効化	v4、v5

入力 / アクセシビリティ

パラメーター	タイプ	説明	対象プレイヤー
`enable_hotkey`	`boolean`	ショートカットキーを有効化	v4、v5
`enable_volume_scroll`	`boolean`	マウスホイールによる音量調整を有効化	v4、v5
`enable_context_menu`	`boolean`	マウス右クリックのコンテキストメニューの使用を許可	v3、v4、v5
`enable_accessibility`	`boolean`	Web アクセシビリティ機能を有効化	v3、v4、v5
`enable_initialize_focus`	`boolean`	プレイヤーロード時にフォーカスを適用（デフォルト値: `true`）	v3、v4

iOS 専用オプション

パラメーター	タイプ	説明
`ios_player_type`	`string`	iOS デコーダータイプ（App Player for iOS バージョン 2.2.14 以上への適用が必須） `native`: Native デコーダー `hw`: ハードウェアデコーダー `sw`: ソフトウェアデコーダー
`mobile_return_url`	`string`	戻る・終了時に遷移する URL（Safari ブラウザーで起動）

開発 / デバッグ

パラメーター	タイプ	説明	対象プレイヤー
`debug_mode`	`boolean`	ブラウザーコンソールにデバッグログを出力	v3、v4、v5
`debug_mode2`	`boolean`	詳細なイベントログおよびデータ状態を出力	v4、v5
`agent_mode`	`boolean`	KollusAgent の検査を実行するか	v3
`agent_url`	`string`	KollusAgent の URL を設定（`debug_mode=true` 設定時に動作）	v3
`loadcheck`	`integer`	`0`: Play Callback でメッセージを使用	v3
`media_key_src`	`string`	メディアキーを直接指定	v3
`media_url`	`string`	再生 URL を直接指定	v3

その他

パラメーター	タイプ	説明	対象プレイヤー
`uservalue{0~99}`	`mixed`	カスタム変数（`uservalue0`〜`uservalue99`）再生・DRM・LMS Callback などのクライアント情報送信時に一緒に送信されます。	全体

使用例

参考文書

キー (Key/ID) 情報については、認証と主要キードキュメントを参照してください。

視聴体験の最適化（再生制御）

自動再生と初期ミュートの設定

ブラウザーの自動再生ブロックポリシーを回避して、視聴への自動エントリーを実現するオプションの組み合わせです。

https://v.jp.kollus.com/{MEDIA_CONTENT_KEY}?autoplay&mute

10 秒地点からすぐに再生

続きから再生のポップアップを表示せず、指定した時点からすぐに再生を開始します。

https://v.jp.kollus.com/{MEDIA_CONTENT_KEY}?s=10

画質（プロファイル）の指定とタイトルの変更

特定の画質を選択したり、プレイヤーに表示されるタイトルを指定します。title の値に日本語やスペースが含まれる場合は、必ず UTF-8 URL エンコーディング処理を行ってください。

https://v.jp.kollus.com/{MEDIA_CONTENT_KEY}?pf={ENCODING_PROFILE_KEY}&title={TITLE}

UI 制御

プレイヤーの指定とデバッグログの有効化

特定のプレイヤー環境をテストしたり、ブラウザーの開発者ツール(Console)でログを確認する際に活用します。

https://v.jp.kollus.com/{MEDIA_CONTENT_KEY}?player_version=v4&debug_mode=true

モバイル全画面切り替え時に横向きを固定

モバイルユーザーが全画面ボタンを押した際に、デバイスの向きにかかわらず画面の向きを横向きに切り替えます。

https://v.jp.kollus.com/{MEDIA_CONTENT_KEY}?force_landscape_fullscreen=true

コントロールバーの常時表示とポイントカラーの変更

ユーザー操作がなくてもコントロールバーを常に表示し、ブランドテーマに合わせたポイントカラーを適用します。

https://v.jp.kollus.com/{MEDIA_CONTENT_KEY}?controls_activation=always&pointcolor=FF5500

ダウンロード

ダウンロードモードの実行とフォルダーパスの指定

コンテンツを保存するサブフォルダーのパスを指定します。特殊文字や日本語が含まれるパスは、必ず UTF-8 URL エンコーディング処理を行ってください。

https://v.jp.kollus.com/{MEDIA_CONTENT_KEY}?download&mobile_folder_download=movie/action

Query String の形式​

Kollus プレイヤーの種類​

全オプション​

再生​

ブラウザー/プラットフォーム別自動再生ポリシー​

参考資料​

ダウンロード​

プレイヤー​

コントロールバー​

オーバーレイ / ポスター​

サムネイル / タイムディスプレイ​

シーク (Seek) / 自動再生​

バッファリング / ストリーミング​

画面制御​

入力 / アクセシビリティ​

iOS 専用オプション​

開発 / デバッグ​

その他​

使用例​

視聴体験の最適化（再生制御）​

自動再生と初期ミュートの設定​

10 秒地点からすぐに再生​

画質（プロファイル）の指定とタイトルの変更​

UI 制御​

プレイヤーの指定とデバッグログの有効化​

モバイル全画面切り替え時に横向きを固定​

コントロールバーの常時表示とポイントカラーの変更​

ダウンロード​

ダウンロードモードの実行とフォルダーパスの指定​

Query String の形式

Kollus プレイヤーの種類

全オプション

再生

ブラウザー/プラットフォーム別自動再生ポリシー

参考資料

ダウンロード

プレイヤー

コントロールバー

オーバーレイ / ポスター

サムネイル / タイムディスプレイ

シーク (Seek) / 自動再生

バッファリング / ストリーミング

画面制御

入力 / アクセシビリティ

iOS 専用オプション

開発 / デバッグ

その他

使用例

視聴体験の最適化（再生制御）

自動再生と初期ミュートの設定

10 秒地点からすぐに再生

画質（プロファイル）の指定とタイトルの変更

UI 制御

プレイヤーの指定とデバッグログの有効化

モバイル全画面切り替え時に横向きを固定

コントロールバーの常時表示とポイントカラーの変更

ダウンロード

ダウンロードモードの実行とフォルダーパスの指定