GET Audio Player Config

Overview

---

The following table contains important information about the GET method in regards to receiving the audio player configuration.

GET Audio Player Config
Method	GET
URL or Endpoint	/audio-player/playerId/audioId.json
Headers	Not Applicable
Parameters	playerId, audioId, startEpisode
Body	Not Applicable

The description of the URL parameters is as follows:

URL Parameter Name	Mandatory	Type	Description
playerId	Yes	string	Unique Id of the audio player.
audioId	Yes	string	Unique Id of the audio.
startEpisode	No	string (query)	The episode to start playback from (used for podcasts).

Request Body

The request does not contain a request body

Response

{
  "projectId": "{projectId}",
  "config": {
    "configId": "{configId}",
    "biskoId": "{biskoId}",
    "recommended": false,
    "autoplay": true,
    "volume": 0.5,
    "loop": false,
    "highlightCurrentAudio": false,
    "focusOnAutostart": false,
    "readQualities": false,
    "chromeCastApplicationId": "{chromeCastApplicationId}",
    "version": 1,
    "thumbnail": true,
    "showPlaylistItemProgress": false,
    "pauseOtherAudios": true,
    "showPlaylist": false,
    "size": {
      "sizeType": "RESPONSIVE",
      "width": 640,
      "height": 360
    },
    "playbackRates": [0.25, 0.5, 0.75, 1, 1.25, 1.5, 1.75, 2],
    "socialMedia": [],
    "autostartOnViewable": {
      "state": false,
      "onMobile": false,
      "onData": false,
      "percentageViewable": 0.5
    },
    "autopauseOnViewable": {
      "state": false,
      "percentageViewable": 0.5
    },
    "float": {
      "state": false,
      "onMobile": false,
      "position": "TOP_RIGHT",
      "dismissible": false,
      "requiresInteraction": false,
      "style": {
        "width": "340",
        "border": null
      }
    },
    "skin": {
      "background": {
        "useThumbnail": false,
        "blur": false,
        "gradient": false,
        "url": null,
        "primary": "011030",
        "secondary": "EA622B"
      },
      "border": {
        "width": 0,
        "color": "FFFFFF"
      },
      "menu": {
        "background": {
          "default": "011030"
        },
        "text": {
          "default": "FFFFFF"
        },
        "toggle": {
          "default": "FFFFFF",
          "on": "206ED5",
          "off": "CACACA"
        }
      },
      "elements": {
        "primary": "FFFFFF",
        "secondary": "FFFFFF",
        "playlist": "011030",
        "itemsProgress": "FFFFFF",
        "playbackButton": "FFFFFF",
        "volumeButton": "FFFFFF",
        "skipButton": "FFFFFF",
        "settingsButton": "FFFFFF",
        "nextPrevButton": "FFFFFF",
        "listButton": "FFFFFF",
        "timeInfo": "FFFFFF",
        "title": "FFFFFF",
        "author": "FFFFFF",
        "description": "FFFFFF",
        "default": "FFFFFF",
        "logo": "",
        "dividers": "FFFFFF",
        "sliderRail": "FFFFFF",
        "sliderProgressBar": "EA622B",
        "dragger": "FFFFFF",
        "item": "FFFFFF"
      }
    },
    "lang": {
      "controls": {
        "play": "Play",
        "pause": "Pause",
        "next": "Next",
        "back": "Back",
        "replay": "Replay",
        "volume": "Volume",
        "mute": "Mute",
        "unmute": "Unmute",
        "settings": "Settings",
        "chromecast": "ChromeCast",
        "airplay": "Airplay",
        "playlist": "Related",
        "share": "Share Audio"
      },
      "settings": {
        "quality": "Quality",
        "autoplay": "Autoplay",
        "playbackSpeed": "Speed",
        "auto": "Auto",
        "off": "Off",
        "normal": "Normal"
      }
    },
    "controls": {
      "volumeButton": true,
      "skipButton": true,
      "settingsButton": true,
      "nextPrevButton": true,
      "listButton": true,
      "playbackSpeedOn": true,
      "timeInfoOn": true,
      "dividersOn": true,
      "showHelperButton": false,
      "showAutoPlay": false,
      "showQualities": false
    },
    "logo": {
      "state": false,
      "file": "",
      "position": "TOP_RIGHT",
      "onClickURL": ""
    },
    "autopauseOnCuepoint": {
      "state": false,
      "timeToPause": 0,
      "continueUnmuted": false,
      "onDesktop": false,
      "onMobile": false
    },
    "jumpBackAfterMidroll": {
      "state": false,
      "seconds": 3
    }
  },
  "audio": {
    "audioId": "{audioId}",
    "file": "{file}",
    "thumbnail": "{thumbnail}",
    "title": "{title}",
    "author": "{author}",
    "chapterState": false,
    "chapterPath": "{chapterPath}",
    "adId": null,
    "advertising": false,
    "ads": null,
    "podcast": {
      "state": false,
      "id": null,
      "title": null,
      "author": null,
      "thumbnail": null,
      "audioIndex": 0
    }
  }
}

Information about the fields that appear when you receive the response are displayed in the table below.

Top-Level Properties

Field Name	Type	Description
projectId	string	Unique identifier of the project.
config	object	Player configuration object.
audio	object	Audio configuration object.

config Properties

