aboutsummaryrefslogtreecommitdiff
path: root/files/fr/web/api/mediastream/index.md
blob: 292cb700e0ca3b8334623dcfecfe31d75606d9dc (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
---
title: MediaStream
slug: Web/API/MediaStream
translation_of: Web/API/MediaStream
---
<div>{{APIRef("Media Capture and Streams")}} {{SeeCompatTable}}</div>

<p>L'interface <code>MediaStream</code> représente le contenu d'un flux de média. Un flux est composé de plusieurs <em>pistes</em>, tel que des pistes vidéos ou audio.</p>

<h2 id="Attributs">Attributs</h2>

<dl>
 <dt>{{domxref("MediaStream.id")}} {{readonlyInline}}</dt>
 <dd>{{domxref("DOMString")}} contenant 36 carractères correspondant à l'identifiant unique (GUID) de l'objet.</dd>
 <dt>{{domxref("MediaStream.ended")}} {{readonlyInline}}</dt>
 <dd>Booléen dont la valeur est <code>true</code> si l'évènement {{event("ended (MediaStream)", "ended")}} à été déclenché sur l'objet, signifiant que le flux à été complètement lu, ou <code>false</code> si la fin du flux n'à pas été atteinte.</dd>
</dl>

<h3 id="Gestionnaire_d'évènements">Gestionnaire d'évènements</h3>

<dl>
 <dt>{{domxref("MediaStream.onaddtrack")}}</dt>
 <dd>Est un {{event("Event_handlers", "event handler")}} contenant l'action à exécuter lorsqu'un évènement {{event("addtrack")}} est déclenché sur l'objet, ce qui arrive lorsqu'un nouvel objet {{domxref("MediaStreamTrack")}} est ajouté.</dd>
 <dt>{{domxref("MediaStream.onended")}}</dt>
 <dd>Est un  {{event("Event_handlers", "event handler")}} contenant l'action à exécuter lorsqu'un évènement {{event("ended (MediaStream)","ended")}} est déclenché sur l'objet, ce qui arrive lorsque la diffusion est terminée.</dd>
 <dt>{{domxref("MediaStream.onremovetrack")}}</dt>
 <dd>Est un {{event("Event_handlers", "event handler")}} contenant l'action à exécuter lorsqu'un évènement {{event("removetrack")}} est délenché sur l'objet, ce qui arrive quand un objet  {{domxref("MediaStreamTrack")}} est retiré.</dd>
</dl>

<h2 id="Méthodes">Méthodes</h2>

<dl>
 <dt>{{domxref("MediaStream.getTrackById()")}}</dt>
 <dd>Retourne la piste dont l'ID correspond à celui passé en paramètre, <code>trackid</code>. Si aucun paramètre n'est fourni, ou si aucune piste avec cet id existe, la fonction retourne <code>null</code>. Si plusieurs pistes ont le même id, elle retourne la première piste.</dd>
</dl>

<dl>
 <dt>{{domxref("MediaStream.addTrack()")}}</dt>
 <dd>Stocke une copie de {{domxref("MediaStreamTrack")}} fourni en paramètre. Si la piste à déjà été ajouté à l'objet <code>MediaStream</code>, rien ne se passe; si la piste est au statut <code>finished</code>, c'est à dire qu'elle est terminée, l'exception <code>INVALID_STATE_RAISE</code> est levée.</dd>
 <dt>{{domxref("MediaStream.removeTrack()")}}</dt>
 <dd>Retire le the {{domxref("MediaStreamTrack")}} fourni comme argument. Si la piste ne fait pas parti du <code>MediaStream</code>, rien ne se passe; Si la piste est au statut <code>finished</code>, ce qui arrive lorsqu'elle est terminée, l'exception <code>INVALID_STATE_RAISE</code> est levée.</dd>
 <dt>{{domxref("MediaStream.getAudioTracks()")}}</dt>
 <dd>Retourne la liste des {{domxref("MediaStreamTrack")}} stockés dans l'objet <code>MediaStream</code> qui ont leur attribut <code>kind</code> défini à <code>"audio"</code>. L'ordre n'est pas défini, et peut varier d'un navigateur à l'autre, mais aussi d'un appel de la méthode à l'autre.</dd>
 <dt>{{domxref("MediaStream.getVideoTracks()")}}</dt>
 <dd>Retourne une liste des {{domxref("MediaStreamTrack")}} stockés dans l'objet <code>MediaStream</code> qui ont leur attribut <code>kind</code> défini à <code>"video"</code>. L'ordre n'est pas défini, et peut varier d'un navigateur à l'autre, mais aussi d'un appel de la méthode à l'autre.</dd>
</dl>

<h2 id="Spécifications">Spécifications</h2>

<table class="standard-table">
 <tbody>
  <tr>
   <th scope="col">Spécification</th>
   <th scope="col">Statut</th>
   <th scope="col">Commentaire</th>
  </tr>
  <tr>
   <td>{{SpecName('Media Capture', '#mediastream', 'MediaStream')}}</td>
   <td>{{Spec2('Media Capture')}}</td>
   <td></td>
  </tr>
 </tbody>
</table>

<h2 id="Browser_compatibility">Compatibilité des navigateurs</h2>

<p>{{Compat("api.MediaStream")}}</p>

<h2 id="See_also">Voir aussi</h2>

<ul>
  <li>Utilisation de l'API MediaStream</li>
  <li><a href="/fr/docs/Web/API/WebRTC_API">WebRTC API</a></li>
  <li><a href="/fr/docs/Web/API/Web_Audio_API">Web Audio API</a></li>
  <li>{{domxref("MediaStreamTrack")}}</li>
</ul>