.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Audio::Nama::Globals 3pm" .TH Audio::Nama::Globals 3pm "2017-03-27" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Audio::Nama::Globals \- Nama global variables .SS "Exported" .IX Subsection "Exported" Audio::Nama::Globals exports Nama globals, which it gets by merging the contents of the following files: .IP "\fIvar_pronouns\fR" 4 .IX Item "var_pronouns" Pronouns (e.g. \f(CW$this_track\fR) and indices (e.g. \f(CW%tn\fR, get track by name) .IP "\fIvar_serialize\fR" 4 .IX Item "var_serialize" Marshalling variables for serializing/deserializing (e.g. \f(CW@tracks_data\fR) .IP "\fIvar_singletons\fR" 4 .IX Item "var_singletons" Simple hash structures (such as \f(CW$config\fR) or objects such as \fI\f(CI$file\fI\fR that aggregate data. The hashes can be invested with object properties as need be. .SS "Other lists" .IX Subsection "Other lists" .IP "\fIvar_config\fR" 4 .IX Item "var_config" Maps keys in \fI.namarc\fR (e.g. \fImix_to_disk_format\fR) to the corresponding Nama internal scalar (e.g. \f(CW\*(C`$config\->{mix_to_disk_format}\*(C'\fR .IP "\fIvar_keys\fR" 4 .IX Item "var_keys" List of allowed singleton hash keys. .Sp Keys of variables appearing in ./var_singletons should be listed in var_keys or in var_config. Undeclared keys will trigger warnings during build. .SS "\fIvar_lists\fP" .IX Subsection "var_lists" Declares lists of variables used in serializing/deserializing. .ie n .IP "@global_effect_chain_vars" 4 .el .IP "\f(CW@global_effect_chain_vars\fR" 4 .IX Item "@global_effect_chain_vars" Mainly user defined and system-wide effect chains, stored in \fIglobal_effect_chains.json\fR in the Nama project root directory. .ie n .IP "@tracked_vars" 4 .el .IP "\f(CW@tracked_vars\fR" 4 .IX Item "@tracked_vars" These variables are saved to \fIState.json\fR in the project directory and placed under version control. .ie n .IP "@persistent_vars" 4 .el .IP "\f(CW@persistent_vars\fR" 4 .IX Item "@persistent_vars" These Variables saved to \fIAux.json\fR, \fInot\fR under version control. including project-specific effect-chain definitions, and track/version comments.