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.
- checksums.yaml +7 -0
- data/.circleci/config.yml +146 -0
- data/.circleci/docker/build/Dockerfile +3 -0
- data/.circleci/helpers/add_preamble.rb +29 -0
- data/.circleci/helpers/build_docs.sh +5 -0
- data/.circleci/helpers/build_gem.sh +5 -0
- data/.circleci/helpers/debundle-context.sh +14 -0
- data/.circleci/helpers/finalize_release.sh +24 -0
- data/.circleci/helpers/publish_docs.sh +10 -0
- data/.circleci/helpers/release_gem.sh +8 -0
- data/.circleci/helpers/setup.sh +11 -0
- data/.circleci/helpers/setup_aws.sh +13 -0
- data/.circleci/helpers/setup_gem.sh +2 -0
- data/.circleci/helpers/setup_git.sh +27 -0
- data/.circleci/helpers/setup_rubygems.sh +15 -0
- data/.circleci/helpers/test_integration.sh +12 -0
- data/.circleci/helpers/test_unit.sh +6 -0
- data/.circleci/jobs/publish-production.sh +17 -0
- data/.circleci/jobs/publish-staging.sh +17 -0
- data/.circleci/jobs/release-production.sh +21 -0
- data/.circleci/jobs/test-integration.sh +9 -0
- data/.circleci/jobs/test-unit.sh +9 -0
- data/.circleci/tag_repo.rb +46 -0
- data/.gitignore +28 -0
- data/.rspec +2 -0
- data/.yard/config +2 -0
- data/.yard/template/default/fulldoc/html/css/custom.css +151 -0
- data/.yard/template/default/layout/html/footer.erb +0 -0
- data/.yard/template/default/layout/html/headers.erb +10 -0
- data/.yard/template/default/layout/html/layout.erb +45 -0
- data/.yard/template/default/layout/html/setup.rb +24 -0
- data/.yardopts +1 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/Gemfile.lock +99 -0
- data/LICENSE.txt +28 -0
- data/README.md +397 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/doc/Hash.html +291 -0
- data/doc/WscSdk.html +570 -0
- data/doc/WscSdk/ApiResponse.html +242 -0
- data/doc/WscSdk/Attributes.html +128 -0
- data/doc/WscSdk/Attributes/Mode.html +191 -0
- data/doc/WscSdk/Attributes/Type.html +389 -0
- data/doc/WscSdk/Client.html +2677 -0
- data/doc/WscSdk/Configuration.html +595 -0
- data/doc/WscSdk/Endpoint.html +2974 -0
- data/doc/WscSdk/Endpoints.html +141 -0
- data/doc/WscSdk/Endpoints/CustomStreamTargets.html +383 -0
- data/doc/WscSdk/Endpoints/LiveStreams.html +197 -0
- data/doc/WscSdk/Endpoints/OutputStreamTargets.html +180 -0
- data/doc/WscSdk/Endpoints/Outputs.html +180 -0
- data/doc/WscSdk/Endpoints/StreamTargets.html +446 -0
- data/doc/WscSdk/Endpoints/Transcoders.html +197 -0
- data/doc/WscSdk/Endpoints/UllStreamTargets.html +383 -0
- data/doc/WscSdk/Endpoints/WowzaStreamTargets.html +383 -0
- data/doc/WscSdk/Enum.html +225 -0
- data/doc/WscSdk/Enums.html +321 -0
- data/doc/WscSdk/Enums/BillingMode.html +188 -0
- data/doc/WscSdk/Enums/BroadcastLocation.html +396 -0
- data/doc/WscSdk/Enums/BufferSize.html +301 -0
- data/doc/WscSdk/Enums/ClosedCaptionType.html +221 -0
- data/doc/WscSdk/Enums/CustomProvider.html +252 -0
- data/doc/WscSdk/Enums/DeliveryMethod.html +188 -0
- data/doc/WscSdk/Enums/DeliveryType.html +188 -0
- data/doc/WscSdk/Enums/Encoder.html +460 -0
- data/doc/WscSdk/Enums/Errors.html +555 -0
- data/doc/WscSdk/Enums/IdleTimeout.html +398 -0
- data/doc/WscSdk/Enums/ImagePosition.html +220 -0
- data/doc/WscSdk/Enums/ModelMode.html +175 -0
- data/doc/WscSdk/Enums/ModelType.html +373 -0
- data/doc/WscSdk/Enums/PlayerType.html +188 -0
- data/doc/WscSdk/Enums/Protocol.html +204 -0
- data/doc/WscSdk/Enums/TargetDeliveryProtocol.html +188 -0
- data/doc/WscSdk/Enums/TranscoderType.html +188 -0
- data/doc/WscSdk/Enums/UserRegion.html +383 -0
- data/doc/WscSdk/Enums/WowzaProvider.html +188 -0
- data/doc/WscSdk/Errors.html +683 -0
- data/doc/WscSdk/Loggable.html +346 -0
- data/doc/WscSdk/Model.html +3316 -0
- data/doc/WscSdk/ModelList.html +442 -0
- data/doc/WscSdk/ModelTemplate.html +267 -0
- data/doc/WscSdk/Models.html +141 -0
- data/doc/WscSdk/Models/CustomStreamTarget.html +192 -0
- data/doc/WscSdk/Models/Error.html +351 -0
- data/doc/WscSdk/Models/LiveStream.html +601 -0
- data/doc/WscSdk/Models/LiveStreamConnectionCode.html +192 -0
- data/doc/WscSdk/Models/LiveStreamState.html +200 -0
- data/doc/WscSdk/Models/LiveStreamStats.html +200 -0
- data/doc/WscSdk/Models/LiveStreamThumbnailUrl.html +200 -0
- data/doc/WscSdk/Models/Output.html +294 -0
- data/doc/WscSdk/Models/OutputStreamTarget.html +274 -0
- data/doc/WscSdk/Models/StreamTarget.html +273 -0
- data/doc/WscSdk/Models/Transcoder.html +793 -0
- data/doc/WscSdk/Models/TranscoderBooleanStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderConnectionCode.html +192 -0
- data/doc/WscSdk/Models/TranscoderFloatStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderIntegerStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderState.html +196 -0
- data/doc/WscSdk/Models/TranscoderStats.html +196 -0
- data/doc/WscSdk/Models/TranscoderStreamTargetState.html +192 -0
- data/doc/WscSdk/Models/TranscoderStringStat.html +278 -0
- data/doc/WscSdk/Models/TranscoderThumbnailUrl.html +196 -0
- data/doc/WscSdk/Models/UllStreamTarget.html +360 -0
- data/doc/WscSdk/Models/WowzaStreamTarget.html +380 -0
- data/doc/WscSdk/Pagination.html +1277 -0
- data/doc/WscSdk/Schema.html +861 -0
- data/doc/WscSdk/SchemaAttribute.html +2400 -0
- data/doc/WscSdk/Templates.html +141 -0
- data/doc/WscSdk/Templates/CustomStreamTarget.html +1045 -0
- data/doc/WscSdk/Templates/LiveStream.html +1432 -0
- data/doc/WscSdk/Templates/Output.html +829 -0
- data/doc/WscSdk/Templates/Transcoder.html +699 -0
- data/doc/WscSdk/Templates/UllStreamTarget.html +411 -0
- data/doc/WscSdk/Templates/WowzaStreamTarget.html +447 -0
- data/doc/WscSdk/TranscoderSharedMethods.html +1113 -0
- data/doc/_index.html +705 -0
- data/doc/class_list.html +51 -0
- data/doc/css/bootstrap.css +5 -0
- data/doc/css/common.css +1 -0
- data/doc/css/custom.css +151 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +570 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/images/wsc-ruby-1800x400.png +0 -0
- data/doc/index.html +570 -0
- data/doc/js/app.js +292 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +1731 -0
- data/doc/top-level-namespace.html +182 -0
- data/examples/client.rb +40 -0
- data/examples/helpers.rb +100 -0
- data/examples/live_streams/create.rb +39 -0
- data/examples/live_streams/delete.rb +32 -0
- data/examples/live_streams/find.rb +22 -0
- data/examples/live_streams/flood.rb +126 -0
- data/examples/live_streams/list.rb +24 -0
- data/examples/live_streams/regenerate_connection_code.rb +29 -0
- data/examples/live_streams/reset.rb +32 -0
- data/examples/live_streams/reset_and_wait.rb +51 -0
- data/examples/live_streams/start.rb +33 -0
- data/examples/live_streams/start_and_wait.rb +51 -0
- data/examples/live_streams/state.rb +33 -0
- data/examples/live_streams/stats.rb +43 -0
- data/examples/live_streams/stop.rb +33 -0
- data/examples/live_streams/stop_and_wait.rb +51 -0
- data/examples/live_streams/thumbnail_url.rb +46 -0
- data/examples/live_streams/update.rb +43 -0
- data/examples/live_streams/workflow.rb +165 -0
- data/examples/output_stream_targets/create.rb +56 -0
- data/examples/output_stream_targets/delete.rb +45 -0
- data/examples/output_stream_targets/find.rb +37 -0
- data/examples/output_stream_targets/list.rb +36 -0
- data/examples/output_stream_targets/update.rb +56 -0
- data/examples/outputs/create.rb +49 -0
- data/examples/outputs/delete.rb +39 -0
- data/examples/outputs/find.rb +31 -0
- data/examples/outputs/list.rb +29 -0
- data/examples/outputs/update.rb +50 -0
- data/examples/stream_targets/custom/create.rb +42 -0
- data/examples/stream_targets/custom/delete.rb +31 -0
- data/examples/stream_targets/custom/find.rb +23 -0
- data/examples/stream_targets/custom/list.rb +24 -0
- data/examples/stream_targets/custom/update.rb +43 -0
- data/examples/stream_targets/list.rb +24 -0
- data/examples/stream_targets/ull/create.rb +41 -0
- data/examples/stream_targets/ull/delete.rb +31 -0
- data/examples/stream_targets/ull/find.rb +23 -0
- data/examples/stream_targets/ull/list.rb +24 -0
- data/examples/stream_targets/ull/update.rb +43 -0
- data/examples/stream_targets/wowza/create.rb +42 -0
- data/examples/stream_targets/wowza/delete.rb +31 -0
- data/examples/stream_targets/wowza/find.rb +23 -0
- data/examples/stream_targets/wowza/list.rb +23 -0
- data/examples/stream_targets/wowza/update.rb +43 -0
- data/examples/transcoders/create.rb +39 -0
- data/examples/transcoders/delete.rb +31 -0
- data/examples/transcoders/find.rb +23 -0
- data/examples/transcoders/list.rb +24 -0
- data/examples/transcoders/reset.rb +32 -0
- data/examples/transcoders/reset_and_wait.rb +48 -0
- data/examples/transcoders/start.rb +33 -0
- data/examples/transcoders/start_and_wait.rb +50 -0
- data/examples/transcoders/state.rb +33 -0
- data/examples/transcoders/stats.rb +43 -0
- data/examples/transcoders/stop.rb +33 -0
- data/examples/transcoders/stop_and_wait.rb +50 -0
- data/examples/transcoders/thumbnail_url.rb +46 -0
- data/examples/transcoders/update.rb +43 -0
- data/images/wsc-ruby-1800x400.png +0 -0
- data/lib/wsc_sdk.rb +81 -0
- data/lib/wsc_sdk/client.rb +417 -0
- data/lib/wsc_sdk/configuration.rb +21 -0
- data/lib/wsc_sdk/constants.rb +29 -0
- data/lib/wsc_sdk/endpoint.rb +492 -0
- data/lib/wsc_sdk/endpoints/custom_stream_targets.rb +44 -0
- data/lib/wsc_sdk/endpoints/live_streams.rb +34 -0
- data/lib/wsc_sdk/endpoints/output_stream_targets.rb +17 -0
- data/lib/wsc_sdk/endpoints/outputs.rb +17 -0
- data/lib/wsc_sdk/endpoints/stream_targets.rb +45 -0
- data/lib/wsc_sdk/endpoints/transcoders.rb +38 -0
- data/lib/wsc_sdk/endpoints/ull_stream_targets.rb +44 -0
- data/lib/wsc_sdk/endpoints/wowza_stream_targets.rb +44 -0
- data/lib/wsc_sdk/enums.rb +31 -0
- data/lib/wsc_sdk/enums/billing_mode.rb +20 -0
- data/lib/wsc_sdk/enums/broadcast_location.rb +58 -0
- data/lib/wsc_sdk/enums/buffer_size.rb +41 -0
- data/lib/wsc_sdk/enums/closed_caption_type.rb +26 -0
- data/lib/wsc_sdk/enums/custom_provider.rb +32 -0
- data/lib/wsc_sdk/enums/delivery_method.rb +20 -0
- data/lib/wsc_sdk/enums/delivery_type.rb +20 -0
- data/lib/wsc_sdk/enums/encoder.rb +71 -0
- data/lib/wsc_sdk/enums/idle_timeout.rb +50 -0
- data/lib/wsc_sdk/enums/image_position.rb +26 -0
- data/lib/wsc_sdk/enums/player_type.rb +20 -0
- data/lib/wsc_sdk/enums/protocol.rb +23 -0
- data/lib/wsc_sdk/enums/target_delivery_protocol.rb +20 -0
- data/lib/wsc_sdk/enums/transcoder_type.rb +20 -0
- data/lib/wsc_sdk/enums/wowza_provider.rb +20 -0
- data/lib/wsc_sdk/errors.rb +115 -0
- data/lib/wsc_sdk/model.rb +515 -0
- data/lib/wsc_sdk/model_list.rb +42 -0
- data/lib/wsc_sdk/model_template.rb +27 -0
- data/lib/wsc_sdk/models/custom_stream_target.rb +34 -0
- data/lib/wsc_sdk/models/error.rb +53 -0
- data/lib/wsc_sdk/models/live_stream.rb +130 -0
- data/lib/wsc_sdk/models/live_stream_connection_code.rb +31 -0
- data/lib/wsc_sdk/models/live_stream_state.rb +20 -0
- data/lib/wsc_sdk/models/live_stream_stats.rb +20 -0
- data/lib/wsc_sdk/models/live_stream_thumbnail_url.rb +20 -0
- data/lib/wsc_sdk/models/output.rb +61 -0
- data/lib/wsc_sdk/models/output_stream_target.rb +37 -0
- data/lib/wsc_sdk/models/stream_target.rb +29 -0
- data/lib/wsc_sdk/models/transcoder.rb +135 -0
- data/lib/wsc_sdk/models/transcoder_boolean_stat.rb +41 -0
- data/lib/wsc_sdk/models/transcoder_connection_code.rb +29 -0
- data/lib/wsc_sdk/models/transcoder_float_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_integer_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_state.rb +31 -0
- data/lib/wsc_sdk/models/transcoder_stats.rb +51 -0
- data/lib/wsc_sdk/models/transcoder_stream_target_state.rb +29 -0
- data/lib/wsc_sdk/models/transcoder_string_stat.rb +40 -0
- data/lib/wsc_sdk/models/transcoder_thumbnail_url.rb +29 -0
- data/lib/wsc_sdk/models/ull_stream_target.rb +54 -0
- data/lib/wsc_sdk/models/wowza_stream_target.rb +60 -0
- data/lib/wsc_sdk/modules/api_response.rb +24 -0
- data/lib/wsc_sdk/modules/loggable.rb +44 -0
- data/lib/wsc_sdk/modules/transcoder_shared_methods.rb +221 -0
- data/lib/wsc_sdk/pagination.rb +89 -0
- data/lib/wsc_sdk/schema.rb +140 -0
- data/lib/wsc_sdk/schema_attribute.rb +349 -0
- data/lib/wsc_sdk/templates/custom_stream_target.rb +154 -0
- data/lib/wsc_sdk/templates/live_stream.rb +234 -0
- data/lib/wsc_sdk/templates/output.rb +133 -0
- data/lib/wsc_sdk/templates/transcoder.rb +97 -0
- data/lib/wsc_sdk/templates/ull_stream_target.rb +49 -0
- data/lib/wsc_sdk/templates/wowza_stream_target.rb +57 -0
- data/lib/wsc_sdk/version.rb +7 -0
- data/wsc_sdk.gemspec +48 -0
- metadata +460 -0
|
@@ -0,0 +1,1113 @@
|
|
|
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::TranscoderSharedMethods";
|
|
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 (T)</a> »
|
|
56
|
+
<span class='title'><span class='object_link'><a href="../WscSdk.html" title="WscSdk (module)">WscSdk</a></span></span>
|
|
57
|
+
»
|
|
58
|
+
<span class="title">TranscoderSharedMethods</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>Module: WscSdk::TranscoderSharedMethods
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
</h1>
|
|
83
|
+
<div class="box_info">
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
<dl>
|
|
94
|
+
<dt>Included in:</dt>
|
|
95
|
+
<dd><span class='object_link'><a href="Models/LiveStream.html" title="WscSdk::Models::LiveStream (class)">Models::LiveStream</a></span>, <span class='object_link'><a href="Models/Transcoder.html" title="WscSdk::Models::Transcoder (class)">Models::Transcoder</a></span></dd>
|
|
96
|
+
</dl>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<dl>
|
|
101
|
+
<dt>Defined in:</dt>
|
|
102
|
+
<dd>lib/wsc_sdk/modules/transcoder_shared_methods.rb</dd>
|
|
103
|
+
</dl>
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
<h2>Overview</h2><div class="docstring">
|
|
108
|
+
<div class="discussion">
|
|
109
|
+
|
|
110
|
+
<p>Module for providing methods to handle state actions and transitions for a
|
|
111
|
+
Transcoder or Live Stream model, since they have a lot of shared
|
|
112
|
+
functionality.</p>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
</div>
|
|
117
|
+
<div class="tags">
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
<h2>
|
|
129
|
+
Instance Method Summary
|
|
130
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
131
|
+
</h2>
|
|
132
|
+
|
|
133
|
+
<ul class="summary">
|
|
134
|
+
|
|
135
|
+
<li class="public ">
|
|
136
|
+
<span class="summary_signature">
|
|
137
|
+
|
|
138
|
+
<a href="#reset-instance_method" title="#reset (instance method)">#<strong>reset</strong>(options = {}) {|wait_state, transcoder_state| ... } ⇒ WscSdk::Model::TranscoderState </a>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</span>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
<span class="summary_desc"><div class='inline'>
|
|
153
|
+
<p>Reset the transcoder/live stream.</p>
|
|
154
|
+
</div></span>
|
|
155
|
+
|
|
156
|
+
</li>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
<li class="public ">
|
|
160
|
+
<span class="summary_signature">
|
|
161
|
+
|
|
162
|
+
<a href="#start-instance_method" title="#start (instance method)">#<strong>start</strong>(options = {}) {|wait_state, transcoder_state| ... } ⇒ WscSdk::Model::TranscoderState </a>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
</span>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
<span class="summary_desc"><div class='inline'>
|
|
177
|
+
<p>Start the transcoder/live stream.</p>
|
|
178
|
+
</div></span>
|
|
179
|
+
|
|
180
|
+
</li>
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<li class="public ">
|
|
184
|
+
<span class="summary_signature">
|
|
185
|
+
|
|
186
|
+
<a href="#state-instance_method" title="#state (instance method)">#<strong>state</strong> ⇒ WscSdk::Model::TranscoderState </a>
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
</span>
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class="summary_desc"><div class='inline'>
|
|
201
|
+
<p>Return the current state of the transcoder/live stream.</p>
|
|
202
|
+
</div></span>
|
|
203
|
+
|
|
204
|
+
</li>
|
|
205
|
+
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#stats-instance_method" title="#stats (instance method)">#<strong>stats</strong> ⇒ WscSdk::Model::TranscoderStats </a>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
|
225
|
+
<p>Return the url of the current stats for the transcoder/live stream.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#stop-instance_method" title="#stop (instance method)">#<strong>stop</strong>(options = {}) {|wait_state, transcoder_state| ... } ⇒ WscSdk::Model::TranscoderState </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>Stop the transcoder.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#thumbnail_url-instance_method" title="#thumbnail_url (instance method)">#<strong>thumbnail_url</strong> ⇒ WscSdk::Model::TranscoderThumbnailUrl </a>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
|
273
|
+
<p>Return the url of the current thumbnail for transcoder/live stream.</p>
|
|
274
|
+
</div></span>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
</ul>
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<div id="instance_method_details" class="method_details_list">
|
|
285
|
+
<h2>Instance Method Details</h2>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
<div class="method_details first">
|
|
289
|
+
<h3 class="signature first" id="reset-instance_method">
|
|
290
|
+
|
|
291
|
+
#<strong>reset</strong>(options = {}) {|wait_state, transcoder_state| ... } ⇒ <tt>WscSdk::Model::TranscoderState</tt>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
</h3><div class="docstring">
|
|
298
|
+
<div class="discussion">
|
|
299
|
+
|
|
300
|
+
<p>Reset the transcoder/live stream</p>
|
|
301
|
+
|
|
302
|
+
<p>If a block is passed to the call, the SDK will start a state request loop
|
|
303
|
+
that checks the state of the transcoder for a given period of time
|
|
304
|
+
(timeout). Each iteration of the wait loop will call the block with the
|
|
305
|
+
current state of the wait loop, and the current state of the transcoder</p>
|
|
306
|
+
|
|
307
|
+
<p>The wait state will be one of 3 options: :waiting, :complete or :timeout</p>
|
|
308
|
+
|
|
309
|
+
<p>The loop will exit when the transcoder state is “started” or the timeout
|
|
310
|
+
limit is reached.</p>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
</div>
|
|
314
|
+
</div>
|
|
315
|
+
<div class="tags">
|
|
316
|
+
|
|
317
|
+
<div class="examples">
|
|
318
|
+
<p class="tag_title">Examples:</p>
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
<p class="example_title"><div class='inline'>
|
|
322
|
+
<p>Simple Reset Request</p>
|
|
323
|
+
</div></p>
|
|
324
|
+
|
|
325
|
+
<pre class="example code"><code>state = transcoder.reset</code></pre>
|
|
326
|
+
|
|
327
|
+
|
|
328
|
+
<p class="example_title"><div class='inline'>
|
|
329
|
+
<p>Reset and Wait for Started</p>
|
|
330
|
+
</div></p>
|
|
331
|
+
|
|
332
|
+
<pre class="example code"><code>transcoder.reset <span style="color:#080;font-weight:bold">do</span> |wait_state, transcoder_state|
|
|
333
|
+
<span style="color:#080;font-weight:bold">if</span> wait_state == <span style="color:#A60">:waiting</span>
|
|
334
|
+
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Waiting for the transcoder to start...</span><span style="color:#710">"</span></span>
|
|
335
|
+
<span style="color:#080;font-weight:bold">if</span> wait_state == <span style="color:#A60">:timeout</span>
|
|
336
|
+
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">The transcoder did not start in within the timeout period.</span><span style="color:#710">"</span></span>
|
|
337
|
+
<span style="color:#080;font-weight:bold">else</span>
|
|
338
|
+
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Transcoder is </span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span>state.state<span style="font-weight:bold;color:#666">}</span></span><span style="color:#D20">. The IP Address is </span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span>state.ip_address<span style="font-weight:bold;color:#666">}</span></span><span style="color:#D20">.</span><span style="color:#710">"</span></span>
|
|
339
|
+
<span style="color:#080;font-weight:bold">end</span>
|
|
340
|
+
<span style="color:#080;font-weight:bold">end</span></code></pre>
|
|
341
|
+
|
|
342
|
+
</div>
|
|
343
|
+
<p class="tag_title">Parameters:</p>
|
|
344
|
+
<ul class="param">
|
|
345
|
+
|
|
346
|
+
<li>
|
|
347
|
+
|
|
348
|
+
<span class='name'>options</span>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
352
|
+
|
|
353
|
+
|
|
354
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
—
|
|
358
|
+
<div class='inline'>
|
|
359
|
+
<p>A hash of options</p>
|
|
360
|
+
</div>
|
|
361
|
+
|
|
362
|
+
</li>
|
|
363
|
+
|
|
364
|
+
</ul>
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
370
|
+
<ul class="option">
|
|
371
|
+
|
|
372
|
+
<li>
|
|
373
|
+
<span class="name">:timeout</span>
|
|
374
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
375
|
+
<span class="default">
|
|
376
|
+
|
|
377
|
+
— default:
|
|
378
|
+
<tt>30</tt>
|
|
379
|
+
|
|
380
|
+
</span>
|
|
381
|
+
|
|
382
|
+
— <div class='inline'>
|
|
383
|
+
<p>The maximum wait for a `started` state response.</p>
|
|
384
|
+
</div>
|
|
385
|
+
|
|
386
|
+
</li>
|
|
387
|
+
|
|
388
|
+
<li>
|
|
389
|
+
<span class="name">:poll_interval</span>
|
|
390
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
391
|
+
<span class="default">
|
|
392
|
+
|
|
393
|
+
— default:
|
|
394
|
+
<tt>5</tt>
|
|
395
|
+
|
|
396
|
+
</span>
|
|
397
|
+
|
|
398
|
+
— <div class='inline'>
|
|
399
|
+
<p>The wait time (in seconds) between state requests. (Min: 1)</p>
|
|
400
|
+
</div>
|
|
401
|
+
|
|
402
|
+
</li>
|
|
403
|
+
|
|
404
|
+
</ul>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
<p class="tag_title">Yields:</p>
|
|
408
|
+
<ul class="yield">
|
|
409
|
+
|
|
410
|
+
<li>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
<span class='type'>(<tt>wait_state</tt>, <tt>transcoder_state</tt>)</span>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
—
|
|
418
|
+
<div class='inline'>
|
|
419
|
+
<p>Calls the block with the states of the wait loop and the transcoder.</p>
|
|
420
|
+
</div>
|
|
421
|
+
|
|
422
|
+
</li>
|
|
423
|
+
|
|
424
|
+
</ul>
|
|
425
|
+
<p class="tag_title">Yield Parameters:</p>
|
|
426
|
+
<ul class="yieldparam">
|
|
427
|
+
|
|
428
|
+
<li>
|
|
429
|
+
|
|
430
|
+
<span class='name'>wait_state</span>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
—
|
|
438
|
+
<div class='inline'>
|
|
439
|
+
<p>The current state of the wait loop. Will always be one of the following:
|
|
440
|
+
:waiting, :complete, :cannot_change_state or :timeout</p>
|
|
441
|
+
</div>
|
|
442
|
+
|
|
443
|
+
</li>
|
|
444
|
+
|
|
445
|
+
<li>
|
|
446
|
+
|
|
447
|
+
<span class='name'>transcoder_state</span>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<span class='type'>(<tt>WscSdk::Model::TranscoderState</tt>)</span>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
—
|
|
455
|
+
<div class='inline'>
|
|
456
|
+
<p>The current transcoder state data.</p>
|
|
457
|
+
</div>
|
|
458
|
+
|
|
459
|
+
</li>
|
|
460
|
+
|
|
461
|
+
</ul>
|
|
462
|
+
<p class="tag_title">Returns:</p>
|
|
463
|
+
<ul class="return">
|
|
464
|
+
|
|
465
|
+
<li>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
<span class='type'>(<tt>WscSdk::Model::TranscoderState</tt>)</span>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
|
|
472
|
+
—
|
|
473
|
+
<div class='inline'>
|
|
474
|
+
<p>The transcoder state after the method execution has completed.</p>
|
|
475
|
+
</div>
|
|
476
|
+
|
|
477
|
+
</li>
|
|
478
|
+
|
|
479
|
+
</ul>
|
|
480
|
+
|
|
481
|
+
</div><table class="source_code">
|
|
482
|
+
<tr>
|
|
483
|
+
<td>
|
|
484
|
+
<pre class="lines">
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
147
|
|
488
|
+
148
|
|
489
|
+
149
|
|
490
|
+
150
|
|
491
|
+
151</pre>
|
|
492
|
+
</td>
|
|
493
|
+
<td>
|
|
494
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/modules/transcoder_shared_methods.rb', line 147</span>
|
|
495
|
+
|
|
496
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">reset</span>(options={}, &block)
|
|
497
|
+
current_state = <span style="color:#069">self</span>.endpoint.reset(<span style="color:#069">self</span>.id)
|
|
498
|
+
<span style="color:#080;font-weight:bold">return</span> wait_for_state(<span style="color:#A60">:started</span>, options, &block) <span style="color:#080;font-weight:bold">if</span> current_state.success? <span style="color:#080;font-weight:bold">and</span> block_given?
|
|
499
|
+
<span style="color:#080;font-weight:bold">return</span> current_state
|
|
500
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
501
|
+
</td>
|
|
502
|
+
</tr>
|
|
503
|
+
</table>
|
|
504
|
+
</div>
|
|
505
|
+
|
|
506
|
+
<div class="method_details ">
|
|
507
|
+
<h3 class="signature " id="start-instance_method">
|
|
508
|
+
|
|
509
|
+
#<strong>start</strong>(options = {}) {|wait_state, transcoder_state| ... } ⇒ <tt>WscSdk::Model::TranscoderState</tt>
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
|
|
515
|
+
</h3><div class="docstring">
|
|
516
|
+
<div class="discussion">
|
|
517
|
+
|
|
518
|
+
<p>Start the transcoder/live stream</p>
|
|
519
|
+
|
|
520
|
+
<p>If a block is passed to the call, the SDK will start a state request loop
|
|
521
|
+
that checks the state of the transcoder for a given period of time
|
|
522
|
+
(timeout). Each iteration of the wait loop will call the block with the
|
|
523
|
+
current state of the wait loop, and the current state of the transcoder</p>
|
|
524
|
+
|
|
525
|
+
<p>The wait state will be one of 3 options: :waiting, :complete or :timeout</p>
|
|
526
|
+
|
|
527
|
+
<p>The loop will exit when the transcoder state is “started” or the timeout
|
|
528
|
+
limit is reached.</p>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
</div>
|
|
532
|
+
</div>
|
|
533
|
+
<div class="tags">
|
|
534
|
+
|
|
535
|
+
<div class="examples">
|
|
536
|
+
<p class="tag_title">Examples:</p>
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
<p class="example_title"><div class='inline'>
|
|
540
|
+
<p>Simple Start Request</p>
|
|
541
|
+
</div></p>
|
|
542
|
+
|
|
543
|
+
<pre class="example code"><code>state = transcoder.start</code></pre>
|
|
544
|
+
|
|
545
|
+
|
|
546
|
+
<p class="example_title"><div class='inline'>
|
|
547
|
+
<p>Start and Wait for Started</p>
|
|
548
|
+
</div></p>
|
|
549
|
+
|
|
550
|
+
<pre class="example code"><code>transcoder.start <span style="color:#080;font-weight:bold">do</span> |wait_state, transcoder_state|
|
|
551
|
+
<span style="color:#080;font-weight:bold">if</span> wait_state == <span style="color:#A60">:waiting</span>
|
|
552
|
+
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Waiting for the transcoder to start...</span><span style="color:#710">"</span></span>
|
|
553
|
+
<span style="color:#080;font-weight:bold">if</span> wait_state == <span style="color:#A60">:timeout</span>
|
|
554
|
+
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">The transcoder did not start in within the timeout period.</span><span style="color:#710">"</span></span>
|
|
555
|
+
<span style="color:#080;font-weight:bold">else</span>
|
|
556
|
+
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Transcoder is </span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span>state.state<span style="font-weight:bold;color:#666">}</span></span><span style="color:#D20">. The IP Address is </span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span>state.ip_address<span style="font-weight:bold;color:#666">}</span></span><span style="color:#D20">.</span><span style="color:#710">"</span></span>
|
|
557
|
+
<span style="color:#080;font-weight:bold">end</span>
|
|
558
|
+
<span style="color:#080;font-weight:bold">end</span></code></pre>
|
|
559
|
+
|
|
560
|
+
</div>
|
|
561
|
+
<p class="tag_title">Parameters:</p>
|
|
562
|
+
<ul class="param">
|
|
563
|
+
|
|
564
|
+
<li>
|
|
565
|
+
|
|
566
|
+
<span class='name'>options</span>
|
|
567
|
+
|
|
568
|
+
|
|
569
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
573
|
+
|
|
574
|
+
|
|
575
|
+
—
|
|
576
|
+
<div class='inline'>
|
|
577
|
+
<p>A hash of options</p>
|
|
578
|
+
</div>
|
|
579
|
+
|
|
580
|
+
</li>
|
|
581
|
+
|
|
582
|
+
</ul>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
|
|
586
|
+
|
|
587
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
588
|
+
<ul class="option">
|
|
589
|
+
|
|
590
|
+
<li>
|
|
591
|
+
<span class="name">:timeout</span>
|
|
592
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
593
|
+
<span class="default">
|
|
594
|
+
|
|
595
|
+
— default:
|
|
596
|
+
<tt>30</tt>
|
|
597
|
+
|
|
598
|
+
</span>
|
|
599
|
+
|
|
600
|
+
— <div class='inline'>
|
|
601
|
+
<p>The maximum wait for a `started` state response.</p>
|
|
602
|
+
</div>
|
|
603
|
+
|
|
604
|
+
</li>
|
|
605
|
+
|
|
606
|
+
<li>
|
|
607
|
+
<span class="name">:poll_interval</span>
|
|
608
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
609
|
+
<span class="default">
|
|
610
|
+
|
|
611
|
+
— default:
|
|
612
|
+
<tt>5</tt>
|
|
613
|
+
|
|
614
|
+
</span>
|
|
615
|
+
|
|
616
|
+
— <div class='inline'>
|
|
617
|
+
<p>The wait time (in seconds) between state requests. (Min: 1)</p>
|
|
618
|
+
</div>
|
|
619
|
+
|
|
620
|
+
</li>
|
|
621
|
+
|
|
622
|
+
</ul>
|
|
623
|
+
|
|
624
|
+
|
|
625
|
+
<p class="tag_title">Yields:</p>
|
|
626
|
+
<ul class="yield">
|
|
627
|
+
|
|
628
|
+
<li>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
<span class='type'>(<tt>wait_state</tt>, <tt>transcoder_state</tt>)</span>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
—
|
|
636
|
+
<div class='inline'>
|
|
637
|
+
<p>Calls the block with the states of the wait loop and the transcoder.</p>
|
|
638
|
+
</div>
|
|
639
|
+
|
|
640
|
+
</li>
|
|
641
|
+
|
|
642
|
+
</ul>
|
|
643
|
+
<p class="tag_title">Yield Parameters:</p>
|
|
644
|
+
<ul class="yieldparam">
|
|
645
|
+
|
|
646
|
+
<li>
|
|
647
|
+
|
|
648
|
+
<span class='name'>wait_state</span>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
652
|
+
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
—
|
|
656
|
+
<div class='inline'>
|
|
657
|
+
<p>The current state of the wait loop. Will always be one of the following:
|
|
658
|
+
:waiting, :complete, :cannot_change_state or :timeout</p>
|
|
659
|
+
</div>
|
|
660
|
+
|
|
661
|
+
</li>
|
|
662
|
+
|
|
663
|
+
<li>
|
|
664
|
+
|
|
665
|
+
<span class='name'>transcoder_state</span>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
<span class='type'>(<tt>WscSdk::Model::TranscoderState</tt>)</span>
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
—
|
|
673
|
+
<div class='inline'>
|
|
674
|
+
<p>The current transcoder state data.</p>
|
|
675
|
+
</div>
|
|
676
|
+
|
|
677
|
+
</li>
|
|
678
|
+
|
|
679
|
+
</ul>
|
|
680
|
+
<p class="tag_title">Returns:</p>
|
|
681
|
+
<ul class="return">
|
|
682
|
+
|
|
683
|
+
<li>
|
|
684
|
+
|
|
685
|
+
|
|
686
|
+
<span class='type'>(<tt>WscSdk::Model::TranscoderState</tt>)</span>
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
—
|
|
691
|
+
<div class='inline'>
|
|
692
|
+
<p>The transcoder state after the method execution has completed.</p>
|
|
693
|
+
</div>
|
|
694
|
+
|
|
695
|
+
</li>
|
|
696
|
+
|
|
697
|
+
</ul>
|
|
698
|
+
|
|
699
|
+
</div><table class="source_code">
|
|
700
|
+
<tr>
|
|
701
|
+
<td>
|
|
702
|
+
<pre class="lines">
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
59
|
|
706
|
+
60
|
|
707
|
+
61
|
|
708
|
+
62
|
|
709
|
+
63</pre>
|
|
710
|
+
</td>
|
|
711
|
+
<td>
|
|
712
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/modules/transcoder_shared_methods.rb', line 59</span>
|
|
713
|
+
|
|
714
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">start</span>(options={}, &block)
|
|
715
|
+
current_state = <span style="color:#069">self</span>.endpoint.start(<span style="color:#069">self</span>.id)
|
|
716
|
+
<span style="color:#080;font-weight:bold">return</span> wait_for_state(<span style="color:#A60">:started</span>, options, &block) <span style="color:#080;font-weight:bold">if</span> current_state.success? <span style="color:#080;font-weight:bold">and</span> block_given?
|
|
717
|
+
<span style="color:#080;font-weight:bold">return</span> current_state
|
|
718
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
719
|
+
</td>
|
|
720
|
+
</tr>
|
|
721
|
+
</table>
|
|
722
|
+
</div>
|
|
723
|
+
|
|
724
|
+
<div class="method_details ">
|
|
725
|
+
<h3 class="signature " id="state-instance_method">
|
|
726
|
+
|
|
727
|
+
#<strong>state</strong> ⇒ <tt>WscSdk::Model::TranscoderState</tt>
|
|
728
|
+
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
|
|
733
|
+
</h3><div class="docstring">
|
|
734
|
+
<div class="discussion">
|
|
735
|
+
|
|
736
|
+
<p>Return the current state of the transcoder/live stream.</p>
|
|
737
|
+
|
|
738
|
+
|
|
739
|
+
</div>
|
|
740
|
+
</div>
|
|
741
|
+
<div class="tags">
|
|
742
|
+
|
|
743
|
+
<p class="tag_title">Returns:</p>
|
|
744
|
+
<ul class="return">
|
|
745
|
+
|
|
746
|
+
<li>
|
|
747
|
+
|
|
748
|
+
|
|
749
|
+
<span class='type'>(<tt>WscSdk::Model::TranscoderState</tt>)</span>
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
</li>
|
|
754
|
+
|
|
755
|
+
</ul>
|
|
756
|
+
|
|
757
|
+
</div><table class="source_code">
|
|
758
|
+
<tr>
|
|
759
|
+
<td>
|
|
760
|
+
<pre class="lines">
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
157
|
|
764
|
+
158
|
|
765
|
+
159</pre>
|
|
766
|
+
</td>
|
|
767
|
+
<td>
|
|
768
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/modules/transcoder_shared_methods.rb', line 157</span>
|
|
769
|
+
|
|
770
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">state</span>
|
|
771
|
+
<span style="color:#080;font-weight:bold">return</span> <span style="color:#069">self</span>.endpoint.state(<span style="color:#069">self</span>.id)
|
|
772
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
773
|
+
</td>
|
|
774
|
+
</tr>
|
|
775
|
+
</table>
|
|
776
|
+
</div>
|
|
777
|
+
|
|
778
|
+
<div class="method_details ">
|
|
779
|
+
<h3 class="signature " id="stats-instance_method">
|
|
780
|
+
|
|
781
|
+
#<strong>stats</strong> ⇒ <tt>WscSdk::Model::TranscoderStats</tt>
|
|
782
|
+
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
</h3><div class="docstring">
|
|
788
|
+
<div class="discussion">
|
|
789
|
+
|
|
790
|
+
<p>Return the url of the current stats for the transcoder/live stream.</p>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
</div>
|
|
794
|
+
</div>
|
|
795
|
+
<div class="tags">
|
|
796
|
+
|
|
797
|
+
<p class="tag_title">Returns:</p>
|
|
798
|
+
<ul class="return">
|
|
799
|
+
|
|
800
|
+
<li>
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
<span class='type'>(<tt>WscSdk::Model::TranscoderStats</tt>)</span>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
</li>
|
|
808
|
+
|
|
809
|
+
</ul>
|
|
810
|
+
|
|
811
|
+
</div><table class="source_code">
|
|
812
|
+
<tr>
|
|
813
|
+
<td>
|
|
814
|
+
<pre class="lines">
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
174
|
|
818
|
+
175
|
|
819
|
+
176</pre>
|
|
820
|
+
</td>
|
|
821
|
+
<td>
|
|
822
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/modules/transcoder_shared_methods.rb', line 174</span>
|
|
823
|
+
|
|
824
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">stats</span>
|
|
825
|
+
<span style="color:#080;font-weight:bold">return</span> <span style="color:#069">self</span>.endpoint.stats(<span style="color:#069">self</span>.id)
|
|
826
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
827
|
+
</td>
|
|
828
|
+
</tr>
|
|
829
|
+
</table>
|
|
830
|
+
</div>
|
|
831
|
+
|
|
832
|
+
<div class="method_details ">
|
|
833
|
+
<h3 class="signature " id="stop-instance_method">
|
|
834
|
+
|
|
835
|
+
#<strong>stop</strong>(options = {}) {|wait_state, transcoder_state| ... } ⇒ <tt>WscSdk::Model::TranscoderState</tt>
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
</h3><div class="docstring">
|
|
842
|
+
<div class="discussion">
|
|
843
|
+
|
|
844
|
+
<p>Stop the transcoder</p>
|
|
845
|
+
|
|
846
|
+
<p>If a block is passed to the call, the SDK will start a state request loop
|
|
847
|
+
that checks the state of the transcoder for a given period of time
|
|
848
|
+
(timeout). Each iteration of the wait loop will call the block with the
|
|
849
|
+
current state of the wait loop, and the current state of the transcoder</p>
|
|
850
|
+
|
|
851
|
+
<p>The wait state will be one of 3 options: :waiting, :complete or :timeout</p>
|
|
852
|
+
|
|
853
|
+
<p>The loop will exit when the transcoder state is “stopped” or the timeout
|
|
854
|
+
limit is reached.</p>
|
|
855
|
+
|
|
856
|
+
|
|
857
|
+
</div>
|
|
858
|
+
</div>
|
|
859
|
+
<div class="tags">
|
|
860
|
+
|
|
861
|
+
<div class="examples">
|
|
862
|
+
<p class="tag_title">Examples:</p>
|
|
863
|
+
|
|
864
|
+
|
|
865
|
+
<p class="example_title"><div class='inline'>
|
|
866
|
+
<p>Simple Stop Request</p>
|
|
867
|
+
</div></p>
|
|
868
|
+
|
|
869
|
+
<pre class="example code"><code>state = transcoder.stop</code></pre>
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
<p class="example_title"><div class='inline'>
|
|
873
|
+
<p>Stop and Wait for Stopped</p>
|
|
874
|
+
</div></p>
|
|
875
|
+
|
|
876
|
+
<pre class="example code"><code>transcoder.stop <span style="color:#080;font-weight:bold">do</span> |wait_state, transcoder_state|
|
|
877
|
+
<span style="color:#080;font-weight:bold">if</span> wait_state == <span style="color:#A60">:waiting</span>
|
|
878
|
+
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Waiting for the transcoder to stop...</span><span style="color:#710">"</span></span>
|
|
879
|
+
<span style="color:#080;font-weight:bold">if</span> wait_state == <span style="color:#A60">:timeout</span>
|
|
880
|
+
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">The transcoder did not stop in within the timeout period.</span><span style="color:#710">"</span></span>
|
|
881
|
+
<span style="color:#080;font-weight:bold">else</span>
|
|
882
|
+
puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">"</span><span style="color:#D20">Transcoder is </span><span style="background-color:hsla(0,0%,0%,0.07);color:black"><span style="font-weight:bold;color:#666">#{</span>state.state<span style="font-weight:bold;color:#666">}</span></span><span style="color:#D20">.</span><span style="color:#710">"</span></span>
|
|
883
|
+
<span style="color:#080;font-weight:bold">end</span>
|
|
884
|
+
<span style="color:#080;font-weight:bold">end</span></code></pre>
|
|
885
|
+
|
|
886
|
+
</div>
|
|
887
|
+
<p class="tag_title">Parameters:</p>
|
|
888
|
+
<ul class="param">
|
|
889
|
+
|
|
890
|
+
<li>
|
|
891
|
+
|
|
892
|
+
<span class='name'>options</span>
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
<span class='type'>(<tt>Hash</tt>)</span>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
<em class="default">(defaults to: <tt>{}</tt>)</em>
|
|
899
|
+
|
|
900
|
+
|
|
901
|
+
—
|
|
902
|
+
<div class='inline'>
|
|
903
|
+
<p>A hash of options</p>
|
|
904
|
+
</div>
|
|
905
|
+
|
|
906
|
+
</li>
|
|
907
|
+
|
|
908
|
+
</ul>
|
|
909
|
+
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
<p class="tag_title">Options Hash (<tt>options</tt>):</p>
|
|
914
|
+
<ul class="option">
|
|
915
|
+
|
|
916
|
+
<li>
|
|
917
|
+
<span class="name">:timeout</span>
|
|
918
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
919
|
+
<span class="default">
|
|
920
|
+
|
|
921
|
+
— default:
|
|
922
|
+
<tt>30</tt>
|
|
923
|
+
|
|
924
|
+
</span>
|
|
925
|
+
|
|
926
|
+
— <div class='inline'>
|
|
927
|
+
<p>The maximum wait for a `stopped` state response.</p>
|
|
928
|
+
</div>
|
|
929
|
+
|
|
930
|
+
</li>
|
|
931
|
+
|
|
932
|
+
<li>
|
|
933
|
+
<span class="name">:poll_interval</span>
|
|
934
|
+
<span class="type">(<tt>Integer</tt>)</span>
|
|
935
|
+
<span class="default">
|
|
936
|
+
|
|
937
|
+
— default:
|
|
938
|
+
<tt>5</tt>
|
|
939
|
+
|
|
940
|
+
</span>
|
|
941
|
+
|
|
942
|
+
— <div class='inline'>
|
|
943
|
+
<p>The wait time (in seconds) between state requests. (Min: 1)</p>
|
|
944
|
+
</div>
|
|
945
|
+
|
|
946
|
+
</li>
|
|
947
|
+
|
|
948
|
+
</ul>
|
|
949
|
+
|
|
950
|
+
|
|
951
|
+
<p class="tag_title">Yields:</p>
|
|
952
|
+
<ul class="yield">
|
|
953
|
+
|
|
954
|
+
<li>
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
<span class='type'>(<tt>wait_state</tt>, <tt>transcoder_state</tt>)</span>
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
—
|
|
962
|
+
<div class='inline'>
|
|
963
|
+
<p>Calls the block with the states of the wait loop and the transcoder.</p>
|
|
964
|
+
</div>
|
|
965
|
+
|
|
966
|
+
</li>
|
|
967
|
+
|
|
968
|
+
</ul>
|
|
969
|
+
<p class="tag_title">Yield Parameters:</p>
|
|
970
|
+
<ul class="yieldparam">
|
|
971
|
+
|
|
972
|
+
<li>
|
|
973
|
+
|
|
974
|
+
<span class='name'>wait_state</span>
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
<span class='type'>(<tt>Symbol</tt>)</span>
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
|
|
981
|
+
—
|
|
982
|
+
<div class='inline'>
|
|
983
|
+
<p>The current state of the wait loop. Will always be one of the following:
|
|
984
|
+
:waiting, :complete, :cannot_change_state or :timeout</p>
|
|
985
|
+
</div>
|
|
986
|
+
|
|
987
|
+
</li>
|
|
988
|
+
|
|
989
|
+
<li>
|
|
990
|
+
|
|
991
|
+
<span class='name'>transcoder_state</span>
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
<span class='type'>(<tt>WscSdk::Model::TranscoderState</tt>)</span>
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
—
|
|
999
|
+
<div class='inline'>
|
|
1000
|
+
<p>The current transcoder state data.</p>
|
|
1001
|
+
</div>
|
|
1002
|
+
|
|
1003
|
+
</li>
|
|
1004
|
+
|
|
1005
|
+
</ul>
|
|
1006
|
+
<p class="tag_title">Returns:</p>
|
|
1007
|
+
<ul class="return">
|
|
1008
|
+
|
|
1009
|
+
<li>
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
<span class='type'>(<tt>WscSdk::Model::TranscoderState</tt>)</span>
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
—
|
|
1017
|
+
<div class='inline'>
|
|
1018
|
+
<p>The transcoder state after the method execution has completed.</p>
|
|
1019
|
+
</div>
|
|
1020
|
+
|
|
1021
|
+
</li>
|
|
1022
|
+
|
|
1023
|
+
</ul>
|
|
1024
|
+
|
|
1025
|
+
</div><table class="source_code">
|
|
1026
|
+
<tr>
|
|
1027
|
+
<td>
|
|
1028
|
+
<pre class="lines">
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
103
|
|
1032
|
+
104
|
|
1033
|
+
105
|
|
1034
|
+
106
|
|
1035
|
+
107</pre>
|
|
1036
|
+
</td>
|
|
1037
|
+
<td>
|
|
1038
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/modules/transcoder_shared_methods.rb', line 103</span>
|
|
1039
|
+
|
|
1040
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">stop</span>(options={}, &block)
|
|
1041
|
+
current_state = <span style="color:#069">self</span>.endpoint.stop(<span style="color:#069">self</span>.id)
|
|
1042
|
+
<span style="color:#080;font-weight:bold">return</span> wait_for_state(<span style="color:#A60">:stopped</span>, options, &block) <span style="color:#080;font-weight:bold">if</span> current_state.success? <span style="color:#080;font-weight:bold">and</span> block_given?
|
|
1043
|
+
<span style="color:#080;font-weight:bold">return</span> current_state
|
|
1044
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
1045
|
+
</td>
|
|
1046
|
+
</tr>
|
|
1047
|
+
</table>
|
|
1048
|
+
</div>
|
|
1049
|
+
|
|
1050
|
+
<div class="method_details ">
|
|
1051
|
+
<h3 class="signature " id="thumbnail_url-instance_method">
|
|
1052
|
+
|
|
1053
|
+
#<strong>thumbnail_url</strong> ⇒ <tt>WscSdk::Model::TranscoderThumbnailUrl</tt>
|
|
1054
|
+
|
|
1055
|
+
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
|
|
1059
|
+
</h3><div class="docstring">
|
|
1060
|
+
<div class="discussion">
|
|
1061
|
+
|
|
1062
|
+
<p>Return the url of the current thumbnail for transcoder/live stream.</p>
|
|
1063
|
+
|
|
1064
|
+
|
|
1065
|
+
</div>
|
|
1066
|
+
</div>
|
|
1067
|
+
<div class="tags">
|
|
1068
|
+
|
|
1069
|
+
<p class="tag_title">Returns:</p>
|
|
1070
|
+
<ul class="return">
|
|
1071
|
+
|
|
1072
|
+
<li>
|
|
1073
|
+
|
|
1074
|
+
|
|
1075
|
+
<span class='type'>(<tt>WscSdk::Model::TranscoderThumbnailUrl</tt>)</span>
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
</li>
|
|
1080
|
+
|
|
1081
|
+
</ul>
|
|
1082
|
+
|
|
1083
|
+
</div><table class="source_code">
|
|
1084
|
+
<tr>
|
|
1085
|
+
<td>
|
|
1086
|
+
<pre class="lines">
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
166
|
|
1090
|
+
167
|
|
1091
|
+
168</pre>
|
|
1092
|
+
</td>
|
|
1093
|
+
<td>
|
|
1094
|
+
<pre class="code"><span class="info file"># File 'lib/wsc_sdk/modules/transcoder_shared_methods.rb', line 166</span>
|
|
1095
|
+
|
|
1096
|
+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">thumbnail_url</span>
|
|
1097
|
+
<span style="color:#080;font-weight:bold">return</span> <span style="color:#069">self</span>.endpoint.thumbnail_url(<span style="color:#069">self</span>.id)
|
|
1098
|
+
<span style="color:#080;font-weight:bold">end</span></pre>
|
|
1099
|
+
</td>
|
|
1100
|
+
</tr>
|
|
1101
|
+
</table>
|
|
1102
|
+
</div>
|
|
1103
|
+
|
|
1104
|
+
</div>
|
|
1105
|
+
|
|
1106
|
+
</div>
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
</div>
|
|
1110
|
+
</div>
|
|
1111
|
+
</div>
|
|
1112
|
+
</body>
|
|
1113
|
+
</html>
|