メインコンテンツまでスキップ

プレイヤー呼び出しオプション (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 プレイヤーの種類

表記プレイヤー名特徴
v3eApp Player for Windowsインストール型エージェント方式プレイヤー
v3hHTML5 Player for PCインストール型 HTML5 エージェント方式プレイヤー
v3HTML5 Player for PC (Hybrid)Microsoft Edge または Chrome 45 以上で暗号化コンテンツを再生する際に適用されるハイブリッド HTML5 プレイヤー
v4HTML5 Player for All非暗号化コンテンツ専用の非インストール型 HTML5 プレイヤー
v5Web Playerインストール型と非インストール型の長所を組み合わせた次世代統合 Web プレイヤー
iOSApp Player for iOSiOS 専用アプリプレイヤー
AndroidApp Player for AndroidAndroid 専用アプリプレイヤー
プレイヤーのご案内

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

全オプション

再生

パラメータータイプ対象プレイヤー説明
autoplay (a)null全体自動再生設定(モバイル環境ではデフォルトで有効)
mutenull全体ミュート状態で再生開始
tinteger全体指定した時点(秒)から再生し、続きから再生のポップアップを表示
sinteger全体指定した時点(秒)から再生し、続きから再生のポップアップを表示しない
titlestring全体コンテンツタイトルを強制指定
pfstring全体エンコーディングプロファイル(画質)を強制指定
注意
  • 再生オプションの例外: t または s の値が動画の開始・終了 10 秒以内の場合、システムの安定性のため動画の先頭(0 秒)から再生されます。
  • ブラウザーの自動再生ポリシー: Chrome および最新のブラウザーは、音声を含む動画の自動再生をデフォルトでブロックします。詳細は Chrome の自動再生ポリシー を参照してください。

ダウンロード

パラメータータイプ対象プレイヤー説明
downloadnullモバイル、v3e、v3hダウンロードモードの有効化
mobile_folder_downloadstringモバイルモバイルダウンロードフォルダーのパスを指定
pc_folder_downloadstringv3e、v3hPC ダウンロードフォルダーのパスを指定
filenamestring全体R-link ・ SR-link 使用時に保存されるファイル名を指定
参考
  • 前提条件: download パラメーターが正常に動作するには、DRM Download Callback の設定が事前に必要です。
  • フォルダーパスの設定: / 記号を使用してサブフォルダーを指定できます。
    • 例: folder1/folder2/folder3
  • エンコーディング: フォルダー名に日本語・特殊文字・スペースが含まれる場合は、必ずその値を UTF-8 URL エンコーディング処理して渡してください。
  • R-link の有効化: R-link はデフォルトで無効になっています。この機能を有効化するには、営業担当者(jp_sales@catenoid.net) までお問い合わせください。

プレイヤー

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

コントロールバー

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

オーバーレイ / ポスター

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

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

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

シーク (Seek) / 自動再生

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

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

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

画面制御

パラメータータイプ対象プレイヤー説明
force_landscape_fullscreenbooleanv4、v5モバイルの全画面再生時に画面の向きを横向きに固定
force_rotate_fullscreenbooleanv4、v5モバイルデバイスを横向きに回転させた際に全画面モードを強制実行
enable_pipbooleanv3、v4、v5PIP (Picture-in-Picture) モードを許可
pointcolornumberv4、v5UI ポイントカラーを変更(HEX、# 除く)
is_vrbooleanv4、v5VR プレイヤーで再生
is_dvrbooleanv4、v5DVR タイムシフトを有効化

入力 / アクセシビリティ

パラメータータイプ対象プレイヤー説明
enable_hotkeybooleanv4、v5ショートカットキーを有効化
enable_volume_scrollbooleanv4、v5マウスホイールによる音量調整を有効化
enable_context_menubooleanv3、v4、v5マウス右クリックのコンテキストメニューの使用を許可
enable_accessibilitybooleanv3、v4、v5Web アクセシビリティ機能を有効化
enable_initialize_focusbooleanv3、v4プレイヤーロード時にフォーカスを適用(デフォルト値: true

iOS 専用オプション

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

開発 / デバッグ

パラメータータイプ対象プレイヤー説明
debug_modebooleanv3、v4、v5ブラウザーコンソールにデバッグログを出力
debug_mode2booleanv4、v5詳細なイベントログおよびデータ状態を出力
agent_modebooleanv3KollusAgent の検査を実行するか
agent_urlstringv3KollusAgent の URL を設定(debug_mode=true 設定時に動作)
loadcheckintegerv30: Play Callback でメッセージを使用
media_key_srcstringv3メディアキーを直接指定
media_urlstringv3再生 URL を直接指定

その他

パラメータータイプ対象プレイヤー説明
uservalue{0~99}mixed全体カスタム変数(uservalue0uservalue99
  • 再生・ 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