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 1132247 of MediaTrackSettings.facingMode

  • Revision slug: Web/API/MediaTrackSettings/facingMode
  • Revision title: MediaTrackSettings.facingMode
  • Revision id: 1132247
  • Created:
  • Creator: Sheppy
  • Is current revision? No
  • Comment New page for bug 1213517

Revision Content

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

The {{domxref("MediaTrackSettings")}} dictionary's facingMode property is {{domxref("DOMString")}} indicating the direction in which the camera producing the video track represented by the {{domxref("MediaStreamTrack")}} is currently facing. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the {{domxref("MediaTrackConstraints.facingMode")}} property you provided when calling either {{domxref("MediaDevices.getUserMedia", "getUserMedia()")}} or {{domxref("MediaStreamTrack.applyConstraints()")}}.

If needed, you can determine whether or not this constraint is supported by checking the value of {{domxref("MediaTrackSupportedConstraints.facingMode")}} as returned by a call to {{domxref("MediaDevices.getSupportedConstraints()")}}. However, typically this is unnecessary since browsers will simply ignore any constraints they're unfamiliar with.

Syntax

var facingMode = MediaTrackSettings.facingMode;

Value

A {{domxref("DOMString")}} whose value is one of the strings in {{anch("VideoFacingModeEnum")}}.

VideoFacingModeEnum

The following strings are permitted values for the facing mode. These may represent separate cameras, or they may represent directions in which an adjustable camera can be pointed.

"user"
The video source is facing toward the user; this includes, for example, the front-facing camera on a smartphone.
"environment"
The video source is facing away from the user, thereby viewing their environment. This is the back camera on a smartphone.
"left"
The video source is facing toward the user but to their left, such as a camera aimed toward the user but over their left shoulder.
"right"
The video source is facing toward the user but to their right, such as a camera aimed toward the user but over their right shoulder.

Example

See {{SectionOnPage("/en-US/docs/Web/API/Media_Streams_API/Constraints", "Example: Constraint exerciser")}} for an example.

Specifications

Specification Status Comment
{{ SpecName('Media Capture', '#widl-MediaTrackSettings-facingMode', 'facingMode') }} {{ Spec2('Media Capture') }} Initial specification.

Browser compatibility

{{CompatibilityTable}}

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support {{CompatVersionUnknown}} {{CompatGeckoDesktop(36)}} {{CompatNo}} {{CompatVersionUnknown}} {{CompatUnknown}}
Feature Android Android Webview Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support {{CompatUnknown}} {{CompatVersionUnknown}} {{CompatGeckoMobile(36)}} {{CompatNo}} {{CompatUnknown}} {{CompatUnknown}} {{CompatVersionUnknown}}

See also

Revision Source

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

<p>The {{domxref("MediaTrackSettings")}} dictionary's <code><strong>facingMode</strong></code> property is {{domxref("DOMString")}} indicating the direction in which the camera producing the video track represented by the {{domxref("MediaStreamTrack")}} is currently facing. This lets you determine what value was selected to comply with your specified constraints for this property's value as described in the {{domxref("MediaTrackConstraints.facingMode")}} property you provided when calling either {{domxref("MediaDevices.getUserMedia", "getUserMedia()")}} or {{domxref("MediaStreamTrack.applyConstraints()")}}.</p>

<p>If needed, you can determine whether or not this constraint is supported by checking the value of {{domxref("MediaTrackSupportedConstraints.facingMode")}} as returned by a call to {{domxref("MediaDevices.getSupportedConstraints()")}}. However, typically this is unnecessary since browsers will simply ignore any constraints they're unfamiliar with.</p>

<h2 id="Syntax">Syntax</h2>

<pre class="syntaxbox">
var <em>facingMode</em> = <em>MediaTrackSettings</em>.facingMode;
</pre>

<h3 id="Value">Value</h3>

<p>A {{domxref("DOMString")}} whose value is one of the strings in <code>{{anch("VideoFacingModeEnum")}}</code>.</p>

<h3>VideoFacingModeEnum</h3>

<p>The following strings are permitted values for the facing mode. These may represent separate cameras, or they may represent directions in which an adjustable camera can be pointed.</p>

<dl>
 <dt><code>"user"</code></dt>
 <dd>The video source is facing toward the user; this includes, for example, the front-facing camera on a smartphone.</dd>
 <dt><code>"environment"</code></dt>
 <dd>The video source is facing away from the user, thereby viewing their environment. This is the back camera on a smartphone.</dd>
 <dt><code>"left"</code></dt>
 <dd>The video source is facing toward the user but to their left, such as a camera aimed toward the user but over their left shoulder.</dd>
 <dt><code>"right"</code></dt>
 <dd>The video source is facing toward the user but to their right, such as a camera aimed toward the user but over their right shoulder.</dd>
</dl>

<h2 id="Example" name="Example">Example</h2>

<p>See {{SectionOnPage("/en-US/docs/Web/API/Media_Streams_API/Constraints", "Example: Constraint exerciser")}} for an example.</p>

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

<table class="standard-table">
 <thead>
  <tr>
   <th scope="col">Specification</th>
   <th scope="col">Status</th>
   <th scope="col">Comment</th>
  </tr>
 </thead>
 <tbody>
  <tr>
   <td>{{ SpecName('Media Capture', '#widl-MediaTrackSettings-facingMode', 'facingMode') }}</td>
   <td>{{ Spec2('Media Capture') }}</td>
   <td>Initial specification.</td>
  </tr>
 </tbody>
</table>

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

<p>{{CompatibilityTable}}</p>

<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>Opera</th>
   <th>Safari</th>
  </tr>
  <tr>
   <td>Basic support</td>
   <td>{{CompatVersionUnknown}}</td>
   <td>{{CompatGeckoDesktop(36)}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatVersionUnknown}}</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 Mobile</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(36)}}</td>
   <td>{{CompatNo}}</td>
   <td>{{CompatUnknown}}</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("MediaTrackConstraints.facingMode")}}</li>
 <li>{{domxref("MediaTrackSettings")}}</li>
</ul>
Revert to this revision