Skip to content

Mention TrackMetadata in Metadata docs#235

Open
Magmusacy wants to merge 1 commit intomainfrom
FCE-2896
Open

Mention TrackMetadata in Metadata docs#235
Magmusacy wants to merge 1 commit intomainfrom
FCE-2896

Conversation

@Magmusacy
Copy link

Description

  • types.ts: Add JSDoc documentation to TrackMetadata type, describing the purpose of each field (type, paused, displayName)
  • metadata.mdx: Add "Track metadata" section explaining the TrackMetadata object, its fields, and how to read them via usePeers

Motivation and Context

TrackMetadata was undocumented. Users had no way to know what fields are available on tracks or how to use them (e.g. checking if a camera is enabled). This adds both inline API docs and a documentation page section to cover that gap.

@linear
Copy link

linear bot commented Mar 5, 2026

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds documentation for per-track TrackMetadata to the client metadata how-to docs, so users can understand available fields and how to read them from peers/tracks.

Changes:

  • Adds a new “Track metadata” section describing TrackMetadata fields.
  • Adds web and React Native examples showing how to read track metadata via usePeers.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@Magmusacy Magmusacy marked this pull request as ready for review March 6, 2026 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants