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

    Interface IPlatformWorkaroundOptions

    Options for various browser/platform specific workarounds.

    interface IPlatformWorkaroundOptions {
        escapeXmlInTtsUtterancesOnSafari26?: boolean;
        firefoxCspConnectDomains?: string[];
        prepareSyncMediaAudioElementsOnFirstUserInteraction?: boolean;
        useTouchEventsOnIos?: boolean;
    }

    Properties

    escapeXmlInTtsUtterancesOnSafari26?: boolean

    Escapes XML special characters in TTS utterances to prevent issues on Safari 26.

    On Safari 26, the Text-to-Speech (TTS) engine may incorrectly interpret text strings as SSML. This can cause the TTS service to crash if the text contains unescaped special characters like <, >, or &, which are common in code snippets or other technical content. The TTS service will not recover until the application is restarted.

    When true, those characters are replaced with their corresponding XML entities (&lt;, &gt;, and &amp;) if running on Safari 26, ensuring stable TTS playback.

    true
    firefoxCspConnectDomains?: string[]

    Firefox has a bug where some CSP directives from same-origin iframes "leaks" to the parent frame. This may prevent your app from making XHR POST requests to your servers in Firefox after loading a publication.

    To workaround this bug, add the domains you wish to access using POST requests. These domains will be added to the "connect-src" directive of same-origin child iframes.

    Example: ["'self'", "http://myreaderapp.com", "https://s3.aws.com"]

    You can also use wildcards, see https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP#Examples_Common_use_cases

    prepareSyncMediaAudioElementsOnFirstUserInteraction?: boolean

    Safari requires Audio playback to initiated on a user generated event, such as a click.

    Because of this, the Colibrio Reader's SyncMediaPlayer needs to create a pool of audio elements within such a user generated event.

    By setting this option to true, Colibrio Reader Framework will prepare audio elements on first user interaction.

    false
    useTouchEventsOnIos?: boolean

    Set this option to true to force "touch" events to be used on iPhones and iPads instead of "pointer" events. This option should be enabled when integrating the Colibrio Reader Framework with a Flutter app.

    Please see the following Github issue for more details: https://github.com/flutter/flutter/issues/30143

    false
    Properties