RTCEncodedAudioFrame: getMetadata() method

{{APIRef("WebRTC")}}{{AvailableInWorkers("window_and_dedicated")}}

The getMetadata() method of the {{domxref("RTCEncodedAudioFrame")}} interface returns an object containing the metadata associated with the frame.

This includes information about the frame, such as the audio encoding used, the synchronization source and contributing sources, and the sequence number (for incoming frames).

Syntax

getMetadata()

Parameters

None.

Return value

An object with the following properties:

• audioLevel
  • : A number representing the audio level of this frame. The value is between 0 and 1 inclusive (linear), where 1.0 represents 0 dBov (decibels relative to full scale (DBFS)), 0 represents silence, and 0.5 represents approximately 6 dB SPL change in the sound pressure level from 0 dBov. The value is converted from the -127 to 0 range specified in RFC6464 via the equation 10^(-rfc_level/20). If the RFC6464 header extension is not present in the received packets of the frame, audioLevel will be undefined.
• captureTime
  • : A {{domxref("DOMHighResTimeStamp")}} indicating the capture time of the frame relative to {{domxref("Performance.timeOrigin")}}.
• contributingSources
  • : An {{jsxref("Array")}} of sources (ssrc) that have contributed to the frame. Consider the case of a conferencing application that combines audio from multiple users. The synchronizationSource would include the ssrc of the application, while contributingSources would include the ssrc values of all the individual audio sources.
• mimeType
  • : A string containing the {{glossary("MIME type")}} of the codec used, such as "audio/opus".
• payloadType
  • : A positive integer value in the range from 0 to 127 that describes the format of the RTP payload. The mappings of values to formats is defined in {{rfc("3550")}}, and more specifically Section 6: Payload Type Definitions of {{rfc("3551")}}.
• receiveTime
  • : A {{domxref("DOMHighResTimeStamp")}} indicating the timestamp of the last received packet of an incoming frame (from an {{domxref("RTCRtpReceiver")}}) used to produce this media frame, relative to {{domxref("Performance.timeOrigin")}}.
• rtpTimestamp
  • : A positive integer that reflects the sampling instant of the first octet in the RTP data packet (see {{rfc("3550")}}).
• sequenceNumber
  • : The sequence number of an incoming audio frame (not used for outgoing frames) that can be used for reconstructing the original send-order of frames. This is number between 0 and 32767. Note that while numbers are allocated sequentially when sent, they will overflow at 32767 and restart back at 0. Therefore to compare two frame sequence numbers, in order to determine whether one is assumed to be after another, you must use serial number arithmetic. <!-- [RFC1982] -->
• synchronizationSource
  • : A positive integer value indicating the synchronization source ("ssrc") of the stream of RTP packets that are described by this frame. A source might be something like a microphone, or a mixer application that combines multiple sources. All packets from the same source share the same time source and sequence space, and so can be ordered relative to each other. Note that two frames with the same value refer to the same source.

Examples

Getting frame metadata

This example WebRTC encoded transform implementation shows how you might get the frame metadata in a transform() function and log it.

addEventListener("rtctransform", (event) => {
  const transform = new TransformStream({
    async transform(encodedFrame, controller) {
      // Get the metadata and log
      const frameMetaData = encodedFrame.getMetadata();
      console.log(frameMetaData);

      // Enqueue the frame without modifying
      controller.enqueue(encodedFrame);
    },
  });
  event.transformer.readable
    .pipeThrough(transform)
    .pipeTo(event.transformer.writable);
});

The resulting object from a local microphone might look like the one shown below. Note that there are no contributing sources because there is just one source, and no sequenceNumber because this is an outgoing frame.

{
  "captureTime": 19745.400000000373,
  "contributingSources": [],
  "mimeType": "audio/opus",
  "payloadType": 111,
  "rtpTimestamp": 1786045165,
  "synchronizationSource": 3365032712,
  "audioLevel": 0.001584893192461114
}

Specifications

{{Specifications}}

Browser compatibility

{{Compat}}

See also

• Using WebRTC Encoded Transforms