Skip to main content

URL Scheme Integration

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.

From a mobile web browser, you can call a custom URL Scheme (kollus://) targeting devices with the Kollus mobile app installed to directly launch the player or perform specific actions.

This document describes the call options and specifications commonly supported on Android and iOS.

Prerequisites​

  • Delimiter rules: Append ? after the scheme, and connect each parameter with &.
  • Playback URL composition: The url parameter value to be passed on call must be a URL generated according to the Player Call specifications.
    • See Also: Refer to the Player Call document to compose the playback URL.
  • Required encoding: All parameter values included in the URL Scheme must be URI-encoded (Percent-encoding).

Call specifications​

Playback​

Plays content immediately in the Kollus mobile app. The macOS-exclusive Kollus Player can also be called using the same URL Scheme specifications as the mobile app.

Scheme​

kollus://path

Parameters​

ParameterTypeDescription
urlstringPlayback URL

Call example​

kollus://path?url=https%3A%2F%2Fv.kr.kollus.com%2Fsi%3Fjwt%3D{JWT}%26custom_key%3D{CUSTOM_KEY}%26title%3D{CUSTOM_TITLE}

Download​

Downloads content files to the Kollus mobile app's local storage.

Feature activation

To use the download feature, you must enable the download feature in the settings of the channel where the content is registered.

Scheme​

kollus://download

Parameters​

ParameterTypeDescription
urlstringPlayback URL of the content to download
folderstring(Optional) Folder path where the content will be saved. This folder path is not an actual physical path but a virtual structure within the player app, and can be set like media/movie/video.

Multiple download call example​

kollus://download?url={ENCODED_URL_1}&url={ENCODED_URL_2}&url={ENCODED_URL_3}

Play downloaded content​

Plays content downloaded to the device in the Kollus mobile app. If the content file has been deleted from the device or does not exist, the URL Scheme call is automatically ignored and the player performs no action.

Scheme​

kollus://download_play

Parameters​

ParameterTypeDescription
urlstringPlayback URL of the downloaded content

Display download completion list​

Launches the Kollus mobile app and immediately shows the list of downloaded content. If you want to display only the content list for a specific folder, specify the folder parameter.

Scheme​

kollus://list

Parameters​

ParameterTypeDescription
folderstringDisplays only the content list stored in the specified folder (if not specified, displays the list in the top-level folder)