Please note, this is a STATIC archive of website developer.mozilla.org from 03 Nov 2016, cach3.com does not collect or store any user information, there is no "phishing" involved.

Revision 1126631 of ConstrainDouble

  • Revision slug: Web/API/ConstrainDouble
  • Revision title: ConstrainDouble
  • Revision id: 1126631
  • Created:
  • Creator: Sheppy
  • Is current revision? Yes
  • Comment

Revision Content

{{APIRef("Media Capture and Streams")}}

The ConstrainDouble type is used to specify a constraint for a property whose value is a double-precision floating-point number. It extends the {{domxref("DoubleRange")}} dictionary (which provides the ability to specify a permitted range of property values) to also support an exact value and/or an ideal value the property should take on. Additionally, you can specify the property's value as a simple floating-point value, in which case the user agent does its best to match the value once all other more stringent constraints are met.

Properties

If the value of a ConstrainDouble is an object rather than a number, it may have the properties below in addition the properties it inherits from {{domxref("DoubleRange")}}.

exact
A double-precision floating-point number specifying a specific, required, value the property must have to be considered acceptable.
ideal
A double-precision floating-point number specifying a value the property would ideally have, but which can be considered optional if necessary to find a match.

Specifications

Specification Status Comment
{{SpecName('Media Capture', '#idl-def-ConstrainDouble', 'ConstrainDouble')}} {{Spec2('Media Capture')}} Initial definition

Technically, ConstrainDouble is actually based on an intermediary dictionary named ConstrainDoubleRange, which adds exact and ideal to {{domxref("DoubleRange")}}, with ConstrainDouble being a type that can be either a long integer or a DoubleRange. However, for the sake of documentation clarity, the intermediate type (present only because of quirks in {{Glossary("WebIDL")}} syntax) is ignored here.

Browser compatibility

{{CompatibilityTable}}
Feature Chrome Firefox (Gecko) Internet Explorer Microsoft Edge Opera Safari (WebKit)
Basic support {{CompatVersionUnknown}} {{CompatGeckoDesktop(50)}} {{CompatNo}} {{CompatUnknown}} {{CompatNo}} {{CompatUnknown}}
Feature Android Android Webview Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile Chrome for Android
Basic support {{CompatUnknown}} {{CompatVersionUnknown}} {{CompatGeckoMobile(50)}} {{CompatNo}} {{CompatNo}} {{CompatUnknown}} {{CompatVersionUnknown}}

See also

Revision Source

<div>{{APIRef("Media Capture and Streams")}}</div>

<p>The <strong><code>ConstrainDouble</code></strong> type is used to specify a constraint for a property whose value is a double-precision floating-point number. It extends the {{domxref("DoubleRange")}} dictionary (which provides the ability to specify a permitted range of property values) to also support an exact value and/or an ideal value the property should take on. Additionally, you can specify the property's value as a simple floating-point value, in which case the user agent does its best to match the value once all other more stringent constraints are met.</p>

<h2 id="Properties">Properties</h2>

<p><em>If the value of a <code>ConstrainDouble</code> is an object rather than a number, it may have the properties below in addition the properties it inherits from {{domxref("DoubleRange")}}.</em></p>

<dl>
 <dt><code>exact</code></dt>
 <dd>A double-precision floating-point number specifying a specific, required, value the property must have to be considered acceptable.</dd>
 <dt><code>ideal</code></dt>
 <dd>A double-precision floating-point number specifying a value the property would ideally have, but which can be considered optional if necessary to find a match.</dd>
</dl>

<h2 id="Specifications">Specifications</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
  <tr>
   <td>{{SpecName('Media Capture', '#idl-def-ConstrainDouble', 'ConstrainDouble')}}</td>
   <td>{{Spec2('Media Capture')}}</td>
   <td>Initial definition</td>
  </tr>
 </tbody>
</table>

<div class="note">
<p>Technically, <code>ConstrainDouble</code> is actually based on an intermediary dictionary named <code>ConstrainDoubleRange</code>, which adds <code>exact</code> and <code>ideal</code> to {{domxref("DoubleRange")}}, with <code>ConstrainDouble</code> being a type that can be either a long integer or a <code>DoubleRange</code>. However, for the sake of documentation clarity, the intermediate type (present only because of quirks in {{Glossary("WebIDL")}} syntax) is ignored here.</p>
</div>

<h2 id="Browser_compatibility">Browser compatibility</h2>

<div>{{CompatibilityTable}}</div>

<div id="compat-desktop">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Chrome</th>
   <th>Firefox (Gecko)</th>
   <th>Internet Explorer</th>
   <th>Microsoft Edge</th>
   <th>Opera</th>
   <th>Safari (WebKit)</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>{{CompatVersionUnknown}}</td>
   <td>{{CompatGeckoDesktop(50)}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</td>
  </tr>
 </tbody>
</table>
</div>

<div id="compat-mobile">
<table class="compat-table">
 <tbody>
  <tr>
   <th>Feature</th>
   <th>Android</th>
   <th>Android Webview</th>
   <th>Firefox Mobile (Gecko)</th>
   <th>IE Phone</th>
   <th>Opera Mobile</th>
   <th>Safari Mobile</th>
   <th>Chrome for Android</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatVersionUnknown}}</td>
   <td>{{CompatGeckoMobile(50)}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</td>
   <td>{{CompatVersionUnknown}}</td>
  </tr>
 </tbody>
</table>
</div>

<h2 id="See_also">See also</h2>

<ul>
 <li><a href="/en-US/docs/Web/API/Media_Streams_API">Media Capture and Streams API</a></li>
 <li><a href="/en-US/docs/Web/API/Media_Streams_API/Constraints">Capabilities, constraints, and settings</a></li>
 <li>{{domxref("DoubleRange")}}</li>
 <li>{{domxref("MediaTrackConstraints")}}</li>
 <li>{{domxref("MediaTrackCapabilities")}}</li>
 <li>{{domxref("MediaTrackSupportedConstraints")}}</li>
</ul>
Revert to this revision