~michael-sheldon/jokosher/crash_protection

« back to all changes in this revision

Viewing changes to doc/api/Globals.html

  • Committer: davidc
  • Date: 2007-01-02 08:11:10 UTC
  • Revision ID: svn-v3-trunk1:8cf4620e-9a09-0410-af63-e2e309b9c8e0:JonoEdit%2Ftrunk:1115
Updated documentation and theme.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
1
 
2
2
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3
3
<html><head><title>Python: module Globals</title>
4
 
</head><body bgcolor="#f0f0f8">
 
4
</head><body bgcolor="#ffffff">
5
5
 
6
6
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7
 
<tr bgcolor="#7799ee">
 
7
<tr bgcolor="#fcbb58">
8
8
<td valign=bottom>&nbsp;<br>
9
9
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>Globals</strong></big></big></font></td
10
10
><td align=right valign=bottom
11
 
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/mike/src/jokosher/trunk/Jokosher/Globals.py">/home/mike/src/jokosher/trunk/Jokosher/Globals.py</a></font></td></tr></table>
 
11
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/david/Projects/Jokosher/trunk/Jokosher/Globals.py">/home/david/Projects/Jokosher/trunk/Jokosher/Globals.py</a></font></td></tr></table>
12
12
    <p><tt>#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;THIS&nbsp;FILE&nbsp;IS&nbsp;PART&nbsp;OF&nbsp;THE&nbsp;JOKOSHER&nbsp;PROJECT&nbsp;AND&nbsp;LICENSED&nbsp;UNDER&nbsp;THE&nbsp;GPL.&nbsp;SEE<br>
13
13
#&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;THE&nbsp;'COPYING'&nbsp;FILE&nbsp;FOR&nbsp;DETAILS<br>
14
14
#<br>
21
21
#-------------------------------------------------------------------------------</tt></p>
22
22
<p>
23
23
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
24
 
<tr bgcolor="#aa55cc">
 
24
<tr bgcolor="#4e9a06">
25
25
<td colspan=3 valign=bottom>&nbsp;<br>
26
26
<font color="#fffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
27
27
    
28
 
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 
28
<tr><td bgcolor="#4e9a06"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
29
29
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="ConfigParser.html">ConfigParser</a><br>
30
30
<a href="gettext.html">gettext</a><br>
31
31
</td><td width="25%" valign=top><a href="gobject.html">gobject</a><br>
32
32
<a href="gtk.html">gtk</a><br>
33
33
</td><td width="25%" valign=top><a href="locale.html">locale</a><br>
34
34
<a href="os.html">os</a><br>
35
 
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
 
35
</td><td width="25%" valign=top><a href="pygtk.html">pygtk</a><br>
 
36
</td></tr></table></td></tr></table><p>
36
37
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
37
 
<tr bgcolor="#ee77aa">
 
38
<tr bgcolor="#3465a4">
38
39
<td colspan=3 valign=bottom>&nbsp;<br>
39
40
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
40
41
    
41
 
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 
42
<tr><td bgcolor="#3465a4"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
42
43
<td width="100%"><dl>
43
44
<dt><font face="helvetica, arial"><a href="Globals.html#Settings">Settings</a>
44
45
</font></dt></dl>
45
46
 <p>
46
47
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
47
 
<tr bgcolor="#ffc8d8">
 
48
<tr bgcolor="#729fcf">
48
49
<td colspan=3 valign=bottom>&nbsp;<br>
49
50
<font color="#000000" face="helvetica, arial"><a name="Settings">class <strong>Settings</strong></a></font></td></tr>
50
51
    
51
 
<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 
52
<tr bgcolor="#729fcf"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 
53
<td colspan=2><tt>Handles&nbsp;loading/saving&nbsp;settings&nbsp;from/to&nbsp;a&nbsp;file&nbsp;on&nbsp;disk.<br>&nbsp;</tt></td></tr>
 
54
<tr><td>&nbsp;</td>
52
55
<td width="100%">Methods defined here:<br>
53
 
