Packagecom.acapela.vaas.advanced.synchro
Classpublic class BookmarkPosition

A bookmark position associates a bookmark of the speech (generated by a \mrk=id\ tag in the text) to its id and the corresponding timestamp in the generated sound.

Bookmark position in a message is represented by tag \mrk=id\.
Attention: the declaration for a bookmark in a string likes "... \\mrk=id\\ ..."

When the bookmark manager is actived for generating message, you have an access to all the bookmark positions corresponding to the message with the property bookmarkPositions of PositionsManagement. You should access it only from the BOOKMARK_POSITIONS_AVAILABLE event handlers.

See also

com.acapela.vaas.advanced.synchro.WordPosition
com.acapela.vaas.advanced.synchro.MouthPosition
com.acapela.vaas.advanced.Player
com.acapela.vaas.advanced.Player.synchroBookmarkPosition
com.acapela.vaas.advanced.synchro.PositionsManager
com.acapela.vaas.advanced.synchro.PositionsManager.bookmarkPositionsAvailable


Public Properties
 PropertyDefined by
  id : Number
[read-only] The identifier of the bookmark.
BookmarkPosition
  index : Number
[read-only] Index of this bookmark in text message request.
BookmarkPosition
  timestamp : Number
[read-only] the corressponding time stamp
BookmarkPosition
Public Methods
 MethodDefined by
  
BookmarkPosition(index:Number, id:Number, timestamp:Number)
Create a new BookmarkPosition object instance.
BookmarkPosition
Property detail
idproperty
id:Number  [read-only]

The identifier of the bookmark. Two bookmarks can have the same value.

Implementation
    public function get id():Number
indexproperty 
index:Number  [read-only]

Index of this bookmark in text message request. The first bookmark in message has index 0.

Implementation
    public function get index():Number
timestampproperty 
timestamp:Number  [read-only]

the corressponding time stamp

Implementation
    public function get timestamp():Number
Constructor detail
BookmarkPosition()constructor
public function BookmarkPosition(index:Number, id:Number, timestamp:Number)

Create a new BookmarkPosition object instance.

Parameters
index:Number
 
id:Number
 
timestamp:Number