summaryrefslogtreecommitdiff
path: root/docs/Classes/SDLVideoStreamingCapability.html
blob: 52ae2f525cb0102a391a29e907b918543235c7d6 (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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<h1>SDLVideoStreamingCapability Class Reference</h1>

<h3>Section Contents</h3>

<ul>
  <li><a href="#section--initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:">-initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:</a></li>
  <li><a href="#section--initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:diagonalScreenSize:pixelPerInch:scale:">-initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:diagonalScreenSize:pixelPerInch:scale:</a></li>
  <li><a href="#section-preferredResolution">preferredResolution</a></li>
  <li><a href="#section-maxBitrate">maxBitrate</a></li>
  <li><a href="#section-supportedFormats">supportedFormats</a></li>
  <li><a href="#section-hapticSpatialDataSupported">hapticSpatialDataSupported</a></li>
  <li><a href="#section-diagonalScreenSize">diagonalScreenSize</a></li>
  <li><a href="#section-pixelPerInch">pixelPerInch</a></li>
  <li><a href="#section-scale">scale</a></li>
</ul>

<h3>Overview</h3>

<p>Contains information about this system&rsquo;s video streaming capabilities</p>


<section class="section task-group-section">
  <h3 id="section--initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:">
      -initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:
  </h3>
  
  <p>Convenience init for creating a video streaming capability.</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">initWithPreferredResolution</span><span class="p">:</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">preferredResolution</span>
                     <span class="nf">maxBitrate</span><span class="p">:(</span><span class="kt">int32_t</span><span class="p">)</span><span class="nv">maxBitrate</span>
               <span class="nf">supportedFormats</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                                    <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)supportedFormats">supportedFormats</a></span>
            <span class="n">hapticDataSupported</span><span class="o">:</span><span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="n">hapticDataSupported</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="nv">preferredResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">?,</span> <span class="nv">maxBitrate</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">,</span> <span class="nv">supportedFormats</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span><span class="p">]?,</span> <span class="nv">hapticDataSupported</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>preferredResolution</dt>
      <dd><p>The preferred resolution of a video stream for decoding and rendering on HMI</p></dd>
      <dt>maxBitrate</dt>
      <dd><p>The maximum bitrate of video stream that is supported, in kbps</p></dd>
      <dt>supportedFormats</dt>
      <dd><p>Detailed information on each format supported by this system, in its preferred order</p></dd>
      <dt>hapticDataSupported</dt>
      <dd><p>True if the system can utilize the haptic spatial data from the source being streamed</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A SDLVideoStreamingCapability object</p>
  </div>
  
  <h3 id="section--initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:diagonalScreenSize:pixelPerInch:scale:">
      -initWithPreferredResolution:maxBitrate:supportedFormats:hapticDataSupported:diagonalScreenSize:pixelPerInch:scale:
  </h3>
  
  <p>Convenience init for creating a video streaming capability with all parameters.</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">initWithPreferredResolution</span><span class="p">:</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">preferredResolution</span>
                     <span class="nf">maxBitrate</span><span class="p">:(</span><span class="kt">int32_t</span><span class="p">)</span><span class="nv">maxBitrate</span>
               <span class="nf">supportedFormats</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="p">)</span>
                                    <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)supportedFormats">supportedFormats</a></span>
            <span class="n">hapticDataSupported</span><span class="o">:</span><span class="p">(</span><span class="n">BOOL</span><span class="p">)</span><span class="n">hapticDataSupported</span>
             <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)diagonalScreenSize">diagonalScreenSize</a></span><span class="o">:</span><span class="p">(</span><span class="kt">float</span><span class="p">)</span><span class="n"><a href="../Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)diagonalScreenSize">diagonalScreenSize</a></span>
                   <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)pixelPerInch">pixelPerInch</a></span><span class="o">:</span><span class="p">(</span><span class="kt">float</span><span class="p">)</span><span class="n"><a href="../Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)pixelPerInch">pixelPerInch</a></span>
                          <span class="n"><a href="../Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)scale">scale</a></span><span class="o">:</span><span class="p">(</span><span class="kt">float</span><span class="p">)</span><span class="n"><a href="../Classes/SDLVideoStreamingCapability.html#/c:objc(cs)SDLVideoStreamingCapability(py)scale">scale</a></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="nv">preferredResolution</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLImageResolution.html">SDLImageResolution</a></span><span class="p">?,</span> <span class="nv">maxBitrate</span><span class="p">:</span> <span class="kt">Int32</span><span class="p">,</span> <span class="nv">supportedFormats</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span><span class="p">]?,</span> <span class="nv">hapticDataSupported</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">,</span> <span class="nv">diagonalScreenSize</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">pixelPerInch</span><span class="p">:</span> <span class="kt">Float</span><span class="p">,</span> <span class="nv">scale</span><span class="p">:</span> <span class="kt">Float</span><span class="p">)</span></code></pre>

  
  
  <h4>Parameters</h4>
  <dl>
      <dt>preferredResolution</dt>
      <dd><p>The preferred resolution of a video stream for decoding and rendering on HMI</p></dd>
      <dt>maxBitrate</dt>
      <dd><p>The maximum bitrate of video stream that is supported, in kbps</p></dd>
      <dt>supportedFormats</dt>
      <dd><p>Detailed information on each format supported by this system, in its preferred order</p></dd>
      <dt>hapticDataSupported</dt>
      <dd><p>True if the system can utilize the haptic spatial data from the source being streamed</p></dd>
      <dt>diagonalScreenSize</dt>
      <dd><p>The diagonal screen size in inches</p></dd>
      <dt>pixelPerInch</dt>
      <dd><p>The diagonal resolution in pixels divided by the diagonal screen size in inches</p></dd>
      <dt>scale</dt>
      <dd><p>The scaling factor the app should use to change the size of the projecting view</p></dd>
  </dl>
  <div>
    <h4>Return Value</h4>
    <p>A SDLVideoStreamingCapability object</p>
  </div>
  
  <h3 id="section-preferredResolution">
      preferredResolution
  </h3>
  
  <p>The preferred resolution of a video stream for decoding and rendering on HMI</p>

