wsc_sdk 1.3.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.
Files changed (265) hide show
  1. checksums.yaml +7 -0
  2. data/.circleci/config.yml +146 -0
  3. data/.circleci/docker/build/Dockerfile +3 -0
  4. data/.circleci/helpers/add_preamble.rb +29 -0
  5. data/.circleci/helpers/build_docs.sh +5 -0
  6. data/.circleci/helpers/build_gem.sh +5 -0
  7. data/.circleci/helpers/debundle-context.sh +14 -0
  8. data/.circleci/helpers/finalize_release.sh +24 -0
  9. data/.circleci/helpers/publish_docs.sh +10 -0
  10. data/.circleci/helpers/release_gem.sh +8 -0
  11. data/.circleci/helpers/setup.sh +11 -0
  12. data/.circleci/helpers/setup_aws.sh +13 -0
  13. data/.circleci/helpers/setup_gem.sh +2 -0
  14. data/.circleci/helpers/setup_git.sh +27 -0
  15. data/.circleci/helpers/setup_rubygems.sh +15 -0
  16. data/.circleci/helpers/test_integration.sh +12 -0
  17. data/.circleci/helpers/test_unit.sh +6 -0
  18. data/.circleci/jobs/publish-production.sh +17 -0
  19. data/.circleci/jobs/publish-staging.sh +17 -0
  20. data/.circleci/jobs/release-production.sh +21 -0
  21. data/.circleci/jobs/test-integration.sh +9 -0
  22. data/.circleci/jobs/test-unit.sh +9 -0
  23. data/.circleci/tag_repo.rb +46 -0
  24. data/.gitignore +28 -0
  25. data/.rspec +2 -0
  26. data/.yard/config +2 -0
  27. data/.yard/template/default/fulldoc/html/css/custom.css +151 -0
  28. data/.yard/template/default/layout/html/footer.erb +0 -0
  29. data/.yard/template/default/layout/html/headers.erb +10 -0
  30. data/.yard/template/default/layout/html/layout.erb +45 -0
  31. data/.yard/template/default/layout/html/setup.rb +24 -0
  32. data/.yardopts +1 -0
  33. data/CODE_OF_CONDUCT.md +74 -0
  34. data/Gemfile +6 -0
  35. data/Gemfile.lock +99 -0
  36. data/LICENSE.txt +28 -0
  37. data/README.md +397 -0
  38. data/Rakefile +2 -0
  39. data/bin/console +14 -0
  40. data/bin/setup +8 -0
  41. data/doc/Hash.html +291 -0
  42. data/doc/WscSdk.html +570 -0
  43. data/doc/WscSdk/ApiResponse.html +242 -0
  44. data/doc/WscSdk/Attributes.html +128 -0
  45. data/doc/WscSdk/Attributes/Mode.html +191 -0
  46. data/doc/WscSdk/Attributes/Type.html +389 -0
  47. data/doc/WscSdk/Client.html +2677 -0
  48. data/doc/WscSdk/Configuration.html +595 -0
  49. data/doc/WscSdk/Endpoint.html +2974 -0
  50. data/doc/WscSdk/Endpoints.html +141 -0
  51. data/doc/WscSdk/Endpoints/CustomStreamTargets.html +383 -0
  52. data/doc/WscSdk/Endpoints/LiveStreams.html +197 -0
  53. data/doc/WscSdk/Endpoints/OutputStreamTargets.html +180 -0
  54. data/doc/WscSdk/Endpoints/Outputs.html +180 -0
  55. data/doc/WscSdk/Endpoints/StreamTargets.html +446 -0
  56. data/doc/WscSdk/Endpoints/Transcoders.html +197 -0
  57. data/doc/WscSdk/Endpoints/UllStreamTargets.html +383 -0
  58. data/doc/WscSdk/Endpoints/WowzaStreamTargets.html +383 -0
  59. data/doc/WscSdk/Enum.html +225 -0
  60. data/doc/WscSdk/Enums.html +321 -0
  61. data/doc/WscSdk/Enums/BillingMode.html +188 -0
  62. data/doc/WscSdk/Enums/BroadcastLocation.html +396 -0
  63. data/doc/WscSdk/Enums/BufferSize.html +301 -0
  64. data/doc/WscSdk/Enums/ClosedCaptionType.html +221 -0
  65. data/doc/WscSdk/Enums/CustomProvider.html +252 -0
  66. data/doc/WscSdk/Enums/DeliveryMethod.html +188 -0
  67. data/doc/WscSdk/Enums/DeliveryType.html +188 -0
  68. data/doc/WscSdk/Enums/Encoder.html +460 -0
  69. data/doc/WscSdk/Enums/Errors.html +555 -0
  70. data/doc/WscSdk/Enums/IdleTimeout.html +398 -0
  71. data/doc/WscSdk/Enums/ImagePosition.html +220 -0
  72. data/doc/WscSdk/Enums/ModelMode.html +175 -0
  73. data/doc/WscSdk/Enums/ModelType.html +373 -0
  74. data/doc/WscSdk/Enums/PlayerType.html +188 -0
  75. data/doc/WscSdk/Enums/Protocol.html +204 -0
  76. data/doc/WscSdk/Enums/TargetDeliveryProtocol.html +188 -0
  77. data/doc/WscSdk/Enums/TranscoderType.html +188 -0
  78. data/doc/WscSdk/Enums/UserRegion.html +383 -0
  79. data/doc/WscSdk/Enums/WowzaProvider.html +188 -0
  80. data/doc/WscSdk/Errors.html +683 -0
  81. data/doc/WscSdk/Loggable.html +346 -0
  82. data/doc/WscSdk/Model.html +3316 -0
  83. data/doc/WscSdk/ModelList.html +442 -0
  84. data/doc/WscSdk/ModelTemplate.html +267 -0
  85. data/doc/WscSdk/Models.html +141 -0
  86. data/doc/WscSdk/Models/CustomStreamTarget.html +192 -0
  87. data/doc/WscSdk/Models/Error.html +351 -0
  88. data/doc/WscSdk/Models/LiveStream.html +601 -0
  89. data/doc/WscSdk/Models/LiveStreamConnectionCode.html +192 -0
  90. data/doc/WscSdk/Models/LiveStreamState.html +200 -0
  91. data/doc/WscSdk/Models/LiveStreamStats.html +200 -0
  92. data/doc/WscSdk/Models/LiveStreamThumbnailUrl.html +200 -0
  93. data/doc/WscSdk/Models/Output.html +294 -0
  94. data/doc/WscSdk/Models/OutputStreamTarget.html +274 -0
  95. data/doc/WscSdk/Models/StreamTarget.html +273 -0
  96. data/doc/WscSdk/Models/Transcoder.html +793 -0
  97. data/doc/WscSdk/Models/TranscoderBooleanStat.html +278 -0
  98. data/doc/WscSdk/Models/TranscoderConnectionCode.html +192 -0
  99. data/doc/WscSdk/Models/TranscoderFloatStat.html +278 -0
  100. data/doc/WscSdk/Models/TranscoderIntegerStat.html +278 -0
  101. data/doc/WscSdk/Models/TranscoderState.html +196 -0
  102. data/doc/WscSdk/Models/TranscoderStats.html +196 -0
  103. data/doc/WscSdk/Models/TranscoderStreamTargetState.html +192 -0
  104. data/doc/WscSdk/Models/TranscoderStringStat.html +278 -0
  105. data/doc/WscSdk/Models/TranscoderThumbnailUrl.html +196 -0
  106. data/doc/WscSdk/Models/UllStreamTarget.html +360 -0
  107. data/doc/WscSdk/Models/WowzaStreamTarget.html +380 -0
  108. data/doc/WscSdk/Pagination.html +1277 -0
  109. data/doc/WscSdk/Schema.html +861 -0
  110. data/doc/WscSdk/SchemaAttribute.html +2400 -0
  111. data/doc/WscSdk/Templates.html +141 -0
  112. data/doc/WscSdk/Templates/CustomStreamTarget.html +1045 -0
  113. data/doc/WscSdk/Templates/LiveStream.html +1432 -0
  114. data/doc/WscSdk/Templates/Output.html +829 -0
  115. data/doc/WscSdk/Templates/Transcoder.html +699 -0
  116. data/doc/WscSdk/Templates/UllStreamTarget.html +411 -0
  117. data/doc/WscSdk/Templates/WowzaStreamTarget.html +447 -0
  118. data/doc/WscSdk/TranscoderSharedMethods.html +1113 -0
  119. data/doc/_index.html +705 -0
  120. data/doc/class_list.html +51 -0
  121. data/doc/css/bootstrap.css +5 -0
  122. data/doc/css/common.css +1 -0
  123. data/doc/css/custom.css +151 -0
  124. data/doc/css/full_list.css +58 -0
  125. data/doc/css/style.css +496 -0
  126. data/doc/file.README.html +570 -0
  127. data/doc/file_list.html +56 -0
  128. data/doc/frames.html +17 -0
  129. data/doc/images/wsc-ruby-1800x400.png +0 -0
  130. data/doc/index.html +570 -0
  131. data/doc/js/app.js +292 -0
  132. data/doc/js/full_list.js +216 -0
  133. data/doc/js/jquery.js +4 -0
  134. data/doc/method_list.html +1731 -0
  135. data/doc/top-level-namespace.html +182 -0
  136. data/examples/client.rb +40 -0
  137. data/examples/helpers.rb +100 -0
  138. data/examples/live_streams/create.rb +39 -0
  139. data/examples/live_streams/delete.rb +32 -0
  140. data/examples/live_streams/find.rb +22 -0
  141. data/examples/live_streams/flood.rb +126 -0
  142. data/examples/live_streams/list.rb +24 -0
  143. data/examples/live_streams/regenerate_connection_code.rb +29 -0
  144. data/examples/live_streams/reset.rb +32 -0
  145. data/examples/live_streams/reset_and_wait.rb +51 -0
  146. data/examples/live_streams/start.rb +33 -0
  147. data/examples/live_streams/start_and_wait.rb +51 -0
  148. data/examples/live_streams/state.rb +33 -0
  149. data/examples/live_streams/stats.rb +43 -0
  150. data/examples/live_streams/stop.rb +33 -0
  151. data/examples/live_streams/stop_and_wait.rb +51 -0
  152. data/examples/live_streams/thumbnail_url.rb +46 -0
  153. data/examples/live_streams/update.rb +43 -0
  154. data/examples/live_streams/workflow.rb +165 -0
  155. data/examples/output_stream_targets/create.rb +56 -0
  156. data/examples/output_stream_targets/delete.rb +45 -0
  157. data/examples/output_stream_targets/find.rb +37 -0
  158. data/examples/output_stream_targets/list.rb +36 -0
  159. data/examples/output_stream_targets/update.rb +56 -0
  160. data/examples/outputs/create.rb +49 -0
  161. data/examples/outputs/delete.rb +39 -0
  162. data/examples/outputs/find.rb +31 -0
  163. data/examples/outputs/list.rb +29 -0
  164. data/examples/outputs/update.rb +50 -0
  165. data/examples/stream_targets/custom/create.rb +42 -0
  166. data/examples/stream_targets/custom/delete.rb +31 -0
  167. data/examples/stream_targets/custom/find.rb +23 -0
  168. data/examples/stream_targets/custom/list.rb +24 -0
  169. data/examples/stream_targets/custom/update.rb +43 -0
  170. data/examples/stream_targets/list.rb +24 -0
  171. data/examples/stream_targets/ull/create.rb +41 -0
  172. data/examples/stream_targets/ull/delete.rb +31 -0
  173. data/examples/stream_targets/ull/find.rb +23 -0
  174. data/examples/stream_targets/ull/list.rb +24 -0
  175. data/examples/stream_targets/ull/update.rb +43 -0
  176. data/examples/stream_targets/wowza/create.rb +42 -0
  177. data/examples/stream_targets/wowza/delete.rb +31 -0
  178. data/examples/stream_targets/wowza/find.rb +23 -0
  179. data/examples/stream_targets/wowza/list.rb +23 -0
  180. data/examples/stream_targets/wowza/update.rb +43 -0
  181. data/examples/transcoders/create.rb +39 -0
  182. data/examples/transcoders/delete.rb +31 -0
  183. data/examples/transcoders/find.rb +23 -0
  184. data/examples/transcoders/list.rb +24 -0
  185. data/examples/transcoders/reset.rb +32 -0
  186. data/examples/transcoders/reset_and_wait.rb +48 -0
  187. data/examples/transcoders/start.rb +33 -0
  188. data/examples/transcoders/start_and_wait.rb +50 -0
  189. data/examples/transcoders/state.rb +33 -0
  190. data/examples/transcoders/stats.rb +43 -0
  191. data/examples/transcoders/stop.rb +33 -0
  192. data/examples/transcoders/stop_and_wait.rb +50 -0
  193. data/examples/transcoders/thumbnail_url.rb +46 -0
  194. data/examples/transcoders/update.rb +43 -0
  195. data/images/wsc-ruby-1800x400.png +0 -0
  196. data/lib/wsc_sdk.rb +81 -0
  197. data/lib/wsc_sdk/client.rb +417 -0
  198. data/lib/wsc_sdk/configuration.rb +21 -0
  199. data/lib/wsc_sdk/constants.rb +29 -0
  200. data/lib/wsc_sdk/endpoint.rb +492 -0
  201. data/lib/wsc_sdk/endpoints/custom_stream_targets.rb +44 -0
  202. data/lib/wsc_sdk/endpoints/live_streams.rb +34 -0
  203. data/lib/wsc_sdk/endpoints/output_stream_targets.rb +17 -0
  204. data/lib/wsc_sdk/endpoints/outputs.rb +17 -0
  205. data/lib/wsc_sdk/endpoints/stream_targets.rb +45 -0
  206. data/lib/wsc_sdk/endpoints/transcoders.rb +38 -0
  207. data/lib/wsc_sdk/endpoints/ull_stream_targets.rb +44 -0
  208. data/lib/wsc_sdk/endpoints/wowza_stream_targets.rb +44 -0
  209. data/lib/wsc_sdk/enums.rb +31 -0
  210. data/lib/wsc_sdk/enums/billing_mode.rb +20 -0
  211. data/lib/wsc_sdk/enums/broadcast_location.rb +58 -0
  212. data/lib/wsc_sdk/enums/buffer_size.rb +41 -0
  213. data/lib/wsc_sdk/enums/closed_caption_type.rb +26 -0
  214. data/lib/wsc_sdk/enums/custom_provider.rb +32 -0
  215. data/lib/wsc_sdk/enums/delivery_method.rb +20 -0
  216. data/lib/wsc_sdk/enums/delivery_type.rb +20 -0
  217. data/lib/wsc_sdk/enums/encoder.rb +71 -0
  218. data/lib/wsc_sdk/enums/idle_timeout.rb +50 -0
  219. data/lib/wsc_sdk/enums/image_position.rb +26 -0
  220. data/lib/wsc_sdk/enums/player_type.rb +20 -0
  221. data/lib/wsc_sdk/enums/protocol.rb +23 -0
  222. data/lib/wsc_sdk/enums/target_delivery_protocol.rb +20 -0
  223. data/lib/wsc_sdk/enums/transcoder_type.rb +20 -0
  224. data/lib/wsc_sdk/enums/wowza_provider.rb +20 -0
  225. data/lib/wsc_sdk/errors.rb +115 -0
  226. data/lib/wsc_sdk/model.rb +515 -0
  227. data/lib/wsc_sdk/model_list.rb +42 -0
  228. data/lib/wsc_sdk/model_template.rb +27 -0
  229. data/lib/wsc_sdk/models/custom_stream_target.rb +34 -0
  230. data/lib/wsc_sdk/models/error.rb +53 -0
  231. data/lib/wsc_sdk/models/live_stream.rb +130 -0
  232. data/lib/wsc_sdk/models/live_stream_connection_code.rb +31 -0
  233. data/lib/wsc_sdk/models/live_stream_state.rb +20 -0
  234. data/lib/wsc_sdk/models/live_stream_stats.rb +20 -0
  235. data/lib/wsc_sdk/models/live_stream_thumbnail_url.rb +20 -0
  236. data/lib/wsc_sdk/models/output.rb +61 -0
  237. data/lib/wsc_sdk/models/output_stream_target.rb +37 -0
  238. data/lib/wsc_sdk/models/stream_target.rb +29 -0
  239. data/lib/wsc_sdk/models/transcoder.rb +135 -0
  240. data/lib/wsc_sdk/models/transcoder_boolean_stat.rb +41 -0
  241. data/lib/wsc_sdk/models/transcoder_connection_code.rb +29 -0
  242. data/lib/wsc_sdk/models/transcoder_float_stat.rb +40 -0
  243. data/lib/wsc_sdk/models/transcoder_integer_stat.rb +40 -0
  244. data/lib/wsc_sdk/models/transcoder_state.rb +31 -0
  245. data/lib/wsc_sdk/models/transcoder_stats.rb +51 -0
  246. data/lib/wsc_sdk/models/transcoder_stream_target_state.rb +29 -0
  247. data/lib/wsc_sdk/models/transcoder_string_stat.rb +40 -0
  248. data/lib/wsc_sdk/models/transcoder_thumbnail_url.rb +29 -0
  249. data/lib/wsc_sdk/models/ull_stream_target.rb +54 -0
  250. data/lib/wsc_sdk/models/wowza_stream_target.rb +60 -0
  251. data/lib/wsc_sdk/modules/api_response.rb +24 -0
  252. data/lib/wsc_sdk/modules/loggable.rb +44 -0
  253. data/lib/wsc_sdk/modules/transcoder_shared_methods.rb +221 -0
  254. data/lib/wsc_sdk/pagination.rb +89 -0
  255. data/lib/wsc_sdk/schema.rb +140 -0
  256. data/lib/wsc_sdk/schema_attribute.rb +349 -0
  257. data/lib/wsc_sdk/templates/custom_stream_target.rb +154 -0
  258. data/lib/wsc_sdk/templates/live_stream.rb +234 -0
  259. data/lib/wsc_sdk/templates/output.rb +133 -0
  260. data/lib/wsc_sdk/templates/transcoder.rb +97 -0
  261. data/lib/wsc_sdk/templates/ull_stream_target.rb +49 -0
  262. data/lib/wsc_sdk/templates/wowza_stream_target.rb +57 -0
  263. data/lib/wsc_sdk/version.rb +7 -0
  264. data/wsc_sdk.gemspec +48 -0
  265. metadata +460 -0
