HypnoSpec // space.hypna.feature.spirals.media
Spiral Feature Descriptor for Spiral Metadata

Spiral Feature Descriptor for Spiral Metadata

Type: object

This feature adds text lines to the session.

root id
Type: string

A unique identifier for the project. Current standard is java-inspired. ex. 'space.hypna.feature.variables'

root creator
Type: string

Name or ID of the Creator of this Feature.

root version
Type: string

Version of this Feature.

root required
Type: boolean

Flag to determine if the feature is required or not.

root useProjectLevelConfiguration
Type: boolean

If this schema is used in a Session Container, and this value is true, the system should read the configuration from the Project-Level Feature Schema with the same key. If the key cannot be found, fall back to this configuration.

root dependencies
Type: array of string

List of features that are required to enable this feature. An exclamation mark in front of the string denotes an optional requirement that should raise a warning.

 No Additional Items

Each item of this array must be:

root dependencies dependencies items
Type: string

root configuration
Type: object

The configuration of this feature. Can be any free-form configuration in this space, but should be documented somewhere for feature comparison. It is recommended that this spec be used as the base for other feature specs.

root configuration media_url
Type: string

URL to the media content

root configuration media_is_image
Type: boolean

If true, the session should render using an image tag. If false, assume it's a video that requires special handling.

root configuration media_opacity
Type: string

Opacity of the media content, between 0 and 1, where 1 is fully opaque.