moovatom 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,587 @@
1
+ <?xml version="1.0" encoding="UTF-8"?>
2
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
3
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
4
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5
+ <head>
6
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
7
+
8
+ <title>Class: MoovAtom::MoovEngine</title>
9
+
10
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
11
+
12
+ <script src="../js/jquery.js" type="text/javascript" charset="utf-8"></script>
13
+ <script src="../js/thickbox-compressed.js" type="text/javascript" charset="utf-8"></script>
14
+ <script src="../js/quicksearch.js" type="text/javascript" charset="utf-8"></script>
15
+ <script src="../js/darkfish.js" type="text/javascript" charset="utf-8"></script>
16
+
17
+ </head>
18
+ <body id="top" class="class">
19
+
20
+ <div id="metadata">
21
+ <div id="home-metadata">
22
+ <div id="home-section" class="section">
23
+ <h3 class="section-header">
24
+ <a href="../index.html">Home</a>
25
+ <a href="../index.html#classes">Classes</a>
26
+ <a href="../index.html#methods">Methods</a>
27
+ </h3>
28
+ </div>
29
+ </div>
30
+
31
+ <div id="file-metadata">
32
+ <div id="file-list-section" class="section">
33
+ <h3 class="section-header">In Files</h3>
34
+ <div class="section-body">
35
+ <ul>
36
+
37
+ <li><a href="../lib/moovatom_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
38
+ class="thickbox" title="lib/moovatom.rb">lib/moovatom.rb</a></li>
39
+
40
+ </ul>
41
+ </div>
42
+ </div>
43
+
44
+
45
+ </div>
46
+
47
+ <div id="class-metadata">
48
+
49
+ <!-- Parent Class -->
50
+ <div id="parent-class-section" class="section">
51
+ <h3 class="section-header">Parent</h3>
52
+
53
+ <p class="link">Object</p>
54
+
55
+ </div>
56
+
57
+
58
+
59
+
60
+
61
+
62
+
63
+ <!-- Method Quickref -->
64
+ <div id="method-list-section" class="section">
65
+ <h3 class="section-header">Methods</h3>
66
+ <ul class="link-list">
67
+
68
+ <li><a href="#method-c-new">::new</a></li>
69
+
70
+ <li><a href="#method-i-cancel">#cancel</a></li>
71
+
72
+ <li><a href="#method-i-details">#details</a></li>
73
+
74
+ <li><a href="#method-i-encode">#encode</a></li>
75
+
76
+ <li><a href="#method-i-status">#status</a></li>
77
+
78
+ </ul>
79
+ </div>
80
+
81
+
82
+
83
+ </div>
84
+
85
+ <div id="project-metadata">
86
+
87
+
88
+ <div id="fileindex-section" class="section project-section">
89
+ <h3 class="section-header">Files</h3>
90
+ <ul>
91
+
92
+ <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
93
+
94
+ <li class="file"><a href="../LICENSE_txt.html">LICENSE.txt</a></li>
95
+
96
+ <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
97
+
98
+ </ul>
99
+ </div>
100
+
101
+
102
+ <div id="classindex-section" class="section project-section">
103
+ <h3 class="section-header">Class/Module Index
104
+ <span class="search-toggle"><img src="../images/find.png"
105
+ height="16" width="16" alt="[+]"
106
+ title="show/hide quicksearch" /></span></h3>
107
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
108
+ <fieldset>
109
+ <legend>Quicksearch</legend>
110
+ <input type="text" name="quicksearch" value=""
111
+ class="quicksearch-field" />
112
+ </fieldset>
113
+ </form>
114
+
115
+ <ul class="link-list">
116
+
117
+ <li><a href="../MoovAtom.html">MoovAtom</a></li>
118
+
119
+ <li><a href="../MoovAtom/MoovEngine.html">MoovAtom::MoovEngine</a></li>
120
+
121
+ </ul>
122
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
123
+ </div>
124
+
125
+
126
+ </div>
127
+ </div>
128
+
129
+ <div id="documentation">
130
+ <h1 class="class">MoovAtom::MoovEngine</h1>
131
+
132
+ <div id="description" class="description">
133
+
134
+ </div><!-- description -->
135
+
136
+
137
+
138
+
139
+ <div id="5Buntitled-5D" class="documentation-section">
140
+
141
+
142
+
143
+
144
+
145
+
146
+
147
+ <!-- Attributes -->
148
+ <div id="attribute-method-details" class="method-section section">
149
+ <h3 class="section-header">Attributes</h3>
150
+
151
+
152
+ <div id="blurb-attribute-method" class="method-detail">
153
+ <a name="blurb"></a>
154
+
155
+ <a name="blurb="></a>
156
+
157
+ <div class="method-heading attribute-method-heading">
158
+ <span class="method-name">blurb</span><span
159
+ class="attribute-access-type">[RW]</span>
160
+ </div>
161
+
162
+ <div class="method-description">
163
+
164
+
165
+
166
+ </div>
167
+ </div>
168
+
169
+ <div id="callbackurl-attribute-method" class="method-detail">
170
+ <a name="callbackurl"></a>
171
+
172
+ <a name="callbackurl="></a>
173
+
174
+ <div class="method-heading attribute-method-heading">
175
+ <span class="method-name">callbackurl</span><span
176
+ class="attribute-access-type">[RW]</span>
177
+ </div>
178
+
179
+ <div class="method-description">
180
+
181
+
182
+
183
+ </div>
184
+ </div>
185
+
186
+ <div id="content_type-attribute-method" class="method-detail">
187
+ <a name="content_type"></a>
188
+
189
+ <a name="content_type="></a>
190
+
191
+ <div class="method-heading attribute-method-heading">
192
+ <span class="method-name">content_type</span><span
193
+ class="attribute-access-type">[RW]</span>
194
+ </div>
195
+
196
+ <div class="method-description">
197
+
198
+
199
+
200
+ </div>
201
+ </div>
202
+
203
+ <div id="guid-attribute-method" class="method-detail">
204
+ <a name="guid"></a>
205
+
206
+ <a name="guid="></a>
207
+
208
+ <div class="method-heading attribute-method-heading">
209
+ <span class="method-name">guid</span><span
210
+ class="attribute-access-type">[RW]</span>
211
+ </div>
212
+
213
+ <div class="method-description">
214
+
215
+
216
+
217
+ </div>
218
+ </div>
219
+
220
+ <div id="sourcefile-attribute-method" class="method-detail">
221
+ <a name="sourcefile"></a>
222
+
223
+ <a name="sourcefile="></a>
224
+
225
+ <div class="method-heading attribute-method-heading">
226
+ <span class="method-name">sourcefile</span><span
227
+ class="attribute-access-type">[RW]</span>
228
+ </div>
229
+
230
+ <div class="method-description">
231
+
232
+
233
+
234
+ </div>
235
+ </div>
236
+
237
+ <div id="title-attribute-method" class="method-detail">
238
+ <a name="title"></a>
239
+
240
+ <a name="title="></a>
241
+
242
+ <div class="method-heading attribute-method-heading">
243
+ <span class="method-name">title</span><span
244
+ class="attribute-access-type">[RW]</span>
245
+ </div>
246
+
247
+ <div class="method-description">
248
+
249
+
250
+
251
+ </div>
252
+ </div>
253
+
254
+ <div id="userkey-attribute-method" class="method-detail">
255
+ <a name="userkey"></a>
256
+
257
+ <a name="userkey="></a>
258
+
259
+ <div class="method-heading attribute-method-heading">
260
+ <span class="method-name">userkey</span><span
261
+ class="attribute-access-type">[RW]</span>
262
+ </div>
263
+
264
+ <div class="method-description">
265
+
266
+
267
+
268
+ </div>
269
+ </div>
270
+
271
+ <div id="username-attribute-method" class="method-detail">
272
+ <a name="username"></a>
273
+
274
+ <a name="username="></a>
275
+
276
+ <div class="method-heading attribute-method-heading">
277
+ <span class="method-name">username</span><span
278
+ class="attribute-access-type">[RW]</span>
279
+ </div>
280
+
281
+ <div class="method-description">
282
+
283
+
284
+
285
+ </div>
286
+ </div>
287
+
288
+ <div id="xml_response-attribute-method" class="method-detail">
289
+ <a name="xml_response"></a>
290
+
291
+ <div class="method-heading attribute-method-heading">
292
+ <span class="method-name">xml_response</span><span
293
+ class="attribute-access-type">[R]</span>
294
+ </div>
295
+
296
+ <div class="method-description">
297
+
298
+
299
+
300
+ </div>
301
+ </div>
302
+
303
+ </div><!-- attribute-method-details -->
304
+
305
+
306
+ <!-- Methods -->
307
+
308
+ <div id="public-class-method-details" class="method-section section">
309
+ <h3 class="section-header">Public Class Methods</h3>
310
+
311
+
312
+ <div id="new-method" class="method-detail ">
313
+ <a name="method-c-new"></a>
314
+
315
+
316
+ <div class="method-heading">
317
+ <span class="method-name">new</span><span
318
+ class="method-args">(args={})</span>
319
+ <span class="method-click-advice">click to toggle source</span>
320
+ </div>
321
+
322
+
323
+ <div class="method-description">
324
+
325
+ <p>The initializer creates a set of instance variables to hold all the
326
+ specifics about the video you’re accessing. You can define these variables
327
+ when instantiating a new <a href="MoovEngine.html">MoovEngine</a> object or
328
+ after a blank object has been created. All variables with the exception of
329
+ @<a href="MoovEngine.html#attribute-i-xml_response">xml_response</a> and
330
+ @action are writable. @<a
331
+ href="MoovEngine.html#attribute-i-xml_response">xml_response</a> is only
332
+ readable because it contains the respnse from MoovAtom’s servers. @action
333
+ gets set in each of the methods below to correctly correspond with the
334
+ associated request.</p>
335
+
336
+ <p>Usage:</p>
337
+ <ul><li>
338
+ <p>moov_engine = <a
339
+ href="MoovEngine.html#method-c-new">MoovAtom::MoovEngine.new</a></p>
340
+ </li><li>
341
+ <p>moov_engine.username = ‘YOUR_USERNAME’</p>
342
+ </li><li>
343
+ <p>moov_engine.userkey = ‘YOUR_USERKEY’</p>
344
+ </li><li>
345
+ <p>etc…</p>
346
+ </li></ul>
347
+
348
+ <p>Or:</p>
349
+ <ul><li>
350
+ <p>args = { :username =&gt; ‘YOUR_USERNAME’, :userkey =&gt; ‘YOUR_USERKEY’,
351
+ etc… }</p>
352
+ </li><li>
353
+ <p>moov_engine = <a
354
+ href="MoovEngine.html#method-c-new">MoovAtom::MoovEngine.new(args)</a></p>
355
+ </li></ul>
356
+
357
+
358
+
359
+ <div class="method-source-code" id="new-source">
360
+ <pre>
361
+ <span class="ruby-comment"># File lib/moovatom.rb, line 43</span>
362
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">args</span>={})
363
+ <span class="ruby-ivar">@guid</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:guid</span>]
364
+ <span class="ruby-ivar">@username</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:username</span>]
365
+ <span class="ruby-ivar">@userkey</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:userkey</span>]
366
+ <span class="ruby-ivar">@content_type</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:content_type</span>] <span class="ruby-operator">||</span> <span class="ruby-string">&quot;video&quot;</span>
367
+ <span class="ruby-ivar">@title</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:title</span>]
368
+ <span class="ruby-ivar">@blurb</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:blurb</span>]
369
+ <span class="ruby-ivar">@sourcefile</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:sourcefile</span>]
370
+ <span class="ruby-ivar">@callbackurl</span> = <span class="ruby-identifier">args</span>[<span class="ruby-value">:callbackurl</span>]
371
+ <span class="ruby-keyword">end</span></pre>
372
+ </div><!-- new-source -->
373
+
374
+ </div>
375
+
376
+
377
+
378
+
379
+ </div><!-- new-method -->
380
+
381
+
382
+ </div><!-- public-class-method-details -->
383
+
384
+ <div id="public-instance-method-details" class="method-section section">
385
+ <h3 class="section-header">Public Instance Methods</h3>
386
+
387
+
388
+ <div id="cancel-method" class="method-detail ">
389
+ <a name="method-i-cancel"></a>
390
+
391
+
392
+ <div class="method-heading">
393
+ <span class="method-name">cancel</span><span
394
+ class="method-args">(guid)</span>
395
+ <span class="method-click-advice">click to toggle source</span>
396
+ </div>
397
+
398
+
399
+ <div class="method-description">
400
+
401
+ <p>Use this method to cancel the encoding of a video. This method requires
402
+ @username, @userkey and @guid to be set.</p>
403
+
404
+ <p>Usage:</p>
405
+ <ul><li>
406
+ <p>moov_engine.cancel ‘GUID_OF_VIDEO’</p>
407
+ </li></ul>
408
+
409
+
410
+
411
+ <div class="method-source-code" id="cancel-source">
412
+ <pre>
413
+ <span class="ruby-comment"># File lib/moovatom.rb, line 104</span>
414
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">cancel</span>(<span class="ruby-identifier">guid</span>)
415
+ <span class="ruby-ivar">@guid</span> = <span class="ruby-identifier">guid</span>
416
+ <span class="ruby-ivar">@action</span> = <span class="ruby-string">'cancel'</span>
417
+ <span class="ruby-ivar">@xml_response</span> = <span class="ruby-identifier">send_xml_request</span>(<span class="ruby-identifier">build_xml_request</span>)
418
+ <span class="ruby-keyword">end</span></pre>
419
+ </div><!-- cancel-source -->
420
+
421
+ </div>
422
+
423
+
424
+
425
+
426
+ </div><!-- cancel-method -->
427
+
428
+
429
+ <div id="details-method" class="method-detail ">
430
+ <a name="method-i-details"></a>
431
+
432
+
433
+ <div class="method-heading">
434
+ <span class="method-name">details</span><span
435
+ class="method-args">(guid)</span>
436
+ <span class="method-click-advice">click to toggle source</span>
437
+ </div>
438
+
439
+
440
+ <div class="method-description">
441
+
442
+ <p>Use this method to get the details about a video that’s finished encoding.
443
+ This method requires @username, @userkey and @guid to be set.</p>
444
+
445
+ <p>@TODO add the ability to yield to a block</p>
446
+
447
+ <p>Usage:</p>
448
+ <ul><li>
449
+ <p>moov_engine.details ‘GUID_OF_VIDEO’</p>
450
+ </li></ul>
451
+
452
+
453
+
454
+ <div class="method-source-code" id="details-source">
455
+ <pre>
456
+ <span class="ruby-comment"># File lib/moovatom.rb, line 61</span>
457
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">details</span>(<span class="ruby-identifier">guid</span>)
458
+ <span class="ruby-ivar">@guid</span> = <span class="ruby-identifier">guid</span>
459
+ <span class="ruby-ivar">@action</span> = <span class="ruby-string">'details'</span>
460
+ <span class="ruby-ivar">@xml_response</span> = <span class="ruby-identifier">send_xml_request</span>(<span class="ruby-identifier">build_xml_request</span>)
461
+ <span class="ruby-keyword">end</span></pre>
462
+ </div><!-- details-source -->
463
+
464
+ </div>
465
+
466
+
467
+
468
+
469
+ </div><!-- details-method -->
470
+
471
+
472
+ <div id="encode-method" class="method-detail ">
473
+ <a name="method-i-encode"></a>
474
+
475
+
476
+ <div class="method-heading">
477
+ <span class="method-name">encode</span><span
478
+ class="method-args">()</span>
479
+ <span class="method-click-advice">click to toggle source</span>
480
+ </div>
481
+
482
+
483
+ <div class="method-description">
484
+
485
+ <p>Use this method to start encoding a new video. This method requires the
486
+ following variables be set:</p>
487
+ <ul><li>
488
+ <p>@username</p>
489
+ </li><li>
490
+ <p>@userkey</p>
491
+ </li><li>
492
+ <p>@<a href="MoovEngine.html#attribute-i-content_type">content_type</a></p>
493
+ </li><li>
494
+ <p>@title</p>
495
+ </li><li>
496
+ <p>@blurb</p>
497
+ </li><li>
498
+ <p>@sourcefile</p>
499
+ </li><li>
500
+ <p>@callbackurl</p>
501
+ </li></ul>
502
+
503
+ <p>@TODO this method <b>REALLY</b> needs to be able to yield to a block!</p>
504
+
505
+ <p>Usage:</p>
506
+ <ul><li>
507
+ <p>moov_engine.status ‘GUID_OF_VIDEO’</p>
508
+ </li></ul>
509
+
510
+
511
+
512
+ <div class="method-source-code" id="encode-source">
513
+ <pre>
514
+ <span class="ruby-comment"># File lib/moovatom.rb, line 94</span>
515
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">encode</span>
516
+ <span class="ruby-ivar">@action</span> = <span class="ruby-string">'encode'</span>
517
+ <span class="ruby-ivar">@xml_response</span> = <span class="ruby-identifier">send_xml_request</span>(<span class="ruby-identifier">build_xml_request</span>)
518
+ <span class="ruby-keyword">end</span></pre>
519
+ </div><!-- encode-source -->
520
+
521
+ </div>
522
+
523
+
524
+
525
+
526
+ </div><!-- encode-method -->
527
+
528
+
529
+ <div id="status-method" class="method-detail ">
530
+ <a name="method-i-status"></a>
531
+
532
+
533
+ <div class="method-heading">
534
+ <span class="method-name">status</span><span
535
+ class="method-args">(guid)</span>
536
+ <span class="method-click-advice">click to toggle source</span>
537
+ </div>
538
+
539
+
540
+ <div class="method-description">
541
+
542
+ <p>Use this method to get the status of a video that is currently being
543
+ encoded. This method requires @username, @userkey and @guid to be set.</p>
544
+
545
+ <p>@TODO add the ability to yield to a block</p>
546
+
547
+ <p>Usage:</p>
548
+ <ul><li>
549
+ <p>moov_engine.status ‘GUID_OF_VIDEO’</p>
550
+ </li></ul>
551
+
552
+
553
+
554
+ <div class="method-source-code" id="status-source">
555
+ <pre>
556
+ <span class="ruby-comment"># File lib/moovatom.rb, line 74</span>
557
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">status</span>(<span class="ruby-identifier">guid</span>)
558
+ <span class="ruby-ivar">@guid</span> = <span class="ruby-identifier">guid</span>
559
+ <span class="ruby-ivar">@action</span> = <span class="ruby-string">'status'</span>
560
+ <span class="ruby-ivar">@xml_response</span> = <span class="ruby-identifier">send_xml_request</span>(<span class="ruby-identifier">build_xml_request</span>)
561
+ <span class="ruby-keyword">end</span></pre>
562
+ </div><!-- status-source -->
563
+
564
+ </div>
565
+
566
+
567
+
568
+
569
+ </div><!-- status-method -->
570
+
571
+
572
+ </div><!-- public-instance-method-details -->
573
+
574
+ </div><!-- 5Buntitled-5D -->
575
+
576
+
577
+ </div><!-- documentation -->
578
+
579
+ <div id="validator-badges">
580
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
581
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
582
+ Rdoc Generator</a> 2</small>.</p>
583
+ </div>
584
+
585
+ </body>
586
+ </html>
587
+