summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLVideoStreamingRange.html
blob: b23ebcba90476fc1df746dce12a600a52e96b667 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
<h1>SDLVideoStreamingRange Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section-minimumAspectRatio">minimumAspectRatio</a></li>
  <li><a href="#section-maximumAspectRatio">maximumAspectRatio</a></li>
  <li><a href="#section-minimumDiagonal">minimumDiagonal</a></li>
  <li><a href="#section-minimumResolution">minimumResolution</a></li>
  <li><a href="#section-maximumResolution">maximumResolution</a></li>
  <li><a href="#section--initWithMinimumResolution:maximumResolution:">-initWithMinimumResolution:maximumResolution:</a></li>
  <li><a href="#section--initWithMinimumResolution:maximumResolution:minimumAspectRatio:maximumAspectRatio:minimumDiagonal:">-initWithMinimumResolution:maximumResolution:minimumAspectRatio:maximumAspectRatio:minimumDiagonal:</a></li>
  <li><a href="#section-+disabled">+disabled</a></li>
  <li><a href="#section--isImageResolutionInRange:">-isImageResolutionInRange:</a></li>
  <li><a href="#section--isAspectRatioInRange:">-isAspectRatioInRange:</a></li>
</ul>

<h3>Overview</h3>

<p>Undocumented</p>


<section class="section task-group-section">
  <h3 id="section-minimumAspectRatio">
      minimumAspectRatio
  </h3>
  
  <p>The minimum supported normalized aspect ratio, min value is 1.0, defaults to 1.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">)</span> <span class="kt">float</span> <span class="n">minimumAspectRatio</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">minimumAspectRatio</span><span class="p">:</span> <span class="kt">Float</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-maximumAspectRatio">
      maximumAspectRatio
  </h3>
  
  <p>The maximum supported normalized aspect ratio, min value is 1.0, defaults to 9999.0</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">)</span> <span class="kt">float</span> <span class="n">maximumAspectRatio</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">maximumAspectRatio</span><span class="p">:</span> <span class="kt">Float</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-minimumDiagonal">
      minimumDiagonal
  </h3>
  
  <p>The minimum supported diagonal screen size in inches, defaults to 0.0 (matches any size)</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">)</span> <span class="kt">float</span> <span class="n">minimumDiagonal</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">minimumDiagonal</span><span class="p">:</span> <span class="kt">Float</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-minimumResolution">
      minimumResolution
  </h3>
  
  <p>The minimum resolution to support, it overrides .minimumAspectRatio</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">minimumResolution</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">minimumResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section-maximumResolution">
      maximumResolution
  </h3>
  
  <p>The maximum resolution to support, it overrides .maximumAspectRatio</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="n">maximumResolution</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">maximumResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">?</span> <span class="p">{</span> <span class="k">get</span> <span class="k">set</span> <span class="p">}</span></code></pre>

  
  
  
  <h3 id="section--initWithMinimumResolution:maximumResolution:">
      -initWithMinimumResolution:maximumResolution:
  </h3>
  
  <p>Create a video streaming range based on a minimum and maximum resolution</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
    <span class="nf">initWithMinimumResolution</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">minResolution</span>
            <span class="nf">maximumResolution</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">maxResolution</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n"><a href="../Classes/SDLVideoStreamingRange.html#/c:objc(cs)SDLVideoStreamingRange(py)minimumResolution">minimumResolution</a></span> <span class="nv">minResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">?,</span> <span class="n"><a href="../Classes/SDLVideoStreamingRange.html#/c:objc(cs)SDLVideoStreamingRange(py)maximumResolution">maximumResolution</a></span> <span class="nv">maxResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">?)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>minResolution</dt>
      <dd><p>The minimum supported height / width resolution</p></dd>
      <dt>maxResolution</dt>
      <dd><p>The maximum supported height / width resolution</p></dd>
  </dl>
  
  <h3 id="section--initWithMinimumResolution:maximumResolution:minimumAspectRatio:maximumAspectRatio:minimumDiagonal:">
      -initWithMinimumResolution:maximumResolution:minimumAspectRatio:maximumAspectRatio:minimumDiagonal:
  </h3>
  
  <p>Create a video streaming range with all supported options</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span>
    <span class="nf">initWithMinimumResolution</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">minResolution</span>
            <span class="nf">maximumResolution</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">maxResolution</span>
           <span class="nf">minimumAspectRatio</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">minimumAspectRatio</span>
           <span class="nf">maximumAspectRatio</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">maximumAspectRatio</span>
              <span class="nf">minimumDiagonal</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">minimumDiagonal</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="nf">init</span><span class="p">(</span><span class="n"><a href="../Classes/SDLVideoStreamingRange.html#/c:objc(cs)SDLVideoStreamingRange(py)minimumResolution">minimumResolution</a></span> <span class="nv">minResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">?,</span> <span class="n"><a href="../Classes/SDLVideoStreamingRange.html#/c:objc(cs)SDLVideoStreamingRange(py)maximumResolution">maximumResolution</a></span> <span class="nv">maxResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">?,</span> <span class="nv">minimumAspectRatio</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">maximumAspectRatio</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">minimumDiagonal</span><span class="p">:</span> <span class="kt">Float</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>minResolution</dt>
      <dd><p>The minimum supported height / width resolution</p></dd>
      <dt>maxResolution</dt>
      <dd><p>The maximum supported height / width resolution</p></dd>
      <dt>minimumAspectRatio</dt>
      <dd><p>The minimum supported normalized aspect ratio, min value is 1.0, defaults to 1.0</p></dd>
      <dt>maximumAspectRatio</dt>
      <dd><p>The maximum supported normalized aspect ratio, min value is 1.0, defaults to 9999.0</p></dd>
      <dt>minimumDiagonal</dt>
      <dd><p>The minimum supported diagonal screen size in inches, defaults to 0 (0 matches any size)</p></dd>
  </dl>
  
  <h3 id="section-+disabled">
      +disabled
  </h3>
  
  <p>A convenience method to create a disabled range with the min and max resolutions equal to zero</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">+</span> <span class="p">(</span><span class="n">nonnull</span> <span class="n">instancetype</span><span class="p">)</span><span class="n">disabled</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">class</span> <span class="kd">func</span> <span class="nf">disabled</span><span class="p">()</span> <span class="o">-&gt;</span> <span class="k">Self</span></code></pre>

  
  
  
  <h3 id="section--isImageResolutionInRange:">
      -isImageResolutionInRange:
  </h3>
  
  <p>Check if the argument is within the [.minimumResolution, .maximumResolution] range</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isImageResolutionInRange</span><span class="p">:(</span><span class="n">nonnull</span> <span class="n"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">imageResolution</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">isImageResolution</span><span class="p">(</span><span class="n">inRange</span> <span class="nv">imageResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

  
  
  
  <h3 id="section--isAspectRatioInRange:">
      -isAspectRatioInRange:
  </h3>
  
  <p>Check if the argument is within the [.minimumAspectRatio, .maximumAspectRatio] range</p>

  
  
  <h4>Objective-C</h4>
  <pre class="highlight objective_c"><code><span class="k">-</span> <span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="nf">isAspectRatioInRange</span><span class="p">:(</span><span class="kt">float</span><span class="p">)</span><span class="nv">aspectRatio</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="kd">func</span> <span class="nf">isAspectRatio</span><span class="p">(</span><span class="n">inRange</span> <span class="nv">aspectRatio</span><span class="p">:</span> <span class="kt">Float</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

  
  
  
</section>