@@ -0,0 +1,829 @@
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>Wowza Streaming Cloud - SDK Code Documentation</title>
7
+
8
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
9
+
10
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
11
+
12
+ <link rel="stylesheet" href="../../css/custom.css" type="text/css" charset="utf-8" />
13
+
14
+ <script type="text/javascript" charset="utf-8">
15
+ pathId = "WscSdk::Templates::Output";
16
+ relpath = '../../';
17
+ </script>
18
+
19
+
20
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
23
+
24
+
25
+ </head>
26
+ <body>
27
+ <div id="wowza-wrapper">
28
+ <header>
29
+ <div class="logo">
30
+ <a href="https://www.wowza.com">
31
+ <img src="https://cloud.wowza.com/apidocs/assets/logo.png" alt="Wowza Logo" />
32
+ </a>
33
+ <h1>Wowza Streaming Cloud<br/>SDK Code Documentation</h1>
34
+ <div class="clearfix"></div>
35
+ </div>
36
+ <div class="links">
37
+ <a href="https://www.wowza.com/">Wowza Home</a>
38
+ <a href="https://www.wowza.com/docs">Docs & APIS</a>
39
+ <a href="https://www.wowza.com/community/index.html">Forums</a>
40
+ <a href="https://www.wowza.com/support">Support</a>
41
+ </div>
42
+ <div class="clearfix"></div>
43
+ </header>
44
+
45
+ <div id="content">
46
+ <div class="nav_wrap">
47
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
48
+ <div id="resizer"></div>
49
+ </div>
50
+
51
+ <div id="main" tabindex="-1">
52
+ <div id="header">
53
+ <div id="menu">
54
+
55
+ <a href="../../_index.html">Index (O)</a> &raquo;
56
+ <span class='title'><span class='object_link'><a href="../../WscSdk.html" title="WscSdk (module)">WscSdk</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Templates.html" title="WscSdk::Templates (module)">Templates</a></span></span>
57
+ &raquo;
58
+ <span class="title">Output</span>
59
+
60
+ </div>
61
+
62
+ <div id="search">
63
+
64
+ <a class="full_list_link" id="class_list_link"
65
+ href="../../class_list.html">
66
+
67
+ <svg width="24" height="24">
68
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
69
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
70
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
71
+ </svg>
72
+ </a>
73
+
74
+ </div>
75
+ <div class="clear"></div>
76
+ </div>
77
+
78
+ <div id="content"><h1>Class: WscSdk::Templates::Output
79
+
80
+
81
+
82
+ </h1>
83
+ <div class="box_info">
84
+
85
+ <dl>
86
+ <dt>Inherits:</dt>
87
+ <dd>
88
+ <span class="inheritName"><span class='object_link'><a href="../ModelTemplate.html" title="WscSdk::ModelTemplate (class)">ModelTemplate</a></span></span>
89
+
90
+ <ul class="fullTree">
91
+ <li>Object</li>
92
+
93
+ <li class="next"><span class='object_link'><a href="../ModelTemplate.html" title="WscSdk::ModelTemplate (class)">ModelTemplate</a></span></li>
94
+
95
+ <li class="next">WscSdk::Templates::Output</li>
96
+
97
+ </ul>
98
+ <a href="#" class="inheritanceTree">show all</a>
99
+
100
+ </dd>
101
+ </dl>
102
+
103
+
104
+
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+ <dl>
114
+ <dt>Defined in:</dt>
115
+ <dd>lib/wsc_sdk/templates/output.rb</dd>
116
+ </dl>
117
+
118
+ </div>
119
+
120
+ <h2>Overview</h2><div class="docstring">
121
+ <div class="discussion">
122
+
123
+ <p>Templates for generating Outputs</p>
124
+
125
+
126
+ </div>
127
+ </div>
128
+ <div class="tags">
129
+
130
+
131
+ </div>
132
+
133
+
134
+
135
+
136
+
137
+
138
+
139
+ <h2>
140
+ Class Method Summary
141
+ <small><a href="#" class="summary_toggle">collapse</a></small>
142
+ </h2>
143
+
144
+ <ul class="summary">
145
+
146
+ <li class="public ">
147
+ <span class="summary_signature">
148
+
149
+ <a href="#full_hd-class_method" title="full_hd (class method)">.<strong>full_hd</strong>(modifiers = {}) &#x21d2; Object </a>
150
+
151
+
152
+
153
+ </span>
154
+
155
+
156
+
157
+
158
+
159
+
160
+
161
+
162
+
163
+ <span class="summary_desc"><div class='inline'>
164
+ <p>Generate a Full HD output (1920x1080).</p>
165
+ </div></span>
166
+
167
+ </li>
168
+
169
+
170
+ <li class="public ">
171
+ <span class="summary_signature">
172
+
173
+ <a href="#hd-class_method" title="hd (class method)">.<strong>hd</strong>(modifiers = {}) &#x21d2; Object </a>
174
+
175
+
176
+
177
+ </span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>Generate an HD output (1280x720).</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#low_res_large-class_method" title="low_res_large (class method)">.<strong>low_res_large</strong>(modifiers = {}) &#x21d2; Object </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+
207
+
208
+
209
+
210
+
211
+ <span class="summary_desc"><div class='inline'>
212
+ <p>Generate a larger sized low res output (640x360).</p>
213
+ </div></span>
214
+
215
+ </li>
216
+
217
+
218
+ <li class="public ">
219
+ <span class="summary_signature">
220
+
221
+ <a href="#low_res_medium-class_method" title="low_res_medium (class method)">.<strong>low_res_medium</strong>(modifiers = {}) &#x21d2; Object </a>
222
+
223
+
224
+
225
+ </span>
226
+
227
+
228
+
229
+
230
+
231
+
232
+
233
+
234
+
235
+ <span class="summary_desc"><div class='inline'>
236
+ <p>Generate a medium sized low res output (512x288).</p>
237
+ </div></span>
238
+
239
+ </li>
240
+
241
+
242
+ <li class="public ">
243
+ <span class="summary_signature">
244
+
245
+ <a href="#low_res_small-class_method" title="low_res_small (class method)">.<strong>low_res_small</strong>(modifiers = {}) &#x21d2; Object </a>
246
+
247
+
248
+
249
+ </span>
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+
259
+ <span class="summary_desc"><div class='inline'>
260
+ <p>Generate a smaller sized low res output (320x180).</p>
261
+ </div></span>
262
+
263
+ </li>
264
+
265
+
266
+ <li class="public ">
267
+ <span class="summary_signature">
268
+
269
+ <a href="#sd_wide-class_method" title="sd_wide (class method)">.<strong>sd_wide</strong>(modifiers = {}) &#x21d2; Object </a>
270
+
271
+
272
+
273
+ </span>
274
+
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+ <span class="summary_desc"><div class='inline'>
284
+ <p>Generate an SD wide screen output (854x480).</p>
285
+ </div></span>
286
+
287
+ </li>
288
+
289
+
290
+ </ul>
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+
302
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../ModelTemplate.html" title="WscSdk::ModelTemplate (class)">ModelTemplate</a></span></h3>
303
+ <p class="inherited"><span class='object_link'><a href="../ModelTemplate.html#merge-class_method" title="WscSdk::ModelTemplate.merge (method)">merge</a></span></p>
304
+
305
+
306
+ <div id="class_method_details" class="method_details_list">
307
+ <h2>Class Method Details</h2>
308
+
309
+
310
+ <div class="method_details first">
311
+ <h3 class="signature first" id="full_hd-class_method">
312
+
313
+ .<strong>full_hd</strong>(modifiers = {}) &#x21d2; <tt>Object</tt>
314
+
315
+
316
+
317
+
318
+
319
+ </h3><div class="docstring">
320
+ <div class="discussion">
321
+
322
+ <p>Generate a Full HD output (1920x1080).</p>
323
+
324
+
325
+ </div>
326
+ </div>
327
+ <div class="tags">
328
+ <p class="tag_title">Parameters:</p>
329
+ <ul class="param">
330
+
331
+ <li>
332
+
333
+ <span class='name'>modifiers</span>
334
+
335
+
336
+ <span class='type'>(<tt>Hash</tt>)</span>
337
+
338
+
339
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
340
+
341
+
342
+ &mdash;
343
+ <div class='inline'>
344
+ <p>A hash of key/value modifiers to change data in the template.</p>
345
+ </div>
346
+
347
+ </li>
348
+
349
+ </ul>
350
+
351
+
352
+ </div><table class="source_code">
353
+ <tr>
354
+ <td>
355
+ <pre class="lines">
356
+
357
+
358
+ 16
359
+ 17
360
+ 18
361
+ 19
362
+ 20
363
+ 21
364
+ 22
365
+ 23
366
+ 24
367
+ 25
368
+ 26
369
+ 27
370
+ 28
371
+ 29</pre>
372
+ </td>
373
+ <td>
374
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/templates/output.rb', line 16</span>
375
+
376
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">full_hd</span>(modifiers={})
377
+ <span style="color:#069">self</span>.merge({
378
+ <span style="color:#606">stream_format</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">audiovideo</span><span style="color:#710">&quot;</span></span>,
379
+ <span style="color:#606">passthrough_video</span>: <span style="color:#069">false</span>,
380
+ <span style="color:#606">passthrough_audio</span>: <span style="color:#069">false</span>,
381
+ <span style="color:#606">aspect_ratio_height</span>: <span style="color:#00D">1080</span>,
382
+ <span style="color:#606">aspect_ratio_width</span>: <span style="color:#00D">1920</span>,
383
+ <span style="color:#606">bitrate_audio</span>: <span style="color:#00D">128</span>,
384
+ <span style="color:#606">bitrate_video</span>: <span style="color:#00D">4000</span>,
385
+ <span style="color:#606">h264_profile</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">high</span><span style="color:#710">&quot;</span></span>,
386
+ <span style="color:#606">framerate_reduction</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">0</span><span style="color:#710">&quot;</span></span>,
387
+ <span style="color:#606">keyframes</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">follow_source</span><span style="color:#710">&quot;</span></span>
388
+ }, modifiers)
389
+ <span style="color:#080;font-weight:bold">end</span></pre>
390
+ </td>
391
+ </tr>
392
+ </table>
393
+ </div>
394
+
395
+ <div class="method_details ">
396
+ <h3 class="signature " id="hd-class_method">
397
+
398
+ .<strong>hd</strong>(modifiers = {}) &#x21d2; <tt>Object</tt>
399
+
400
+
401
+
402
+
403
+
404
+ </h3><div class="docstring">
405
+ <div class="discussion">
406
+
407
+ <p>Generate an HD output (1280x720)</p>
408
+
409
+
410
+ </div>
411
+ </div>
412
+ <div class="tags">
413
+ <p class="tag_title">Parameters:</p>
414
+ <ul class="param">
415
+
416
+ <li>
417
+
418
+ <span class='name'>modifiers</span>
419
+
420
+
421
+ <span class='type'>(<tt>Hash</tt>)</span>
422
+
423
+
424
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
425
+
426
+
427
+ &mdash;
428
+ <div class='inline'>
429
+ <p>A hash of key/value modifiers to change data in the template.</p>
430
+ </div>
431
+
432
+ </li>
433
+
434
+ </ul>
435
+
436
+
437
+ </div><table class="source_code">
438
+ <tr>
439
+ <td>
440
+ <pre class="lines">
441
+
442
+
443
+ 36
444
+ 37
445
+ 38
446
+ 39
447
+ 40
448
+ 41
449
+ 42
450
+ 43
451
+ 44
452
+ 45
453
+ 46
454
+ 47
455
+ 48
456
+ 49</pre>
457
+ </td>
458
+ <td>
459
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/templates/output.rb', line 36</span>
460
+
461
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">hd</span>(modifiers={})
462
+ <span style="color:#069">self</span>.merge({
463
+ <span style="color:#606">stream_format</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">audiovideo</span><span style="color:#710">&quot;</span></span>,
464
+ <span style="color:#606">passthrough_video</span>: <span style="color:#069">false</span>,
465
+ <span style="color:#606">passthrough_audio</span>: <span style="color:#069">false</span>,
466
+ <span style="color:#606">aspect_ratio_height</span>: <span style="color:#00D">720</span>,
467
+ <span style="color:#606">aspect_ratio_width</span>: <span style="color:#00D">1280</span>,
468
+ <span style="color:#606">bitrate_audio</span>: <span style="color:#00D">128</span>,
469
+ <span style="color:#606">bitrate_video</span>: <span style="color:#00D">2600</span>,
470
+ <span style="color:#606">h264_profile</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">high</span><span style="color:#710">&quot;</span></span>,
471
+ <span style="color:#606">framerate_reduction</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">0</span><span style="color:#710">&quot;</span></span>,
472
+ <span style="color:#606">keyframes</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">follow_source</span><span style="color:#710">&quot;</span></span>,
473
+ }, modifiers)
474
+ <span style="color:#080;font-weight:bold">end</span></pre>
475
+ </td>
476
+ </tr>
477
+ </table>
478
+ </div>
479
+
480
+ <div class="method_details ">
481
+ <h3 class="signature " id="low_res_large-class_method">
482
+
483
+ .<strong>low_res_large</strong>(modifiers = {}) &#x21d2; <tt>Object</tt>
484
+
485
+
486
+
487
+
488
+
489
+ </h3><div class="docstring">
490
+ <div class="discussion">
491
+
492
+ <p>Generate a larger sized low res output (640x360)</p>
493
+
494
+
495
+ </div>
496
+ </div>
497
+ <div class="tags">
498
+ <p class="tag_title">Parameters:</p>
499
+ <ul class="param">
500
+
501
+ <li>
502
+
503
+ <span class='name'>modifiers</span>
504
+
505
+
506
+ <span class='type'>(<tt>Hash</tt>)</span>
507
+
508
+
509
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
510
+
511
+
512
+ &mdash;
513
+ <div class='inline'>
514
+ <p>A hash of key/value modifiers to change data in the template.</p>
515
+ </div>
516
+
517
+ </li>
518
+
519
+ </ul>
520
+
521
+
522
+ </div><table class="source_code">
523
+ <tr>
524
+ <td>
525
+ <pre class="lines">
526
+
527
+
528
+ 77
529
+ 78
530
+ 79
531
+ 80
532
+ 81
533
+ 82
534
+ 83
535
+ 84
536
+ 85
537
+ 86
538
+ 87
539
+ 88
540
+ 89
541
+ 90</pre>
542
+ </td>
543
+ <td>
544
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/templates/output.rb', line 77</span>
545
+
546
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">low_res_large</span>(modifiers={})
547
+ <span style="color:#069">self</span>.merge({
548
+ <span style="color:#606">stream_format</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">audiovideo</span><span style="color:#710">&quot;</span></span>,
549
+ <span style="color:#606">passthrough_video</span>: <span style="color:#069">false</span>,
550
+ <span style="color:#606">passthrough_audio</span>: <span style="color:#069">false</span>,
551
+ <span style="color:#606">aspect_ratio_height</span>: <span style="color:#00D">360</span>,
552
+ <span style="color:#606">aspect_ratio_width</span>: <span style="color:#00D">640</span>,
553
+ <span style="color:#606">bitrate_audio</span>: <span style="color:#00D">128</span>,
554
+ <span style="color:#606">bitrate_video</span>: <span style="color:#00D">1024</span>,
555
+ <span style="color:#606">h264_profile</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">main</span><span style="color:#710">&quot;</span></span>,
556
+ <span style="color:#606">framerate_reduction</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">0</span><span style="color:#710">&quot;</span></span>,
557
+ <span style="color:#606">keyframes</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">follow_source</span><span style="color:#710">&quot;</span></span>,
558
+ }, modifiers)
559
+ <span style="color:#080;font-weight:bold">end</span></pre>
560
+ </td>
561
+ </tr>
562
+ </table>
563
+ </div>
564
+
565
+ <div class="method_details ">
566
+ <h3 class="signature " id="low_res_medium-class_method">
567
+
568
+ .<strong>low_res_medium</strong>(modifiers = {}) &#x21d2; <tt>Object</tt>
569
+
570
+
571
+
572
+
573
+
574
+ </h3><div class="docstring">
575
+ <div class="discussion">
576
+
577
+ <p>Generate a medium sized low res output (512x288)</p>
578
+
579
+
580
+ </div>
581
+ </div>
582
+ <div class="tags">
583
+ <p class="tag_title">Parameters:</p>
584
+ <ul class="param">
585
+
586
+ <li>
587
+
588
+ <span class='name'>modifiers</span>
589
+
590
+
591
+ <span class='type'>(<tt>Hash</tt>)</span>
592
+
593
+
594
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
595
+
596
+
597
+ &mdash;
598
+ <div class='inline'>
599
+ <p>A hash of key/value modifiers to change data in the template.</p>
600
+ </div>
601
+
602
+ </li>
603
+
604
+ </ul>
605
+
606
+
607
+ </div><table class="source_code">
608
+ <tr>
609
+ <td>
610
+ <pre class="lines">
611
+
612
+
613
+ 97
614
+ 98
615
+ 99
616
+ 100
617
+ 101
618
+ 102
619
+ 103
620
+ 104
621
+ 105
622
+ 106
623
+ 107
624
+ 108
625
+ 109
626
+ 110</pre>
627
+ </td>
628
+ <td>
629
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/templates/output.rb', line 97</span>
630
+
631
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">low_res_medium</span>(modifiers={})
632
+ <span style="color:#069">self</span>.merge({
633
+ <span style="color:#606">stream_format</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">audiovideo</span><span style="color:#710">&quot;</span></span>,
634
+ <span style="color:#606">passthrough_video</span>: <span style="color:#069">false</span>,
635
+ <span style="color:#606">passthrough_audio</span>: <span style="color:#069">false</span>,
636
+ <span style="color:#606">aspect_ratio_height</span>: <span style="color:#00D">288</span>,
637
+ <span style="color:#606">aspect_ratio_width</span>: <span style="color:#00D">512</span>,
638
+ <span style="color:#606">bitrate_audio</span>: <span style="color:#00D">128</span>,
639
+ <span style="color:#606">bitrate_video</span>: <span style="color:#00D">512</span>,
640
+ <span style="color:#606">h264_profile</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">baseline</span><span style="color:#710">&quot;</span></span>,
641
+ <span style="color:#606">framerate_reduction</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">0</span><span style="color:#710">&quot;</span></span>,
642
+ <span style="color:#606">keyframes</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">follow_source</span><span style="color:#710">&quot;</span></span>,
643
+ }, modifiers)
644
+ <span style="color:#080;font-weight:bold">end</span></pre>
645
+ </td>
646
+ </tr>
647
+ </table>
648
+ </div>
649
+
650
+ <div class="method_details ">
651
+ <h3 class="signature " id="low_res_small-class_method">
652
+
653
+ .<strong>low_res_small</strong>(modifiers = {}) &#x21d2; <tt>Object</tt>
654
+
655
+
656
+
657
+
658
+
659
+ </h3><div class="docstring">
660
+ <div class="discussion">
661
+
662
+ <p>Generate a smaller sized low res output (320x180)</p>
663
+
664
+
665
+ </div>
666
+ </div>
667
+ <div class="tags">
668
+ <p class="tag_title">Parameters:</p>
669
+ <ul class="param">
670
+
671
+ <li>
672
+
673
+ <span class='name'>modifiers</span>
674
+
675
+
676
+ <span class='type'>(<tt>Hash</tt>)</span>
677
+
678
+
679
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
680
+
681
+
682
+ &mdash;
683
+ <div class='inline'>
684
+ <p>A hash of key/value modifiers to change data in the template.</p>
685
+ </div>
686
+
687
+ </li>
688
+
689
+ </ul>
690
+
691
+
692
+ </div><table class="source_code">
693
+ <tr>
694
+ <td>
695
+ <pre class="lines">
696
+
697
+
698
+ 117
699
+ 118
700
+ 119
701
+ 120
702
+ 121
703
+ 122
704
+ 123
705
+ 124
706
+ 125
707
+ 126
708
+ 127
709
+ 128
710
+ 129
711
+ 130</pre>
712
+ </td>
713
+ <td>
714
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/templates/output.rb', line 117</span>
715
+
716
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">low_res_small</span>(modifiers={})
717
+ <span style="color:#069">self</span>.merge({
718
+ <span style="color:#606">stream_format</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">audiovideo</span><span style="color:#710">&quot;</span></span>,
719
+ <span style="color:#606">passthrough_video</span>: <span style="color:#069">false</span>,
720
+ <span style="color:#606">passthrough_audio</span>: <span style="color:#069">false</span>,
721
+ <span style="color:#606">aspect_ratio_height</span>: <span style="color:#00D">180</span>,
722
+ <span style="color:#606">aspect_ratio_width</span>: <span style="color:#00D">320</span>,
723
+ <span style="color:#606">bitrate_audio</span>: <span style="color:#00D">128</span>,
724
+ <span style="color:#606">bitrate_video</span>: <span style="color:#00D">320</span>,
725
+ <span style="color:#606">h264_profile</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">baseline</span><span style="color:#710">&quot;</span></span>,
726
+ <span style="color:#606">framerate_reduction</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">0</span><span style="color:#710">&quot;</span></span>,
727
+ <span style="color:#606">keyframes</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">follow_source</span><span style="color:#710">&quot;</span></span>,
728
+ }, modifiers)
729
+ <span style="color:#080;font-weight:bold">end</span></pre>
730
+ </td>
731
+ </tr>
732
+ </table>
733
+ </div>
734
+
735
+ <div class="method_details ">
736
+ <h3 class="signature " id="sd_wide-class_method">
737
+
738
+ .<strong>sd_wide</strong>(modifiers = {}) &#x21d2; <tt>Object</tt>
739
+
740
+
741
+
742
+
743
+
744
+ </h3><div class="docstring">
745
+ <div class="discussion">
746
+
747
+ <p>Generate an SD wide screen output (854x480)</p>
748
+
749
+
750
+ </div>
751
+ </div>
752
+ <div class="tags">
753
+ <p class="tag_title">Parameters:</p>
754
+ <ul class="param">
755
+
756
+ <li>
757
+
758
+ <span class='name'>modifiers</span>
759
+
760
+
761
+ <span class='type'>(<tt>Hash</tt>)</span>
762
+
763
+
764
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
765
+
766
+
767
+ &mdash;
768
+ <div class='inline'>
769
+ <p>A hash of key/value modifiers to change data in the template.</p>
770
+ </div>
771
+
772
+ </li>
773
+
774
+ </ul>
775
+
776
+
777
+ </div><table class="source_code">
778
+ <tr>
779
+ <td>
780
+ <pre class="lines">
781
+
782
+
783
+ 57
784
+ 58
785
+ 59
786
+ 60
787
+ 61
788
+ 62
789
+ 63
790
+ 64
791
+ 65
792
+ 66
793
+ 67
794
+ 68
795
+ 69
796
+ 70</pre>
797
+ </td>
798
+ <td>
799
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/templates/output.rb', line 57</span>
800
+
801
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#069">self</span>.<span style="color:#06B;font-weight:bold">sd_wide</span>(modifiers={})
802
+ <span style="color:#069">self</span>.merge({
803
+ <span style="color:#606">stream_format</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">audiovideo</span><span style="color:#710">&quot;</span></span>,
804
+ <span style="color:#606">passthrough_video</span>: <span style="color:#069">false</span>,
805
+ <span style="color:#606">passthrough_audio</span>: <span style="color:#069">false</span>,
806
+ <span style="color:#606">aspect_ratio_height</span>: <span style="color:#00D">480</span>,
807
+ <span style="color:#606">aspect_ratio_width</span>: <span style="color:#00D">854</span>,
808
+ <span style="color:#606">bitrate_audio</span>: <span style="color:#00D">128</span>,
809
+ <span style="color:#606">bitrate_video</span>: <span style="color:#00D">1600</span>,
810
+ <span style="color:#606">h264_profile</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">main</span><span style="color:#710">&quot;</span></span>,
811
+ <span style="color:#606">framerate_reduction</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">0</span><span style="color:#710">&quot;</span></span>,
812
+ <span style="color:#606">keyframes</span>: <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">follow_source</span><span style="color:#710">&quot;</span></span>,
813
+ }, modifiers)
814
+ <span style="color:#080;font-weight:bold">end</span></pre>
815
+ </td>
816
+ </tr>
817
+ </table>
818
+ </div>
819
+
820
+ </div>
821
+
822
+ </div>
823
+
824
+
825
+ </div>
826
+ </div>
827
+ </div>
828
+ </body>
829
+ </html>