Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface ISyncMediaTtsTimelineContentTransformationOptions

    Options related to how content is generated for TTS SyncMediaTimelines.

    interface ISyncMediaTtsTimelineContentTransformationOptions {
        contentBlockAttributeExclusions?: ISyncMediaTtsContentBlockAttributeExclusion[];
        imageAltTextPrefix?: string;
        normalizeQuotationMarks?: boolean;
    }

    Properties

    contentBlockAttributeExclusions?: ISyncMediaTtsContentBlockAttributeExclusion[]

    Content blocks carrying an attribute that matches one of these exclusions are left out of the timeline, together with their descendants.

    NOTE: Setting this option replaces the default list instead of adding to it, so restate any default entry you want to keep. Set an empty list to exclude nothing.

    Only attributes that a content block exposes can be matched. By default those are role, any aria-* attribute, epub:type, lang, xml:lang, the attributes listed in ContentBlockMicrodataAttribute and ContentBlockRdfAttribute, id, alt, alttext and title.

    To match any other attribute, such as hidden or a data-* attribute, add it to IEpubContentBlockOptions.attributeNamesThatCreateContentBlocks when loading the publication. That list replaces the default set of attributes that create content blocks. Include every default name you still rely on. If role and aria-hidden are missing from your list, elements such as div and span no longer become content blocks because of those attributes, and the exclusions above silently stop matching them.

    IEpubContentBlockOptions.disableDefaultAttributeFiltering exposes all of a content block's attributes, but does not turn an element into a content block. Neither option can be changed after the publication loads.

    This option has no effect for PDF publications, whose content blocks expose no attributes.

    [{"name": "role", "values": ["presentation", "none"]}, {"name": "aria-hidden", "values": ["true"]}]
    imageAltTextPrefix?: string

    Text that will be prepended to alt text when reading an image element. Defaults to empty string

    normalizeQuotationMarks?: boolean

    If set to true, then:

    • all Unicode double quotation mark characters are replaced with the standard U+0022 Quotation mark (").
    • all Unicode single quotation mark characters are replaced with the standard U+0027 Apostrophe (').

    This may increase compatibility with some TTS Voices which may not work correctly otherwise.

    If set to false, quotation mark characters are left untouched.

    true
    Properties