Skip to content

Latest commit

 

History

History
213 lines (150 loc) · 8.06 KB

README.textile

File metadata and controls

213 lines (150 loc) · 8.06 KB
Raw

oui_dailymotion

Introduction

oui_dailymotion is a oui_player v2+ extension to easily embed Dailymotion provided videos in Textpattern powered websites.

The above platform serves cookies with its player, according to the EU legislation, you should warn your users about these cookies before they are added. This can be done by using oui_cookie.

Plugin requirements

oui_dailymotion’s minimum requirements:

Plugin management

Installation

From the admin interface

  1. Download the compiled plugin file or the source to compile a customized file.
  2. Paste the content of the compiled plugin file under the “Admin > Plugins”:?event=plugin tab and click the Upload button.
  3. Confirm the plugin install by clicking the Install button on the plugin preview page.
  4. Enable the plugin and click the Options link (or visit the Preferences tab) to set the provider preferences.

Via Composer (not available yet)

After installing Composer

  1. Target your project directory:
    $ cd /path/to/your/textpattern/installation/dir
  2. If it’s not already done, lock your version of Txp:
    $ composer require textpattern/lock:4.6.2, where 4.6.2 is the Txp version in use.
  3. Install oui_dailymotion:
    $ composer require nicolasgraph/oui_dailymotion

Update

From the admin interface

  1. Follow the installation instruction above.

Via Composer (not available yet)

$ composer update nicolasgraph/oui_dailymotion

Uninstall

From the admin interface

  1. Check the box on the left of the plugin row under the “Admin > Plugins”:?event=plugin.
  2. open the select list at the bottom of the plugins table and choose Delete.
  3. confirm the plugin deletion.

Via Composer (not available yet)

$ composer remove nicolasgraph/oui_dailymotion

Tags and parameters

oui_dailymotion vs oui_player

While the <txp:oui_player /> tag is able to embed any video from any extension-related provider, the <txp:oui_dailymotion /> tag is a shortcut to embed Dailymotion videos only. It is strictly equivalent to <txp:oui_player provider="dailymotion" />.

Check the oui_player documentation for more informations.

Recognised values for the play attribute

When using the <txp:oui_player /> tag (vs <oui_dailymotion />), the right provider needs to be set if the play value or its field related one is an ID. It is optional, but can fasten the rendering, if the value is an URL.

Player customization

Preferences vs attributes

While some player customization elements, related to the media to play, should be used through attributes, these used as global settings should preferrably be set through the plugin preferences to avoid a massive use of tag attributes.

Of course, it is still possible to override a preference value via an attribute when needed.

Size
width

Integer; initially set to 480;
The width of the player in pixels.

height

Integer; initially set to 270;
The height of the player in pixels.

ratio

Integer:integer; initially not set;
The ratio used to calculate the missing value for the width or the height.

responsive

true or false; initially set to false.
Adapts the final player size from the provided width and/or height and/or ratio values to fit the container width.
Wraps the player and adds some styles.

Parameters (a→z)

From Txp 4.7, paramaters accepting true and false as valid values can be enable through boolean/valueless attributes.

api

false, postMessage, location or 1; initially set to false.
Enables or disables the javascript player api.

autoplay

true or false; initially set to false.
Starts the playback of the video automatically after the player load.
This parameter may not work on some mobile OS.

controls

true or false; initially set to true.
Whether to display the player controls or not.

endscreen_enable

true or false; initially set to true.
Whether to enable the end screen or not.

mute

true or false; initially set to false.
Whether to mute the video or not.

origin

URL; initially not set.
The domain of the page hosting the Dailymotion player.
When using api="postMessage", you might want to specify origin for extra security.

quality

240, 380, 480, 720, 1080, 1440 or 2160; initially set to auto.
Set the suggested playback quality for the video.

sharing_enable

true or false; initially set to true.
Whether to display the sharing button or not.

start

Integer, initially not set.
Specifies the time (in seconds) from which the video should start playing.

subtitles_default

Initially not set.
Specifies the default selected subtitles language.

syndication

Initially not set.
Passes your syndication key to the player.

ui_highlight

Hexadecimal color value; initially set to ffcc33.
Changes the default colour used in the controls.

ui_logo

true or false; initially set to true.
Whether to display the Dailymotion logo or not.

ui_start_screen_info

true or false; initially set to true.
Whether to show video information on the start screen or not.

ui_theme

dark or light, initially set to dark.
Choose the default base colour theme.

oui_if_dailymotion vs oui_if_player

While the <txp:oui_if_player>…</txp:oui_if_player> tag is able to check an URL against any URL from any extension-related provider, the <txp:oui_if_dailymotion>…</txp:oui_if_dailymotion> tag is a shortcut to check an URL against Dailymotion related URL schemes only. It is strictly equivalent to <txp:oui_if_player provider="dailymotion">…</txp:oui_if_player>.

Check the oui_player documentation for more informations.

Examples

Embed a player using the preference values

<txp:oui_player />

oui_player preference related field value: http://dai.ly/x2m8jpp.

Embed a player by defining its provider and a media ID through attributes

<txp:oui_player provider="dailymotion" play="x2m8jpp" />

…or:

<txp:oui_dailymotion play="x2m8jpp" />

Conditionally embed a player using attributes

<txp:oui_if_player provider="dailymotion" play="https://www.dailymotion.com/video/x2m8jpp">
    <txp:oui_player />
</txp:oui_if_player>

…or:

<txp:oui_if_dailymotion play="https://www.dailymotion.com/video/x2m8jpp">
    <txp:oui_dailymotion />
</txp:oui_if_dailymotion>

Credits

Author

Nicolas Morand
Thank you to the Textpattern community and the core team.

License

This plugin is distributed under GPL v2.0.

oui_dailymotion version 2.0.0-BETA3, Copyright © 2018 Nicolas Morand
This Textpattern plugin comes with ABSOLUTELY NO WARRANTY.
This is free software, and you are welcome to redistribute it under certain conditions.

Changelog

  • oui_dailymotion v2.0.0-BETA3 (2018-08-15)
    • Changed: initial player size.
  • oui_player v1.3.0 (2017-05-24)