Skip to main content

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

NotationPlayer NameCharacteristics
v3eApp Player for WindowsInstallable Agent-based player
v3hHTML5 Player for PCInstallable HTML5 Agent-based player
v3HTML5 Player for PC (Hybrid)Hybrid HTML5 player applied when playing encrypted content on Microsoft Edge or Chrome 45 or later
v4HTML5 Player for AllNon-installable HTML5 player for standard content(unencrypted) only
v5Web PlayerNext-generation integrated web player combining the advantages of installable and non-installable players
iOSApp Player for iOSiOS-exclusive app player
AndroidApp Player for AndroidAndroid-exclusive app player
Player Guide

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

All options

Playback

ParameterTypeTarget PlayerDescription
autoplay (a)nullAllAuto-play setting (enabled by default in mobile environments)
mutenullAllStart playback in muted state
tintegerAllPlay from the specified point (sec) and show resume popup
sintegerAllPlay from the specified point (sec) without resume popup
titlestringAllForce-specify content title
pfstringAllForce-specify encoding profile (video quality)
Caution
  • 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

ParameterTypeTarget PlayerDescription
downloadnullMobile, v3e, v3hEnable download mode
mobile_folder_downloadstringMobileSpecify mobile download folder path
pc_folder_downloadstringv3e, v3hSpecify PC download folder path
filenamestringAllSpecify the file name to be saved when using R-link or SR-link
Note
  • 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

ParameterTypeTarget PlayerDescription
player_version (pv)stringPCSpecify 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
force_exclusive_playernullv3e, v3hApply Kollus secure player for PC even when playing standard content(unencrypted)
force_independent_playerbooleanv3Force apply Kollus secure player

Control bar

ParameterTypeTarget PlayerDescription
controls_activationstringv3, v4, v5Control bar activation policy
  • auto: Automatically show/hide according to inactive_time setting
  • always: Always visible
  • none: Always hidden
show_controls_pausedbooleanv4Whether to keep control bar visible when paused (default: false)
set_controlbar_progress_onlybooleanv4, v5Show only the progress bar
transparent_controlbar_layerbooleanv4, v5Make control bar background transparent
hide_header_displaybooleanv4, v5Hide header area

Overlay / poster

ParameterTypeTarget PlayerDescription
overlay_button_positionstringv4Overlay button position
  • TR: Top Right
  • TL: Top Left
  • BR: Bottom Right
  • BL: Bottom Left
  • Unspecified: Center aligned
show_poster_endedbooleanv4Whether to show poster after playback ends (default: false)
enable_posterbooleanv4, v5Whether to enable poster
enable_spinner_activationbooleanv4, v5Whether to enable loading icon

Thumbnail / time display

ParameterTypeTarget PlayerDescription
enable_thumbnailbooleanv4, v5Enable thumbnail preview when seeking on progress bar
enable_mouse_time_displaybooleanv5Show time display on mouse over

Seek / autoplay

ParameterTypeTarget PlayerDescription
autoplay_after_seekstringv4, v5Playback 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
disable_autoplaybooleanv4, v5Disable autoplay even when autoplay is available
play_atnumberv3Set resume playback point

Buffering / streaming

ParameterTypeTarget PlayerDescription
bufferintegerv3e, v3hSet buffering multiplier (2–10x)
frag_load_pausedbooleanv4, v5Whether to load HLS Fragment when paused
force_custom_headerbooleanv4, v5Force add HLS concurrent access check header (X-Kollus-SessionId)
force_use_credentialsbooleanv4, v5Force apply withCredentials for HLS XHR requests

Screen control

ParameterTypeTarget PlayerDescription
force_landscape_fullscreenbooleanv4, v5Lock screen orientation to landscape during mobile fullscreen playback
force_rotate_fullscreenbooleanv4, v5Force fullscreen mode when mobile device rotates to landscape
enable_pipbooleanv3, v4, v5Allow PIP(Picture-in-Picture) mode
pointcolornumberv4, v5Change UI point color (HEX, excluding #)
is_vrbooleanv4, v5VR player playback
is_dvrbooleanv4, v5Enable DVR timeshift

Input / accessibility

ParameterTypeTarget PlayerDescription
enable_hotkeybooleanv4, v5Enable shortcuts
enable_volume_scrollbooleanv4, v5Enable mouse wheel volume control
enable_context_menubooleanv3, v4, v5Allow mouse right-click context menu
enable_accessibilitybooleanv3, v4, v5Enable web accessibility features
enable_initialize_focusbooleanv3, v4Apply focus when player loads (default: true)

Ios-exclusive options

ParameterTypeTarget PlayerDescription
ios_player_typestringiOSiOS 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_urlstringiOSURL to navigate to when going back/closing (launches Safari browser)

Development / debugging

ParameterTypeTarget PlayerDescription
debug_modebooleanv3, v4, v5Output debug log to browser console
debug_mode2booleanv4, v5Output detailed event log and data status
agent_modebooleanv3Whether to run Kollus Agent inspection
agent_urlstringv3Set Kollus Agent URL (works when debug_mode=true is set)
loadcheckintegerv30: Use message in playback callback
media_key_srcstringv3Directly specify media key
media_urlstringv3Directly specify Playback URL

Other

ParameterTypeTarget PlayerDescription
uservalue{0~99}mixedAllCustom variables (uservalue0uservalue99)
  • Transmitted together when sending client information via playback, DRM, LMS callbacks, etc.

Usage examples

See Also

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

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