<dl><dt><a name="Settings-__init__"><strong>__init__</strong></a>(self, filename<font color="#909090">=None</font>)</dt></dl>
54
 
 
55
 
<dl><dt><a name="Settings-read"><strong>read</strong></a>(self)</dt><dd><tt>Read&nbsp;in&nbsp;configuration&nbsp;settings&nbsp;from&nbsp;the&nbsp;config&nbsp;file</tt></dd></dl>
56
 
 
57
 
<dl><dt><a name="Settings-write"><strong>write</strong></a>(self)</dt><dd><tt>Write&nbsp;config&nbsp;settings&nbsp;to&nbsp;the&nbsp;config&nbsp;file</tt></dd></dl>
 
56
<dl><dt><a name="Settings-__init__"><strong>__init__</strong></a>(self, filename<font color="#909090">=None</font>)</dt><dd><tt>Creates&nbsp;a&nbsp;new&nbsp;instance&nbsp;of&nbsp;<a href="#Settings">Settings</a>.<br>
 
57
&nbsp;<br>
 
58
Parameters:<br>
 
59
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;filename&nbsp;--&nbsp;path&nbsp;to&nbsp;the&nbsp;settings&nbsp;file.<br>
 
60
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;None,&nbsp;the&nbsp;default&nbsp;~/.jokosher/config&nbsp;will&nbsp;be&nbsp;used.</tt></dd></dl>
 
61
 
 
62
<dl><dt><a name="Settings-read"><strong>read</strong></a>(self)</dt><dd><tt>Reads&nbsp;configuration&nbsp;settings&nbsp;from&nbsp;the&nbsp;config&nbsp;file&nbsp;and&nbsp;loads<br>
 
63
then&nbsp;into&nbsp;the&nbsp;<a href="#Settings">Settings</a>&nbsp;dictionaries.</tt></dd></dl>
 
64
 
 
65
<dl><dt><a name="Settings-write"><strong>write</strong></a>(self)</dt><dd><tt>Writes&nbsp;configuration&nbsp;settings&nbsp;to&nbsp;the&nbsp;<a href="#Settings">Settings</a>&nbsp;config&nbsp;file.</tt></dd></dl>
58
66
 
59
67
<hr>
60
68
Data and other attributes defined here:<br>
61
 
<dl><dt><strong>general</strong> = {'mixdownformat': 'value', 'recentprojects': '/home/mike/src/jokosher/trunk/Jokosher/Test3/Tes...okosher/trunk/New Test/New Test.jokosher|New Test', 'sampleformat': 'value', 'samplerate': 'value', 'startupaction': 'value'}</dl>
62
 
 
63
 
<dl><dt><strong>playback</strong> = {'device': 'value', 'devicecardnum': 'value'}</dl>
64
 
 
65
 
<dl><dt><strong>recording</strong> = {'device': 'value', 'devicecardnum': 'value', 'fileformat': 'value'}</dl>
 
69
<dl><dt><strong>extensions</strong> = {'extensions_blacklist': ''}</dl>
 
70
 
 
71
<dl><dt><strong>general</strong> = {'mixdownformat': 'value', 'projectfolder': '/home/david/mp3/Fourplay/The Best of Fourplay', 'recentprojects': '/home/david/tmp/Effects/Effects.jokosher|Effects...baJokosher/PruebaJokosher.jokosher|PruebaJokosher', 'startupaction': 'lastproject'}</dl>
 
72
 
 
73
<dl><dt><strong>playback</strong> = {'audiosink': 'autoaudiosink', 'device': 'C-Media PCI IEC958', 'devicecardnum': 'hw:0'}</dl>
 
74
 
 
75
<dl><dt><strong>recording</strong> = {'fileformat': 'vorbisenc ! oggmux', 'samplerate': '44100'}</dl>
66
76
 
67
77
</td></tr></table></td></tr></table><p>
68
78
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
69
 
<tr bgcolor="#eeaa77">
 
79
<tr bgcolor="#c17d11">
70
80
<td colspan=3 valign=bottom>&nbsp;<br>
71
81
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
72
82
    
