Skip to Content

TwentyThree™ API

API Method: /api/player/options

List available player options.

Permission level

The minimum required permission level is:

write

Example XML Response

<response status="ok" permission_level="write" cached="0">
  ...
<playeroption key="defaultQuality" type="option" name="Default quality" description="Which video quality should the player use by default?" section="">
  <options>
    <option value="low" label="Low quality"/>
    <option value="standard" label="Standard quality"/>
    <option value="high" label="HD quality"/>
    <option value="auto" label="Auto"/>
  </options>
</playeroption>
<playeroption key="showBrowse" type="boolean" name="Show recommendations?" description="Do you want to show recommendations in the video player?" section="Recommendations"/>
<playeroption key="browseMode" type="boolean" name="Show on start" description="Should the player show recommended videos immediately after it loads?" section=""/>
...
</response>

Example JSON Response

{
 "status":"ok",
 "permission_level":"admin",
 "cached":"0",
 "playeroptions":[
  ...
  {
     "key":"defaultQuality",
     "type":"option",
     "name":"Default quality",
     "description":"Which video quality should the player use by default?",
     "section":"",
     "options":[
        {
           "value":"low",
           "label":"Low quality"
        },
        {
           "value":"standard",
           "label":"Standard quality"
        },
        {
           "value":"high",
           "label":"HD quality"
        },
        {
           "value":"auto",
           "label":"Auto"
        }
     ]
  },
  {
     "key":"showBrowse",
     "type":"boolean",
     "name":"Show recommendations?",
     "description":"Do you want to show recommendations in the video player?",
     "section":"Recommendations"
  },
  {
     "key":"browseMode",
     "type":"boolean",
     "name":"Show on start",
     "description":"Should the player show recommended videos immediately after it loads?",
     "section":""
  },
  ...
 ],
 "p":"1",
 "size":"1",
 "site":{...},
 "endpoint":"/api/player/options"
}