VTurb API

Immersive mode expands the player into a fullscreen takeover while the video plays. The patch controls where it applies and how it reacts to play/pause. This is a merge-patch: send only the keys you want to change and everything else keeps its stored value.

Enable it on mobile only

curl -X PATCH https://api.vturb.com/v1/videos/{id} \
  -H "Authorization: Bearer vt_..." \
  -H "Content-Type: application/json" \
  -d '{ "immersive_mode": { "enabled": true, "mobile": true, "desktop": false } }'

{
  "immersive_mode": {
    "enabled": true,
    "mobile": true,
    "desktop": false
  }
}

The keys

Every key is a boolean.

Key	Writes
`enabled`	Master switch for the feature
`desktop`	Run the takeover on desktop
`mobile`	Run the takeover on mobile
`disable_scrolling`	Lock page scroll while immersed
`expand_on_play`	Enter the takeover when playback starts
`minimize_on_pause`	Leave the takeover when the viewer pauses