diff options
Diffstat (limited to 'docs/Classes.html')
| -rw-r--r-- | docs/Classes.html | 181 |
1 files changed, 11 insertions, 170 deletions
diff --git a/docs/Classes.html b/docs/Classes.html index 86cb90b3a..903dd2040 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -499,20 +499,13 @@ SDLAlertAudioData </h3> - <p>Undocumented</p> + <p>Audio data for an SDLAlertView</p> <a href="Classes/SDLAlertAudioData.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAlertAudioData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLAudioData.html">SDLAudioData</a></span> - -<span class="c1">/// Whether the alert tone should be played before the prompt (if any) is spoken. Defaults to NO.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">playTone</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAlertAudioData</span> <span class="p">:</span> <span class="nc"><a href="Classes/SDLAudioData.html">SDLAudioData</a></span></code></pre> <h4>Swift</h4> @@ -587,65 +580,13 @@ SDLAlertView </h3> - <p>Undocumented</p> + <p>An alert view to be displayed on the remote module. Pass this object to the SDLScreenManager to display.</p> <a href="Classes/SDLAlertView.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAlertView</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> - -<span class="c1">/// Set this to change the default timeout for all alerts. If a timeout is not set on an individual alert object (or if it is set to 0.0), then it will use this timeout instead. See `timeout` for more details. If this is not set by you, it will default to 5 seconds. The minimum is 3 seconds, the maximum is 10 seconds. If this is set below the minimum, it will be capped at 3 seconds. If this is set above the maximum, it will be capped at 10 seconds.</span> -<span class="c1">/// Please note that if a button is added to the alert, the defaultTimeout and timeout values will be ignored.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">class</span><span class="p">,</span> <span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSTimeInterval</span> <span class="n">defaultTimeout</span><span class="p">;</span> - -<span class="c1">/// The primary line of text for display on the alert. If fewer than three alert lines are available on the head unit, the screen manager will automatically concatenate some of the lines together.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">text</span><span class="p">;</span> - -<span class="c1">/// The secondary line of text for display on the alert. If fewer than three alert lines are available on the head unit, the screen manager will automatically concatenate some of the lines together.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">secondaryText</span><span class="p">;</span> - -<span class="c1">/// The tertiary line of text for display on the alert. If fewer than three alert lines are available on the head unit, the screen manager will automatically concatenate some of the lines together.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">tertiaryText</span><span class="p">;</span> - -<span class="c1">/// Timeout in seconds. Defaults to 0, which will use `defaultTimeout`. If this is set below the minimum, it will be capped at 3 seconds. Minimum 3 seconds, maximum 10 seconds. If this is set above the maximum, it will be capped at 10 seconds. Defaults to 0.</span> -<span class="c1">/// Please note that if a button is added to the alert, the defaultTimeout and timeout values will be ignored.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSTimeInterval</span> <span class="n">timeout</span><span class="p">;</span> - -<span class="c1">/// Text spoken, file(s) played, and/or tone played when the alert appears</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLAlertAudioData.html">SDLAlertAudioData</a></span> <span class="o">*</span><span class="n">audio</span><span class="p">;</span> - -<span class="c1">/// If supported, the alert GUI will display some sort of indefinite waiting / refresh / loading indicator animation. Defaults to NO.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">assign</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">BOOL</span> <span class="n">showWaitIndicator</span><span class="p">;</span> - -<span class="c1">/// Soft buttons the user may select to perform actions. Only one `SDLSoftButtonState` per object is supported; if any soft button object contains multiple states, an exception will be thrown.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">softButtons</span><span class="p">;</span> - -<span class="c1">/// An artwork that will be displayed when the icon appears. This will be uploaded prior to the appearance of the alert if necessary. This will not be uploaded if the head unit does not declare support for alertIcon.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">)</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="n">icon</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_DESIGNATED_INITIALIZER</span><span class="p">;</span> - -<span class="c1">/// Initialize a basic alert with a message and buttons</span> -<span class="c1">/// @param text The primary line of text for display on the alert</span> -<span class="c1">/// @param softButtons Soft buttons the user may select to perform actions</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithText</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">buttons</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">softButtons</span><span class="p">;</span> - -<span class="c1">/// Initialize a alert with a text, image, buttons and sound</span> -<span class="c1">/// @param text The primary line of text for display on the alert</span> -<span class="c1">/// @param secondaryText The secondary line of text for display on the alert</span> -<span class="c1">/// @param tertiaryText The tertiary line of text for display on the alert</span> -<span class="c1">/// @param timeout Timeout in seconds</span> -<span class="c1">/// @param showWaitIndicator If supported, the alert GUI will display some sort of indefinite waiting / refresh / loading indicator animation</span> -<span class="c1">/// @param audio Text spoken and/or tone played when the alert appears</span> -<span class="c1">/// @param softButtons Soft buttons the user may select to perform actions</span> -<span class="c1">/// @param icon An artwork that will be displayed when the icon appears</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">text</span> <span class="nf">secondaryText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">secondaryText</span> <span class="nf">tertiaryText</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">tertiaryText</span> <span class="nf">timeout</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLFloat">SDLFloat</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">timeout</span> <span class="nf">showWaitIndicator</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSNumber</span><span class="o"><</span><span class="n"><a href="Protocols.html#/c:objc(pl)SDLBool">SDLBool</a></span><span class="o">></span> <span class="o">*</span><span class="p">)</span><span class="nv">showWaitIndicator</span> <span class="nf">audioIndication</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLAlertAudioData.html">SDLAlertAudioData</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audio</span> <span class="nf">buttons</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLSoftButtonObject.html">SDLSoftButtonObject</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">softButtons</span> <span class="nf">icon</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLArtwork.html">SDLArtwork</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">icon</span><span class="p">;</span> - -<span class="c1">/// Cancels the alert. If the alert has not yet been sent to the module, it will not be sent. If the alert is already presented on the module, the alert will be immediately dismissed. Canceling an already presented alert will only work if connected to modules supporting RPC Spec v.6.0+. On older versions the alert will not be dismissed.</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="n">cancel</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAlertView</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span></code></pre> <h4>Swift</h4> @@ -860,48 +801,13 @@ SDLAudioData </h3> - <p>Undocumented</p> + <p>Audio data for various SDLScreenManager views</p> <a href="Classes/SDLAudioData.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioData</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> - -<span class="c1">/// The text-to-speech prompts that will used and/or audio files that will be played. The audio prompts and files will be played in the same order they are added.</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nullable</span><span class="p">,</span> <span class="n">copy</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">)</span> <span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLTTSChunk.html">SDLTTSChunk</a></span> <span class="o">*></span> <span class="o">*</span><span class="n">audioData</span><span class="p">;</span> - -<span class="c1">/// Initialize with an SDLFile holding data or pointing to a file on the file system. When this object is passed to an `Alert` or `Speak`, the file will be uploaded if it is not already, then played if the system supports that feature.</span> -<span class="c1">/// @discussion Only available on systems supporting RPC Spec v5.0+</span> -<span class="c1">///</span> -<span class="c1">/// @param audioFile The audio file to be played by the system</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithAudioFile</span><span class="p">:(</span><span class="n"><a href="Classes/SDLFile.html">SDLFile</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioFile</span><span class="p">;</span> - -<span class="c1">/// Initialize with a string to be spoken by the system speech synthesizer.</span> -<span class="c1">/// @param spokenString The string to be spoken by the system speech synthesizer</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithSpeechSynthesizerString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">spokenString</span><span class="p">;</span> - -<span class="c1">/// Initialize with a string to be spoken by the system speech synthesizer using a phonetic string.</span> -<span class="c1">/// @param phoneticString The string to be spoken by the system speech synthesizer</span> -<span class="c1">/// @param phoneticType Must be one of `SAPI_PHONEMES`, `LHPLUS_PHONEMES`, `TEXT`, or `PRE_RECORDED` or no object will be created</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithPhoneticSpeechSynthesizerString</span><span class="p">:(</span><span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">phoneticString</span> <span class="nf">phoneticType</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="p">)</span><span class="nv">phoneticType</span><span class="p">;</span> - -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">init</span> <span class="n">NS_UNAVAILABLE</span><span class="p">;</span> - -<span class="c1">/// Add additional SDLFiles holding data or pointing to a file on the file system. When this object is passed to an `Alert` or `Speak`, the file will be uploaded if it is not already, then played if the system supports that feature.</span> -<span class="c1">/// @param audioFiles An array of audio file to be played by the system</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addAudioFiles</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n"><a href="Classes/SDLFile.html">SDLFile</a></span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">audioFiles</span><span class="p">;</span> - -<span class="c1">/// Create additional strings to be spoken by the system speech synthesizer.</span> -<span class="c1">/// @param spokenStrings The strings to be spoken by the system speech synthesizer</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addSpeechSynthesizerStrings</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">spokenStrings</span><span class="p">;</span> - -<span class="c1">/// Create additional strings to be spoken by the system speech synthesizer using a phonetic string.</span> -<span class="c1">/// @param phoneticStrings The strings to be spoken by the system speech synthesizer</span> -<span class="c1">/// @param phoneticType Must be one of `SAPI_PHONEMES`, `LHPLUS_PHONEMES`, `TEXT`, or `PRE_RECORDED` or no object will be created</span> -<span class="k">-</span> <span class="p">(</span><span class="kt">void</span><span class="p">)</span><span class="nf">addPhoneticSpeechSynthesizerStrings</span><span class="p">:(</span><span class="n">NSArray</span><span class="o"><</span><span class="n">NSString</span> <span class="o">*></span> <span class="o">*</span><span class="p">)</span><span class="nv">phoneticStrings</span> <span class="nf">phoneticType</span><span class="p">:(</span><span class="n"><a href="Type%20Definitions.html#/c:SDLSpeechCapabilities.h@T@SDLSpeechCapabilities">SDLSpeechCapabilities</a></span><span class="p">)</span><span class="nv">phoneticType</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLAudioData</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span></code></pre> <h4>Swift</h4> @@ -992,7 +898,7 @@ SDLBodyInformation </h3> - <p>Undocumented</p> + <p>Vehicle data body information containing information like the park brake status, the ignition status, gate and roof statuses, etc.</p> <a href="Classes/SDLBodyInformation.html" class="slightly-smaller">See more</a> @@ -6532,39 +6438,13 @@ change the settings of a specific remote control module.</p> SDLSystemInfo </h3> - <p>Undocumented</p> + <p>Basic information about the connected module system</p> <a href="Classes/SDLSystemInfo.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSystemInfo</span> <span class="p">:</span> <span class="nc">NSObject</span> - -<span class="c1">/// The connected module's vehicle type: it's make, model, trim, and model year</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n"><a href="Classes/SDLVehicleType.html">SDLVehicleType</a></span> <span class="o">*</span><span class="n">vehicleType</span><span class="p">;</span> - -<span class="c1">/// The connected module's software version</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">systemSoftwareVersion</span><span class="p">;</span> - -<span class="c1">/// The connected module's hardware version</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">strong</span><span class="p">,</span> <span class="n">nonatomic</span><span class="p">,</span> <span class="n">readonly</span><span class="p">,</span> <span class="n">nullable</span><span class="p">)</span> <span class="n">NSString</span> <span class="o">*</span><span class="n">systemHardwareVersion</span><span class="p">;</span> - -<span class="c1">/// Initialize a system info object with individual pieces</span> -<span class="c1">/// @param make The vehicle's make</span> -<span class="c1">/// @param model The vehicle's model</span> -<span class="c1">/// @param trim The vehicle's trim</span> -<span class="c1">/// @param modelYear The vehicle's model year</span> -<span class="c1">/// @param softwareVersion The vehicle's software version</span> -<span class="c1">/// @param hardwareVersion The vehicle's hardware version</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithMake</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">make</span> <span class="nf">model</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">model</span> <span class="nf">trim</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">trim</span> <span class="nf">modelYear</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">modelYear</span> <span class="nf">softwareVersion</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">softwareVersion</span> <span class="nf">hardwareVersion</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">hardwareVersion</span><span class="p">;</span> - -<span class="c1">/// Initialize a system info object with the vehicle type and versions</span> -<span class="c1">/// @param vehicleType The vehicle information</span> -<span class="c1">/// @param softwareVersion The vehicle's software version</span> -<span class="c1">/// @param hardwareVersion The vehicle's hardware version</span> -<span class="k">-</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="nf">initWithVehicleType</span><span class="p">:(</span><span class="n">nullable</span> <span class="n"><a href="Classes/SDLVehicleType.html">SDLVehicleType</a></span> <span class="o">*</span><span class="p">)</span><span class="nv">vehicleType</span> <span class="nf">softwareVersion</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">softwareVersion</span> <span class="nf">hardwareVersion</span><span class="p">:(</span><span class="n">nullable</span> <span class="n">NSString</span> <span class="o">*</span><span class="p">)</span><span class="nv">hardwareVersion</span><span class="p">;</span> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLSystemInfo</span> <span class="p">:</span> <span class="nc">NSObject</span></code></pre> <h4>Swift</h4> @@ -7219,52 +7099,13 @@ See SDLSubscribeButton</p> SDLVideoStreamingRange </h3> - <p>Undocumented</p> + <p>A range of supported video streaming sizes from minimum to maximum</p> <a href="Classes/SDLVideoStreamingRange.html" class="slightly-smaller">See more</a> <h4>Objective-C</h4> - <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVideoStreamingRange</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span> - -<span class="c1">/// The minimum supported normalized aspect ratio, min value is 1.0, defaults to 1.0</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">)</span> <span class="kt">float</span> <span class="n">minimumAspectRatio</span><span class="p">;</span> - -<span class="c1">/// The maximum supported normalized aspect ratio, min value is 1.0, defaults to 9999.0</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">)</span> <span class="kt">float</span> <span class="n">maximumAspectRatio</span><span class="p">;</span> - -<span class="c1">/// The minimum supported diagonal screen size in inches, defaults to 0.0 (matches any size)</span> -<span class="k">@property</span> <span class="p">(</span><span class="n">nonatomic</span><span class="p">,</span> <span class="n">assign</span><span class="p">)</span> <span class="kt">float</span> <span class="n">minimumDiagonal</span><span class="p">;</span> - -<span class="c1">/// The minimum resolution to support, it overrides .minimumAspectRatio</span> -<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> - -<span class="c1">/// The maximum resolution to support, it overrides .maximumAspectRatio</span> -<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> - -<span class="c1">/// Create a video streaming range based on a minimum and maximum resolution</span> -<span class="c1">/// @param minResolution The minimum supported height / width resolution</span> -<span class="c1">/// @param maxResolution The maximum supported height / width resolution</span> -<span class="k">-</span> <span class="p">(</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> - -<span class="c1">/// Create a video streaming range with all supported options</span> -<span class="c1">/// @param minResolution The minimum supported height / width resolution</span> -<span class="c1">/// @param maxResolution The maximum supported height / width resolution</span> -<span class="c1">/// @param minimumAspectRatio The minimum supported normalized aspect ratio, min value is 1.0, defaults to 1.0</span> -<span class="c1">/// @param maximumAspectRatio The maximum supported normalized aspect ratio, min value is 1.0, defaults to 9999.0</span> -<span class="c1">/// @param minimumDiagonal The minimum supported diagonal screen size in inches, defaults to 0 (0 matches any size)</span> -<span class="k">-</span> <span class="p">(</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> - -<span class="c1">/// A convenience method to create a disabled range with the min and max resolutions equal to zero</span> -<span class="k">+</span> <span class="p">(</span><span class="n">instancetype</span><span class="p">)</span><span class="n">disabled</span><span class="p">;</span> - -<span class="c1">/// Check if the argument is within the [.minimumResolution, .maximumResolution] range</span> -<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"><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> - -<span class="c1">/// Check if the argument is within the [.minimumAspectRatio, .maximumAspectRatio] range</span> -<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> - -<span class="k">@end</span></code></pre> + <pre class="highlight objective_c"><code><span class="k">@interface</span> <span class="nc">SDLVideoStreamingRange</span> <span class="p">:</span> <span class="nc">NSObject</span> <span class="o"><</span><span class="n">NSCopying</span><span class="o">></span></code></pre> <h4>Swift</h4> |