Player Call Options (Query String)

Notice

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.

Query string format

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

For detailed descriptions of Kollus Players, refer to the Kollus Player Types document.

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

All options

Playback

Parameter	Type	Description	Target Player
`autoplay (a)`	`null`	Auto-play setting (enabled by default in mobile environments)	All
`mute`	`null`	Start playback in muted state	All
`t`	`integer`	Play from the specified point (sec) and show resume popup	All
`s`	`integer`	Play from the specified point (sec) without resume popup	All
`title`	`string`	Force-specify content title	All
`pf`	`string`	Force-specify encoding profile (video quality)	All

Note

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/platform autoplay policy: Modern browsers block autoplay of videos with sound by default. For details, refer to 'Autoplay policy by browser/platform' below.

Autoplay policy by browser/platform

Browser and platform	Video without sound	Video with sound	Notes
Chrome	Autoplay allowed	Blocked by default	Autoplay is allowed as an exception only if the user's Media Engagement Index (MEI) is high or the user has a prior click history
Edge	Autoplay allowed	Blocked by default	Autoplay is allowed if the user changes the autoplay setting to "Allow" in browser settings Autoplay is allowed if an administrator deploys the group policy (AutoplayAllowed) as "Allow" in an enterprise environment
Safari (macOS)	Autoplay allowed	Blocked by default	Users can individually change whether autoplay is allowed on a per-website basis in Safari settings
iOS (iPhone/iPad)	Autoplay allowed (`playsinline` required)	Blocked by default	Playback via script is allowed only after the user directly touches (gestures on) the screen
Firefox	Autoplay allowed	Blocked by default	Users can change the autoplay blocking and allow level in browser settings

References

Recommended implementation guideline

For videos with sound, we recommend starting autoplay in a muted state. Then provide a mute-off button so users can enable audio themselves.

Download

Parameter	Type	Description	Target Player
`download`	`null`	Enable content download feature	Mobile, v3e, v3h
`mobile_folder_download`	`string`	Specify mobile download folder path	Mobile
`pc_folder_download`	`string`	Specify PC download folder path	v3e, v3h
`filename`	`string`	Specify the file name to be saved when using R-link or SR-link	All

Note

Prerequisite: The DRM download callback must be configured for the download parameter to work properly. (Guide: DRM download callback)
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 Support(tech_support@kollus.com) or Account Manager.

Player

Parameter	Type	Description	Target Player
`player_version (pv)`	`string`	Specify player `v3h`: HTML5 Player for PC `v3e`: App Player for Windows `v4`: HTML5 Player for All `v5`: Web Player `Unspecified`: Automatically applied based on playback environment	PC
`force_exclusive_player`	`null`	Apply Kollus secure player for PC even when playing standard content(unencrypted)	v3e, v3h
`force_independent_player`	`boolean`	Force apply Kollus secure player	v3

Control bar

Parameter	Type	Description	Target Player
`controls_activation`	`string`	Control bar activation policy `auto`: Automatically show/hide according to `inactive_time` setting `always`: Always visible `none`: Always hidden	v3, v4, v5
`show_controls_paused`	`boolean`	Whether to keep control bar visible when paused (default: `false`)	v4
`set_controlbar_progress_only`	`boolean`	Show only the progress bar	v4, v5
`transparent_controlbar_layer`	`boolean`	Make control bar background transparent	v4, v5
`hide_header_display`	`boolean`	Hide header area	v4, v5

Overlay / poster

Parameter	Type	Description	Target Player
`overlay_button_position`	`string`	Overlay button position `TR`: Top Right `TL`: Top Left `BR`: Bottom Right `BL`: Bottom Left `Unspecified`: Center aligned	v4
`show_poster_ended`	`boolean`	Whether to show poster after playback ends (default: `false`)	v4
`enable_poster`	`boolean`	Whether to enable poster	v4, v5
`enable_spinner_activation`	`boolean`	Whether to enable loading icon	v4, v5

Thumbnail / time display

Parameter	Type	Description	Target Player
`enable_thumbnail`	`boolean`	Enable thumbnail preview when seeking on progress bar	v4, v5
`enable_mouse_time_display`	`boolean`	Show time display on mouse over	v5

Seek / autoplay

Parameter	Type	Description	Target Player
`autoplay_after_seek`	`string`	Playback policy after seeking `auto`: Auto-play when seeking during playback, maintain pause when seeking while paused `play`: Play immediately after seeking `pause`: Pause after seeking	v4, v5
`disable_autoplay`	`boolean`	Disable autoplay even when autoplay is available	v4, v5
`play_at`	`number`	Set resume playback point	v3

Buffering / streaming

Parameter	Type	Description	Target Player
`buffer`	`integer`	Set buffering multiplier (2–10x)	v3e, v3h
`frag_load_paused`	`boolean`	Whether to load HLS Fragment when paused	v4, v5
`force_custom_header`	`boolean`	Force add HLS concurrent access check header (`X-Kollus-SessionId`)	v4, v5
`force_use_credentials`	`boolean`	Force apply `withCredentials` for HLS XHR requests	v4, v5

Screen control

Parameter	Type	Description	Target Player
`force_landscape_fullscreen`	`boolean`	Lock screen orientation to landscape during mobile fullscreen playback	v4, v5
`force_rotate_fullscreen`	`boolean`	Force fullscreen mode when mobile device rotates to landscape	v4, v5
`enable_pip`	`boolean`	Allow PIP(Picture-in-Picture) mode	v3, v4, v5
`pointcolor`	`number`	Change UI point color (HEX, excluding #)	v4, v5
`is_vr`	`boolean`	VR player playback	v4, v5
`is_dvr`	`boolean`	Enable DVR timeshift	v4, v5

Input / accessibility

Parameter	Type	Description	Target Player
`enable_hotkey`	`boolean`	Enable shortcuts	v4, v5
`enable_volume_scroll`	`boolean`	Enable mouse wheel volume control	v4, v5
`enable_context_menu`	`boolean`	Allow mouse right-click context menu	v3, v4, v5
`enable_accessibility`	`boolean`	Enable web accessibility features	v3, v4, v5
`enable_initialize_focus`	`boolean`	Apply focus when player loads (default: `true`)	v3, v4

Ios-exclusive options

Parameter	Type	Description
`ios_player_type`	`string`	iOS decoder type (required for App Player for iOS version 2.2.14 or later) `native`: Native decoder `hw`: Hardware decoder `sw`: Software decoder
`mobile_return_url`	`string`	URL to navigate to when going back/closing (launches Safari browser)

Development / debugging

Parameter	Type	Description	Target Player
`debug_mode`	`boolean`	Output debug log to browser console	v3, v4, v5
`debug_mode2`	`boolean`	Output detailed event log and data status	v4, v5
`agent_mode`	`boolean`	Whether to run Kollus Agent inspection	v3
`agent_url`	`string`	Set Kollus Agent URL (works when `debug_mode=true` is set)	v3
`loadcheck`	`integer`	`0`: Use message in playback callback	v3
`media_key_src`	`string`	Directly specify media key	v3
`media_url`	`string`	Directly specify Playback URL	v3

Other

Parameter	Type	Description	Target Player
`uservalue{0~99}`	`mixed`	Custom variables (`uservalue0`–`uservalue99`) Transmitted together when sending client information via playback, DRM, LMS callbacks, etc.	All

Usage examples

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

Immediate playback from the 10-second mark

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

Query string format​

Kollus Player types​

All options​

Playback​

Autoplay policy by browser/platform​

References​

Download​

Player​

Control bar​

Overlay / poster​

Thumbnail / time display​

Seek / autoplay​

Buffering / streaming​

Screen control​

Input / accessibility​

Ios-exclusive options​

Development / debugging​

Other​

Usage examples​

Optimizing viewing experience (playback control)​

Auto-play and initial mute settings​

Immediate playback from the 10-second mark​

Specifying video quality (profile) and changing title​

UI control​

Specifying player and enabling debug log​

Locking landscape orientation on mobile fullscreen​

Fixed control bar display and point color change​

Download​

Running download mode and specifying folder path​

Query string format

Kollus Player types

All options

Playback

Autoplay policy by browser/platform

References

Download

Player

Control bar

Overlay / poster

Thumbnail / time display

Seek / autoplay

Buffering / streaming

Screen control

Input / accessibility

Ios-exclusive options

Development / debugging

Other

Usage examples

Optimizing viewing experience (playback control)

Auto-play and initial mute settings

Immediate playback from the 10-second mark

Specifying video quality (profile) and changing title

UI control

Specifying player and enabling debug log

Locking landscape orientation on mobile fullscreen

Fixed control bar display and point color change

Download

Running download mode and specifying folder path