Where it sits
| Body | In the body | Inside its texts |
|---|---|---|
| The store’s home | Yes | Yes |
| A custom page | Yes | Yes |
| A product’s page | Yes | Yes |
| An event’s page | Yes | Yes |
| A portfolio’s page | Yes | Yes |
| A lesson | Yes | Yes |
| An article | Yes | Yes |
A text holds it as a <block type="audio" props="…"></block> element: its props are those below but type, which the element’s own type names.
See Bodies for how a body holds its blocks.
Props
| Name | Type | Required | Description |
|---|---|---|---|
id |
string |
Yes | The block’s id, unique within its body. |
type |
"audio" |
Yes | The block’s type. |
src |
string |
No | An external URL, when no fileId names a store file. Defaults to "". |
fileId |
string |
No | A store file’s id, listed in the read’s files. |
title |
string |
No | A title shown above its waveform. |
caption |
string |
No | A caption under it. |
startTime |
number |
No | Where it starts playing, in seconds. |
hidden |
boolean |
No | Whether the block is hidden: it, and every block it holds, doesn’t show. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The block's id, unique within its body."
},
"type": {
"type": "string",
"const": "audio",
"description": "The block's type."
},
"src": {
"default": "",
"type": "string",
"description": "An external URL, when no `fileId` names a store file."
},
"fileId": {
"type": "string",
"description": "A store file's id, listed in the read's `files`."
},
"title": {
"type": "string",
"description": "A title shown above its waveform."
},
"caption": {
"type": "string",
"description": "A caption under it."
},
"startTime": {
"type": "number",
"description": "Where it starts playing, in seconds."
},
"hidden": {
"type": "boolean",
"description": "Whether the block is hidden: it, and every block it holds, doesn't show."
}
},
"required": [
"id",
"type"
],
"description": "An audio file played with its waveform: a store file, or an external URL.",
"additionalProperties": false
}