Vachak
Last updated
Last updated
Vachak (Reverie's Web Reader) is a powerful and user-friendly tool that enhances your online reading experience by providing Reverie text-to-speech functionality, allowing you to listen to web content as you browse supported with 12 official indian languages.
To integrate the Web Reader you have to add two scripts in your html file.
First one will be added in the head tag which will get the bundle.
With the help of second script you will be able to call the the vachak() method which will create the player UI and render it to webpage
Note: Here, the ‘API-KEY’ and ‘PROJECT-ID’ are provided by the Reverie team.
Parameter | Description |
---|---|
Language | Language Code |
---|---|
Hindi
Assamese
Odia
Kannada
Bengali
Gujarati
Tamil
Malayalam
Punjabi
Marathi
Telugu
Indian English
apikey projectId
These serve as authentication parameters. The apikey is a unique identifier Reverie provides to the client for application identification and authentication. The projectId is a specific identifier for your project
UiConfig
This object contains configurations for the user interface of the vachak audio player
UiConfig.position
Sets the initial position of the audio player on the screen. Users can specify the distance from the top and left on the screen.
UiConfig.fontFamily
Specifies the font family to be used in the Vachak UI
UiConfig.theme
Sets the color theme of the UI. The color can be specified in any format, such as #BF711F (a shade of orange)
UiConfig.size
Sets the font size of the text in Vachak. Options include small, medium, or large.
UiConfig.draggable
Specifies whether Vachak is draggable (can be moved). It is set to true by default, allowing users to move Vachak to their desired location.
UiConfig.type
Can be default, replaceable or draggable according to user’s preference. It is an optional parameter.
sourceLanguage
Specifies the source language for the text. For example, "en" for English.
textNodes
An array containing the class names of the text nodes for which audio needs to be generated. The array can be empty ([]) indicating that audio for the entire page is to be generated. Provide the actual class names of the HTML elements containing the text intended for conversion to audio.
version
Specifies the version of Vachak. Options include "v1.1" or “v1”
Hindi
hi
Assamese
as
Bengali
bn
Gujarati
gu
Kannada
kn
Malayalam
ml
Marathi
mr
Odia
or
Punjabi
pa
Tamil
ta
Telugu
te
Indian English
en