Warning, /multimedia/subtitlecomposer/src/scripting/examples/README is written in an unsupported language. File is not indexed.
0001 SUBTITLE COMPOSER SCRIPTING README 0002 ================================== 0003 0004 There's currently no real documentation but the examples and the included API 0005 (see 'api' directory) should give you enough information to get started. 0006 0007 Besides the corresponding interpreter framework and Kross defined modules (i18n, 0008 forms, etc.), scripts can access some modules specific to Subtitle Composer that 0009 provide methods to access global objects, enum values and/or create other objects: 0010 0011 ranges: 0012 contains methods to create ranges and ranges lists, including a range list 0013 describing the current selection ranges. 0014 0015 strings: 0016 contains only one method for creating styled string objects and provides 0017 access to the StyleFlag enum values, used to get/set styling information 0018 (see SString class *StyleFlag* methods). 0019 0020 subtitle: 0021 contains methods to access the subtitle instance and query the translation 0022 mode state (true when there's an open translation, false otherwise). It also 0023 provides access to TextTarget enum values, used to specify the target (primary 0024 text, secondary text/translation, or both) in subtitle operations that modify 0025 text (i.e., lowerCase(...) or breakLines(...) methods). 0026 0027 subtitleline: 0028 provides access to the ErrorFlag enum values, used to specify errors bits in 0029 error manipulation methods on both Subtitle and SubtitleLine classes. 0030 0031 debug: 0032 contains three functions (information, warning and error) that can be used 0033 while debuging scripts 0034 0035 Using these modules you can access objects to do pretty much anything the main 0036 application can do. Included are some basic examples showcasing some of the 0037 things you can do. If you have other scripts you consider worth sharing then send 0038 them to me and I'll consider them for inclusion with the program.