diff options
Diffstat (limited to 'docs/Classes/SDLStreamingMediaConfiguration.html')
| -rw-r--r-- | docs/Classes/SDLStreamingMediaConfiguration.html | 114 |
1 files changed, 111 insertions, 3 deletions
diff --git a/docs/Classes/SDLStreamingMediaConfiguration.html b/docs/Classes/SDLStreamingMediaConfiguration.html index 7cb438c57..bad8b638b 100644 --- a/docs/Classes/SDLStreamingMediaConfiguration.html +++ b/docs/Classes/SDLStreamingMediaConfiguration.html @@ -10,9 +10,13 @@ <li><a href="#section-carWindowRenderingType">carWindowRenderingType</a></li> <li><a href="#section-enableForcedFramerateSync">enableForcedFramerateSync</a></li> <li><a href="#section-allowMultipleViewControllerOrientations">allowMultipleViewControllerOrientations</a></li> + <li><a href="#section-supportedLandscapeStreamingRange">supportedLandscapeStreamingRange</a></li> + <li><a href="#section-supportedPortraitStreamingRange">supportedPortraitStreamingRange</a></li> + <li><a href="#section-delegate">delegate</a></li> <li><a href="#section--init">-init</a></li> <li><a href="#section-+secureConfiguration">+secureConfiguration</a></li> <li><a href="#section--initWithEncryptionFlag:videoSettings:dataSource:rootViewController:">-initWithEncryptionFlag:videoSettings:dataSource:rootViewController:</a></li> + <li><a href="#section--initWithEncryptionFlag:videoSettings:supportedLandscapeRange:supportedPortraitRange:dataSource:delegate:rootViewController:">-initWithEncryptionFlag:videoSettings:supportedLandscapeRange:supportedPortraitRange:dataSource:delegate:rootViewController:</a></li> <li><a href="#section-+insecureConfiguration">+insecureConfiguration</a></li> <li><a href="#section-+autostreamingInsecureConfigurationWithInitialViewController:">+autostreamingInsecureConfigurationWithInitialViewController:</a></li> <li><a href="#section-+autostreamingSecureConfigurationWithInitialViewController:">+autostreamingSecureConfigurationWithInitialViewController:</a></li> @@ -90,7 +94,7 @@ </div><div class="aside aside-warning"> <p class="aside-title">Warning</p> - <p>Apps using views outside of the <code>UIView</code> heirarchy (such as OpenGL) are currently unsupported. If you app uses partial views in the heirarchy, only those views will be discovered. Your OpenGL views will not be discoverable to a haptic interface head unit and you will have to manually make these views discoverable via the <code><a href="../Classes/SDLSendHapticData.html">SDLSendHapticData</a></code> RPC request.</p> + <p>Apps using views outside of the <code>UIView</code> hierarchy (such as OpenGL) are currently unsupported. If you app uses partial views in the hierarchy, only those views will be discovered. Your OpenGL views will not be discoverable to a haptic interface head unit and you will have to manually make these views discoverable via the <code><a href="../Classes/SDLSendHapticData.html">SDLSendHapticData</a></code> RPC request.</p> </div><div class="aside aside-warning"> <p class="aside-title">Warning</p> @@ -172,6 +176,69 @@ + <h3 id="section-supportedLandscapeStreamingRange"> + supportedLandscapeStreamingRange + </h3> + + <p>Set a landscape image dimension range and/or aspect ratio range that your rootViewController supports. If the module’s screen size for your app changes during streaming (i.e. to a collapsed view, split screen, preview mode or picture-in-picture), your rootViewController will be resized to the new screen size. If left unset or set to <code>nil</code>, the default is to support all lanscape streaming ranges. If you wish to disable support for streaming in landscape mode, set a <code>disabled</code> video streaming range. +If desired, you can subscribe to screen size updates via the SDLStreamingVideoDelegate.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + If you disable both the supportedLandscapeStreamingRange and supportedPortraitStreamingRange, video will not stream + +</div> + + + + <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/SDLVideoStreamingRange.html">SDLVideoStreamingRange</a></span> <span class="o">*</span><span class="n">supportedLandscapeStreamingRange</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">supportedLandscapeStreamingRange</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVideoStreamingRange.html">SDLVideoStreamingRange</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-supportedPortraitStreamingRange"> + supportedPortraitStreamingRange + </h3> + + <p>Set a portrait image dimension range and/or aspect ratio range that your rootViewController supports. If the module’s screen size for your app changes during streaming (i.e. to a collapsed view, split screen, preview mode or picture-in-picture), your rootViewController will be resized to the new screen size. If left unset or set to <code>nil</code>, the default is to support all portrait streaming ranges. If you wish to disable support for streaming in portrait mode, set a <code>disabled</code> video streaming range. +If desired, you can subscribe to screen size updates via the SDLStreamingVideoDelegate.</p> +<div class="aside aside-warning"> + <p class="aside-title">Warning</p> + If you disable both the supportedLandscapeStreamingRange and supportedPortraitStreamingRange, video will not stream + +</div> + + + + <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/SDLVideoStreamingRange.html">SDLVideoStreamingRange</a></span> <span class="o">*</span><span class="n">supportedPortraitStreamingRange</span><span class="p">;</span></code></pre> + + + <h4>Swift</h4> + <pre class="highlight swift"><code><span class="k">var</span> <span class="nv">supportedPortraitStreamingRange</span><span class="p">:</span> <span class="kt"><a href="../Classes/SDLVideoStreamingRange.html">SDLVideoStreamingRange</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-delegate"> + delegate + </h3> + + <p>The configuration delegate, this is an object conforming to the SDLStreamingVideoDelegate protocol. If video streaming parameters change then this object will be called on.</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">weak</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingVideoDelegate.html">SDLStreamingVideoDelegate</a></span><span class="o">></span> <span class="n">delegate</span><span class="p">;</span></code></pre> + + + + + <h3 id="section--init"> -init </h3> @@ -239,17 +306,58 @@ <h4>Parameters</h4> <dl> <dt>encryptionFlag</dt> - <dd><p>The maximum encrpytion supported. If the connected head unit supports less than set here, it will still connect, but if it supports more than set here, it will not connect.</p></dd> + <dd><p>The maximum encryption supported. If the connected head unit supports less than set here, it will still connect, but if it supports more than set here, it will not connect.</p></dd> <dt>videoSettings</dt> <dd><p>Custom video encoder settings to be used in video streaming.</p></dd> <dt>rootViewController</dt> - <dd><p>The UIViewController wih the content that is being streamed on, to use for haptics if needed and possible (only works for UIViews)</p></dd> + <dd><p>The UIViewController with the content that is being streamed on, to use for haptics if needed and possible (only works for UIViews)</p></dd> </dl> <div> <h4>Return Value</h4> <p>The configuration</p> </div> + <h3 id="section--initWithEncryptionFlag:videoSettings:supportedLandscapeRange:supportedPortraitRange:dataSource:delegate:rootViewController:"> + -initWithEncryptionFlag:videoSettings:supportedLandscapeRange:supportedPortraitRange:dataSource:delegate:rootViewController: + </h3> + + <p>Manually set all the properties to the streaming media configuration</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">initWithEncryptionFlag</span><span class="p">:(</span><span class="n"><a href="../Enums/SDLStreamingEncryptionFlag.html">SDLStreamingEncryptionFlag</a></span><span class="p">)</span><span class="nv">encryptionFlag</span> + <span class="nf">videoSettings</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n">NSDictionary</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*</span><span class="p">,</span> <span class="n">id</span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">videoSettings</span> + <span class="nf">supportedLandscapeRange</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLVideoStreamingRange.html">SDLVideoStreamingRange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">landscapeRange</span> + <span class="nf">supportedPortraitRange</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="../Classes/SDLVideoStreamingRange.html">SDLVideoStreamingRange</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">portraitRange</span> + <span class="nf">dataSource</span><span class="p">:</span> + <span class="p">(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingMediaManagerDataSource.html">SDLStreamingMediaManagerDataSource</a></span><span class="o">></span><span class="p">)</span><span class="nv">dataSource</span> + <span class="nf">delegate</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">id</span><span class="o"><</span><span class="n"><a href="../Protocols/SDLStreamingVideoDelegate.html">SDLStreamingVideoDelegate</a></span><span class="o">></span><span class="p">)</span><span class="nv">delegate</span> + <span class="nf">rootViewController</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">UIViewController</span> <span class="o">*</span><span class="p">)</span><span class="nv">rootViewController</span><span class="p">;</span></code></pre> + + + + + <h4>Parameters</h4> + <dl> + <dt>encryptionFlag</dt> + <dd><p>The maximum encryption supported. If the connected head unit supports less than set here, it will still connect, but if it supports more than set here, it will not connect</p></dd> + <dt>videoSettings</dt> + <dd><p>Custom video encoder settings to be used in video streaming</p></dd> + <dt>landscapeRange</dt> + <dd><p>Set a landscape image dimension range and/or aspect ratio range that your app supports</p></dd> + <dt>portraitRange</dt> + <dd><p>Set a portrait image dimension range and/or aspect ratio range that your rootViewController supports</p></dd> + <dt>dataSource</dt> + <dd><p>Allows you to respond with preferred resolutions and/or formats</p></dd> + <dt>delegate</dt> + <dd><p>Provides a delegate with notifications about changes to the audio stream</p></dd> + <dt>rootViewController</dt> + <dd><p>A view controller that should be automatically streamed</p></dd> + </dl> + <h3 id="section-+insecureConfiguration"> +insecureConfiguration </h3> |