StoryMapJS API
    Preparing search index...

    Interface StorymapSlideNarration

    Optional spoken narration for one slide, played through a dedicated audio element rather than the slide's media frame — a tour stop usually has a picture and a recording, not one media item. In a IIIF manifest this is a motivation: "supplementing" Sound/Video body, read and written alongside the painting annotation.

    interface StorymapSlideNarration {
        loop?: boolean;
        offset?: number;
        play?: "auto" | "click";
        stopAllPrevious?: boolean;
        stopOnExit?: boolean;
        url: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    loop? offset? play? stopAllPrevious? stopOnExit? url
    loop?: boolean

    Loop the narration (slideshow audio.loop). Absent means no loop. Note: a looping narration never fires ended, so autoplay_media falls back to its millisecond timer for that slide. Honored only with slideshow_source.

    offset?: number

    Start offset in seconds (slideshow audio.offset), applied once the audio metadata is available. Absent or negative means 0. Honored only with slideshow_source.

    play?: "auto" | "click"

    auto (default) plays on navigation; click arms the narration paused and lets the visitor start it (slideshow audio.play). Honored only with slideshow_source.

    stopAllPrevious?: boolean

    Stop any other playing narration/ambient track before starting this one (default true). false allows the ambient overlap of two tracks. Honored only with slideshow_source.

    stopOnExit?: boolean

    Stop the narration when leaving the slide (default true). false keeps an audio bed playing across slides while the URL is unchanged (slideshow ambient audio). Honored only with slideshow_source.

    url: string

    Settings
    Member Visibility

    On This Page
    Properties