This section describes the procedures for associating media descriptions representing MediaStreamTracks within MediaStreams, as defined in [
W3C-WebRTC].
In the Javascript API described in that specification, each MediaStream and MediaStreamTrack has an "id" attribute, which is a DOMString.
The value of the "msid-id" field in the MSID consists of the "id" attribute of a MediaStream, as defined in the MediaStream's WebIDL specification [
WEBIDL]. The special value "-" indicates "no MediaStream".
The value of the "msid-appdata" field in the MSID, if present, consists of the "id" attribute of a MediaStreamTrack, as defined in the MediaStreamTrack's WebIDL specification.
When an SDP session description is updated, a specific "msid-id" value continues to refer to the same MediaStream, and a specific "msid-appdata" to the same MediaStreamTrack. There is no memory apart from the currently valid SDP descriptions; if an MSID "identifier" value disappears from the SDP and appears in a later negotiation, it will be taken to refer to a new MediaStream.
If the "msid" attribute does not conform to the ABNF given here, it
SHOULD be ignored.
The following is a high-level description of the rules for handling SDP updates. Detailed procedures are located in
Section 3.2.
-
When a new MSID "identifier" value occurs in a session description, and it is not "-", the recipient can signal to its application that a new MediaStream has been added.
-
When a session description is updated to have media descriptions with an MSID "identifier" value, with one or more different "appdata" values, the recipient can signal to its application that new MediaStreamTracks have been added and note to which MediaStream they have been added. This is done for each different MSID "identifier" value, including the special value "-", which indicates that a MediaStreamTrack has been added with no corresponding MediaStream.
-
If an MSID "identifier" value with no "appdata" value appears, it means that the sender did not inform the recipient of the desired identifier of the MediaStreamTrack, and the recipient will assign the "id" value of the created MediaStreamTrack on its own. All MSIDs in a media section that do not have an "appdata" value are assumed to refer to the same MediaStreamTrack.
-
When a session description is updated to no longer list any "msid" attribute on a specific media description, the recipient can signal to its application that the corresponding MediaStreamTrack has ended.
In addition to signaling that the track is ended when its "msid" attribute disappears from the SDP, the track will also be signaled as being ended when all associated SSRCs have disappeared by the rules of [
RFC 3550], Sections
6.3.4 (BYE packet received) and
6.3.5 (timeout), or when the corresponding media description is disabled by setting the port number to zero. Changing the direction of the media description (by setting "sendonly", "recvonly", or "inactive" attributes) will not end the MediaStreamTrack.
The association between SSRCs and media descriptions is specified in [
RFC 8829].
Entities that do not use the mechanism described in this document will not send the "msid" attribute and thus will not send information allowing the mapping of RTP packets to MediaStreams. This means that there will be some incoming RTP packets for which the recipient has no predefined MediaStream ID value.
Note that the handling described below is triggered by incoming RTP packets, not SDP negotiation.
When communicating with entities that use the MSID mechanism, the only time incoming RTP packets can be received without an associated MediaStream ID value is when, after the initial negotiation, a negotiation is performed where the answerer adds a MediaStreamTrack to an already established connection and starts sending data before the answer is received by the offerer. For initial negotiation, packets won't flow until the Interactive Connectivity Establishment (ICE) candidates and fingerprints have been exchanged, so this is not an issue.
The recipient of those packets will perform the following steps:
-
When RTP packets are initially received, it will create an appropriate MediaStreamTrack based on the type of the media (carried in PayloadType) and use the MID RTP header extension [RFC 8843] (if present) to associate the RTP packets with a specific media section.
-
If the connection is not in the RTCSignalingState "stable", it will wait at this point.
-
When the connection is in the RTCSignalingState "stable", it will assign ID values.
The following steps are performed to assign ID values:
-
If there is an "msid" attribute, it will use that attribute to populate the "id" field of the MediaStreamTrack and associated MediaStreams, as described above.
-
If there is no "msid" attribute, the identifier of the MediaStreamTrack will be set to a randomly generated string, and it will be signaled as being part of a MediaStream with the WebIDL "label" attribute set to "Non-WebRTC stream".
-
After deciding on the "id" field to be applied to the MediaStreamTrack, the track will be signaled to the user.
The process above may involve a considerable amount of buffering before the "stable" state is entered. If the implementation wishes to limit this buffering, it
MUST signal to the user that media has been discarded.
It follows from the above that MediaStreamTracks in the "default" MediaStream cannot be closed by removing the "msid" attribute; the application must instead signal these as closed when the SSRC disappears, either according to the rules of Sections
6.3.4 and
6.3.5 of [
RFC 3550] or by disabling the media description by setting its port to zero.
These procedures are given in terms of sections recommended by [
RFC 3264]. They describe the actions to be taken in terms of MediaStreams and MediaStreamTracks; they do not include event signaling inside the application, which is described in the JavaScript Session Establishment Protocol (JSEP) [
RFC 8829].
For each media description in the offer, if there is an associated outgoing MediaStreamTrack, the offerer adds one "a=msid" attribute to the section for each MediaStream with which the MediaStreamTrack is associated. The "identifier" field of the attribute is set to the WebIDL "id" attribute of the MediaStream. If the sender wishes to signal identifiers for the MediaStreamTracks, the "appdata" field is set to the WebIDL "id" attribute of the MediaStreamTrack; otherwise, it is omitted.
For each media description in the offer and each "a=msid" attribute in the media description, the receiver of the offer will perform the following steps:
-
Extract the "appdata" field of the "a=msid" attribute, if present.
-
If the "appdata" field exists: Check if a MediaStreamTrack with the same WebIDL "id" attribute as the "appdata" field already exists and is not in the "ended" state. If such a MediaStreamTrack is not found, create it.
-
If the "appdata" field does not exist, and a MediaStreamTrack is not associated with this media section, create a MediaStreamTrack and associate it with this media section for future use.
-
Extract the "identifier" field of the "a=msid" attribute.
-
Check if a MediaStream with the same WebIDL "id" attribute already exists. If not, create it.
-
Add the MediaStreamTrack to the MediaStream.
-
Signal to the user that a new MediaStreamTrack is available.
The answer is generated in exactly the same manner as the offer. "a=msid" values in the offer do not influence the answer.
The answer is processed in exactly the same manner as the offer.
On subsequent exchanges, precisely the same procedure as for the initial offer/answer is followed, but with one additional step in the parsing of the offer and answer:
-
For each MediaStreamTrack that has been created as a result of previous offer/answer exchanges, and is not in the "ended" state, check to see if there is still an "a=msid" attribute in the present SDP whose "appdata" field is the same as the WebIDL "id" attribute of the track.
-
If no such attribute is found, stop the MediaStreamTrack. This will set its state to "ended".
The following SDP description shows the representation of a WebRTC PeerConnection with two MediaStreams, each of which has one audio and one video track. Only the parts relevant to the MSID are shown.
Line wrapping, empty lines, and comments are added for clarity. They are not part of the SDP.
# First MediaStream - id is 4701...
m=audio 56500 UDP/TLS/RTP/SAVPF 96 0 8 97 98
a=msid:47017fee-b6c1-4162-929c-a25110252400
f83006c5-a0ff-4e0a-9ed9-d3e6747be7d9
m=video 56502 UDP/TLS/RTP/SAVPF 100 101
a=msid:47017fee-b6c1-4162-929c-a25110252400
b47bdb4a-5db8-49b5-bcdc-e0c9a23172e0
# Second MediaStream - id is 6131....
m=audio 56503 UDP/TLS/RTP/SAVPF 96 0 8 97 98
a=msid:61317484-2ed4-49d7-9eb7-1414322a7aae
b94006c5-cade-4e0a-9ed9-d3e6747be7d9
m=video 56504 UDP/TLS/RTP/SAVPF 100 101
a=msid:61317484-2ed4-49d7-9eb7-1414322a7aae
f30bdb4a-1497-49b5-3198-e0c9a23172e0