Elgato Stream Deck

Elgato Stream Deck plugin manifest file

elgato-stream-deck-plugin.ymlelgato-stream-deck-plugin.yaml

Validate

Check your file against this schema

Opens the validator with this schema already loaded. Paste your elgato-stream-deck-plugin.yml and it validates in your browser — nothing is uploaded.

Validate a elgato-stream-deck-plugin.yml → View raw schema

Reference

Fields

Generated directly from the schema, following local $refs, to two levels of nesting.

Field	Type	Description
`Author`	`string`	The author of the plugin. This string is displayed to the user in the Stream Deck store.
`CodePath`required	`string`	The relative path to the HTML/binary file containing the plugin code.
`Description`required	`string`	Provides a general description of what the plugin does. This string is displayed to the user in the Stream Deck store.
`Icon`required	`string`	The relative path to an image without the extension. This image is displayed in the Stream Deck marketplace. SVGs are preferred. If not, the PNG image should be 288 x 288 px, and you should provide @1x and @2x (288 x 288 px & 576 x 576 px
`Name`required	`string`	The name of the plugin. This string is displayed to the user in the Stream Deck store.
`Version`required	`string`	Plugin's semantic version (1.0.0).
`SDKVersion`required	`number`	The current SDK version is 2.
`OS`required	`array<object>`	The list of operating systems & versions supported by the plugin.
`Software`required	`object`	Indicates which version of the Stream Deck application is required to install the plugin.
`Software.MinimumVersion`	`string`	The minimum version of the operating system that the plugin requires. For Windows 10, you can use “10”. For macOS 10.11, you can use “10.11”.
`Category`	`string`	The name of the custom category in which the actions should be listed. This string is visible to the user in the actions list. If you don't provide a category, the actions will appear inside a "Custom" category.
`CategoryIcon`	`string`	The relative path to a PNG image without the .png extension. This image is used in the actions list. The PNG image should be a 28pt x 28pt image. You should provide @1x and @2x versions of the image. The Stream Deck application takes care
`CodePathMac`	`string`	Override CodePath for macOS.
`CodePathWin`	`string`	Override CodePath for Windows.
`Profiles`	`array<object>`	Specifies an array of profiles. A plugin can have one or more profiles proposed to the user on installation. This lets you create full screen plugins.
`PropertyInspectorPath`	`string`	The relative path to the Property Inspector HTML file if your plugin wants to display some custom settings in the Property Inspector. If missing, the plugin will have an empty Property Inspector.
`DefaultWindowSize`	`array<number>`	Specify the default window size when a Javascript plugin or Property Inspector opens a window using window.open(). The default value is [500, 650].
`URL`	`string`	A site to provide more information about the plugin.
`ApplicationsToMonitor`	`object`	List of application identifiers to monitor (applications launched or terminated). See the `applicationDidLaunch` and `applicationDidTerminate` events.
`ApplicationsToMonitor.mac`	`array<string>`	—
`ApplicationsToMonitor.windows`	`array<string>`	—
`Actions`required	`array<object>`	Specifies an array of actions. A plugin can indeed have one or multiple actions. For example, the “Game Capture” plugin has six actions: Scene, Record, Screenshot, Flashback Recording, Stream, Live Commentary.

Audit

What we found in this schema

Declared draft: draft-07
Validates cleanly against its own meta-schema.
63 properties, 94% carrying a description, max nesting depth 10.

Standards

Specification sections for the keywords in this schema

Keyword	Document	Section
`$comment`	JSON Schema Core, draft 2020-12	§8.3 — Comments With "$comment"
`$id`	JSON Schema Core, draft 2020-12	§8.2.1 — The "$id" Keyword
`$schema`	JSON Schema Core, draft 2020-12	§8.1.1 — "$schema"
`additionalProperties`	JSON Schema Core, draft 2020-12	§10.3.2.3 — "additionalProperties"
`default`	JSON Schema Validation, draft 2020-12	§9.2 — "default"
`description`	JSON Schema Validation, draft 2020-12	§9.1 — "title" and "description"
`enum`	JSON Schema Validation, draft 2020-12	§6.1.2 — "enum"
`examples`	JSON Schema Validation, draft 2020-12	§9.5 — "examples"
`items`	JSON Schema Core, draft 2020-12	§10.3.1.2 — "items"
`minItems`	JSON Schema Validation, draft 2020-12	§6.4.2 — "minItems"
`minimum`	JSON Schema Validation, draft 2020-12	§6.2.4 — "minimum"
`pattern`	JSON Schema Validation, draft 2020-12	§6.3.3 — "pattern"
`properties`	JSON Schema Core, draft 2020-12	§10.3.2.1 — "properties"
`required`	JSON Schema Validation, draft 2020-12	§6.5.3 — "required"
`type`	JSON Schema Validation, draft 2020-12	§6.1.1 — "type"

Documents

JSON Schema Core, draft 2020-12 — JSON Schema: A Media Type for Describing JSON Documents, A. Wright, H. Andrews, B. Hutton, G. Dennis, Eds., 2022. draft-bhutton-json-schema-01. An expired Internet-Draft with no formal standing in the IETF standards process; it is nonetheless the specification of record for JSON Schema 2020-12, published by json-schema.org.
JSON Schema Validation, draft 2020-12 — JSON Schema Validation: A Vocabulary for Structural Validation of JSON, A. Wright, H. Andrews, B. Hutton, Eds., 2022.
RFC 8259 (STD 90) — The JavaScript Object Notation (JSON) Data Interchange Format, T. Bray, Ed., 2017. The format a schema describes.
RFC 6901 — JavaScript Object Notation (JSON) Pointer. Defines the pointer syntax used by $ref fragments and the ~0 / ~1 escapes.

Source

Attribution

This schema comes from SchemaStore, distributed under the Apache License 2.0. Copyright 2015–present Mads Kristensen and contributors. View the original file. The field table and audit on this page are generated by JSONTools.tools; the schema itself is unmodified.

← All schemas