django-embed-video’s documentation¶

Admin¶

class embed_video.admin.AdminVideoMixin[source]¶

Mixin using AdminVideoWidget for fields with EmbedVideoField.

Usage:

from django.contrib import admin
from embed_video.admin import AdminVideoMixin
from .models import MyModel

class MyModelAdmin(AdminVideoMixin, admin.ModelAdmin):
    pass

admin.site.register(MyModel, MyModelAdmin)

class embed_video.admin.AdminVideoWidget(attrs=None)[source]¶

Widget for video input in administration. If empty it works just like django.forms.TextInput. Otherwise it renders embedded video together with input field.

Todo

Django 1.6 provides better parent for this widget - django.forms.URLInput.

Backends¶

exception embed_video.backends.EmbedVideoException[source]¶

Parental class for all embed_video exceptions

class embed_video.backends.SoundCloudBackend(url, is_secure=False)[source]¶

Backend for SoundCloud URLs.

exception embed_video.backends.UnknownBackendException[source]¶

Exception thrown if video backend is not recognized.

exception embed_video.backends.UnknownIdException[source]¶

Exception thrown if backend is detected, but video ID cannot be parsed.

class embed_video.backends.VideoBackend(url, is_secure=False)[source]¶

Base class used as parental class for backends.

class MyBackend(VideoBackend):
    ...

allow_https = True¶

Sets if HTTPS version allowed for specific backend.

get_code()[source]¶

Returns video code matched from given url by re_code.

get_embed_code(width, height)[source]¶

Returns embed code rendered from template template_name.

get_thumbnail_url()[source]¶

Returns thumbnail URL folded from pattern_thumbnail_url and parsed code.

get_url()[source]¶

Returns URL folded from pattern_url and parsed code.

classmethod is_valid(url)[source]¶

Class method to control if passed url is valid for current backend. By default it is done by re_detect regex.

pattern_thumbnail_url = None¶

Pattern in which the code is inserted to get thumbnail url.

Example: http://static.myvideo.com/thumbs/%s

pattern_url = None¶

Pattern in which the code is inserted.

Example: http://myvideo.com?code=%s

re_code = None¶

Compiled regex (re.compile()) to search code in URL.

Example: re.compile(r'myvideo\.com/\?code=(?P<code>\w+)')

re_detect = None¶

Compilede regec (re.compile()) to detect, if input URL is valid for current backend.

Example: re.compile(r'^http://myvideo\.com/.*')

template_name = 'embed_video/embed_code.html'¶

Name of embed code template used by get_embed_code().

Passed template variables: {{ backend }} (instance of VideoBackend), {{ width }}, {{ height }}

exception embed_video.backends.VideoDoesntExistException[source]¶

Exception thrown if video doesn’t exist

class embed_video.backends.VimeoBackend(url, is_secure=False)[source]¶

Backend for Vimeo URLs.

class embed_video.backends.YoutubeBackend(url, is_secure=False)[source]¶

Backend for YouTube URLs.

embed_video.backends.detect_backend(url)[source]¶

Detect the right backend for given URL.

Goes over backends in settings.EMBED_VIDEO_BACKENDS, calls is_valid() and returns backend instance.

Fields¶

class embed_video.fields.EmbedVideoField(verbose_name=None, name=None, **kwargs)[source]¶

Model field for embeded video. Descendant of django.db.models.URLField.

class embed_video.fields.EmbedVideoFormField(max_length=None, min_length=None, *args, **kwargs)[source]¶

Form field for embeded video. Descendant of django.forms.URLField

Settings¶

EMBED_VIDEO_BACKENDS = (
    'embed_video.backends.YoutubeBackend',
    'embed_video.backends.VimeoBackend',
    'embed_video.backends.SoundCloudBackend',
)

Template tags¶

You have to load template tag library first.

{% load embed_video_tags %}

class embed_video.templatetags.embed_video_tags.VideoNode(parser, token)[source]¶

Template tag video. It gives access to all VideoBackend variables.

Usage (shortcut):

{% video URL [SIZE] %}

Or as a block:

{% video URL as VAR %}
    ...
{% endvideo %}

Example:

{% video item.video "large" %}
{% video item.video "340x200" %}
{% video item.video "100% x 300" %}

{% video item.video as my_video %}
    URL: {{ my_video.url }}
    Thumbnail: {{ my_video.thumbnail }}
    Backend: {{ my_video.backend }}
{% endvideo %}

static embed(url, size, context=None)[source]¶

Direct render of embed video.

static get_backend(backend_or_url, context=None)[source]¶

Returns instance of VideoBackend. If context is passed to the method and request is secure, than the is_secure mark is set to backend.

A string or VideoBackend instance can be passed to the method.

static get_size(value)[source]¶

Predefined sizes:

size	width	height
tiny	420	315
small	480	360
medium	640	480
large	960	720
huge	1280	960

You can also use custom size - in format WIDTHxHEIGHT (eg. 500x400).

embed_video.templatetags.embed_video_tags.embed(backend, size='small')[source]¶

Warning

Deprecated since version 0.7: Use VideoNode.embed() instead.

Same like VideoNode.embed() tag but always uses insecure HTTP protocol.

Usage:

{{ URL|embed:SIZE }}

Example:

{{ 'http://www.youtube.com/watch?v=guXyvo2FfLs'|embed:'large' }}

Utils¶

embed_video.utils.import_by_path(dotted_path, error_prefix='')[source]¶

Import a dotted module path and return the attribute/class designated by the last name in the path. Raise ImproperlyConfigured if something goes wrong.

Warning

Deprecated since version Django: 1.6

Function django.utils.module_loading.import_by_path() has been added in Django 1.6.