Player Call Options (Query String)
This document is a machine-translated draft and is currently undergoing review. Some content may be inaccurate or differ from the original Korean version. For the most precise information, refer to the Korean documentation.
This document explains how to add Query String parameters to the Playback URL to finely control the player's behavior and UI.
The rules for adding parameters to the Playback URL are as follows.
https://v.kr.kollus.com/{MEDIA_CONTENT_KEY}?{KEY}={VALUE}&{KEY2}={VALUE2}
- Separator: Append
? to the end of the URL. Use & as a separator when connecting multiple options.
- Flag format: For options that do not require a separate value (
VALUE), enter only the key (KEY). (e.g., ?autoplay&mute)
- Encoding: If the parameter value contains Korean characters, special characters, or spaces, you must pass the value after UTF-8 URL encoding.
Kollus Player types
| Notation | Player Name | Characteristics |
|---|
| v3e | App Player for Windows | Installable Agent-based player |
| v3h | HTML5 Player for PC | Installable HTML5 Agent-based player |
| v3 | HTML5 Player for PC (Hybrid) | Hybrid HTML5 player applied when playing encrypted content on Microsoft Edge or Chrome 45 or later |
| v4 | HTML5 Player for All | Non-installable HTML5 player for standard content(unencrypted) only |
| v5 | Web Player | Next-generation integrated web player combining the advantages of installable and non-installable players |
| iOS | App Player for iOS | iOS-exclusive app player |
| Android | App Player for Android | Android-exclusive app player |
For detailed descriptions of Kollus Players, refer to the document below.
All options
Playback
| Parameter | Type | Target Player | Description |
|---|
autoplay (a) | null | All | Auto-play setting (enabled by default in mobile environments) |
mute | null | All | Start playback in muted state |
t | integer | All | Play from the specified point (sec) and show resume popup |
s | integer | All | Play from the specified point (sec) without resume popup |
title | string | All | Force-specify content title |
pf | string | All | Force-specify encoding profile (video quality) |
- Playback option exception: If the
t or s value is within 10 seconds of the start/end of the video, playback will start from the beginning (0 seconds) for system stability.
- Browser autoplay policy: Chrome and modern browsers block autoplay of videos with audio by default. For details, refer to Chrome's Autoplay Policy.
Download
| Parameter | Type | Target Player | Description |
|---|
download | null | Mobile, v3e, v3h | Enable download mode |
mobile_folder_download | string | Mobile | Specify mobile download folder path |
pc_folder_download | string | v3e, v3h | Specify PC download folder path |
filename | string | All | Specify the file name to be saved when using R-link or SR-link |
- Prerequisite: The DRM download callback must be configured for the
download parameter to work properly.
- Folder path settings: Use the
/ symbol to specify subfolders.
- e.g.,
folder1/folder2/folder3
- Encoding: If the folder name contains Korean characters, special characters, or spaces, you must pass the value after UTF-8 URL encoding.
- R-link activation: R-link is disabled by default. To activate this feature, contact your Account Manager(biz@catenoid.net) or Technical Support(tech_support@catenoid.net).
Player
| Parameter | Type | Target Player | Description |
|---|
player_version (pv) | string | PC | Specify playerv3h: HTML5 Player for PCv3e: App Player for Windowsv4: HTML5 Player for Allv5: Web PlayerUnspecified: Automatically applied based on playback environment
|
force_exclusive_player | null | v3e, v3h | Apply Kollus secure player for PC even when playing standard content(unencrypted) |
force_independent_player | boolean | v3 | Force apply Kollus secure player |
Control bar
| Parameter | Type | Target Player | Description |
|---|
controls_activation | string | v3, v4, v5 | Control bar activation policyauto: Automatically show/hide according to inactive_time settingalways: Always visiblenone: Always hidden
|
show_controls_paused | boolean | v4 | Whether to keep control bar visible when paused (default: false) |
set_controlbar_progress_only | boolean | v4, v5 | Show only the progress bar |
transparent_controlbar_layer | boolean | v4, v5 | Make control bar background transparent |
hide_header_display | boolean | v4, v5 | Hide header area |
Overlay / poster
| Parameter | Type | Target Player | Description |
|---|
overlay_button_position | string | v4 | Overlay button positionTR: Top RightTL: Top LeftBR: Bottom RightBL: Bottom LeftUnspecified: Center aligned
|
show_poster_ended | boolean | v4 | Whether to show poster after playback ends (default: false) |
enable_poster | boolean | v4, v5 | Whether to enable poster |
enable_spinner_activation | boolean | v4, v5 | Whether to enable loading icon |
Thumbnail / time display
| Parameter | Type | Target Player | Description |
|---|
enable_thumbnail | boolean | v4, v5 | Enable thumbnail preview when seeking on progress bar |
enable_mouse_time_display | boolean | v5 | Show time display on mouse over |
Seek / autoplay
| Parameter | Type | Target Player | Description |
|---|
autoplay_after_seek | string | v4, v5 | Playback policy after seekingauto: Auto-play when seeking during playback, maintain pause when seeking while pausedplay: Play immediately after seekingpause: Pause after seeking
|
disable_autoplay | boolean | v4, v5 | Disable autoplay even when autoplay is available |
play_at | number | v3 | Set resume playback point |
Buffering / streaming
| Parameter | Type | Target Player | Description |
|---|
buffer | integer | v3e, v3h | Set buffering multiplier (2–10x) |
frag_load_paused | boolean | v4, v5 | Whether to load HLS Fragment when paused |
force_custom_header | boolean | v4, v5 | Force add HLS concurrent access check header (X-Kollus-SessionId) |
force_use_credentials | boolean | v4, v5 | Force apply withCredentials for HLS XHR requests |
Screen control
| Parameter | Type | Target Player | Description |
|---|
force_landscape_fullscreen | boolean | v4, v5 | Lock screen orientation to landscape during mobile fullscreen playback |
force_rotate_fullscreen | boolean | v4, v5 | Force fullscreen mode when mobile device rotates to landscape |
enable_pip | boolean | v3, v4, v5 | Allow PIP(Picture-in-Picture) mode |
pointcolor | number | v4, v5 | Change UI point color (HEX, excluding #) |
is_vr | boolean | v4, v5 | VR player playback |
is_dvr | boolean | v4, v5 | Enable DVR timeshift |
| Parameter | Type | Target Player | Description |
|---|
enable_hotkey | boolean | v4, v5 | Enable shortcuts |
enable_volume_scroll | boolean | v4, v5 | Enable mouse wheel volume control |
enable_context_menu | boolean | v3, v4, v5 | Allow mouse right-click context menu |
enable_accessibility | boolean | v3, v4, v5 | Enable web accessibility features |
enable_initialize_focus | boolean | v3, v4 | Apply focus when player loads (default: true) |
Ios-exclusive options
| Parameter | Type | Target Player | Description |
|---|
ios_player_type | string | iOS | iOS decoder type (required for App Player for iOS version 2.2.14 or later) native: Native decoderhw: Hardware decodersw: Software decoder
|
mobile_return_url | string | iOS | URL to navigate to when going back/closing (launches Safari browser) |
Development / debugging
| Parameter | Type | Target Player | Description |
|---|
debug_mode | boolean | v3, v4, v5 | Output debug log to browser console |
debug_mode2 | boolean | v4, v5 | Output detailed event log and data status |
agent_mode | boolean | v3 | Whether to run Kollus Agent inspection |
agent_url | string | v3 | Set Kollus Agent URL (works when debug_mode=true is set) |
loadcheck | integer | v3 | 0: Use message in playback callback |
media_key_src | string | v3 | Directly specify media key |
media_url | string | v3 | Directly specify Playback URL |
Other
| Parameter | Type | Target Player | Description |
|---|
uservalue{0~99} | mixed | All | Custom variables (uservalue0–uservalue99)- Transmitted together when sending client information via playback, DRM, LMS callbacks, etc.
|
Usage examples
Refer to the document below for key (Key/ID) information.
Optimizing viewing experience (playback control)
Auto-play and initial mute settings
An option combination that automates viewing entry by bypassing the browser's autoplay blocking policy.
https://v.kr.kollus.com/{MEDIA_CONTENT_KEY}?autoplay&mute
Starts playback immediately from the specified point without showing the resume popup.
https://v.kr.kollus.com/{MEDIA_CONTENT_KEY}?s=10
Specifying video quality (profile) and changing title
Select a specific video quality or specify the title to be displayed in the player. If the title value contains Korean characters or spaces, UTF-8 URL encoding must be applied.
https://v.kr.kollus.com/{MEDIA_CONTENT_KEY}?pf={ENCODING_PROFILE_KEY}&title={TITLE}
UI control
Specifying player and enabling debug log
Use this when testing a specific player environment or checking logs in the browser developer tools (Console).
https://v.kr.kollus.com/{MEDIA_CONTENT_KEY}?player_version=v4&debug_mode=true
Locking landscape orientation on mobile fullscreen
When a mobile user presses the fullscreen button, the screen orientation is switched to landscape regardless of the device orientation.
https://v.kr.kollus.com/{MEDIA_CONTENT_KEY}?force_landscape_fullscreen=true
Fixed control bar display and point color change
Always displays the control bar even without user interaction, and applies a point color to match the brand theme.
https://v.kr.kollus.com/{MEDIA_CONTENT_KEY}?controls_activation=always&pointcolor=FF5500
Download
Running download mode and specifying folder path
Specifies the subfolder path where content will be saved. Paths containing special characters or Korean characters must have UTF-8 URL encoding applied.
https://v.kr.kollus.com/{MEDIA_CONTENT_KEY}?download&mobile_folder_download=movie/action