# video URL: /api/rendering/plugins/directives/video/ Section: directives -------------------------------------------------------------------------------- video - Bengal window.BENGAL_THEME_DEFAULTS = { appearance: 'dark', palette: 'snow-lynx' }; // Progressive Enhancement System Configuration window.Bengal = window.Bengal || {}; window.Bengal.enhanceBaseUrl = '/bengal/assets/js/enhancements'; window.Bengal.watchDom = true; window.Bengal.debug = false; (function () { try { var defaults = window.BENGAL_THEME_DEFAULTS || { appearance: 'system', palette: '' }; var defaultAppearance = defaults.appearance; if (defaultAppearance === 'system') { defaultAppearance = (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) ? 'dark' : 'light'; } var storedTheme = localStorage.getItem('bengal-theme'); var storedPalette = localStorage.getItem('bengal-palette'); var theme = storedTheme ? (storedTheme === 'system' ? defaultAppearance : storedTheme) : defaultAppearance; var palette = storedPalette ?? defaults.palette; document.documentElement.setAttribute('data-theme', theme); if (palette) { document.documentElement.setAttribute('data-palette', palette); } } catch (e) { document.documentElement.setAttribute('data-theme', 'light'); } })(); Skip to main content Magnifying Glass ESC Recent Clear Magnifying Glass No results for "" Try different keywords or check your spelling Start typing to search... ↑↓ Navigate ↵ Open ESC Close Powered by Lunr ᓚᘏᗢ Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Magnifying Glass Search ⌘K Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal List ᓚᘏᗢ Magnifying Glass Search X Close Documentation Info About Arrow Clockwise Get Started Note Tutorials File Text Content Palette Theming Settings Building Starburst Extending Bookmark Reference Learning Tracks Releases Dev GitHub API Reference bengal CLI Palette Appearance Chevron Down Mode Monitor System Sun Light Moon Dark Palette Snow Lynx Brown Bengal Silver Bengal Charcoal Bengal Blue Bengal API Reference __main__ bengal Caret Right Folder Analysis community_detection graph_analysis graph_reporting graph_visualizer knowledge_graph link_suggestions link_types page_rank path_analysis performance_advisor results Caret Right Folder Assets manifest pipeline Caret Right Folder Autodoc base config docstring_parser utils virtual_orchestrator Caret Right Folder Extractors cli openapi python Caret Right Folder Models cli common openapi python Caret Right Folder Cache asset_dependency_map cache_store cacheable compression dependency_tracker page_discovery_cache query_index query_index_registry taxonomy_index utils Caret Right Folder Build Cache autodoc_tracking core file_tracking fingerprint parsed_content_cache rendered_output_cache taxonomy_index_mixin validation_cache Caret Right Folder Indexes author_index category_index date_range_index section_index Caret Right Folder Cli __main__ base site_templates utils Caret Right Folder Commands assets build clean collections config debug explain fix health init perf project serve site skeleton sources theme utils validate Caret Right Folder Graph __main__ bridges communities orphans pagerank report suggest Caret Right Folder New config presets scaffolds site wizard Caret Right Folder Helpers cli_app_loader cli_output config_validation error_handling menu_config metadata progress site_loader traceback validation Caret Right Folder Skeleton hydrator schema Caret Right Folder Templates base registry Caret Right Folder Blog template Caret Right Folder Changelog template Caret Right Folder Default template Caret Right Folder Docs template Caret Right Folder Landing template Caret Right Folder Portfolio template Caret Right Folder Resume template Caret Right Folder Collections errors loader schemas validator Caret Right Folder Config defaults deprecation directory_loader env_overrides environment feature_mappings hash loader merge origin_tracker validators Caret Right Folder Content Layer entry loaders manager source Caret Right Folder Sources github local notion rest Caret Right Folder Content Types base registry strategies Caret Right Folder Core build_context cascade_engine menu section theme Caret Right Folder Asset asset_core css_transforms Caret Right Folder Page computed content metadata navigation operations page_core proxy relationships utils Caret Right Folder Site core data discovery factories page_caches properties section_registry theme Caret Right Folder Debug base config_inspector content_migrator delta_analyzer dependency_visualizer explainer incremental_debugger models reporter shortcode_sandbox Caret Right Folder Discovery asset_discovery content_discovery Caret Right Folder Fonts downloader generator Caret Right Folder Health autofix base health_check report Caret Right Folder Linkcheck async_checker ignore_policy internal_checker models orchestrator Caret Right Folder Validators anchors assets cache config connectivity cross_ref fonts links menu navigation output performance rendering rss sitemap taxonomy tracks Caret Right Folder Directives analysis checkers constants Caret Right Folder Orchestration asset content full_to_incremental incremental menu postprocess related_posts render section static streaming taxonomy Caret Right Folder Postprocess html_output redirects rss sitemap special_pages Caret Right Folder Output Formats index_generator json_generator llm_generator lunr_index_generator txt_generator utils Caret Right Folder Rendering api_doc_enhancer asset_extractor errors jinja_utils link_transformer link_validator pygments_cache renderer template_context template_profiler validator Caret Right Folder Parsers base factory mistune native_html pygments_patch python_markdown Caret Right Folder Pipeline core output thread_local toc transforms Caret Right Folder Plugins badges cross_references inline_icon term variable_substitution Caret Right Folder Directives _icons admonitions badge base button cache cards checklist code_tabs container contracts data_table dropdown embed errors example_label fenced figure glossary icon include list_table literalinclude marimo navigation options rubric steps tabs target term terminal tokens utils validator video Caret Right Folder Template Engine asset_url core environment manifest menu url_helpers Caret Right Folder Template Functions advanced_collections advanced_strings autodoc collections content crossref data dates debug files get_page i18n icons images math_functions navigation pagination_helpers seo strings tables taxonomies theme urls Caret Right Folder Server build_handler component_preview constants dev_server live_reload pid_manager reload_controller request_handler request_logger resource_manager utils Caret Right Folder Services validation Caret Right Folder Themes config Caret Right Folder Utils atomic_write autodoc build_context build_stats build_summary cli_output css_minifier dates dotdict error_handlers file_io file_lock hashing incremental_constants js_bundler live_progress logger metadata observability page_initializer pagination path_resolver paths performance_collector performance_report profile progress retry rich_console sections swizzle text theme_registry theme_resolution thread_local traceback_config traceback_renderer url_normalization url_strategy Plugins Directives ᗢ Caret Down Link Copy URL External Open LLM text Copy Copy LLM text Share with AI Ask Claude Ask ChatGPT Ask Gemini Ask Copilot Module rendering.plugins.directives.video Video embed directives for Bengal. Provides directives for embedding videos from YouTube, Vimeo, and self-hosted sources with privacy-by-default, accessibility requirements, and responsive design. Architecture: VideoDirective: Abstract base class for video embeds YouTubeDirective: YouTube with privacy-enhanced mode (youtube-nocookie.com) VimeoDirective: Vimeo with Do Not Track mode SelfHostedVideoDirective: Native HTML5 video for local files Security: All video IDs are validated via regex patterns to prevent XSS and injection. Iframe embeds use appropriate sandbox attributes and CSP-friendly URLs. Accessibility: Title is required for all embeds to meet WCAG 2.1 AA requirements. Fallback content provided for users without JavaScript/iframe support. Related: bengal/rendering/plugins/directives/base.py: BengalDirective RFC: plan/active/rfc-media-embed-directives.md View source 8 Classes Classes VideoOptions dataclass Common options for all video directives. 0 Caret Right Common options for all video directives. Inherits from DirectiveOptions Attributes Name Type Description title str Required - Accessible title for iframe/video (WCAG requirement) aspect str Aspect ratio for responsive container (default: 16/9) css_class str Additional CSS classes autoplay bool Auto-start video (not recommended for accessibility) loop bool Loop video playback muted bool Start video muted _field_aliases ClassVar[dict[str, str]] VideoDirective Abstract base class for video embed directives. Provides common functionality for all video embeds… 3 Caret Right Abstract base class for video embed directives. Provides common functionality for all video embeds: URL/ID validation via subclass patterns Responsive container with aspect ratio Accessibility requirements (title required) Shared rendering utilities Subclass Requirements: ID_PATTERN: Compiled regex for validating video source validate_source(): Validate and return error or None build_embed_url(): Build the embed URL from source and options Inherits from BengalDirective Attributes Name Type Description ID_PATTERN ClassVar[re.Pattern[str]] Methods 2 validate_source Validate video source (ID or URL). 1 str | None Caret Right def validate_source(self, source: str) -> str | None Validate video source (ID or URL). Parameters 1 source str Video ID or URL from directive argument Returns str | None — Error message if invalid, None if valid build_embed_url Build the embed URL from source and options. 2 str Caret Right def build_embed_url(self, source: str, options: VideoOptions) -> str Build the embed URL from source and options. Parameters 2 source str Validated video source options VideoOptions Parsed directive options Returns str — Full embed URL Internal Methods 1 Caret Right _validate_title Check that title is provided (accessibility requirement). 2 str | None Caret Right def _validate_title(self, title: str, source: str) -> str | None Check that title is provided (accessibility requirement). Parameters 2 title str source str Returns str | None YouTubeOptions dataclass Options for YouTube video embed. 0 Caret Right Options for YouTube video embed. Inherits from VideoOptions Attributes Name Type Description start int Start time in seconds end int | None End time in seconds privacy bool Use youtube-nocookie.com (default: true for GDPR compliance) controls bool Show player controls _field_aliases ClassVar[dict[str, str]] title — Required - Accessible title for iframe aspect — Aspect ratio (default: 16/9) YouTubeDirective YouTube video embed directive with privacy-enhanced mode. Uses youtube-nocookie.com by default for… 4 Caret Right YouTube video embed directive with privacy-enhanced mode. Uses youtube-nocookie.com by default for GDPR compliance. Validates YouTube video IDs (11 alphanumeric characters). Syntax: :::{youtube} dQw4w9WgXcQ :title: Never Gonna Give You Up :start: 30 :privacy: true ::: Options: :title: (required) Accessible title for iframe :start: Start time in seconds :end: End time in seconds :privacy: Use youtube-nocookie.com (default: true) :autoplay: Auto-start video (default: false) :controls: Show player controls (default: true) :loop: Loop video (default: false) :muted: Start muted (default: false) :aspect: Aspect ratio (default: 16/9) :class: Additional CSS classes Output: <div class="video-embed youtube" data-aspect="16/9"> <iframe src="https://www.youtube-nocookie.com/embed/..." title="..." loading="lazy" allowfullscreen></iframe> </div> Security: Video ID validated via regex (11 alphanumeric + _ -) XSS prevention via strict ID validation Privacy mode uses youtube-nocookie.com domain Inherits from VideoDirective Attributes Name Type Description NAMES ClassVar[list[str]] TOKEN_TYPE ClassVar[str] OPTIONS_CLASS ClassVar[type[DirectiveOptions]] DIRECTIVE_NAMES ClassVar[list[str]] ID_PATTERN ClassVar[re.Pattern[str]] Methods 4 validate_source Validate YouTube video ID (11 alphanumeric chars). 1 str | None Caret Right def validate_source(self, video_id: str) -> str | None Validate YouTube video ID (11 alphanumeric chars). Parameters 1 video_id str Returns str | None build_embed_url Build YouTube embed URL with options. 2 str Caret Right def build_embed_url(self, video_id: str, options: YouTubeOptions) -> str Build YouTube embed URL with options. Parameters 2 video_id str options YouTubeOptions Returns str parse_directive Build YouTube embed token. 5 DirectiveToken Caret Right def parse_directive(self, title: str, options: YouTubeOptions, content: str, children: list[Any], state: Any) -> DirectiveToken Build YouTube embed token. Parameters 5 title str options YouTubeOptions content str children list[Any] state Any Returns DirectiveToken render Render YouTube embed to HTML. 2 str Caret Right def render(self, renderer: Any, text: str, **attrs: Any) -> str Render YouTube embed to HTML. Parameters 2 renderer Any text str Returns str VimeoOptions dataclass Options for Vimeo video embed. 0 Caret Right Options for Vimeo video embed. Inherits from VideoOptions Attributes Name Type Description color str Player accent color (hex without #) autopause bool Pause when another video starts (default: true) dnt bool Do Not Track mode (default: true for privacy) background bool Background mode - no controls (default: false) _field_aliases ClassVar[dict[str, str]] title — Required - Accessible title for iframe aspect — Aspect ratio (default: 16/9) VimeoDirective Vimeo video embed directive with Do Not Track mode. Uses dnt=1 by default for privacy compliance. … 4 Caret Right Vimeo video embed directive with Do Not Track mode. Uses dnt=1 by default for privacy compliance. Validates Vimeo video IDs (6-11 digits). Syntax: :::{vimeo} 123456789 :title: My Vimeo Video :color: ff0000 ::: Options: :title: (required) Accessible title for iframe :color: Player accent color (hex without #) :autopause: Pause when another video starts (default: true) :dnt: Do Not Track mode (default: true) :background: Background mode - no controls (default: false) :autoplay: Auto-start video (default: false) :loop: Loop video (default: false) :muted: Start muted (default: false) :aspect: Aspect ratio (default: 16/9) :class: Additional CSS classes Security: Video ID validated via regex (6-11 digits) DNT mode respects user privacy preferences Inherits from VideoDirective Attributes Name Type Description NAMES ClassVar[list[str]] TOKEN_TYPE ClassVar[str] OPTIONS_CLASS ClassVar[type[DirectiveOptions]] DIRECTIVE_NAMES ClassVar[list[str]] ID_PATTERN ClassVar[re.Pattern[str]] Methods 4 validate_source Validate Vimeo video ID (6-11 digits). 1 str | None Caret Right def validate_source(self, video_id: str) -> str | None Validate Vimeo video ID (6-11 digits). Parameters 1 video_id str Returns str | None build_embed_url Build Vimeo embed URL with options. 2 str Caret Right def build_embed_url(self, video_id: str, options: VimeoOptions) -> str Build Vimeo embed URL with options. Parameters 2 video_id str options VimeoOptions Returns str parse_directive Build Vimeo embed token. 5 DirectiveToken Caret Right def parse_directive(self, title: str, options: VimeoOptions, content: str, children: list[Any], state: Any) -> DirectiveToken Build Vimeo embed token. Parameters 5 title str options VimeoOptions content str children list[Any] state Any Returns DirectiveToken render Render Vimeo embed to HTML. 2 str Caret Right def render(self, renderer: Any, text: str, **attrs: Any) -> str Render Vimeo embed to HTML. Parameters 2 renderer Any text str Returns str SelfHostedVideoOptions dataclass Options for self-hosted video embed. 0 Caret Right Options for self-hosted video embed. Inherits from VideoOptions Attributes Name Type Description poster str Poster image URL controls bool Show video controls (default: true) preload str Preload mode - none, metadata, auto (default: metadata) width str Video width (px or %) _field_aliases ClassVar[dict[str, str]] _allowed_values ClassVar[dict[str, list[str]]] title — Required - Accessible title for video element aspect — Aspect ratio (default: 16/9) SelfHostedVideoDirective Self-hosted video directive using HTML5 video element. Provides native video playback for local or… 5 Caret Right Self-hosted video directive using HTML5 video element. Provides native video playback for local or CDN-hosted video files. Supports poster images, controls, and accessibility requirements. Syntax: :::{video} /assets/demo.mp4 :title: Product Demo :poster: /assets/demo-poster.jpg :controls: true ::: Options: :title: (required) Accessible title for video :poster: Poster image URL shown before playback :controls: Show video controls (default: true) :autoplay: Auto-start video (requires muted) (default: false) :muted: Start muted (default: false) :loop: Loop video (default: false) :preload: Preload mode - none, metadata, auto (default: metadata) :width: Video width (default: 100%) :aspect: Aspect ratio (default: 16/9) :class: Additional CSS classes Output: <figure class="video-embed self-hosted"> <video title="..." controls preload="metadata"> <source src="..." type="video/mp4"> <p>Fallback text with download link</p> </video> </figure> Supported formats (auto-detected from extension): .mp4 (video/mp4) .webm (video/webm) .ogg (video/ogg) .mov (video/quicktime) Inherits from VideoDirective Attributes Name Type Description NAMES ClassVar[list[str]] TOKEN_TYPE ClassVar[str] OPTIONS_CLASS ClassVar[type[DirectiveOptions]] DIRECTIVE_NAMES ClassVar[list[str]] ID_PATTERN ClassVar[re.Pattern[str]] MIME_TYPES ClassVar[dict[str, str]] Methods 4 validate_source Validate video path/URL. 1 str | None Caret Right def validate_source(self, video_path: str) -> str | None Validate video path/URL. Parameters 1 video_path str Returns str | None build_embed_url Return video path (no transformation needed for self-hosted). 2 str Caret Right def build_embed_url(self, video_path: str, options: SelfHostedVideoOptions) -> str Return video path (no transformation needed for self-hosted). Parameters 2 video_path str options SelfHostedVideoOptions Returns str parse_directive Build self-hosted video token. 5 DirectiveToken Caret Right def parse_directive(self, title: str, options: SelfHostedVideoOptions, content: str, children: list[Any], state: Any) -> DirectiveToken Build self-hosted video token. Parameters 5 title str options SelfHostedVideoOptions content str children list[Any] state Any Returns DirectiveToken render Render self-hosted video to HTML. 2 str Caret Right def render(self, renderer: Any, text: str, **attrs: Any) -> str Render self-hosted video to HTML. Parameters 2 renderer Any text str Returns str Internal Methods 1 Caret Right _get_mime_type Get MIME type from video path extension. 1 str Caret Right def _get_mime_type(self, video_path: str) -> str Get MIME type from video path extension. Parameters 1 video_path str Returns str ← Previous validator List © 2025 Bengal ᓚᘏᗢ window.BENGAL_LAZY_ASSETS = { tabulator: '/bengal/assets/js/tabulator.min.js', dataTable: '/bengal/assets/js/data-table.js', mermaidToolbar: '/bengal/assets/js/mermaid-toolbar.9de5abba.js', mermaidTheme: '/bengal/assets/js/mermaid-theme.344822c5.js', graphMinimap: '/bengal/assets/js/graph-minimap.cc7e42e3.js', graphContextual: '/bengal/assets/js/graph-contextual.440e59c6.js' }; window.BENGAL_ICONS = { close: '/bengal/assets/icons/close.911d4fe1.svg', enlarge: '/bengal/assets/icons/enlarge.652035e5.svg', copy: '/bengal/assets/icons/copy.3d56e945.svg', 'download-svg': '/bengal/assets/icons/download.04f07e1b.svg', 'download-png': '/bengal/assets/icons/image.c34dfd40.svg', 'zoom-in': '/bengal/assets/icons/zoom-in.237b4a83.svg', 'zoom-out': '/bengal/assets/icons/zoom-out.38857c77.svg', reset: '/bengal/assets/icons/reset.d26dba29.svg' }; Arrow Up X -------------------------------------------------------------------------------- Metadata: - Author: lbliii - Word Count: 2462 - Reading Time: 12 minutes