Skip to main content

Live Playback Callback

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, please refer to the Korean documentation.

Playback Callback(Play Callback) is called in real time when a user requests live playback from the player. Live viewing is only available when a normal response is received from the callback server.


How to configure the callback

The callback URL can be configured independently for each channel.

Caution

The playback callback only works when using the Kollus secure player, not the standard HTML5-based player. Even if a URL is configured on a channel where the Kollus secure player is not applied, the callback will not be triggered.

  1. Go to Kollus Live console > [Channel] > [Channel list].
  2. Depending on your situation, choose one of the following:
    • When creating a new channel: Click [Register channel] in the upper right corner.
    • When configuring an existing channel: Click [Edit] on the right side of the target channel.
  3. In the [Callback] tab at the bottom, enter the playback callback URL and click [Save].

Request

Transmission method

  • Method: POST
  • Content-Type: application/x-www-form-urlencoded
  • Data Format: FormData

Request parameters

ParameterTypeDescription
kindinteger100 (fixed value for live playback callback)
client_user_idstringUser ID (the client_user_id entered when generating the JWT)
player_idstringKollus player unique ID
hardware_idstringHardware ID (provided when an identifiable value exists, such as in a Windows environment)
device_namestringDevice model name
media_content_keystringLive broadcast key
channel_keystringChannel key
uservaluesJSON stringCustom variables (uservalue0~uservalue99)
localtimeintegerUTC time based on the device

uservalues example

{
"uservalue0": "class_code_01",
"uservalue1": "product_code_02",
"uservalue99": "custom_code_03"
}

Response fields

data items

FieldTypeDescription
resultinteger
  • 0: Abnormal (playback blocked)
  • 1: Normal (playback allowed)
messagestringMessage to display in the player when result is 0
vmcheckinteger(HTML5 Player for PC only) Whether to allow playback in a virtual machine(VM) environment
  • 0: Allow
  • 1: Detect and block virtual machine environment (default)
disable_tvoutintegerTV output restriction setting (takes priority over the channel's default policy)
  • 0: Allow TV output
  • 1: Block TV output

Response example

{
"data": {
"result": 1,
"vmcheck": 0,
"disable_tvout": 1
}
}