File: SWF%3A%3ASoundInstance.3pm

package info (click to toggle)
ming 1%3A0.4.3-1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 27,236 kB
  • ctags: 11,055
  • sloc: ansic: 55,058; sh: 9,111; cpp: 3,752; yacc: 2,808; makefile: 2,155; python: 1,864; perl: 1,472; php: 678; tcl: 13
file content (199 lines) | stat: -rw-r--r-- 6,347 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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" ''
'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 turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "SWF::SoundInstance 3"
.TH SWF::SoundInstance 3 "2009-02-08" "perl v5.10.0" "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"
SWF::SoundInstance \- SWF Sound Instance class
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 7
\&        use SWF::Sound;
\&        use SWF::SoundInstance;
\&        $sound = new SWF::Sound("test.mp3");
\&        $snd_instance = $movie\->startSound($sound);
\&        $snd_instance\->loopInPoint(4000);
\&        $snd_instance\->loopOutPoint(8000);
\&        $snd_instance\->loopCount(2);
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
SWF::SoundStream is a helper class useful for setting information
about a sound instance. There is no constructor method,
SWF::SoundStream objects are available only thru:
.IP "\fIstartSound()\fR method of SWF::Movie," 4
.IX Item "startSound() method of SWF::Movie,"
.PD 0
.IP "\fIstartSound()\fR method of SWF::MovieClip," 4
.IX Item "startSound() method of SWF::MovieClip,"
.IP "\fIaddSound()\fR   method of SWF::Button." 4
.IX Item "addSound()   method of SWF::Button."
.PD
.SH "METHODS"
.IX Header "METHODS"
.ie n .IP "$snd_instance\fR\->\fInoMultiple()" 4
.el .IP "\f(CW$snd_instance\fR\->\fInoMultiple()\fR" 4
.IX Item "$snd_instance->noMultiple()"
Prohibits starting sound if sound is already playing.
.ie n .IP "$snd_instance\->loopInPoint($point)" 4
.el .IP "\f(CW$snd_instance\fR\->loopInPoint($point)" 4
.IX Item "$snd_instance->loopInPoint($point)"
Sets the loop start \f(CW$point\fR counted in samples.
.ie n .IP "$snd_instance\->loopOutPoint($point)" 4
.el .IP "\f(CW$snd_instance\fR\->loopOutPoint($point)" 4
.IX Item "$snd_instance->loopOutPoint($point)"
Sets the loop's last sample to play.
.ie n .IP "$snd_instance\->loopCount($count)" 4
.el .IP "\f(CW$snd_instance\fR\->loopCount($count)" 4
.IX Item "$snd_instance->loopCount($count)"
Sets loop count. The default value is 1 loop.
.ie n .IP "$snd_instance\fR\->addEnvelope($mark44, \f(CW$left\fR, \f(CW$right)" 4
.el .IP "\f(CW$snd_instance\fR\->addEnvelope($mark44, \f(CW$left\fR, \f(CW$right\fR)" 4
.IX Item "$snd_instance->addEnvelope($mark44, $left, $right)"
Adds a SoundEnvelope to event sound. Parameters are \f(CW$mark44\fR, the  Position in 44khz samples,
and volumes both for left and right stereo channel.
Next example will mute the right channel:
.Sp
.Vb 1
\&        $snd_instance\->addEnvelope(0,10000,0);
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
developers of ming.sourceforge.net, Albrecht Kleine
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1SWF\s0, \s-1SWF::\s0 Movie, SWF::MovieClip, SWF::Button, SWF::Sound, SWF::SoundStream, SWF::Constants