Visual Experience Platform
Help CenterRelease NotesBlogWebsite
  • VXP - Visual Experience Platform
    • The VXP
      • Token
    • Settings
      • My Account
        • Profile
        • Support
      • Organisation
        • General Organisation Settings
        • Billing
          • Payment
          • Invoices
          • Plan
        • Users
          • Users
          • Roles
        • Teams
      • Project
        • Branding
        • Subscription
        • Analytics
          • Standard Dashboards
            • Multi tenants
            • User Dashboard
            • DAM Storage
            • Workflows Monitoring
            • Traffic Origin
            • Caching (Volumetry)
            • CDN performance
          • Custom Dashboard
        • Access
          • API keys
          • Security templates
          • OAuth2
  • Digital Asset Management (DAM)
    • Library
      • Assets
        • Asset Details window
          • Asset actions
            • Regional settings
            • Context menu ("..." button)
            • Add to My favorites (heart icon)
            • Edit media (image, video, etc)
              • Edit image
              • Edit video (coming soon)
              • Edit design template (coming soon)
            • Share
          • Asset information tabs
            • General
            • Metadata
            • Variations
            • Comments
            • Approvals
            • History
      • Folders
      • Collections
      • Labels
      • Products
      • My favorites
      • Help
      • Sharebox
      • Airbox
      • Search and Filters
        • Faceted Search
    • Plugins & Connectors
      • Plugins
        • Adobe Creative Cloud
        • Adobe Commerce (Magento)
        • Canva
        • Contentful
        • Contentstack
        • Directus
        • Drupal
        • Opencart
          • Opencart (v4)
        • Prestashop
        • Shopware
        • Storyblok
        • Strapi (v4)
        • Sylius
        • Uniform CMS
        • Wordpress
      • Connectors
        • Akeneo PIM App
        • Canva App
        • CI-Hub
        • Commercetools FaaS App
        • Hygraph app
        • Kontent.ai
        • OneTeg
        • Pabbly Connect
        • Prismic
        • Shopify / Shopify plus app
        • Zapier automation
    • Settings
      • Library
        • Featured components
        • Interface customization
      • Metadata
        • Metadata Configuration
        • Assets
      • Tags
        • Configuration
        • Dictionary
      • Notifications
      • Automations
        • Post processing
        • Webhooks
        • Workflows
      • Storage
        • Providers
        • Upload
        • Video
        • Listing
        • Download
        • Custom routing
  • Visual AI
    • Welcome
    • Visual AI
      • Images
        • Classification models
          • Auto-tagging
          • Brand detect
          • Dominant color extraction
          • Faces
            • Face analysis
            • Face clustering
          • Image quality
          • OCR
          • Number Plate recognition
          • Product type
          • Property classification
          • Scene Classification
          • Sport Classification
        • Generative AI models
          • Image-to-text
          • Plate blurring
          • Quality improvement (remove artifacts)
          • Remove background
          • Text-to-Image
        • Moderation models
          • Face count
          • NSFW - Not Safe For Work
          • Real estate authenticity
          • Watermark detection
      • Videos
        • Face detection
      • Search & find assets
        • Text Search
        • Similar Assets
  • Portals
    • Welcome
    • Creating a Portal
    • Editing a Portal
      • Pages
      • Sections
      • Design
      • Fonts
    • Managing a Portal
      • Settings
      • Access
      • Users
      • Labeling, Cloning, Archiving
    • Publishing a Portal
  • Dynamic Media Optimization (DMO)
    • Welcome
      • Responsive libraries
      • Native plugins
      • 360° view builder
      • Service status
    • Insights
      • Delivery
      • Optimization
      • Alerts
      • Logs
    • Transformations
      • Image optimization
        • Operations
          • Width and height
          • Prevent enlargement
          • Crop
            • Automatic Gravity Crop
            • Positionable Crop
            • Focal point Crop
            • Face Crop
            • Face hide
            • Aspect ratio crop
          • Fit
          • Cropfit
          • Bound
          • Boundmin
          • Cover
          • Device pixel ratio
          • Flip
          • Rotate
          • Trim
          • Rounded corners
        • Filters
          • Adjustment
            • Brightness
            • Contrast
            • Saturate
          • Color manipulation
            • Color overlay
            • Grayscale
            • Duotone
          • Blur
          • Pixelate
          • Sharpen
        • Watermarking
          • Static watermark
          • Dynamic watermark
          • Text watermark
        • Image compression
          • Image formats
          • Optipress
      • Video optimization
        • Video API
          • Editing
            • Chapters
            • Combine
            • Trim
          • Optimizing
            • Convert
            • Compress
            • Transcode
        • On-the-fly-video optimization
      • Static content optimization
        • PDF to image
        • JS/CSS optimization
    • Invalidation
    • Settings
      • Asset Origin
        • AWS S3 or any other S3-compatible storage provider
        • Google Cloud storage (GCP)
        • Azure Blob storage
        • Own HTTP-based Storage
      • Images
        • Compression
        • Optimization
        • Watermark
      • Static content
      • Delivery
        • CNAME
        • URL format
        • Rules
        • Security
        • Caching
        • Default behaviors
  • Developers / Headless
    • Headless DAM
      • DAM APIs
        • API Authentication
        • API Reference
      • Command Line Interface (CLI)
      • Media Asset Widget(MAW)
        • Overview
        • Developer reference
        • V2 End-of-life
