@bbc/object-based-media-schema
Advanced tools
@bbc/object-based-media-schema - npm Package Compare versions
Comparing version 1.0.5 to 1.0.7
@@ -282,3 +282,9 @@ # Object Based Media Schema Overview | ||
| | Show variable panel | `showvariablepanel/v1.0` | Display an interface to allow users to set the values of one or more story variables | See below for details || | ||
| | Link Map Overlay | `mapoverlay/v1.0` | Places an invisible set of clickable rectangles on the screen (e.g., over an image or video) that can be used to navigate to Narrative Elements. | See below for details | This behaviour overrides the concepts of links, so link conditions are not evaluated. | | ||
| | Fade in | `fadein/v1.0` | Apply a colour overlay, fading in over a given duration | `colour` (string, css colour) and `duration` (number, time in s) | Typically applied as a during behaviour with `start_time` 0 | | ||
| | Fade out | `fadeout/v1.0` | Apply a colour overlay, then fade it out over a given duration | `colour` (string, css colour) and `duration` (number, time in s) | Typically applied as a during behaviour with `start_time` of the media duration minus the `duration` | | ||
| | Fade audio in | `fadeaudioin/v1.0` | Set the foreground audio volume to an initial value, then fade up to last user set value over a given duration | `duration` (number, time in s) and optional `initialVolume` (default is 0) | | | ||
| | Fade audio out | `fadeaudioout/v1.0`| Fade the foreground audio down to the given value over a given duration | `duration` (number, time in s) and optional `targetVolume` (default is 0) | | | ||
| The attributes omitted from the table above are as follows: | ||
@@ -338,2 +344,7 @@ | ||
| #### `mapoverlay` | ||
| * `links` (Array of Objects, required) - Defines a set of rectangles on the screen; each has the UUID of the element that it links to and the position and size of the rectangle: | ||
| - `narrative_element_id` string defining the Narrative Element that clicking on the rectangle will navigate to | ||
| - `position` (Object) with `left`, `top`, `width`, `height` as number attributes specifying location within the player using percent | ||
| ### Example | ||
@@ -340,0 +351,0 @@ [Representation example](../samples/sample.representation.json) |
| { | ||
| "name": "@bbc/object-based-media-schema", | ||
| "version": "1.0.5", | ||
| "version": "1.0.7", | ||
| "description": "JSON schemas which describe a common language for object-based media", | ||
@@ -5,0 +5,0 @@ "main": "lib/validate.js", |
@@ -369,2 +369,94 @@ { | ||
| { | ||
| "title": "Fade in Behaviour", | ||
| "properties": { | ||
| "id": {}, | ||
| "type":{ | ||
| "type":"string", | ||
| "enum": [ | ||
| "urn:x-object-based-media:representation-behaviour:fadein/v1.0" | ||
| ] | ||
| }, | ||
| "colour": { | ||
| "description": "In form rgba(R, G, B, A)", | ||
| "type":"string" | ||
| }, | ||
| "duration": { | ||
| "description": "time to fade from colour to fully opaque (seconds)", | ||
| "type": "number" | ||
| } | ||
| }, | ||
| "required": ["colour", "duration"], | ||
| "additionalProperties": false | ||
| }, | ||
| { | ||
| "title": "Fade out Behaviour", | ||
| "properties": { | ||
| "id": {}, | ||
| "type":{ | ||
| "type":"string", | ||
| "enum": [ | ||
| "urn:x-object-based-media:representation-behaviour:fadeout/v1.0" | ||
| ] | ||
| }, | ||
| "colour": { | ||
| "description": "In form rgba(R, G, B, A)", | ||
| "type":"string" | ||
| }, | ||
| "duration": { | ||
| "description": "time to fade from invisible to colour (seconds)", | ||
| "type": "number" | ||
| } | ||
| }, | ||
| "required": ["colour", "duration"], | ||
| "additionalProperties": false | ||
| }, | ||
| { | ||
| "title": "Fade audio in Behaviour", | ||
| "properties": { | ||
| "id": {}, | ||
| "type":{ | ||
| "type":"string", | ||
| "enum": [ | ||
| "urn:x-object-based-media:representation-behaviour:fadeaudioin/v1.0" | ||
| ] | ||
| }, | ||
| "startVolume": { | ||
| "description": "Value between 1 and 0 to set the volume at for start of fade (default 0)", | ||
| "type":"number" | ||
| }, | ||
| "duration": { | ||
| "description": "time to fade from startVolume to previously user set volume", | ||
| "type": "number" | ||
| } | ||
| }, | ||
| "required": ["duration"], | ||
| "additionalProperties": false | ||
| }, | ||
| { | ||
| "title": "Fade audio out Behaviour", | ||
| "properties": { | ||
| "id": {}, | ||
| "type":{ | ||
| "type":"string", | ||
| "enum": [ | ||
| "urn:x-object-based-media:representation-behaviour:fadeaudioout/v1.0" | ||
| ] | ||
| }, | ||
| "targetVolume": { | ||
| "description": "Value between 0 and 1 to fade the volume to (default 0)", | ||
| "type":"number" | ||
| }, | ||
| "duration": { | ||
| "description": "time to fade from current volume to targetVolume", | ||
| "type": "number" | ||
| } | ||
| }, | ||
| "required": ["duration"], | ||
| "additionalProperties": false | ||
| }, | ||
| { | ||
| "title": "Opaque Colour Overlay Behaviour", | ||
@@ -538,2 +630,55 @@ "properties": { | ||
| { | ||
| "title": "Link Map Overlay Behaviour", | ||
| "properties": { | ||
| "id": {}, | ||
| "type":{ | ||
| "type":"string", | ||
| "enum": [ | ||
| "urn:x-object-based-media:representation-behaviour:mapoverlay/v1.0" | ||
| ] | ||
| }, | ||
| "links": { | ||
| "type": "array", | ||
| "description": "List of links with rectangles defining click areas", | ||
| "items": { | ||
| "title": "Link area", | ||
| "type": "object", | ||
| "properties": { | ||
| "narrative_element_id": { | ||
| "type": "string", | ||
| "description": "UUID of Narrative Element the link points at" | ||
| }, | ||
| "position": { | ||
| "type": "object", | ||
| "description": "Position and size of link area on screen, using percentages", | ||
| "properties": { | ||
| "top": { | ||
| "description": "Distance of top edge of link area from top of player (%)", | ||
| "type": "number" | ||
| }, | ||
| "left": { | ||
| "description": "Distance of left edge of link area from left of player (%)", | ||
| "type": "number" | ||
| }, | ||
| "width": { | ||
| "description": "Width of link area, in %", | ||
| "type": "number" | ||
| }, | ||
| "height": { | ||
| "description": "Height of link area (%)", | ||
| "type": "number" | ||
| } | ||
| }, | ||
| "additionalProperties": false, | ||
| "required": ["top", "left", "width", "height"] | ||
| } | ||
| } | ||
| }, | ||
| "additionalProperties": false | ||
| } | ||
| }, | ||
| "required": ["type", "links"], | ||
| "additionalProperties": false | ||
| }, | ||
| { | ||
| "title": "Manipulate Variables Behaviour", | ||
@@ -540,0 +685,0 @@ "properties": { |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by3.47%
252445
- Lines of code
- increased by3.61%
4046
No dependency changes