StoryMapJS API
    Preparing search index...

    Interface StorymapSlideMedia

    Public data and options types for constructing a StoryMap.

    The data types are exported rather than only referenced: they are what a host actually types its document and options with, and TypeDoc warns about a documented member whose type it cannot link.

    interface StorymapSlideMedia {
        alt?: string | null;
        caption?: string | null;
        credit?: string | null;
        loop?: boolean;
        mediatype?: MediaTypeMatch | null;
        offset?: number;
        play?: "auto" | "click";
        stopOnExit?: boolean;
        subtitles?: string | null;
        thumb?: string | null;
        url?: string | null;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    alt? caption? credit? loop? mediatype? offset? play? stopOnExit? subtitles? thumb? url?
    alt?: string | null

    Accessible description of the media, used as the image's alt when the media is an image. In IIIF this is the painting annotation's accessibilitySummary.

    caption?: string | null
    credit?: string | null
    loop?: boolean

    Loop audio/video media (slideshow audio.loop). Absent means no loop. Honored only with slideshow_source.

    mediatype?: MediaTypeMatch | null
    offset?: number

    Start offset in seconds for audio/video media (slideshow audio.offset). Applied once the media metadata is available; absent or negative means 0. Honored only with slideshow_source.

    play?: "auto" | "click"

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

    stopOnExit?: boolean

    Stop this media when leaving the slide (default true). false lets an audio bed continue across slides (slideshow ambient audio). Honored only with slideshow_source.

    subtitles?: string | null

    WebVTT subtitle file for an audio or video slide, rendered as a <track kind="subtitles">. IIIF has no subtitle term, so this stays a storymap-JSON field; the authoring guide notes the TextualBody + format: text/vtt shape we also accept.

    thumb?: string | null
    url?: string | null

    Settings
    Member Visibility

    On This Page
    Properties