vtt2ass 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,510 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: ASSStyle
8
+
9
+ &mdash; Documentation by YARD 0.9.26
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "ASSStyle";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index (A)</a> &raquo;
40
+
41
+
42
+ <span class="title">ASSStyle</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: ASSStyle
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">ASSStyle</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/vtt2ass/ASSStyle.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>This class defines an ASS style that can be applied on a subtitle line.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#style_name-instance_method" title="#style_name (instance method)">#<strong>style_name</strong> &#x21d2; Object </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+ <span class="note title readonly">readonly</span>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>Returns the value of attribute style_name.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ </ul>
150
+
151
+
152
+
153
+
154
+
155
+ <h2>
156
+ Instance Method Summary
157
+ <small><a href="#" class="summary_toggle">collapse</a></small>
158
+ </h2>
159
+
160
+ <ul class="summary">
161
+
162
+ <li class="public ">
163
+ <span class="summary_signature">
164
+
165
+ <a href="#assignParams-instance_method" title="#assignParams (instance method)">#<strong>assignParams</strong>(params) &#x21d2; Object </a>
166
+
167
+
168
+
169
+ </span>
170
+
171
+
172
+
173
+
174
+
175
+
176
+
177
+
178
+
179
+ <span class="summary_desc"><div class='inline'>
180
+ <p>This method converts the string of VTT styling in values used for ASS styling.</p>
181
+ </div></span>
182
+
183
+ </li>
184
+
185
+
186
+ <li class="public ">
187
+ <span class="summary_signature">
188
+
189
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(style_name, params, font_size, width, height) &#x21d2; ASSStyle </a>
190
+
191
+
192
+
193
+ </span>
194
+
195
+
196
+ <span class="note title constructor">constructor</span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <span class="summary_desc"><div class='inline'>
206
+ <p>This method creates and instance of an ASSStyle.</p>
207
+ </div></span>
208
+
209
+ </li>
210
+
211
+
212
+ <li class="public ">
213
+ <span class="summary_signature">
214
+
215
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
216
+
217
+
218
+
219
+ </span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'>
230
+ <p>This method assigns the object values to an ASS style line and outputs it.</p>
231
+ </div></span>
232
+
233
+ </li>
234
+
235
+
236
+ </ul>
237
+
238
+
239
+ <div id="constructor_details" class="method_details_list">
240
+ <h2>Constructor Details</h2>
241
+
242
+ <div class="method_details first">
243
+ <h3 class="signature first" id="initialize-instance_method">
244
+
245
+ #<strong>initialize</strong>(style_name, params, font_size, width, height) &#x21d2; <tt><span class='object_link'><a href="" title="ASSStyle (class)">ASSStyle</a></span></tt>
246
+
247
+
248
+
249
+
250
+
251
+ </h3><div class="docstring">
252
+ <div class="discussion">
253
+
254
+ <p>This method creates and instance of an ASSStyle.</p>
255
+ <ul><li>
256
+ <p>Requires <code>style_name</code>, a string name for the style as input.</p>
257
+ </li><li>
258
+ <p>Requires <code>params</code>, a string of VTT styling as input.</p>
259
+ </li><li>
260
+ <p>Requires a video <code>width</code> as input.</p>
261
+ </li><li>
262
+ <p>Requires a video <code>height</code> as input.</p>
263
+ </li></ul>
264
+
265
+
266
+ </div>
267
+ </div>
268
+ <div class="tags">
269
+
270
+
271
+ </div><table class="source_code">
272
+ <tr>
273
+ <td>
274
+ <pre class="lines">
275
+
276
+
277
+ 13
278
+ 14
279
+ 15
280
+ 16
281
+ 17
282
+ 18
283
+ 19</pre>
284
+ </td>
285
+ <td>
286
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/ASSStyle.rb', line 13</span>
287
+
288
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_style_name'>style_name</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_font_size'>font_size</span><span class='comma'>,</span> <span class='id identifier rubyid_width'>width</span><span class='comma'>,</span> <span class='id identifier rubyid_height'>height</span><span class='rparen'>)</span>
289
+ <span class='ivar'>@width</span> <span class='op'>=</span> <span class='id identifier rubyid_width'>width</span>
290
+ <span class='ivar'>@height</span> <span class='op'>=</span> <span class='id identifier rubyid_height'>height</span>
291
+ <span class='ivar'>@font_size</span> <span class='op'>=</span> <span class='id identifier rubyid_font_size'>font_size</span>
292
+ <span class='ivar'>@style_name</span> <span class='op'>=</span> <span class='id identifier rubyid_style_name'>style_name</span>
293
+ <span class='id identifier rubyid_assignParams'>assignParams</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
294
+ <span class='kw'>end</span></pre>
295
+ </td>
296
+ </tr>
297
+ </table>
298
+ </div>
299
+
300
+ </div>
301
+
302
+ <div id="instance_attr_details" class="attr_details">
303
+ <h2>Instance Attribute Details</h2>
304
+
305
+
306
+ <span id=""></span>
307
+ <div class="method_details first">
308
+ <h3 class="signature first" id="style_name-instance_method">
309
+
310
+ #<strong>style_name</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
311
+
312
+
313
+
314
+
315
+
316
+ </h3><div class="docstring">
317
+ <div class="discussion">
318
+
319
+ <p>Returns the value of attribute style_name.</p>
320
+
321
+
322
+ </div>
323
+ </div>
324
+ <div class="tags">
325
+
326
+
327
+ </div><table class="source_code">
328
+ <tr>
329
+ <td>
330
+ <pre class="lines">
331
+
332
+
333
+ 4
334
+ 5
335
+ 6</pre>
336
+ </td>
337
+ <td>
338
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/ASSStyle.rb', line 4</span>
339
+
340
+ <span class='kw'>def</span> <span class='id identifier rubyid_style_name'>style_name</span>
341
+ <span class='ivar'>@style_name</span>
342
+ <span class='kw'>end</span></pre>
343
+ </td>
344
+ </tr>
345
+ </table>
346
+ </div>
347
+
348
+ </div>
349
+
350
+
351
+ <div id="instance_method_details" class="method_details_list">
352
+ <h2>Instance Method Details</h2>
353
+
354
+
355
+ <div class="method_details first">
356
+ <h3 class="signature first" id="assignParams-instance_method">
357
+
358
+ #<strong>assignParams</strong>(params) &#x21d2; <tt>Object</tt>
359
+
360
+
361
+
362
+
363
+
364
+ </h3><div class="docstring">
365
+ <div class="discussion">
366
+
367
+ <p>This method converts the string of VTT styling in values used for ASS styling.</p>
368
+ <ul><li>
369
+ <p>Requires <code>params</code>, a string of VTT styling as input.</p>
370
+ </li></ul>
371
+
372
+
373
+ </div>
374
+ </div>
375
+ <div class="tags">
376
+
377
+
378
+ </div><table class="source_code">
379
+ <tr>
380
+ <td>
381
+ <pre class="lines">
382
+
383
+
384
+ 25
385
+ 26
386
+ 27
387
+ 28
388
+ 29
389
+ 30
390
+ 31
391
+ 32
392
+ 33
393
+ 34
394
+ 35
395
+ 36
396
+ 37
397
+ 38
398
+ 39
399
+ 40
400
+ 41
401
+ 42
402
+ 43
403
+ 44
404
+ 45
405
+ 46
406
+ 47
407
+ 48
408
+ 49
409
+ 50
410
+ 51
411
+ 52
412
+ 53
413
+ 54
414
+ 55
415
+ 56</pre>
416
+ </td>
417
+ <td>
418
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/ASSStyle.rb', line 25</span>
419
+
420
+ <span class='kw'>def</span> <span class='id identifier rubyid_assignParams'>assignParams</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
421
+ <span class='ivar'>@alignment</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>2</span><span class='tstring_end'>&quot;</span></span>
422
+ <span class='ivar'>@left_margin</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>10</span><span class='tstring_end'>&quot;</span></span>
423
+ <span class='ivar'>@right_margin</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>10</span><span class='tstring_end'>&quot;</span></span>
424
+ <span class='ivar'>@vertical_margin</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>50</span><span class='tstring_end'>&quot;</span></span>
425
+
426
+ <span class='kw'>if</span> <span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>align:middle line:7%</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>then</span>
427
+ <span class='ivar'>@style_name</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>MainTop</span><span class='tstring_end'>&quot;</span></span>
428
+ <span class='ivar'>@vertical_margin</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>30</span><span class='tstring_end'>&quot;</span></span>
429
+ <span class='ivar'>@alignment</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>8</span><span class='tstring_end'>&quot;</span></span>
430
+ <span class='kw'>else</span>
431
+ <span class='id identifier rubyid_param_count'>param_count</span> <span class='op'>=</span> <span class='int'>0</span>
432
+ <span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'> </span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span> <span class='id identifier rubyid_p'>p</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>:</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span> <span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_p'>p</span><span class='op'>|</span>
433
+ <span class='kw'>case</span> <span class='id identifier rubyid_p'>p</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span>
434
+ <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>position</span><span class='tstring_end'>&quot;</span></span>
435
+ <span class='ivar'>@left_margin</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='ivar'>@width</span> <span class='op'>*</span> <span class='lparen'>(</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>%</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span> <span class='op'>-</span> <span class='int'>7</span><span class='rparen'>)</span> <span class='op'>/</span> <span class='int'>100</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
436
+ <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>align</span><span class='tstring_end'>&quot;</span></span>
437
+ <span class='kw'>case</span> <span class='id identifier rubyid_p'>p</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
438
+ <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>left</span><span class='tstring_end'>&quot;</span></span>
439
+ <span class='ivar'>@alignment</span> <span class='op'>=</span> <span class='int'>1</span>
440
+ <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>middle</span><span class='tstring_end'>&quot;</span></span>
441
+ <span class='ivar'>@alignment</span> <span class='op'>=</span> <span class='int'>2</span>
442
+ <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>right</span><span class='tstring_end'>&quot;</span></span>
443
+ <span class='ivar'>@alignment</span> <span class='op'>=</span> <span class='int'>3</span>
444
+ <span class='kw'>end</span>
445
+ <span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>line</span><span class='tstring_end'>&quot;</span></span>
446
+ <span class='ivar'>@vertical_margin</span> <span class='op'>=</span> <span class='lparen'>(</span><span class='ivar'>@height</span> <span class='op'>-</span> <span class='lparen'>(</span><span class='ivar'>@height</span> <span class='op'>*</span> <span class='lparen'>(</span><span class='lparen'>(</span><span class='id identifier rubyid_p'>p</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>%</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_f'>to_f</span> <span class='op'>+</span> <span class='int'>7</span><span class='rparen'>)</span> <span class='op'>/</span> <span class='int'>100</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
447
+ <span class='kw'>end</span>
448
+ <span class='id identifier rubyid_param_count'>param_count</span> <span class='op'>+=</span> <span class='int'>1</span>
449
+ <span class='kw'>end</span>
450
+ <span class='kw'>end</span>
451
+ <span class='kw'>end</span></pre>
452
+ </td>
453
+ </tr>
454
+ </table>
455
+ </div>
456
+
457
+ <div class="method_details ">
458
+ <h3 class="signature " id="to_s-instance_method">
459
+
460
+ #<strong>to_s</strong> &#x21d2; <tt>Object</tt>
461
+
462
+
463
+
464
+
465
+
466
+ </h3><div class="docstring">
467
+ <div class="discussion">
468
+
469
+ <p>This method assigns the object values to an ASS style line and outputs it.</p>
470
+
471
+
472
+ </div>
473
+ </div>
474
+ <div class="tags">
475
+
476
+
477
+ </div><table class="source_code">
478
+ <tr>
479
+ <td>
480
+ <pre class="lines">
481
+
482
+
483
+ 60
484
+ 61
485
+ 62</pre>
486
+ </td>
487
+ <td>
488
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/ASSStyle.rb', line 60</span>
489
+
490
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
491
+ <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Style: </span><span class='embexpr_beg'>#{</span><span class='ivar'>@style_name</span><span class='embexpr_end'>}</span><span class='tstring_content'>,Open Sans Semibold,</span><span class='embexpr_beg'>#{</span><span class='ivar'>@font_size</span><span class='embexpr_end'>}</span><span class='tstring_content'>,&amp;H00FFFFFF,&amp;H000000FF,&amp;H00020713,&amp;H00000000,-1,0,0,0,100,100,0,0,1,2.0,2.0,</span><span class='embexpr_beg'>#{</span><span class='ivar'>@alignment</span><span class='embexpr_end'>}</span><span class='tstring_content'>,</span><span class='embexpr_beg'>#{</span><span class='ivar'>@left_margin</span><span class='embexpr_end'>}</span><span class='tstring_content'>,</span><span class='embexpr_beg'>#{</span><span class='ivar'>@right_margin</span><span class='embexpr_end'>}</span><span class='tstring_content'>,</span><span class='embexpr_beg'>#{</span><span class='ivar'>@vertical_margin</span><span class='embexpr_end'>}</span><span class='tstring_content'>,1</span><span class='tstring_end'>&quot;</span></span>
492
+ <span class='kw'>end</span></pre>
493
+ </td>
494
+ </tr>
495
+ </table>
496
+ </div>
497
+
498
+ </div>
499
+
500
+ </div>
501
+
502
+ <div id="footer">
503
+ Generated on Thu Jan 14 00:31:16 2021 by
504
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
505
+ 0.9.26 (ruby-2.7.2).
506
+ </div>
507
+
508
+ </div>
509
+ </body>
510
+ </html>