matrix-spec/data/event-schemas/schema/components/sdp_stream_metadata.yaml
Kévin Commaille f8ff581208
Apply review suggestion
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2024-03-13 11:01:34 +01:00

28 lines
695 B
YAML

type: object
x-addedInMatrixVersion: "1.10"
description: |-
Metadata describing the [streams](/client-server-api/#streams) that will be
sent.
This is a map of stream ID to metadata about the stream.
additionalProperties:
type: object
title: StreamMetadata
description: Metadata describing a stream.
properties:
purpose:
type: string
enum:
- m.usermedia
- m.screenshare
description: |-
The purpose of the stream.
The possible values are:
* `m.usermedia`: Stream that contains the webcam and/or microphone
tracks.
* `m.screenshare`: Stream with the screen-sharing tracks.
required:
- purpose