EMBED_VIDEO_YOUTUBE_DEFAULT_QUERY [skip ci]

This commit is contained in:
Juda Kaleta 2014-07-26 18:01:54 +02:00
parent 07e3e1cae1
commit 5c20fd6348
2 changed files with 8 additions and 19 deletions

View file

@ -3,6 +3,7 @@ Settings
.. setting:: EMBED_VIDEO_BACKENDS
EMBED_VIDEO_BACKENDS
--------------------
@ -19,6 +20,7 @@ Default::
.. setting:: EMBED_VIDEO_TIMEOUT
EMBED_VIDEO_TIMEOUT
-------------------
@ -27,25 +29,13 @@ Sets timeout for ``GET`` requests to remote servers.
Default: ``10``
.. setting:: EMBED_VIDEO_{BACKEND}_QUERY
.. setting:: EMBED_VIDEO_YOUTUBE_DEFAULT_QUERY
EMBED_VIDEO_{BACKEND}_QUERY
---------------------------
Set default query dictionary for including in the embedded URL. This is
backend-specific. Substitute the actual name of the backend for {BACKEND}
(i.e. to set the default query for the YouTube backend, the setting name would
be ``EMBED_VIDEO_YOUTUBE_QUERY`` and for SoundCloud the name would be
``EMBED_VIDEO_SOUNDCLOUD_QUERY``).
EMBED_VIDEO_YOUTUBE_DEFAULT_QUERY
---------------------------------
As an example, if you set the following::
Sets default :py:attr:`~embed_video.backends.VideoBackend.query` appended
to YouTube url. Can be string or :py:class:`~django.http.QueryDict` instance.
EMBED_VIDEO_YOUTUBE_QUERY = {
'wmode': 'opaque',
'rel': '0'
}
All URLs for YouTube will include the query string ``?wmode=opaque&rel=0``.
The default value for EMBED_VIDEO_YOUTUBE_QUERY is ``{'wmode': 'opaque'}``.
None of the other backends have default values set.
Default: ``"wmode=opaque"``

View file

@ -75,7 +75,6 @@ class VideoBackend(object):
template_name
.. code-block:: python
class MyBackend(VideoBackend):