Object

Audio

The component for adding a playable audio clip.

Properties

role
string
(Required)

Always audio for this component.

URL
uri
(Required)

The URL of an audio file (http or https only). This component supports all AVPlayer audio formats, including the following:

  • MP3: MPEG-1 audio layer 3

  • AAC: MPEG-4 Advanced Audio Coding

  • ALAC: Apple Lossless

  • HE-AAC: MPEG-4 High Efficiency AAC

accessibilityCaption
string

A caption that describes the content of the audio file. The text is used for VoiceOver for iOS and VoiceOver for macOS. If accessibilityCaption is not provided, the caption value is used for VoiceOver for iOS and VoiceOver for macOS.

anchor

An object that defines vertical alignment with another component.

animation
*

An object that defines an animation to be applied to the component.

The none value is used for conditional design elements. Adding it here has no effect.

behavior
*

An object that defines behavior for a component, like Parallax or Springy.

The none value is used for conditional design elements. Adding it here has no effect.

caption
string

A caption that describes the content of the audio file. This text is also used by VoiceOver for iOS and VoiceOver for macOS if accessibilityCaption is not provided, or it can be shown when the audio cannot be played.

conditional
*

An instance or array of component properties that can be applied conditionally, and the conditions that cause them to be applied.

explicitContent
boolean

A Boolean value that indicates the audio may contain explicit content.

hidden
boolean

A Boolean value that determines whether the component is hidden.

identifier
string

An optional unique identifier for this component. If used, this identifier must be unique across the entire document. You will need an identifier for your component if you want to anchor other components to it.

imageURL
string

The URL of an image file that represents the audio file, such as a cover image.

Image URLs can begin with http://, https://, or bundle://. If the image URL begins with bundle://, the image file must be in the same directory as the document.

Image filenames should be properly encoded as URLs.

See Preparing Image, Video, Audio, Music, and ARKit Assets.

layout
*

An inline ComponentLayout object that contains layout information, or a string reference to a ComponentLayout object that is defined at the top level of the document.

If layout is not defined, size and position will be based on various factors, such as the device type, the length of the content, and the role of this component.

style
*

An inline ComponentStyle object that defines the appearance of this component, or a string reference to a ComponentStyle object that is defined at the top level of the document.

The none value is used for conditional design elements. Adding it here has no effect.

Discussion

Audio is the abstract definition for all audio components. You can also include an image that represents your audio file.

See Preparing Image, Video, Audio, Music, and ARKit Assets.

Example

{ "components": [ { "role": "audio", "URL": "http://example.com/files/sample.mp3", "caption": "Listen up!" } ]}

Relationships

Inherits From

See Also

Audio and Video

object Music

The component for adding a playable music file.

object Video

The component for adding a video.

object EmbedWebVideo

The component for adding a web video from YouTube or Vimeo.