AMP

Important: this documentation is not applicable to your currently selected format ads!

amp-soundcloud

Experimental
Bento

Description

Displays a Soundcloud clip.

 

Required Scripts

<script async custom-element="amp-soundcloud" src="https://cdn.ampproject.org/v0/amp-soundcloud-1.0.js"></script>

Usage

Display a Soundcloud clip.

Standalone use outside valid AMP documents

Bento allows you to use AMP components in non-AMP pages without needing to commit to fully valid AMP. You can take these components and place them in implementations with frameworks and CMSs that don't support AMP. Read more in our guide Use AMP components in non-AMP pages.

To find the standalone version of amp-soundcloud, see bento-soundcloud.

Examples

With the responsive layout, the width and height from the example should yield correct layouts for 1:1 aspect ratio embeds:

Visual Mode:

<amp-soundcloud
  width="480"
  height="480"
  layout="responsive"
  data-trackid="243169232"
  data-visual="true"
></amp-soundcloud>

Classic Mode:

<amp-soundcloud
  width="480"
  height="480"
  layout="responsive"
  data-trackid="243169232"
  data-color="ff5500"
></amp-soundcloud>

Attributes

data-trackid This attribute is required if data-playlistid is not defined.
The value for this attribute is the ID of a track, an integer.
data-playlistid This attribute is required if data-trackid is not defined. The value for this attribute is the ID of a playlist, an integer.
data-secret-token (optional) The secret token of the track, if it is private.
data-visual (optional) If set to true, displays full-width "Visual" mode; otherwise, it displays as "Classic" mode. The default value is false.
data-color (optional) This attribute is a custom color override for the "Classic" mode. The attribute is ignored in "Visual" mode. Specify a hexadecimal color value, without the leading # (e.g., data-color="e540ff").
width and height The layout for amp-soundcloud is set to fixed-height and it fills all of the available horizontal space. This is ideal for the "Classic" mode, but for "Visual" mode, it's recommended that the height is 300px, 450px or 600px, as per Soundcloud embed code. This will allow the clip's internal elements to resize properly on mobile.

Validation

See amp-soundcloud rules in the AMP validator specification.

Need more help?

You've read this document a dozen times but it doesn't really cover all of your questions? Maybe other people felt the same: reach out to them on Stack Overflow.

Go to Stack Overflow
Found a bug or missing a feature?

The AMP project strongly encourages your participation and contributions! We hope you'll become an ongoing participant in our open source community but we also welcome one-off contributions for the issues you're particularly passionate about.

Go to GitHub