Obi Configuration File Documentation

Import and Export using configuration file

Normally Import and Export in obi requires user to set some parameters through dialog boxes, but with the help of configuration file we can bypass these dialog boxes by setting all the requisite parameters in configuration file itself. The details of the configuration parameters are as follows:

Contents of configuration file

Configuration file should consists of following

Import Parameters :

Element name: import
Description: Parent node for import parameters. It has single occurrence. It shall have the following children.

Obi project directory

Element Name : obiprojectdirectory
Description : It contains destination of the project directory at which the new Obi project will be created
Example: <obiprojectdirectory>c:\obi_projects_project-name</obiprojectdirectory>

Audio sample rate

Element Name : audiosamplerate
Description : It sets the Audio sample rate in Hertz for the project during import.
Accepted values:

• 44100
• 22050
• 11025

Audio channels

Element Name : audiochannels
Description : It is set to 1 for mono project and 2 for the stereo project.

Export Parameters

Element name: export
Description: Parent node for export parameters. It has single occurrence till Obi 3.6, while 1 to 3 occurrences are allowed from version 3.7 beta to enable simultaneous export in multiple formats. It shall have the following children.

Directory

Element Name : directory
Description : It contains path of the output folder in which exported files are saved

Standard

Element Name : standard
Description : It sets type of Export. Obi supports namely Daisy 3,Daisy 2.02 format and Epub 3.

Accepted values:

• daisy3
• daisy2.02
• epub3

Audio encoding

Element Name : audioencoding
Description : It sets format of audio files during export.

Accepted values

• wav
• mp3
• mp4
• m4a

Remark: Please note that for encoding the audio files in the mp4/m4a audio format, you will need to download the ffmpeg.exe library

Audio sample rate

Element Name : audiosamplerate
Description : It sets the Audio sample rate during export.For example if you want to set sample rate as 4100 then simply set 44100 as sampling rate

Accepted values:

• 44100
• 22050
• 11025

Audio channels

Element Name : audiochannels :
Description : It is set to 1 for mono project and 2 for the stereo project

Bitrate

Element Name : bitrate
Description : It sets bitrate of the MP3 files to be exported. It will be neglected in case of WAV files

Accepted values:

• 32
• 40
• 48
• 56
• 64
• 128
• 196
• 256