Field Name	Type	Description
configId	string	Unique identifier of the player configuration.
biskoId	string	Bisko analytics identifier.
recommended	boolean	Whether recommendations are enabled.
autoplay	boolean	Whether autoplay is enabled.
volume	float	Default volume level (0.0 to 1.0).
loop	boolean	Whether content loops after finishing.
highlightCurrentAudio	boolean	Whether the current audio is highlighted in the playlist.
focusOnAutostart	boolean	Whether the player receives focus on autostart.
readQualities	boolean	Whether quality options are read from the stream.
chromeCastApplicationId	string	ChromeCast application identifier.
version	integer	Player version identifier.
thumbnail	boolean	Whether the thumbnail is displayed.
showPlaylistItemProgress	boolean	Whether progress is shown for playlist items.
pauseOtherAudios	boolean	Whether other audio players pause when this one plays.
showPlaylist	boolean	Whether the playlist panel is visible.
size	object	Player size configuration.
playbackRates	array	Available playback speed options.
socialMedia	array	List of social media sharing options.
autostartOnViewable	object	Autostart on viewable configuration.
autopauseOnViewable	object	Auto-pause on viewable configuration.
float	object	Float on scroll configuration.
skin	object	Player skin and color configuration.
lang	object	Player localization strings.
controls	object	Player controls visibility configuration.
logo	object	Player logo configuration.
autopauseOnCuepoint	object	Auto-pause on cue point configuration.
jumpBackAfterMidroll	object	Jump back after midroll ad configuration.

size Properties

Field Name	Type	Description
sizeType	string	Size mode of the player (e.g., "RESPONSIVE").
width	integer	Width of the player in pixels.
height	integer	Height of the player in pixels.

autostartOnViewable Properties

Field Name	Type	Description
state	boolean	Whether autostart on viewable is enabled.
onMobile	boolean	Whether autostart on viewable is enabled on mobile.
onData	boolean	Whether autostart on viewable is enabled on mobile data.
percentageViewable	float	Percentage of the player that must be visible to trigger autostart (0.0 to 1.0).

autopauseOnViewable Properties

Field Name	Type	Description
state	boolean	Whether auto-pause on viewable is enabled.
percentageViewable	float	Percentage of the player that must be hidden to trigger pause (0.0 to 1.0).

float Properties

Field Name	Type	Description
state	boolean	Whether float on scroll is enabled.
onMobile	boolean	Whether float on scroll is enabled on mobile.
position	string	Float position (e.g., "TOP_RIGHT", "BOTTOM_RIGHT").
dismissible	boolean	Whether the floating player can be dismissed.
requiresInteraction	boolean	Whether user interaction is required before floating.
style	object	Float style configuration (width, border).

controls Properties

Field Name	Type	Description
volumeButton	boolean	Whether the volume button is visible.
skipButton	boolean	Whether the skip forward/backward button is visible.
settingsButton	boolean	Whether the settings button is visible.
nextPrevButton	boolean	Whether the next/previous buttons are visible.
listButton	boolean	Whether the playlist button is visible.
playbackSpeedOn	boolean	Whether playback speed control is enabled.
timeInfoOn	boolean	Whether time information is displayed.
dividersOn	boolean	Whether dividers are displayed between controls.
showHelperButton	boolean	Whether the helper button is visible.
showAutoPlay	boolean	Whether the autoplay toggle is visible.
showQualities	boolean	Whether quality selection is visible.

logo Properties

Field Name	Type	Description
state	boolean	Whether the logo is displayed.
file	string	URL of the logo image.
position	string	Logo position (e.g., "TOP_RIGHT").
onClickURL	string	URL to navigate to when the logo is clicked.

autopauseOnCuepoint Properties

Field Name	Type	Description
state	boolean	Whether auto-pause on cue point is enabled.
timeToPause	integer	Time in seconds to pause at the cue point.
continueUnmuted	boolean	Whether playback continues unmuted after the cue point.
onDesktop	boolean	Whether cue point pausing is enabled on desktop.
onMobile	boolean	Whether cue point pausing is enabled on mobile.

jumpBackAfterMidroll Properties

Field Name	Type	Description
state	boolean	Whether jump back after midroll is enabled.
seconds	integer	Number of seconds to jump back after a midroll ad.

audio Properties

Field Name	Type	Description
audioId	string	Unique identifier of the audio.
file	string	URL of the audio file.
thumbnail	string	URL of the audio thumbnail image.
title	string	Title of the audio.
author	string	Author of the audio.
chapterState	boolean	Whether chapters are enabled for the audio.
chapterPath	string	URL of the chapter definitions file.
adId	string	Identifier of the ad schedule associated with the audio.
advertising	boolean	Whether advertising is enabled for the audio.
ads	object	Ad configuration object (null when no ad schedule is assigned).
podcast	object	Podcast configuration if the audio belongs to a podcast.

podcast Properties

Field Name	Type	Description
state	boolean	Whether podcast mode is enabled.
id	string	Unique identifier of the podcast.
title	string	Title of the podcast.
author	string	Author of the podcast.
thumbnail	string	URL of the podcast thumbnail image.
audioIndex	integer	Index of the current audio within the podcast.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

• HTTP Status Code 400: Bad Request

• HTTP Status Code 401: Unauthorized

• HTTP Status Code 403: Forbidden

• HTTP Status Code 404: Result Not Found

• HTTP Status Code 500: Internal Server Error

• HTTP Status Code 503: Backend Fetch Failed