1 --- # A metadata schema in Kwalify: http://www.kuwata-lab.com/kwalify/
5 "schema_version": # This should match the version comment above
8 "LC_NUMERIC": # If not provided LC_NUMERIC=C is used, not the system's locale.
11 "type": # A service type
14 enum: [consumer, filter, producer, transition]
15 "identifier": # The same value used to register and create the service
19 "title": # The UI can use this for a field label
21 "copyright": # Who owns the rights to the module and/or service?
23 "version": # The version of the service implementation
25 "license": # The software license for the service implementation
27 "language": # A 2 character ISO 639-1 language code
30 "url": # A hyperlink to a related website
32 "creator": # The name and/or e-mail address of the original author
34 "contributor": # The name and/or e-mail of all source code contributors
38 "tags": # A set of categories, this might become an enum
42 "description": # A slightly longer description than title
44 "icon": # A graphical representation of the effect
55 "notes": # Details about the usage and/or implementation - can be long
57 "bugs": # A list of known problems that users can try to avoid
60 - type: str # Can be a sentence or paragraph, preferably not a hyperlink
61 "parameters": # A list of all of the options for the service
66 "identifier": # The key that must be used to set the mlt_property
69 "type": # An mlt_property_type
72 - boolean # 0 or 1; not 'true', 'false', 'yes', or 'no' strings at this time
76 - properties # for passing options to encapsulated services
78 - time # time string values (clock, SMPTE) can be acccepted in addition to frames
79 "service-name": # for type: properties, a reference to another service
80 type: str # format: type.service, e.g. transition.composite
81 "title": # A UI can use this for a field label
83 "description": # A UI can use this for a tool tip or what's-this
85 "argument": # If this is also the service constructor argument.
88 "readonly": # If you set this property, it will be ignored
91 "required": # Is this property required?
94 "mutable": # The service will change behavior if this is set after
95 # processing the first frame
98 "widget": # A hint to the UI about how to let the user set this
111 - dropdown # aka HTML select or GtkOptionMenu
113 - rectangle # for use with type: geometry
117 - textbox # multi-line
119 "minimum": # For numeric types, the minimal value
121 "maximum": # For numeric types, the maximal value
123 "default": # The default value to be used in a UI
124 type: scalar # If not specified, the UI might be able to display
126 "unit": # A UI can display this as a label after the widget (e.g. %)
128 "scale": # the number of digits after decimal point when type: float
130 "format": # A hint about a custom string encoding, possibly scanf
131 "values": # A list of acceptable string values
132 type: seq # A UI can allow something outside the list with
133 # widget: combo or if "other" is in this sequence