Get default player options

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
Accept: application/json

RESPONSE
200 (OK)
{
  "mute_onload": false,
  "playlist_style": "default",
  "context_menu": true,
  "pause_disabled": false,
  "default_hd": true,
  "height": 360,
  "width": 640,
  "splash_screen_fade": true,
  "color": "7DC577",
  "play_button": true,
  "hd_button": true,
  "embed_button": true,
  "playlist_color": "222222",
  "autoplay": false,
  "chatter_only": null,
  "ignore_organization_ip_whitelist": null,
  "name_overlay": null,
  "yt_live_stream": null,
  "custom_css": null,
  "caption_color": "ffffff",
  "caption_display": "optional",
  "play_button_color": "2e2e2e",
  "ad_second": null,
  "ad_url": null,
  "hidden_controls": false,
  "render_scrubber_thumbnail": true,
  "authorized_by": "",
  "audio_player_visuals": "visualization",
  "background_style": "black",
  "up_next": true,
  "disable_default_events": false,
  "end_chapter_pause": false,
  "disable_playlist": false,
  "disable_legacy": false,
  "disable_live_dvr": false,
  "playlist_always_open": false
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String