73
 
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
74
 
<td width="100%"><dl><dt><a name="-getCachedInstruments"><strong>getCachedInstruments</strong></a>()</dt><dd><tt>Create&nbsp;the&nbsp;instrument&nbsp;cache&nbsp;if&nbsp;it&nbsp;hasn't&nbsp;been&nbsp;<br>
75
 
created&nbsp;already&nbsp;and&nbsp;return&nbsp;the&nbsp;list.</tt></dd></dl>
76
 
 <dl><dt><a name="-idleCacheInstruments"><strong>idleCacheInstruments</strong></a>()</dt></dl>
 
83
<tr><td bgcolor="#c17d11"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 
84
<td width="100%"><dl><dt><a name="-PopulateEncoders"><strong>PopulateEncoders</strong></a>()</dt><dd><tt>Check&nbsp;if&nbsp;the&nbsp;hardcoded&nbsp;list&nbsp;of&nbsp;encoders&nbsp;is&nbsp;available&nbsp;on&nbsp;the&nbsp;system.</tt></dd></dl>
 
85
 <dl><dt><a name="-PrintPipelineDebug"><strong>PrintPipelineDebug</strong></a>(message, pipeline)</dt><dd><tt>Prints&nbsp;debugging&nbsp;information&nbsp;for&nbsp;the&nbsp;GStreamer&nbsp;pipeline.<br>
 
86
&nbsp;<br>
 
87
Parameters:<br>
 
88
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;message&nbsp;--&nbsp;GStreamer&nbsp;message&nbsp;to&nbsp;be&nbsp;printed&nbsp;as&nbsp;debugging&nbsp;output.<br>
 
89
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;pipeline&nbsp;--&nbsp;the&nbsp;currently&nbsp;active&nbsp;Project's&nbsp;main&nbsp;pipeline.</tt></dd></dl>
 
90
 <dl><dt><a name="-debug"><strong>debug</strong></a>(*listToPrint)</dt><dd><tt>Global&nbsp;debug&nbsp;function&nbsp;to&nbsp;redirect&nbsp;all&nbsp;the&nbsp;debugging&nbsp;output&nbsp;from&nbsp;the&nbsp;other<br>
 
91
methods.<br>
 
92
&nbsp;<br>
 
93
Parameters:<br>
 
94
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*listToPrint&nbsp;--&nbsp;list&nbsp;of&nbsp;elements&nbsp;to&nbsp;append&nbsp;to&nbsp;the&nbsp;debugging&nbsp;output.</tt></dd></dl>
 
95
 <dl><dt><a name="-getCachedInstruments"><strong>getCachedInstruments</strong></a>(checkForNew<font color="#909090">=False</font>)</dt><dd><tt>Creates&nbsp;the&nbsp;Instrument&nbsp;cache&nbsp;if&nbsp;it&nbsp;hasn't&nbsp;been&nbsp;created&nbsp;already&nbsp;and<br>
 
96
return&nbsp;it.<br>
 
97
&nbsp;<br>
 
98
Parameters:<br>
 
99
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;checkForNew&nbsp;--&nbsp;&nbsp;True&nbsp;=&nbsp;scan&nbsp;the&nbsp;Instrument&nbsp;folders&nbsp;for&nbsp;new_dir.<br>
 
100
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;False&nbsp;=&nbsp;don't&nbsp;scan&nbsp;for&nbsp;new&nbsp;Instruments.<br>
 
101
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<br>
 
102
Returns:<br>
 
103
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a&nbsp;list&nbsp;with&nbsp;the&nbsp;Instruments&nbsp;cached&nbsp;in&nbsp;memory.</tt></dd></dl>
 
104
 <dl><dt><a name="-idleCacheInstruments"><strong>idleCacheInstruments</strong></a>()</dt><dd><tt>Loads&nbsp;the&nbsp;Instruments&nbsp;'lazily'&nbsp;to&nbsp;avoid&nbsp;blocking&nbsp;the&nbsp;GUI.<br>
 
105
&nbsp;<br>
 
106
Returns:<br>
 
