Skip to main content

A wagtail module for uploading and displaying videos in various codecs.

Project description

https://gitlab.com/neonjungle/wagtailvideos/badges/master/pipeline.svg

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 >= 4.0 (for older wagtail version see the tags)

  • ffmpeg

Installing

Install using pypi

pip install wagtailvideos

Add 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 = True

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.contrib.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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wagtailvideos-4.2.0.tar.gz (58.3 kB view details)

Uploaded Source

Built Distribution

wagtailvideos-4.2.0-py2.py3-none-any.whl (83.4 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file wagtailvideos-4.2.0.tar.gz.

File metadata

  • Download URL: wagtailvideos-4.2.0.tar.gz
  • Upload date:
  • Size: 58.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for wagtailvideos-4.2.0.tar.gz
Algorithm Hash digest
SHA256 93f10bcd9c756f33a717b357abd4a0869d48b0bce9b07a10a6e7dd8b1744c47a
MD5 f7b6fadee79f5259a12ae72b7df6070a
BLAKE2b-256 a560f3ed296d1397814e71abb8642457fa53656c1704b92aa546ef4609909ae4

See more details on using hashes here.

File details

Details for the file wagtailvideos-4.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for wagtailvideos-4.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 a35918fc3d06a7dec3c89f497e9c7c4bc6b9bedffd23a18425751b32f8a2021a
MD5 d99386a3577cf2f521a1aa2b244ad9ee
BLAKE2b-256 5b75127313419170db4a7f9f4eeda0304863f3480293a59af6b0b0f661e2b6e2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page