<p>Optional</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">preferredResolution</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">preferredResolution</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-maxBitrate">
      maxBitrate
  </h3>
  
  <p>The maximum bitrate of video stream that is supported, in kbps, optional</p>

<p>Optional, minvalue= 0, maxvalue= 2147483647</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">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">maxBitrate</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">maxBitrate</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLInt">SDLInt</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-supportedFormats">
      supportedFormats
  </h3>
  
  <p>Detailed information on each format supported by this system, in its preferred order</p>

<p>Optional</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">NSArray</span><span class="o">&lt;</span><span class="n"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</a></span> <span class="o">*&gt;</span> <span class="o">*</span><span class="n">supportedFormats</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">supportedFormats</span><span class="p">:</span> <span class="p">[</span><span class="kt"><a href="../Classes/SDLVideoStreamingFormat.html">SDLVideoStreamingFormat</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-hapticSpatialDataSupported">
      hapticSpatialDataSupported
  </h3>
  
  <p>True if the system can utilize the haptic spatial data from the source being streamed.</p>

<p>Optional</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">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">hapticSpatialDataSupported</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">hapticSpatialDataSupported</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLBool">SDLBool</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-diagonalScreenSize">
      diagonalScreenSize
  </h3>
  
  <p>The diagonal screen size in inches.</p>

<p>Float, Optional, minvalue=&ldquo;0&rdquo;
@since SDL 6.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="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">diagonalScreenSize</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">diagonalScreenSize</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</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-pixelPerInch">
      pixelPerInch
  </h3>
  
  <p>The diagonal resolution in pixels divided by the diagonal screen size in inches.</p>

<p>Float, Optional, minvalue=&ldquo;0&rdquo;
@since SDL 6.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="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">pixelPerInch</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">pixelPerInch</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</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-scale">
      scale
  </h3>
  
  <p>The scaling factor the app should use to change the size of the projecting view.</p>

<p>Float, Optional, minvalue=&ldquo;1&rdquo; maxvalue=&ldquo;10&rdquo;
@since SDL 6.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="n">strong</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSNumber</span><span class="o">&lt;</span><span class="n"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">&gt;</span> <span class="o">*</span><span class="n">scale</span><span class="p">;</span></code></pre>

  
  <h4>Swift</h4>
  <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">scale</span><span class="p">:</span> <span class="p">(</span><span class="kt">NSNumber</span> <span class="o">&amp;</span> <span class="kt"><a href="../Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</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>

  
  
  
</section>