Annotation Pro API
Public Member Functions | Static Public Member Functions | Properties | List of all members
SegmentationModuleObject Class Reference

Segmentation module object. More...

Public Member Functions

void Save (string modulePath)
 Saves module to given folder. More...
 
bool SupportsMode (SegmentationMode mode)
 True if supports given segmentation mode. More...
 

Static Public Member Functions

static SegmentationModuleObject Load (string modulePath)
 Loads segmentation module from folder. More...
 

Properties

string Author [get, set]
 Author of plugin. More...
 
string Description [get, set]
 Plugin description. More...
 
string Language [get, set]
 Plugin supported language. More...
 
StringBuilder Log [get, set]
 Module log. More...
 
string ModulePath = 15000 [get, set]
 Module path. More...
 
string Name [get, set]
 Name of plugin. More...
 
string PhonemesExecuteCommand [get, set]
 Command to execute phonemes segmentation. More...
 
bool ShowConsoleWindow = new StringBuilder() [get, set]
 If true shows console windows during segmentation. More...
 
IList< SegmentationModeSupportedModes = false [get, set]
 Supportes segmentation modes More...
 
string SyllablesExecuteCommand [get, set]
 Command to execute syllables segmentation. More...
 
int Timeout [get, set]
 Timeout after application cancel segmentation. More...
 
string Version [get, set]
 Plugin version. More...
 
string WordsExecuteCommand [get, set]
 Command to execute words segmentation. More...
 

Detailed Description

Segmentation module object.

Member Function Documentation

◆ Load()

static SegmentationModuleObject Load ( string  modulePath)
inlinestatic

Loads segmentation module from folder.

Parameters
modulePathfolder with module
Returns

◆ Save()

void Save ( string  modulePath)
inline

Saves module to given folder.

Parameters
modulePathFolder to save module

◆ SupportsMode()

bool SupportsMode ( SegmentationMode  mode)
inline

True if supports given segmentation mode.

Parameters
modeSegmentation mode
Returns

Property Documentation

◆ Author

string Author
getset

Author of plugin.

◆ Description

string Description
getset

Plugin description.

◆ Language

string Language
getset

Plugin supported language.

◆ Log

StringBuilder Log
getset

Module log.

◆ ModulePath

string ModulePath = 15000
getset

Module path.

◆ Name

string Name
getset

Name of plugin.

◆ PhonemesExecuteCommand

string PhonemesExecuteCommand
getset

Command to execute phonemes segmentation.

◆ ShowConsoleWindow

bool ShowConsoleWindow = new StringBuilder()
getset

If true shows console windows during segmentation.

◆ SupportedModes

IList<SegmentationMode> SupportedModes = false
getset

Supportes segmentation modes

◆ SyllablesExecuteCommand

string SyllablesExecuteCommand
getset

Command to execute syllables segmentation.

◆ Timeout

int Timeout
getset

Timeout after application cancel segmentation.

◆ Version

string Version
getset

Plugin version.

◆ WordsExecuteCommand

string WordsExecuteCommand
getset

Command to execute words segmentation.


The documentation for this class was generated from the following file: