Skip to content
This repository has been archived by the owner on Apr 18, 2024. It is now read-only.

docs: Add paragraphs example with audio #927

Merged
merged 3 commits into from
Nov 9, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions src/tags/object/Paragraphs/Model.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,29 @@ const isFFDev2461 = isFF(FF_DEV_2461);
* <Label value="Random talk"></Label>
* </ParagraphLabels>
* </View>
* @example
* <!-- Paragraphs with audio -->
* <View>
* <Paragraphs audioUrl="$audio" value="$para" name="paragraphs"
* layout="dialogue" textKey="text" nameKey="author"
* showPlayer="true"
* />
*
* <Choices name="choices" toName="paragraphs" choice="multiple">
* <Choice value="Good quality"/>
* <Choice value="Fast speech"/>
* </Choices>
* </View>
*
* <!-- {"data": {
* "para": [
* {"text": "test 1", "author": "A", "start": 0.0, "end": 1.0},
* {"text": "test 2", "author": "B", "start": 1.0, "end": 2.0},
* {"text": "test 3", "author": "A", "start": 2.0, "end": 3.0}
* ],
* "audio": "/static/samples/game.wav"
* }}
* -->
* @name Paragraphs
* @regions ParagraphsRegion
* @meta_title Paragraph Tags for Paragraphs
Expand Down