Skip to content

Latest commit

 

History

History
181 lines (120 loc) · 6.43 KB

README.textile

File metadata and controls

181 lines (120 loc) · 6.43 KB
Raw

oui_mixcloud

Introduction

oui_mixcloud is a oui_player v2+ extension to easily embed Mixcloud provided player 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_mixcloud’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_mixcloud:
    $ composer require nicolasgraph/oui_mixcloud

Update

From the admin interface

  1. Follow the installation instruction above.

Via Composer (not available yet)

$ composer update nicolasgraph/oui_mixcloud

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_mixcloud

Tags and parameters

oui_mixcloud vs oui_player

While the <txp:oui_player /> tag is able to embed any player from any extension-related provider, the <txp:oui_mixcloud /> tag is a shortcut to embed Mixcloud player only. It is strictly equivalent to <txp:oui_player provider="mixcloud" />.

Check the oui_player documentation for more informations.

Recognised values for the play attribute

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 100%;
The width of the player in pixels (OK, pourcentage works also…).

height

Integer; initially set to 400 (alt native heights are 120 and 60);
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 0 and 1 as valid values can be enable through boolean/valueless attributes.

autoplay

0 or 1; initially set to 0.
Whether to play after loading or not.

light

0 or 1; initially set to 0.
Enables the light theme.

hide_artwork

0 or 1; initially set to 0.
Hides the background image.

hide_cover

0 or 1; initially set to 0.
Hides the cover.

mini

0 or 1; initially set to 0.
Uses the mini player config.

Sets

The sets of values below allow to render different player types.

  • Picture:
    • initial values;
  • Classic:
    • hide_cover="1";
    • height="120".
  • Mini:
    • hide_cover="1";
    • height="60";
    • mini="1".

oui_if_mixcloud 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_mixcloud>…</txp:oui_if_mixcloud> tag is a shortcut to check an URL against Mixcloud related URL schemes only. It is strictly equivalent to <txp:oui_if_player provider="mixcloud">…</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: https://www.mixcloud.com/musicismysanctuary/mims-guest-mix-champagne-funk-balamii-radio-london/.

Conditionally embed a player using attributes

<txp:oui_if_player provider="mixcloud" play="https://www.mixcloud.com/musicismysanctuary/mims-guest-mix-champagne-funk-balamii-radio-london/">
    <txp:oui_player height="120" />
</txp:oui_if_player>

…or:

<txp:oui_if_mixcloud play="https://www.mixcloud.com/musicismysanctuary/mims-guest-mix-champagne-funk-balamii-radio-london/">
    <txp:oui_mixcloud height="120" />
</txp:oui_if_mixcloud>

Credits

Author

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

License

This plugin is distributed under GPL v2.0.

oui_mixcloud version 1.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_mixcloud v1.0.0-BETA3 (2018-08-15)
  • oui_player v1.3.0 (2017-05-24)