mirror of
https://github.com/matrix-org/matrix-spec
synced 2025-12-20 16:38:37 +01:00
6e16a19ac9
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
44 lines
1.1 KiB
YAML
44 lines
1.1 KiB
YAML
$schema: https://json-schema.org/draft/2020-12/schema
|
|
|
|
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.
|
|
audio_muted:
|
|
type: boolean
|
|
description: |-
|
|
Whether the audio track in the stream is muted.
|
|
|
|
Defaults to `false` if not present.
|
|
x-addedInMatrixVersion: "1.11"
|
|
video_muted:
|
|
type: boolean
|
|
description: |-
|
|
Whether the video track in the stream is muted.
|
|
|
|
Defaults to `false` if not present.
|
|
x-addedInMatrixVersion: "1.11"
|
|
required:
|
|
- purpose
|