A wagtail module for uploading and displaying videos in various codecs.
Project description
Based on wagtailimages. The aim was to have feature parity with images but for html5 videos. Includes the ability to transcode videos to a html5 compliant codec using ffmpeg.
Requirements
Wagtail >= 5.2 (for older wagtail version see the tags)
ffmpeg (optional, for transcoding)
Installing
Install using pypi
pip install wagtailvideosAdd wagtailvideos to your installed apps.
INSTALLED_APPS = [
'wagtailvideos',
]Using
On a page model:
Implement as a ForeignKey relation, same as wagtailimages.
from django.db import models
from wagtail.admin.edit_handlers import FieldPanel
from wagtail.core.fields import RichTextField
from wagtail.core.models import Page
from wagtailvideos.edit_handlers import VideoChooserPanel
class HomePage(Page):
body = RichtextField()
header_video = models.ForeignKey('wagtailvideos.Video',
related_name='+',
null=True,
on_delete=models.SET_NULL)
content_panels = Page.content_panels + [
FieldPanel('body'),
VideoChooserPanel('header_video'),
]In a Streamfield:
A VideoChooserBlock is included
from wagtail.admin.edit_handlers import StreamFieldPanel
from wagtail.core.fields import StreamField
from wagtail.core.models import Page
from wagtailvideos.blocks import VideoChooserBlock
class ContentPage(Page):
body = StreamField([
('video', VideoChooserBlock()),
])
content_panels = Page.content_panels + [
StreamFieldPanel('body'),
]In template:
The video template tag takes one required postitional argument, a video field. All extra attributes are added to the surrounding <video> tag. The original video and all extra transcodes are added as <source> tags.
{% load wagtailvideos_tags %}
{% video self.header_video autoplay controls width=256 %}Jinja2 extensions are also included.
How to transcode using ffmpeg:
Using the video collection manager from the left hand menu. In the video editing section you can see the available transcodes and a form that can be used to create new transcodes. It is assumed that your compiled version of ffmpeg has the matching codec libraries required for the transcode.
Disable transcode:
Transcode can be disabled using the WAGTAIL_VIDEOS_DISABLE_TRANSCODE setting.
# settings.py
WAGTAIL_VIDEOS_DISABLE_TRANSCODE = TrueModify Thumbnail extension:
The automatically generated Thumbnail extension can be modified using the WAGTAIL_VIDEOS_THUMBNAIL_EXTENSION setting. Default value is jpg
# settings.py
WAGTAIL_VIDEOS_THUMBNAIL_EXTENSION = 'webp'Custom Video models:
Same as Wagtail Images, a custom model can be used to replace the built in Video model using the WAGTAILVIDEOS_VIDEO_MODEL setting.
# settings.py
WAGTAILVIDEOS_VIDEO_MODEL = 'videos.AttributedVideo'
# app.videos.models
from django.db import models
from modelcluster.fields import ParentalKey
from wagtailvideos.models import AbstractVideo, AbstractVideoTranscode
class AttributedVideo(AbstractVideo):
attribution = models.TextField()
admin_form_fields = (
'title',
'attribution',
'file',
'collection',
'thumbnail',
'tags',
)
class CustomTranscode(AbstractVideoTranscode):
video = models.ForeignKey(AttributedVideo, related_name='transcodes', on_delete=models.CASCADE)
class Meta:
unique_together = (
('video', 'media_format')
)
# Only needed if you are using the text tracks feature
class CustomTrackListing(AbstractTrackListing):
video = models.OneToOneField(AttributedVideo, related_name='track_listing', on_delete=models.CASCADE)
class CustomVideoTrack(AbstractVideoTrack):
listing = ParentalKey(CustomTrackListing, related_name='tracks', on_delete=models.CASCADE)Video text tracks:
To enable the uploading and displaying of VTT tracks (e.g. subtitles, captions) you’ll need to add wagtail_modeladmin to your installed apps. Once added, there will be an new area in the admin for attaching VTT files to videos with associaled metadata.
Future features
Some docs
Richtext embed
Transcoding via external service rather than ffmpeg
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file wagtailvideos-6.1.0.tar.gz.
File metadata
- Download URL: wagtailvideos-6.1.0.tar.gz
- Upload date:
- Size: 83.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0354ec89e98b18af6f680953b451c777de2dad8faa512f51236b8445f6bb93a7 |
|
| MD5 | 8adae51971d58d16d81a007b9e90c328 |
|
| BLAKE2b-256 | e9b47f4aadbaef581fe264b7d2e9604d550d255b78410cb445e81c65bf50110e |
File details
Details for the file wagtailvideos-6.1.0-py2.py3-none-any.whl.
File metadata
- Download URL: wagtailvideos-6.1.0-py2.py3-none-any.whl
- Upload date:
- Size: 113.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.11.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | a72b66b0a4061830609fe270e11e6edf53f2e585a62593a939aabc7164f57db1 |
|
| MD5 | 48850daa2d93554af080a5acf0c9bef5 |
|
| BLAKE2b-256 | 54136c0153446be42274ee717922eb72369b3cc2d46756f886f19f0d25a650d0 |
