Docs/Content/Stop types

Stop types

All content types you can use in your tours

AudioGuideKit supports several different stop types. While most tours primarily use audio stops, mixing in other types can create a richer, more engaging experience.

At the moment only audio stops are fully supported and tested. Other stop types are available but flagged as experimental and full support will be introduced in the future.

Overview

TypeDescriptionUse Case
audioAudio playback with optional transcriptionMain tour content
textRich text contentDetailed information
image-textImage with accompanying textPhoto essays
videoVideo playbackDemonstrations, intros
3d-objectInteractive 3D model viewerArtifacts, architecture
headlineLarge text headerSection dividers
quoteStyled quotationHistorical quotes
ratingStar rating collectionFeedback
emailEmail collection formNewsletter signup

Audio stops

The bread and butter of audio tours. Displays a card with image, title, and audio player.

{
  "id": "1",
  "type": "audio",
  "title": "Welcome to Barcelona",
  "duration": "3 min audio",
  "image": "https://images.unsplash.com/photo-xxx",
  "audioFile": "https://your-storage.com/01-welcome.mp3",
  "transcription": "Welcome to Barcelona! Today we'll explore the Gothic Quarter..."
}

Audio stop fields

FieldRequiredDescription
idYesUnique stop identifier
typeYesMust be "audio"
titleYesStop title
durationYesHuman-readable duration
imageYesStop image URL
audioFileYesAudio file URL (MP3, M4A)
transcriptionNoText version of the audio

Include transcriptions! They help with accessibility, allow visitors to read ahead, and improve SEO if search engines crawl your tour.

Text stops

Display rich text content without audio. Good for detailed information that visitors can read at their own pace.

{
  "id": "2",
  "type": "text",
  "title": "Cathedral History",
  "duration": "2 min read",
  "image": "https://images.unsplash.com/photo-xxx",
  "content": "The Barcelona Cathedral was constructed between the 13th and 15th centuries..."
}

Text stop fields

FieldRequiredDescription
contentYesThe text to display
Other standard fieldsYesid, type, title, duration, image

Image-text stops

Combines an image with accompanying text. Like text stops, but with more visual emphasis.

{
  "id": "3",
  "type": "image-text",
  "title": "The Main Altar",
  "duration": "1 min read",
  "image": "https://images.unsplash.com/photo-xxx",
  "content": "Notice the intricate gold leaf work on the altar, dating back to..."
}

Use image-text stops when the image is central to understanding the content. Use text stops when the image is decorative.

Video stops

Embed video content. Useful for introductions, demonstrations, or drone footage.

{
  "id": "4",
  "type": "video",
  "title": "Cathedral Overview",
  "duration": "2 min video",
  "image": "https://images.unsplash.com/photo-xxx",
  "videoUrl": "https://your-storage.com/cathedral-overview.mp4"
}

Video stop fields

FieldRequiredDescription
videoUrlYesVideo file URL (MP4 recommended)
Other standard fieldsYesid, type, title, duration, image

Video files are large and may not work well offline. Consider using video stops only for online-only tours or keep videos short.

3D object stops

Display interactive 3D models that visitors can rotate and zoom. Great for artifacts, sculptures, or architectural details.

{
  "id": "5",
  "type": "3d-object",
  "title": "Roman Amphora",
  "duration": "Interactive",
  "image": "https://images.unsplash.com/photo-xxx",
  "modelUrl": "https://your-storage.com/amphora.glb"
}

3D object fields

FieldRequiredDescription
modelUrlYes3D model file URL (GLB/GLTF format)
Other standard fieldsYesid, type, title, duration, image

3D models use the GLB format (binary glTF). You can export from Blender, SketchUp, or download from Sketchfab.

Headline stops

Large text headers to divide your tour into sections. Don't include duration—these are visual dividers.

{
  "id": "6",
  "type": "headline",
  "title": "Part 2: The Gothic Quarter",
  "image": "https://images.unsplash.com/photo-xxx"
}

Headline stop fields

FieldRequiredDescription
idYesUnique stop identifier
typeYesMust be "headline"
titleYesThe headline text
imageYesBackground image
durationNoTypically omitted for headlines

Quote stops

Display a styled quotation. Perfect for historical quotes, visitor testimonials, or famous sayings about the location.

{
  "id": "7",
  "type": "quote",
  "title": "Antoni Gaudí",
  "duration": "Quote",
  "image": "https://images.unsplash.com/photo-xxx",
  "quote": "Nothing is art if it does not come from nature.",
  "attribution": "Antoni Gaudí, 1910"
}

Quote stop fields

FieldRequiredDescription
quoteYesThe quotation text
attributionNoWho said it and when
Other standard fieldsYesid, type, title, image

Rating stops

Collect star ratings from visitors. Appears as an interactive card with 1-5 stars.

{
  "id": "8",
  "type": "rating",
  "title": "How was your tour?",
  "duration": "Rate us",
  "image": "https://images.unsplash.com/photo-xxx"
}

Place rating stops near the end of your tour, when visitors have experienced enough to form an opinion.

Rating collection

When a visitor submits a rating, it's stored locally. If collectFeedback: true is set in your metadata, ratings can be collected and analyzed.

Email stops

Collect email addresses for newsletters or follow-up communication.

{
  "id": "9",
  "type": "email",
  "title": "Stay in Touch",
  "duration": "Sign up",
  "image": "https://images.unsplash.com/photo-xxx",
  "description": "Get notified about new tours and special events.",
  "placeholder": "Enter your email"
}

Email stop fields

FieldRequiredDescription
descriptionNoText explaining why to sign up
placeholderNoInput placeholder text
Other standard fieldsYesid, type, title, image

Email collection requires backend integration to actually store emails. The stop type provides the UI, but you'll need to connect it to your email service.

Mixing stop types

A typical tour might look like this:

"stops": [
  { "type": "audio", "title": "Welcome" },
  { "type": "audio", "title": "First Stop" },
  { "type": "audio", "title": "Second Stop" },
  { "type": "headline", "title": "Part 2: The Old Town" },
  { "type": "audio", "title": "Third Stop" },
  { "type": "quote", "title": "Historical Quote" },
  { "type": "audio", "title": "Fourth Stop" },
  { "type": "rating", "title": "Rate Your Experience" },
  { "type": "email", "title": "Stay Connected" }
]

Best practices

  1. Lead with audio - Visitors expect audio tours to have audio
  2. Use headlines sparingly - Too many breaks the flow
  3. Place feedback at the end - After visitors have context
  4. Keep videos short - 2 minutes max for mobile attention spans
  5. Test 3D on mobile - Performance varies by device