107
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;True&nbsp;--&nbsp;keep&nbsp;calling&nbsp;itself&nbsp;to&nbsp;load&nbsp;more&nbsp;Instruments.<br>
 
108
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;False&nbsp;--&nbsp;stop&nbsp;calling&nbsp;itself&nbsp;and&nbsp;sort&nbsp;Instruments&nbsp;alphabetically.</tt></dd></dl>
77
109
</td></tr></table><p>
78
110
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
79
111
<tr bgcolor="#55aa55">
81
113
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
82
114
    
83
115
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
84
 
<td width="100%"><strong>EFFECT_PRESETS_PATH</strong> = '/home/mike/src/jokosher/trunk/Jokosher/../effectspresets'<br>
 
116
<td width="100%"><strong>AVAILABLE_EXTENSIONS</strong> = []<br>
 
117
<strong>DEBUG_GST</strong> = False<br>
 
118
<strong>DEBUG_STDOUT</strong> = False<br>
 
119
<strong>EFFECT_PRESETS_PATH</strong> = '/home/david/Projects/Jokosher/trunk/Jokosher/../effectspresets'<br>
85
120
<strong>EFFECT_PRESETS_VERSION</strong> = None<br>
86
 
<strong>GLADE_PATH</strong> = '/home/mike/src/jokosher/trunk/Jokosher/Jokosher.glade'<br>
87
 
<strong>IMAGE_PATH</strong> = '/home/mike/src/jokosher/trunk/Jokosher/../images'<br>
 
121
<strong>EXPORT_FORMATS</strong> = []<br>
 
122
<strong>EXTENSION_PATHS</strong> = ('/home/david/Projects/Jokosher/trunk/Jokosher/../extensions', '/home/david/.jokosher/extensions/')<br>
 
123
<strong>GLADE_PATH</strong> = '/home/david/Projects/Jokosher/trunk/Jokosher/Jokosher.glade'<br>
 
124
<strong>HELP_PATH</strong> = '/home/david/Projects/Jokosher/trunk/Jokosher/../help/jokosher/C/jokosher.xml'<br>
 
125
<strong>IMAGE_PATH</strong> = '/home/david/Projects/Jokosher/trunk/Jokosher/../images'<br>
88
126
<strong>INSTRUMENT_HEADER_WIDTH</strong> = 0<br>
89
 
<strong>JOKOSHER_PATH</strong> = '/home/mike/src/jokosher/trunk/Jokosher'<br>
 
127
<strong>INSTR_PATHS</strong> = ('/home/david/Projects/Jokosher/trunk/Jokosher/../Instruments', '/home/david/.jokosher/instruments')<br>
 
128
<strong>LADSPA_CATEGORIES_MAP</strong> = [('', ['', ''])]<br>
90
129
<strong>LADSPA_FACTORY_REGISTRY</strong> = None<br>
91
130
<strong>LADSPA_NAME_MAP</strong> = []<br>
92
131
<strong>LOCALE_APP</strong> = 'jokosher'<br>
93
 
<strong>LOCALE_DIR</strong> = '/home/mike/src/jokosher/trunk/Jokosher/../locale'<br>
94
 
<strong>VERSION</strong> = None<br>
 
132
<strong>LOCALE_PATH</strong> = '/home/david/Projects/Jokosher/trunk/Jokosher/../locale'<br>
 
133
<strong>SAMPLE_RATES</strong> = [8000, 11025, 22050, 32000, 44100, 48000, 96000, 192000]<br>
 
134
<strong>USE_LOCAL_HELP</strong> = True<br>
 
135
<strong>VERSION</strong> = '0.2'<br>
 
136
<strong>current_locale</strong> = 'C'<br>
 
137
<strong>data_path</strong> = '/home/david/Projects/Jokosher/trunk/Jokosher'<br>
95
138
<strong>instrumentPropertyList</strong> = []<br>
96
139
<strong>settings</strong> = &lt;Globals.Settings instance&gt;</td></tr></table>
97
140
</body></html>
 
 
b'\\ No newline at end of file'