vtt2ass 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,700 @@
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: VTTSubtitle
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 = "VTTSubtitle";
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 (V)</a> &raquo;
40
+
41
+
42
+ <span class="title">VTTSubtitle</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: VTTSubtitle
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">VTTSubtitle</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/VTTSubtitle.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 a VTT subtile 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="#params-instance_method" title="#params (instance method)">#<strong>params</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 params.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#style-instance_method" title="#style (instance method)">#<strong>style</strong> &#x21d2; Object </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+ <span class="note title readonly">readonly</span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>Returns the value of attribute style.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#text-instance_method" title="#text (instance method)">#<strong>text</strong> &#x21d2; Object </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+ <span class="note title readonly">readonly</span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>Returns the value of attribute text.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#time_end-instance_method" title="#time_end (instance method)">#<strong>time_end</strong> &#x21d2; Object </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+ <span class="note title readonly">readonly</span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'>
230
+ <p>Returns the value of attribute time_end.</p>
231
+ </div></span>
232
+
233
+ </li>
234
+
235
+
236
+ <li class="public ">
237
+ <span class="summary_signature">
238
+
239
+ <a href="#time_start-instance_method" title="#time_start (instance method)">#<strong>time_start</strong> &#x21d2; Object </a>
240
+
241
+
242
+
243
+ </span>
244
+
245
+
246
+
247
+
248
+ <span class="note title readonly">readonly</span>
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'>
259
+ <p>Returns the value of attribute time_start.</p>
260
+ </div></span>
261
+
262
+ </li>
263
+
264
+
265
+ </ul>
266
+
267
+
268
+
269
+
270
+
271
+ <h2>
272
+ Instance Method Summary
273
+ <small><a href="#" class="summary_toggle">collapse</a></small>
274
+ </h2>
275
+
276
+ <ul class="summary">
277
+
278
+ <li class="public ">
279
+ <span class="summary_signature">
280
+
281
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(paragraph) &#x21d2; VTTSubtitle </a>
282
+
283
+
284
+
285
+ </span>
286
+
287
+
288
+ <span class="note title constructor">constructor</span>
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+
297
+ <span class="summary_desc"><div class='inline'>
298
+ <p>This method creates an instance of an VTTSubtitle.</p>
299
+ </div></span>
300
+
301
+ </li>
302
+
303
+
304
+ <li class="public ">
305
+ <span class="summary_signature">
306
+
307
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
308
+
309
+
310
+
311
+ </span>
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+ <span class="summary_desc"><div class='inline'>
322
+ <p>This method assigns the object values and outputs a VTT dialogue line.</p>
323
+ </div></span>
324
+
325
+ </li>
326
+
327
+
328
+ </ul>
329
+
330
+
331
+ <div id="constructor_details" class="method_details_list">
332
+ <h2>Constructor Details</h2>
333
+
334
+ <div class="method_details first">
335
+ <h3 class="signature first" id="initialize-instance_method">
336
+
337
+ #<strong>initialize</strong>(paragraph) &#x21d2; <tt><span class='object_link'><a href="" title="VTTSubtitle (class)">VTTSubtitle</a></span></tt>
338
+
339
+
340
+
341
+
342
+
343
+ </h3><div class="docstring">
344
+ <div class="discussion">
345
+
346
+ <p>This method creates an instance of an VTTSubtitle.</p>
347
+ <ul><li>
348
+ <p>Requires <code>paragraph</code>, a VTT formatted string as input.</p>
349
+ </li></ul>
350
+
351
+
352
+ </div>
353
+ </div>
354
+ <div class="tags">
355
+
356
+
357
+ </div><table class="source_code">
358
+ <tr>
359
+ <td>
360
+ <pre class="lines">
361
+
362
+
363
+ 10
364
+ 11
365
+ 12
366
+ 13
367
+ 14
368
+ 15
369
+ 16
370
+ 17
371
+ 18
372
+ 19
373
+ 20
374
+ 21
375
+ 22
376
+ 23
377
+ 24
378
+ 25
379
+ 26
380
+ 27
381
+ 28
382
+ 29
383
+ 30
384
+ 31
385
+ 32
386
+ 33</pre>
387
+ </td>
388
+ <td>
389
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/VTTSubtitle.rb', line 10</span>
390
+
391
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_paragraph'>paragraph</span><span class='rparen'>)</span>
392
+ <span class='id identifier rubyid_lines'>lines</span> <span class='op'>=</span> <span class='id identifier rubyid_paragraph'>paragraph</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
393
+ <span class='id identifier rubyid_rx'>rx</span> <span class='op'>=</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>^([\d:.]*) --&gt; ([\d:.]*)\s?(.*?)\s*$</span><span class='regexp_end'>/</span></span>
394
+ <span class='ivar'>@style</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Main</span><span class='tstring_end'>&quot;</span></span>
395
+ <span class='ivar'>@text</span><span class='comma'>,</span> <span class='ivar'>@time_start</span><span class='comma'>,</span> <span class='ivar'>@time_end</span><span class='comma'>,</span> <span class='ivar'>@params</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
396
+ <span class='id identifier rubyid_count'>count</span> <span class='op'>=</span> <span class='int'>0</span>
397
+
398
+ <span class='id identifier rubyid_lines'>lines</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_line'>line</span><span class='op'>|</span>
399
+ <span class='id identifier rubyid_m'>m</span> <span class='op'>=</span> <span class='id identifier rubyid_line'>line</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='id identifier rubyid_rx'>rx</span><span class='rparen'>)</span>
400
+ <span class='kw'>if</span> <span class='kw'>not</span> <span class='id identifier rubyid_m'>m</span> <span class='kw'>and</span> <span class='id identifier rubyid_count'>count</span> <span class='op'>==</span> <span class='int'>0</span> <span class='kw'>then</span>
401
+ <span class='ivar'>@style</span> <span class='op'>=</span> <span class='id identifier rubyid_line'>line</span>
402
+ <span class='kw'>elsif</span> <span class='id identifier rubyid_m'>m</span> <span class='kw'>then</span>
403
+ <span class='ivar'>@time_start</span> <span class='op'>=</span> <span class='id identifier rubyid_m'>m</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span>
404
+ <span class='ivar'>@time_end</span> <span class='op'>=</span> <span class='id identifier rubyid_m'>m</span><span class='lbracket'>[</span><span class='int'>2</span><span class='rbracket'>]</span>
405
+ <span class='ivar'>@params</span> <span class='op'>=</span> <span class='id identifier rubyid_m'>m</span><span class='lbracket'>[</span><span class='int'>3</span><span class='rbracket'>]</span>
406
+ <span class='kw'>if</span> <span class='ivar'>@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>
407
+ <span class='ivar'>@style</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>
408
+ <span class='kw'>end</span>
409
+ <span class='kw'>else</span>
410
+ <span class='ivar'>@text</span> <span class='op'>+=</span> <span class='id identifier rubyid_line'>line</span> <span class='op'>+</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span>
411
+ <span class='kw'>end</span>
412
+ <span class='id identifier rubyid_count'>count</span> <span class='op'>+=</span> <span class='int'>1</span><span class='semicolon'>;</span>
413
+ <span class='kw'>end</span>
414
+ <span class='kw'>end</span></pre>
415
+ </td>
416
+ </tr>
417
+ </table>
418
+ </div>
419
+
420
+ </div>
421
+
422
+ <div id="instance_attr_details" class="attr_details">
423
+ <h2>Instance Attribute Details</h2>
424
+
425
+
426
+ <span id=""></span>
427
+ <div class="method_details first">
428
+ <h3 class="signature first" id="params-instance_method">
429
+
430
+ #<strong>params</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
431
+
432
+
433
+
434
+
435
+
436
+ </h3><div class="docstring">
437
+ <div class="discussion">
438
+
439
+ <p>Returns the value of attribute params.</p>
440
+
441
+
442
+ </div>
443
+ </div>
444
+ <div class="tags">
445
+
446
+
447
+ </div><table class="source_code">
448
+ <tr>
449
+ <td>
450
+ <pre class="lines">
451
+
452
+
453
+ 4
454
+ 5
455
+ 6</pre>
456
+ </td>
457
+ <td>
458
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/VTTSubtitle.rb', line 4</span>
459
+
460
+ <span class='kw'>def</span> <span class='id identifier rubyid_params'>params</span>
461
+ <span class='ivar'>@params</span>
462
+ <span class='kw'>end</span></pre>
463
+ </td>
464
+ </tr>
465
+ </table>
466
+ </div>
467
+
468
+
469
+ <span id=""></span>
470
+ <div class="method_details ">
471
+ <h3 class="signature " id="style-instance_method">
472
+
473
+ #<strong>style</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
474
+
475
+
476
+
477
+
478
+
479
+ </h3><div class="docstring">
480
+ <div class="discussion">
481
+
482
+ <p>Returns the value of attribute style.</p>
483
+
484
+
485
+ </div>
486
+ </div>
487
+ <div class="tags">
488
+
489
+
490
+ </div><table class="source_code">
491
+ <tr>
492
+ <td>
493
+ <pre class="lines">
494
+
495
+
496
+ 4
497
+ 5
498
+ 6</pre>
499
+ </td>
500
+ <td>
501
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/VTTSubtitle.rb', line 4</span>
502
+
503
+ <span class='kw'>def</span> <span class='id identifier rubyid_style'>style</span>
504
+ <span class='ivar'>@style</span>
505
+ <span class='kw'>end</span></pre>
506
+ </td>
507
+ </tr>
508
+ </table>
509
+ </div>
510
+
511
+
512
+ <span id=""></span>
513
+ <div class="method_details ">
514
+ <h3 class="signature " id="text-instance_method">
515
+
516
+ #<strong>text</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
517
+
518
+
519
+
520
+
521
+
522
+ </h3><div class="docstring">
523
+ <div class="discussion">
524
+
525
+ <p>Returns the value of attribute text.</p>
526
+
527
+
528
+ </div>
529
+ </div>
530
+ <div class="tags">
531
+
532
+
533
+ </div><table class="source_code">
534
+ <tr>
535
+ <td>
536
+ <pre class="lines">
537
+
538
+
539
+ 4
540
+ 5
541
+ 6</pre>
542
+ </td>
543
+ <td>
544
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/VTTSubtitle.rb', line 4</span>
545
+
546
+ <span class='kw'>def</span> <span class='id identifier rubyid_text'>text</span>
547
+ <span class='ivar'>@text</span>
548
+ <span class='kw'>end</span></pre>
549
+ </td>
550
+ </tr>
551
+ </table>
552
+ </div>
553
+
554
+
555
+ <span id=""></span>
556
+ <div class="method_details ">
557
+ <h3 class="signature " id="time_end-instance_method">
558
+
559
+ #<strong>time_end</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
560
+
561
+
562
+
563
+
564
+
565
+ </h3><div class="docstring">
566
+ <div class="discussion">
567
+
568
+ <p>Returns the value of attribute time_end.</p>
569
+
570
+
571
+ </div>
572
+ </div>
573
+ <div class="tags">
574
+
575
+
576
+ </div><table class="source_code">
577
+ <tr>
578
+ <td>
579
+ <pre class="lines">
580
+
581
+
582
+ 4
583
+ 5
584
+ 6</pre>
585
+ </td>
586
+ <td>
587
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/VTTSubtitle.rb', line 4</span>
588
+
589
+ <span class='kw'>def</span> <span class='id identifier rubyid_time_end'>time_end</span>
590
+ <span class='ivar'>@time_end</span>
591
+ <span class='kw'>end</span></pre>
592
+ </td>
593
+ </tr>
594
+ </table>
595
+ </div>
596
+
597
+
598
+ <span id=""></span>
599
+ <div class="method_details ">
600
+ <h3 class="signature " id="time_start-instance_method">
601
+
602
+ #<strong>time_start</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
603
+
604
+
605
+
606
+
607
+
608
+ </h3><div class="docstring">
609
+ <div class="discussion">
610
+
611
+ <p>Returns the value of attribute time_start.</p>
612
+
613
+
614
+ </div>
615
+ </div>
616
+ <div class="tags">
617
+
618
+
619
+ </div><table class="source_code">
620
+ <tr>
621
+ <td>
622
+ <pre class="lines">
623
+
624
+
625
+ 4
626
+ 5
627
+ 6</pre>
628
+ </td>
629
+ <td>
630
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/VTTSubtitle.rb', line 4</span>
631
+
632
+ <span class='kw'>def</span> <span class='id identifier rubyid_time_start'>time_start</span>
633
+ <span class='ivar'>@time_start</span>
634
+ <span class='kw'>end</span></pre>
635
+ </td>
636
+ </tr>
637
+ </table>
638
+ </div>
639
+
640
+ </div>
641
+
642
+
643
+ <div id="instance_method_details" class="method_details_list">
644
+ <h2>Instance Method Details</h2>
645
+
646
+
647
+ <div class="method_details first">
648
+ <h3 class="signature first" id="to_s-instance_method">
649
+
650
+ #<strong>to_s</strong> &#x21d2; <tt>Object</tt>
651
+
652
+
653
+
654
+
655
+
656
+ </h3><div class="docstring">
657
+ <div class="discussion">
658
+
659
+ <p>This method assigns the object values and outputs a VTT dialogue line.</p>
660
+
661
+
662
+ </div>
663
+ </div>
664
+ <div class="tags">
665
+
666
+
667
+ </div><table class="source_code">
668
+ <tr>
669
+ <td>
670
+ <pre class="lines">
671
+
672
+
673
+ 37
674
+ 38
675
+ 39</pre>
676
+ </td>
677
+ <td>
678
+ <pre class="code"><span class="info file"># File 'lib/vtt2ass/VTTSubtitle.rb', line 37</span>
679
+
680
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
681
+ <span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='ivar'>@style</span><span class='embexpr_end'>}</span><span class='tstring_content'> \n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@time_start</span><span class='embexpr_end'>}</span><span class='tstring_content'> --&gt; </span><span class='embexpr_beg'>#{</span><span class='ivar'>@time_end</span><span class='embexpr_end'>}</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='ivar'>@params</span><span class='embexpr_end'>}</span><span class='tstring_content'>\n</span><span class='embexpr_beg'>#{</span><span class='ivar'>@text</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
682
+ <span class='kw'>end</span></pre>
683
+ </td>
684
+ </tr>
685
+ </table>
686
+ </div>
687
+
688
+ </div>
689
+
690
+ </div>
691
+
692
+ <div id="footer">
693
+ Generated on Thu Jan 14 00:31:16 2021 by
694
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
695
+ 0.9.26 (ruby-2.7.2).
696
+ </div>
697
+
698
+ </div>
699
+ </body>
700
+ </html>