External Audio Field

A DatoCMS plugin that allows content editors to easily embed Soundcloud, Mixcloud, Spotify and Anghami tracks and playlists.

Via the oEmbed standard we'll fetch the embed and meta data for the track. All the information you select is available via the Content Delivery Api.

Created By November Five

Head ups

This package used to be called dato-cms-external-audio-field-plugin but was deprecated in favour of the DatoCMS naming convention, the new package name is now datocms-plugin-external-audio-field

Installation

Install the plugin by following the DatoCMS guide: Installing Marketplace Plugins.

IMPORTANT!!: At the moment Mixcloud does not have the right CORS settings for their /oEmbed endpoint. To solve the you can provide a proxy url through which this plugin will fetch the embed response. We will try to call it with the full oEmbed url as a endpoint query parameter. An example would be

1
[GET] https://yourProxyApiEndpoint.org?endpoint=endpoint=https://www.mixcloud.com/oembed/?url=https://www.mixcloud.com/MDLBEASTRADIO/mdlbeast-mdlbeast-radio-001/&format=json

If you want more help on the setup of this proxy you can always react out via the Issues

Usage

This is a JSON field extension. So you can use by adding a JSON field:

1. On the model/block you want to add the field to click New field
2. In the popup modal select the JSON button.
3. Give it a sensible name
4. Select the tab Presentation
5. In the field editor dropdown select: External Audio Field

In the record field you just copy paste and audio url from one of the supported providers (Soundcloud, Mixcloud, Spotify) and configure it the way you want. Each provider has some different players/options which you can select.

You should end up with something like this:

Output:

1
{
2
  "oEmbed": {
3
    "version": 1,
4
    "type": "rich",
5
    "provider_name": "SoundCloud",
6
    "provider_url": "https://soundcloud.com",
7
    "height": 400,
8
    "width": "100%",
9
    "title": "BURN BEAST 001 - DABOUS by MDLBEAST",
10
    "description": "@waleed-abudabous Is a homegrown Saudi DJ/producer thats been crafting music for five years now and is known for his unique style of mixing various House Music genres ⚡",
11
    "thumbnail_url": "https://i1.sndcdn.com/artworks-cPivDyutshSD9GQz-wScohg-t500x500.jpg",
12
    "html": "<iframe width=\"100%\" height=\"160\" scrolling=\"no\" frameborder=\"no\" src=\"https://w.soundcloud.com/player/?height=160&label=Default&show_artwork=true&show_comments=true&url=https%3A%2F%2Fapi.soundcloud.com%2Ftracks%2F1224023323&visual=true\"></iframe>",
13
    "author_name": "MDLBEAST",
14
    "author_url": "https://soundcloud.com/mdlbeast"
15
  },
16
  "options": {
17
    "variant": {
18
      "label": "Default",
19
      "value": {
20
        "label": "Default",
21
        "height": 160
22
      },
23
      "defaultToggles": {
24
        "show_artwork": true,
25
        "show_comments": false,
26
        "visual": false
27
      }
28
    },
29
    "toggles": {
30
      "show_artwork": true,
31
      "show_comments": true,
32
      "visual": true
33
    }
34
  },
35
  "url": "https://soundcloud.com/mdlbeast/dabous-1?in=mdlbeast/sets/burn-beast-riyadh-marathon&utm_source=clipboard&utm_medium=text&utm_campaign=social_sharing"
36
}

Do you know some other options that I forgot? Check the Contributing guide on how to make suggestion for improvements of this plugin! Or you can make a PR if you want.

Contributing

• Reporting a bug: Open an issue explaining your application's setup and the bug you're encountering.

• Suggesting an improvement: Open an issue explaining your improvement or feature so we can discuss and learn more.

• Submitting code changes: For small fixes, feel free to open a pull request with a description of your changes. For large changes, please first open an issue so we can discuss if and how the changes should be implemented.

For more information check the CONTRIBUTING.md document.

License

Copyright (c) November Five BVBA. All rights reserved.

Licensed under the MIT License.