GET Audio Player Config with Ad Schedule

Overview

---

The following table contains important information about the GET method in regards to receiving the audio player configuration with a specific ad schedule.

GET Audio Player Config with Ad Schedule
Method	GET
URL or Endpoint	/audio-player/playerId/audioId/adScheduleId.json
Headers	Not Applicable
Parameters	playerId, audioId, adScheduleId, 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.
adScheduleId	Yes	string	Unique Id of the ad schedule to use for advertising.
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": "{adScheduleId}",
    "advertising": true,
    "ads": {
      "type": "{type}",
      "isVmap": false,
      "enableProgrammability": false,
      "vmap": "{vmap}",
      "skipAllAds": false,
      "VPAIDmode": "{VPAIDmode}",
      "adBreaks": [
        {
          "adTagUrl": ["{adTagUrl}"],
          "breakType": "{breakType}",
          "breakTimingType": "{breakTimingType}",
          "breakTimingValue": 0,
          "schedule": {
            "liveCount": 0,
            "type": "{scheduleType}",
            "protectFirst": 0,
            "protectLast": 0,
            "occurEvery": 0,
            "algorithm": "{algorithm}",
            "ranges": [
              {
                "startTime": 0,
                "endTime": 0,
                "count": 0,
                "breaks": []
              }
            ]
          }
        }
      ],
      "bidding": false,
      "bidders": [],
      "functions": [],
      "enableDemandManager": false,
      "demandManager": null,
      "frequency": {
        "timingType": "{timingType}",
        "value": 0
      },
      "maxCap": 0,
      "initialDelay": {
        "timingType": "{timingType}",
        "value": 0
      },
      "adCycleDelayMs": 0,
      "adRetryLimit": 0,
      "adCycleRestartMs": 0,
      "banner": null,
      "overrides": null
    },
    "podcast": {
      "state": false,
      "id": "{podcastId}",
      "title": "{podcastTitle}",
      "author": "{podcastAuthor}",
      "thumbnail": "{podcastThumbnail}",
      "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.

tip

For config sub-object property descriptions (config, size, autostartOnViewable, autopauseOnViewable, float, controls, logo, autopauseOnCuepoint, jumpBackAfterMidroll), see GET Audio Player Config.

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.
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.

ads Properties

Field Name	Type	Description
type	string	Type of ad configuration (e.g., "DYNAMIC", "STATIC").
isVmap	boolean	Whether the ad schedule uses VMAP format.
enableProgrammability	boolean	Whether ad programmability is enabled.
vmap	string	URL of the VMAP ad schedule.
skipAllAds	boolean	Whether all ads can be skipped.
VPAIDmode	string	VPAID rendering mode.
adBreaks	array	List of ad break configurations.
bidding	boolean	Whether header bidding is enabled.
bidders	array	List of header bidding bidder configurations.
functions	array	List of ad macro function configurations.
enableDemandManager	boolean	Whether the demand manager (prebid) is enabled.
demandManager	object	Demand manager (prebid) configuration.
frequency	object	Ad frequency capping configuration.
maxCap	integer	Maximum number of ad impressions per frequency period.
initialDelay	object	Initial delay configuration before the first ad plays.
adCycleDelayMs	integer	Delay in milliseconds between ad cycles.
adRetryLimit	integer	Maximum number of ad request retries on failure.
adCycleRestartMs	integer	Time in milliseconds before an ad cycle restarts.
banner	object	Banner ad configuration.
overrides	object	Ad override configuration.

adBreaks Properties

Field Name	Type	Description
adTagUrl	array[string]	List of ad tag URLs for the break.
breakType	string	Type of ad break (e.g., "preroll", "midroll", "postroll").
breakTimingType	string	Timing type for the break (e.g., "time", "percentage").
breakTimingValue	integer	Timing value for the ad break.
schedule	object	Ad break schedule configuration.

frequency Properties

Field Name	Type	Description
timingType	string	Timing type for ad frequency.
value	integer	Frequency value.

initialDelay Properties

Field Name	Type	Description
timingType	string	Timing type for the initial delay.
value	integer	Initial delay value.

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