create Media Overlay Sync Media Timeline
Creates a new EPUB Media Overlay SyncMediaTimeline if available in the publication.
You can check if this publication contains Media Overlays by checking if availableSyncMediaFormats contains SyncMediaFormat.EPUB_MEDIA_OVERLAY.
For more information about EPUB Media Overlays, see: https://www.w3.org/publishing/epub3/epub-mediaoverlays.html
Parameters
The reader documents that should be part of the timeline.
Configuration of the timeline.
Called when the SyncMediaTimeline has been created successfully.
Called if there was an error creating the timeline.
A function called several times indicating the create progress as a value between 0 and 1.
Creates a new EPUB Media Overlay SyncMediaTimeline if available in the publication.
You can check if this publication contains Media Overlays by checking if availableSyncMediaFormats contains SyncMediaFormat.EPUB_MEDIA_OVERLAY.
For more information about EPUB Media Overlays, see: https://www.w3.org/publishing/epub3/epub-mediaoverlays.html
Return
Either ColibrioResult.Success when the SyncMediaTimeline has been created successfully, or ColibrioResult.Error if an error occurred while creating the timeline.
Parameters
The reader documents that should be part of the timeline.
Configuration of the timeline.
A function called several times indicating the create progress as a value between 0 and 1.
Creates a new EPUB Media Overlay SyncMediaTimeline if available in the publication.
You can check if this publication contains Media Overlays by checking if availableSyncMediaFormats contains SyncMediaFormat.EPUB_MEDIA_OVERLAY.
This method will use default MediaOverlaySyncMediaTimelineConfiguration
For more information about EPUB Media Overlays, see: https://www.w3.org/publishing/epub3/epub-mediaoverlays.html
Parameters
The reader documents that should be part of the timeline.
Called when the SyncMediaTimeline has been created successfully.
Called if there was an error creating the timeline.
A function called several times indicating the create progress as a value between 0 and 1.
Creates a new EPUB Media Overlay SyncMediaTimeline if available in the publication.
You can check if this publication contains Media Overlays by checking if availableSyncMediaFormats contains SyncMediaFormat.EPUB_MEDIA_OVERLAY.
This method will use default MediaOverlaySyncMediaTimelineConfiguration
For more information about EPUB Media Overlays, see: https://www.w3.org/publishing/epub3/epub-mediaoverlays.html
Return
Either ColibrioResult.Success when the SyncMediaTimeline has been created successfully, or ColibrioResult.Error if an error occurred while creating the timeline.
Parameters
The reader documents that should be part of the timeline.
A function called several times indicating the create progress as a value between 0 and 1.