Powered by GitBook
LogoLogo

Quick links

  • Go to website
  • Legal Center

©2024 Scaleflex SAS

On this page
  • Overview
  • Typical use cases
  • API endpoints
  • Examples
  • Input video
  • Request body
  • API response
  • VTT file
  • Video with chapters demo
Export as PDF
  1. Dynamic Media Optimization (DMO)
  2. Transformations
  3. Video optimization
  4. Video API
  5. Editing

Chapters

Enhance your videos with customizable chapters for improved navigation and accessibility

PreviousEditingNextCombine

Last updated 7 months ago

Overview

Chapter generation offers a simple solution for generating .vtt (WebVTT) files with desired chapter times. WebVTT (Web Video Text Tracks) is a subtitle and caption file format widely used for displaying timed text in HTML5 videos. It provides a standardized format for creating text-based content such as captions, subtitles and descriptive metadata, allowing synchronized display with audiovisual media.

In addition to generating a .vtt file, you have the option to embed chapter information directly into the video metadata. This process involves modifying the metadata tags of the video file to include the chapter markers. Embedding the chapter information ensures that the chapters remain intact even when the video is distributed or played on different platforms.

With this service, you can enhance the accessibility and user experience of your videos by providing interactive chapter navigation.

Typical use cases

This service can be valuable for a plethora of use cases, mainly:

  • Improving the user experience - Adding chapter markers to your videos allows viewers to navigate through the content more efficiently. Users can quickly jump to specific sections, facilitating easier content consumption and ensuring a more engaging viewing experience, especially for longer video content.

  • Enhancing accessibility - Incorporating chapter markers enables better accessibility for individuals with disabilities, such as visual impairments or cognitive challenges. Screen readers and assistive technologies can utilize the chapter information to help users navigate the video and access specific sections.

  • Content organization - Chapters provide a convenient way to organize and structure video content. By generating .vtt files with desired chapter times, lengthy videos can be broken down into logical sections, making it easier for viewers to find and consume the content that is most relevant to them.

  • Chapter customization - The chapter times can be defined according to specific user requirements. Customers have control over the timing and granularity of chapters, ensuring they align with the natural breakpoints or key moments within their videos.

  • Content discovery - Adding chapters to recorded webinars or presentations enables participants to revisit specific segments and key points. This improves the usability of recorded events and enhances content discoverability.

API endpoints

Information about the specific API endpoints is available in an always up-to-date documentation, that can be accessed via the following link:

There, you can find detailed information about the API endpoints, together with all required request parameters, so you know how to interact with them.

Examples

Input video

Request body

[
    {
        "url": "https://fbmjmuoeb.filerobot.com/https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/combined_videos/QFtsC/16343098_2231485_combined.mp4",
        "chapters": [
            {
                "title": "car",
                "start_time": "00:00:00"
            },
            {
                "title": "beach",
                "start_time": "00:00:08"
            }
        ]
    }
]

API response

{
    "status": "ok",
    "version": 2.11,
    "result": [
        {
            "uuid": "58c45b71-775e-401d-b6e2-7322a069ba62",
            "url": "https://fbmjmuoeb.filerobot.com/https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/combined_videos/QFtsC/16343098_2231485_combined.mp4",
            "chapters": "https://fbmjmuoeb.filerobot.com/https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/chapters_videos/mUndc_16343098_2231485_combined/16343098_2231485_combined_chapters.mp4",
            "vtt": "https://fbmjmuoeb.filerobot.com/https://filerobot.s3.eu-west-3.amazonaws.com/fbmjmuoeb/chapters_videos/mUndc_16343098_2231485_combined/16343098_2231485_combined_vtt.vtt",
            "sha1": "6f83b865731dbe193cbc4f885a0cffb87b92153b",
            "progress": "https://api.filerobot.com/fbmjmuoeb/v4/video-status/ZXUtb3YtNzA2LWdyYTIuZWxhc3RpYy11cGxvYWRlci5haXJzdG9yZS5zY2FsM2ZsM3guY29tOjg3MzI__58c45b71-775e-401d-b6e2-7322a069ba62"
        }
    ]
}

VTT file

WEBVTT

1
00:00:00.000 --> 00:00:07.999
car

2
00:00:08.000 --> 00:00:16.000
beach

Video with chapters demo

LogoScaleflex API for Digital Asset Management (DAM), Visual AI and Media OptimizationScaleflex API