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
data/doc/WscSdk/Models/LiveStream.html ADDED
@@ -0,0 +1,601 @@
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::Models::LiveStream";
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 (L)</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="../Models.html" title="WscSdk::Models (module)">Models</a></span></span>
57
+ &raquo;
58
+ <span class="title">LiveStream</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::Models::LiveStream
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="../Model.html" title="WscSdk::Model (class)">WscSdk::Model</a></span></span>
89
+
90
+ <ul class="fullTree">
91
+ <li>Object</li>
92
+
93
+ <li class="next"><span class='object_link'><a href="../Model.html" title="WscSdk::Model (class)">WscSdk::Model</a></span></li>
94
+
95
+ <li class="next">WscSdk::Models::LiveStream</li>
96
+
97
+ </ul>
98
+ <a href="#" class="inheritanceTree">show all</a>
99
+
100
+ </dd>
101
+ </dl>
102
+
103
+
104
+
105
+
106
+
107
+
108
+ <dl>
109
+ <dt>Includes:</dt>
110
+ <dd><span class='object_link'><a href="../TranscoderSharedMethods.html" title="WscSdk::TranscoderSharedMethods (module)">TranscoderSharedMethods</a></span></dd>
111
+ </dl>
112
+
113
+
114
+
115
+
116
+
117
+
118
+ <dl>
119
+ <dt>Defined in:</dt>
120
+ <dd>lib/wsc_sdk/models/live_stream.rb</dd>
121
+ </dl>
122
+
123
+ </div>
124
+
125
+ <h2>Overview</h2><div class="docstring">
126
+ <div class="discussion">
127
+
128
+ <p>A model to represent a Live Stream in the Wowza Streaming Cloud API.</p>
129
+
130
+
131
+ </div>
132
+ </div>
133
+ <div class="tags">
134
+
135
+
136
+ </div>
137
+
138
+
139
+
140
+
141
+
142
+ <h2>Instance Attribute Summary</h2>
143
+
144
+ <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="../Model.html" title="WscSdk::Model (class)">WscSdk::Model</a></span></h3>
145
+ <p class="inherited"><span class='object_link'><a href="../Model.html#attributes-instance_method" title="WscSdk::Model#attributes (method)">#attributes</a></span>, <span class='object_link'><a href="../Model.html#changes-instance_method" title="WscSdk::Model#changes (method)">#changes</a></span>, <span class='object_link'><a href="../Model.html#data_mode-instance_method" title="WscSdk::Model#data_mode (method)">#data_mode</a></span>, <span class='object_link'><a href="../Model.html#endpoint-instance_method" title="WscSdk::Model#endpoint (method)">#endpoint</a></span>, <span class='object_link'><a href="../Model.html#errors-instance_method" title="WscSdk::Model#errors (method)">#errors</a></span>, <span class='object_link'><a href="../Model.html#partial_data-instance_method" title="WscSdk::Model#partial_data (method)">#partial_data</a></span></p>
146
+
147
+
148
+
149
+ <h2>
150
+ Instance Method Summary
151
+ <small><a href="#" class="summary_toggle">collapse</a></small>
152
+ </h2>
153
+
154
+ <ul class="summary">
155
+
156
+ <li class="public ">
157
+ <span class="summary_signature">
158
+
159
+ <a href="#default_source_url-instance_method" title="#default_source_url (instance method)">#<strong>default_source_url</strong> &#x21d2; Object </a>
160
+
161
+
162
+
163
+ </span>
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+
172
+
173
+ <span class="summary_desc"><div class='inline'>
174
+ <p>Since the source_url is a write only attribute, when we update the live
175
+ stream the value is no longer present, so we will default it to the value
176
+ returned in the source_connection_information attribute, if it is present.</p>
177
+ </div></span>
178
+
179
+ </li>
180
+
181
+
182
+ <li class="public ">
183
+ <span class="summary_signature">
184
+
185
+ <a href="#delivery_type_is_required%3F-instance_method" title="#delivery_type_is_required? (instance method)">#<strong>delivery_type_is_required?</strong> &#x21d2; Boolean </a>
186
+
187
+
188
+
189
+ </span>
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+ <span class="summary_desc"><div class='inline'>
200
+ <p>Determine if the delivery type opitons is required.</p>
201
+ </div></span>
202
+
203
+ </li>
204
+
205
+
206
+ <li class="public ">
207
+ <span class="summary_signature">
208
+
209
+ <a href="#hosted_page_access-instance_method" title="#hosted_page_access (instance method)">#<strong>hosted_page_access</strong> &#x21d2; Object </a>
210
+
211
+
212
+
213
+ </span>
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+ <span class="summary_desc"><div class='inline'>
224
+ <p>Determine if the hosted page option can be set.</p>
225
+ </div></span>
226
+
227
+ </li>
228
+
229
+
230
+ <li class="public ">
231
+ <span class="summary_signature">
232
+
233
+ <a href="#regenerate_connection_code-instance_method" title="#regenerate_connection_code (instance method)">#<strong>regenerate_connection_code</strong> &#x21d2; WscSdk::Models::TranscoderConnectionCode </a>
234
+
235
+
236
+
237
+ </span>
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ <span class="summary_desc"><div class='inline'>
248
+ <p>Regenerates the connection code for the transcoder.</p>
249
+ </div></span>
250
+
251
+ </li>
252
+
253
+
254
+ <li class="public ">
255
+ <span class="summary_signature">
256
+
257
+ <a href="#source_url_is_required%3F-instance_method" title="#source_url_is_required? (instance method)">#<strong>source_url_is_required?</strong> &#x21d2; Boolean </a>
258
+
259
+
260
+
261
+ </span>
262
+
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+ <span class="summary_desc"><div class='inline'>
272
+ <p>Determine if the source_url attribute is required.</p>
273
+ </div></span>
274
+
275
+ </li>
276
+
277
+
278
+ </ul>
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+
288
+
289
+
290
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="../TranscoderSharedMethods.html" title="WscSdk::TranscoderSharedMethods (module)">TranscoderSharedMethods</a></span></h3>
291
+ <p class="inherited"><span class='object_link'><a href="../TranscoderSharedMethods.html#reset-instance_method" title="WscSdk::TranscoderSharedMethods#reset (method)">#reset</a></span>, <span class='object_link'><a href="../TranscoderSharedMethods.html#start-instance_method" title="WscSdk::TranscoderSharedMethods#start (method)">#start</a></span>, <span class='object_link'><a href="../TranscoderSharedMethods.html#state-instance_method" title="WscSdk::TranscoderSharedMethods#state (method)">#state</a></span>, <span class='object_link'><a href="../TranscoderSharedMethods.html#stats-instance_method" title="WscSdk::TranscoderSharedMethods#stats (method)">#stats</a></span>, <span class='object_link'><a href="../TranscoderSharedMethods.html#stop-instance_method" title="WscSdk::TranscoderSharedMethods#stop (method)">#stop</a></span>, <span class='object_link'><a href="../TranscoderSharedMethods.html#thumbnail_url-instance_method" title="WscSdk::TranscoderSharedMethods#thumbnail_url (method)">#thumbnail_url</a></span></p>
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+
301
+ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="../Model.html" title="WscSdk::Model (class)">WscSdk::Model</a></span></h3>
302
+ <p class="inherited"><span class='object_link'><a href="../Model.html#add_error-instance_method" title="WscSdk::Model#add_error (method)">#add_error</a></span>, <span class='object_link'><a href="../Model.html#attribute-class_method" title="WscSdk::Model.attribute (method)">attribute</a></span>, <span class='object_link'><a href="../Model.html#build_payload-instance_method" title="WscSdk::Model#build_payload (method)">#build_payload</a></span>, <span class='object_link'><a href="../Model.html#build_payload!-instance_method" title="WscSdk::Model#build_payload! (method)">#build_payload!</a></span>, <span class='object_link'><a href="../Model.html#clean!-instance_method" title="WscSdk::Model#clean! (method)">#clean!</a></span>, <span class='object_link'><a href="../Model.html#clear_primary_key-instance_method" title="WscSdk::Model#clear_primary_key (method)">#clear_primary_key</a></span>, <span class='object_link'><a href="../Model.html#delete-instance_method" title="WscSdk::Model#delete (method)">#delete</a></span>, <span class='object_link'><a href="../Model.html#dirty%3F-instance_method" title="WscSdk::Model#dirty? (method)">#dirty?</a></span>, <span class='object_link'><a href="../Model.html#has_attribute%3F-instance_method" title="WscSdk::Model#has_attribute? (method)">#has_attribute?</a></span>, <span class='object_link'><a href="../Model.html#ingest_attribute-instance_method" title="WscSdk::Model#ingest_attribute (method)">#ingest_attribute</a></span>, <span class='object_link'><a href="../Model.html#ingest_attributes-instance_method" title="WscSdk::Model#ingest_attributes (method)">#ingest_attributes</a></span>, <span class='object_link'><a href="../Model.html#initialize-instance_method" title="WscSdk::Model#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="../Model.html#initialize_attributes-instance_method" title="WscSdk::Model#initialize_attributes (method)">#initialize_attributes</a></span>, <span class='object_link'><a href="../Model.html#model_name_plural-class_method" title="WscSdk::Model.model_name_plural (method)">model_name_plural</a></span>, <span class='object_link'><a href="../Model.html#model_name_singular-class_method" title="WscSdk::Model.model_name_singular (method)">model_name_singular</a></span>, <span class='object_link'><a href="../Model.html#new_model%3F-instance_method" title="WscSdk::Model#new_model? (method)">#new_model?</a></span>, <span class='object_link'><a href="../Model.html#primary_key-class_method" title="WscSdk::Model.primary_key (method)">primary_key</a></span>, <span class='object_link'><a href="../Model.html#primary_key-instance_method" title="WscSdk::Model#primary_key (method)">#primary_key</a></span>, <span class='object_link'><a href="../Model.html#primary_key_attribute-instance_method" title="WscSdk::Model#primary_key_attribute (method)">#primary_key_attribute</a></span>, <span class='object_link'><a href="../Model.html#refresh-instance_method" title="WscSdk::Model#refresh (method)">#refresh</a></span>, <span class='object_link'><a href="../Model.html#save-instance_method" title="WscSdk::Model#save (method)">#save</a></span>, <span class='object_link'><a href="../Model.html#schema-class_method" title="WscSdk::Model.schema (method)">schema</a></span>, <span class='object_link'><a href="../Model.html#schema-instance_method" title="WscSdk::Model#schema (method)">#schema</a></span>, <span class='object_link'><a href="../Model.html#success%3F-instance_method" title="WscSdk::Model#success? (method)">#success?</a></span>, <span class='object_link'><a href="../Model.html#valid!-instance_method" title="WscSdk::Model#valid! (method)">#valid!</a></span>, <span class='object_link'><a href="../Model.html#valid%3F-instance_method" title="WscSdk::Model#valid? (method)">#valid?</a></span>, <span class='object_link'><a href="../Model.html#validate-instance_method" title="WscSdk::Model#validate (method)">#validate</a></span></p>
303
+
304
+
305
+
306
+
307
+
308
+
309
+
310
+
311
+
312
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="../Loggable.html" title="WscSdk::Loggable (module)">Loggable</a></span></h3>
313
+ <p class="inherited"><span class='object_link'><a href="../Loggable.html#logger-instance_method" title="WscSdk::Loggable#logger (method)">#logger</a></span>, <span class='object_link'><a href="../Loggable.html#logger=-instance_method" title="WscSdk::Loggable#logger= (method)">#logger=</a></span></p>
314
+
315
+
316
+
317
+
318
+
319
+
320
+
321
+
322
+
323
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="../ApiResponse.html" title="WscSdk::ApiResponse (module)">ApiResponse</a></span></h3>
324
+ <p class="inherited"><span class='object_link'><a href="../ApiResponse.html#success%3F-instance_method" title="WscSdk::ApiResponse#success? (method)">#success?</a></span></p>
325
+ <div id="constructor_details" class="method_details_list">
326
+ <h2>Constructor Details</h2>
327
+
328
+ <p class="notice">This class inherits a constructor from <span class='object_link'><a href="../Model.html#initialize-instance_method" title="WscSdk::Model#initialize (method)">WscSdk::Model</a></span></p>
329
+
330
+ </div>
331
+
332
+
333
+ <div id="instance_method_details" class="method_details_list">
334
+ <h2>Instance Method Details</h2>
335
+
336
+
337
+ <div class="method_details first">
338
+ <h3 class="signature first" id="default_source_url-instance_method">
339
+
340
+ #<strong>default_source_url</strong> &#x21d2; <tt>Object</tt>
341
+
342
+
343
+
344
+
345
+
346
+ </h3><div class="docstring">
347
+ <div class="discussion">
348
+
349
+ <p>Since the source_url is a write only attribute, when we update the live
350
+ stream the value is no longer present, so we will default it to the value
351
+ returned in the source_connection_information attribute, if it is present.</p>
352
+
353
+
354
+ </div>
355
+ </div>
356
+ <div class="tags">
357
+
358
+
359
+ </div><table class="source_code">
360
+ <tr>
361
+ <td>
362
+ <pre class="lines">
363
+
364
+
365
+ 104
366
+ 105
367
+ 106
368
+ 107
369
+ 108</pre>
370
+ </td>
371
+ <td>
372
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/models/live_stream.rb', line 104</span>
373
+
374
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">default_source_url</span>
375
+ sci = (<span style="color:#069">self</span>.attributes[<span style="color:#A60">:source_connection_information</span>] || {})
376
+ <span style="color:#080;font-weight:bold">return</span> sci[<span style="color:#A60">:source_url</span>] <span style="color:#080;font-weight:bold">if</span> sci.has_key?(<span style="color:#A60">:source_url</span>)
377
+ <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">nil</span>
378
+ <span style="color:#080;font-weight:bold">end</span></pre>
379
+ </td>
380
+ </tr>
381
+ </table>
382
+ </div>
383
+
384
+ <div class="method_details ">
385
+ <h3 class="signature " id="delivery_type_is_required?-instance_method">
386
+
387
+ #<strong>delivery_type_is_required?</strong> &#x21d2; <tt>Boolean</tt>
388
+
389
+
390
+
391
+
392
+
393
+ </h3><div class="docstring">
394
+ <div class="discussion">
395
+
396
+ <p>Determine if the delivery type opitons is required</p>
397
+
398
+
399
+ </div>
400
+ </div>
401
+ <div class="tags">
402
+
403
+ <p class="tag_title">Returns:</p>
404
+ <ul class="return">
405
+
406
+ <li>
407
+
408
+
409
+ <span class='type'>(<tt>Boolean</tt>)</span>
410
+
411
+
412
+
413
+ </li>
414
+
415
+ </ul>
416
+
417
+ </div><table class="source_code">
418
+ <tr>
419
+ <td>
420
+ <pre class="lines">
421
+
422
+
423
+ 89
424
+ 90
425
+ 91</pre>
426
+ </td>
427
+ <td>
428
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/models/live_stream.rb', line 89</span>
429
+
430
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">delivery_type_is_required?</span>
431
+ encoder == <span style="color:#036;font-weight:bold">Enums</span>::<span style="color:#036;font-weight:bold">Encoder</span>::<span style="color:#036;font-weight:bold">WOWZA_STREAMING_ENGINE</span>
432
+ <span style="color:#080;font-weight:bold">end</span></pre>
433
+ </td>
434
+ </tr>
435
+ </table>
436
+ </div>
437
+
438
+ <div class="method_details ">
439
+ <h3 class="signature " id="hosted_page_access-instance_method">
440
+
441
+ #<strong>hosted_page_access</strong> &#x21d2; <tt>Object</tt>
442
+
443
+
444
+
445
+
446
+
447
+ </h3><div class="docstring">
448
+ <div class="discussion">
449
+
450
+ <p>Determine if the hosted page option can be set</p>
451
+
452
+
453
+ </div>
454
+ </div>
455
+ <div class="tags">
456
+
457
+
458
+ </div><table class="source_code">
459
+ <tr>
460
+ <td>
461
+ <pre class="lines">
462
+
463
+
464
+ 95
465
+ 96
466
+ 97</pre>
467
+ </td>
468
+ <td>
469
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/models/live_stream.rb', line 95</span>
470
+
471
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">hosted_page_access</span>
472
+ <span style="color:#069">self</span>.new_model? ? <span style="color:#A60">:read_write</span> : <span style="color:#A60">:read</span>
473
+ <span style="color:#080;font-weight:bold">end</span></pre>
474
+ </td>
475
+ </tr>
476
+ </table>
477
+ </div>
478
+
479
+ <div class="method_details ">
480
+ <h3 class="signature " id="regenerate_connection_code-instance_method">
481
+
482
+ #<strong>regenerate_connection_code</strong> &#x21d2; <tt><span class='object_link'><a href="TranscoderConnectionCode.html" title="WscSdk::Models::TranscoderConnectionCode (class)">WscSdk::Models::TranscoderConnectionCode</a></span></tt>
483
+
484
+
485
+
486
+
487
+
488
+ </h3><div class="docstring">
489
+ <div class="discussion">
490
+
491
+ <p>Regenerates the connection code for the transcoder.</p>
492
+
493
+
494
+ </div>
495
+ </div>
496
+ <div class="tags">
497
+
498
+ <p class="tag_title">Returns:</p>
499
+ <ul class="return">
500
+
501
+ <li>
502
+
503
+
504
+ <span class='type'>(<tt><span class='object_link'><a href="TranscoderConnectionCode.html" title="WscSdk::Models::TranscoderConnectionCode (class)">WscSdk::Models::TranscoderConnectionCode</a></span></tt>)</span>
505
+
506
+
507
+
508
+ &mdash;
509
+ <div class='inline'>
510
+ <p>The regenerated connection code information.</p>
511
+ </div>
512
+
513
+ </li>
514
+
515
+ </ul>
516
+
517
+ </div><table class="source_code">
518
+ <tr>
519
+ <td>
520
+ <pre class="lines">
521
+
522
+
523
+ 124
524
+ 125
525
+ 126</pre>
526
+ </td>
527
+ <td>
528
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/models/live_stream.rb', line 124</span>
529
+
530
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">regenerate_connection_code</span>
531
+ <span style="color:#080;font-weight:bold">return</span> <span style="color:#069">self</span>.endpoint.regenerate_connection_code(<span style="color:#069">self</span>.id)
532
+ <span style="color:#080;font-weight:bold">end</span></pre>
533
+ </td>
534
+ </tr>
535
+ </table>
536
+ </div>
537
+
538
+ <div class="method_details ">
539
+ <h3 class="signature " id="source_url_is_required?-instance_method">
540
+
541
+ #<strong>source_url_is_required?</strong> &#x21d2; <tt>Boolean</tt>
542
+
543
+
544
+
545
+
546
+
547
+ </h3><div class="docstring">
548
+ <div class="discussion">
549
+
550
+ <p>Determine if the source_url attribute is required</p>
551
+
552
+
553
+ </div>
554
+ </div>
555
+ <div class="tags">
556
+
557
+ <p class="tag_title">Returns:</p>
558
+ <ul class="return">
559
+
560
+ <li>
561
+
562
+
563
+ <span class='type'>(<tt>Boolean</tt>)</span>
564
+
565
+
566
+
567
+ </li>
568
+
569
+ </ul>
570
+
571
+ </div><table class="source_code">
572
+ <tr>
573
+ <td>
574
+ <pre class="lines">
575
+
576
+
577
+ 83
578
+ 84
579
+ 85</pre>
580
+ </td>
581
+ <td>
582
+ <pre class="code"><span class="info file"># File 'lib/wsc_sdk/models/live_stream.rb', line 83</span>
583
+
584
+ <span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">source_url_is_required?</span>
585
+ delivery_method == <span style="color:#036;font-weight:bold">Enums</span>::<span style="color:#036;font-weight:bold">DeliveryMethod</span>::<span style="color:#036;font-weight:bold">PULL</span>
586
+ <span style="color:#080;font-weight:bold">end</span></pre>
587
+ </td>
588
+ </tr>
589
+ </table>
590
+ </div>
591
+
592
+ </div>
593
+
594
+ </div>
595
+
596
+
597
+ </div>
598
+ </div>
599
+ </div>
600
+ </body>
601
+ </html>