Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
blocks:drivers:hive [2026-10-29 15:56] – mattiasblocks:drivers:hive [2026-10-29 15:59] (current) – mattias
Line 122: Line 122:
 | ''status'' | String: ''play'', ''pause'', ''stop'' | Playback. ''stop'' means the layer shows black (''0000_BLACK.jpg''). While the play list uses the layer, this is the play list's state. | | ''status'' | String: ''play'', ''pause'', ''stop'' | Playback. ''stop'' means the layer shows black (''0000_BLACK.jpg''). While the play list uses the layer, this is the play list's state. |
 | ''playMode'' | Number | Hive's play mode: 7 pauses, 6 is its own Stop, and every other value runs: 2 Loop Forward, 4 Play Once Forward, 8 Bounce. | | ''playMode'' | Number | Hive's play mode: 7 pauses, 6 is its own Stop, and every other value runs: 2 Loop Forward, 4 Play Once Forward, 8 Bounce. |
-| ''speed'' | Number, 0…1 | 0 halts, 0.5 is normal speed, 1 is ten times. |+| ''speed'' | Number, 0-1 | 0 halts, 0.5 is normal speed, 1 is ten times. |
 | ''time'' | TimeFlow | Position and rate. **Two-way**: write rate 0/1 to pause and play, or a new position to seek. | | ''time'' | TimeFlow | Position and rate. **Two-way**: write rate 0/1 to pause and play, or a new position to seek. |
 | ''media'' | Number | Media by the number Hive shows before the name, within the selected folder. 0 is black, which stops the layer. | | ''media'' | Number | Media by the number Hive shows before the name, within the selected folder. 0 is black, which stops the layer. |
Line 130: Line 130:
 | ''fileName'' | String, read-only | What the layer shows right now. While the play list uses the layer, its current row. | | ''fileName'' | String, read-only | What the layer shows right now. While the play list uses the layer, its current row. |
 | ''duration'' | Number, read-only | Length of the selected media, mS. | | ''duration'' | Number, read-only | Length of the selected media, mS. |
-| ''intensity'' | Number, 0…1 | Opacity. | +| ''intensity'' | Number, 0-1 | Opacity. | 
-| ''volume'' | Number, 0…1 | 1 is 100 % on Hive's Parameters page. Only for video carrying uncompressed embedded audio. |+| ''volume'' | Number, 0-1 | 1 is 100 % on Hive's Parameters page. Only for video carrying uncompressed embedded audio. |
 | ''syncSource'' | String, read-only | Path of the Blocks time property this layer follows. | | ''syncSource'' | String, read-only | Path of the Blocks time property this layer follows. |
  
Line 139: Line 139:
  
 ^ Property ^ Type ^ Description ^ ^ Property ^ Type ^ Description ^
-| ''scale'' | Number, 0…1 | Zoom. 0.5 is 100 %; below zooms out, above zooms in. |+| ''scale'' | Number, 0-1 | Zoom. 0.5 is 100 %; below zooms out, above zooms in. |
 | ''framingMode'' | String | How media fits the output: ''LETTERBOX'', ''CROP'', ''STRETCH'', ''MULTI LETTERBOX'', ''CENTERED''. | | ''framingMode'' | String | How media fits the output: ''LETTERBOX'', ''CROP'', ''STRETCH'', ''MULTI LETTERBOX'', ''CENTERED''. |
-| ''aspectRatio'' | Number, 0…1 | 0.5 is none; below squeezes horizontally, above vertically. | +| ''aspectRatio'' | Number, 0-1 | 0.5 is none; below squeezes horizontally, above vertically. | 
-| ''positionX'', ''positionY'' | Number, 0…1 | 0.5 is centred. | +| ''positionX'', ''positionY'' | Number, 0-1 | 0.5 is centred. | 
-| ''rotationX'', ''rotationY'', ''rotationZ'' | Number, 0…1 | 0.5 is none. The extremes of ''rotationX'' auto-rotate. |+| ''rotationX'', ''rotationY'', ''rotationZ'' | Number, 0-1 | 0.5 is none. The extremes of ''rotationX'' auto-rotate. |
 | ''blendMode'' | String | Blend against the layers below: ''ALPHA'', ''ADDITIVE'', ''MULTIPLY'', ''DIFFERENCE'', ''SCREEN'' and 27 more, through to ''GLITCH''. | | ''blendMode'' | String | Blend against the layers below: ''ALPHA'', ''ADDITIVE'', ''MULTIPLY'', ''DIFFERENCE'', ''SCREEN'' and 27 more, through to ''GLITCH''. |
-| ''red'', ''green'', ''blue'' | Number, 0…1 | 0.5 leaves the channel at 100 %. | +| ''red'', ''green'', ''blue'' | Number, 0-1 | 0.5 leaves the channel at 100 %. | 
-| ''hue'' | Number, 0…1 | Across the full 360 degrees. | +| ''hue'' | Number, 0-1 | Across the full 360 degrees. | 
-| ''saturation'', ''contrast'' | Number, 0…1 | 0.5 leaves them alone. |+| ''saturation'', ''contrast'' | Number, 0-1 | 0.5 leaves them alone. |
 | ''lut'' | Number | LUT from the player's LUTS folder, 0 for none. | | ''lut'' | Number | LUT from the player's LUTS folder, 0 for none. |
-| ''strobe'' | Number, 0…1 | Below 0.5 is on/off strobe slow to fast, above is punch strobe. |+| ''strobe'' | Number, 0-1 | Below 0.5 is on/off strobe slow to fast, above is punch strobe. |
 | ''inFrame'', ''outFrame'' | Number | Frame numbers playback starts from and ends or loops at. | | ''inFrame'', ''outFrame'' | Number | Frame numbers playback starts from and ends or loops at. |
 | ''fx1Select'', ''fx2Select'' | Number | Effect by number, 0 for none. Hive documents 1 Old TV, 2 Sepia, 3 Feedback, 4 Blur and on to 15. | | ''fx1Select'', ''fx2Select'' | Number | Effect by number, 0 for none. Hive documents 1 Old TV, 2 Sepia, 3 Feedback, 4 Blur and on to 15. |
-| ''fx1Opacity'', ''fx2Opacity'' | Number, 0…1 | Effect opacity. |+| ''fx1Opacity'', ''fx2Opacity'' | Number, 0-1 | Effect opacity. |
 | ''transitionDuration'' | Number, mS | Cross-fade duration. | | ''transitionDuration'' | Number, mS | Cross-fade duration. |
 | ''transitionMode'' | String | Cross-fade mode, named as ''blendMode''. | | ''transitionMode'' | String | Cross-fade mode, named as ''blendMode''. |
Line 179: Line 179:
 | ''toggle()'' | Run the layer if it is stopped or paused, pause it if it is running. | | ''toggle()'' | Run the layer if it is stopped or paused, pause it if it is running. |
 | ''setFxParam(effect, param, value)'' | Set one of an effect's 16 parameters. | | ''setFxParam(effect, param, value)'' | Set one of an effect's 16 parameters. |
-| ''setFxParams(effect, p1 … p16)'' | Set any of them together in one call; a parameter left out keeps its value. |+| ''setFxParams(effect, p1 to p16)'' | Set any of them together in one call; a parameter left out keeps its value. |
 | ''readFxParam(effect, param)'' | Read one parameter into the log. | | ''readFxParam(effect, param)'' | Read one parameter into the log. |
 | ''logCues()'' | Log this layer's cue list, with each cue's trigger time and length. | | ''logCues()'' | Log this layer's cue list, with each cue's trigger time and length. |
Line 200: Line 200:
 | ''onLayers'' | String, read-only | The layers showing it, e.g. ''1,2''. Paused counts; stopped does not. | | ''onLayers'' | String, read-only | The layers showing it, e.g. ''1,2''. Paused counts; stopped does not. |
 | ''layer'' | Number | The layer showing it, lowest if several, 0 if none. Write a layer number to play it there, 0 to stop it wherever it plays. | | ''layer'' | Number | The layer showing it, lowest if several, 0 if none. Write a layer number to play it there, 0 to stop it wherever it plays. |
-| ''onLayer1'' … ''onLayer8'' | Boolean | One per layer: true while that layer shows the file. Write true to play it there, false to stop **just that layer**, leaving the others alone. |+| ''onLayer1'' to ''onLayer8'' | Boolean | One per layer: true while that layer shows the file. Write true to play it there, false to stop **just that layer**, leaving the others alone. |
  
 **Black has a member of its own**, ''media.root_0000'' (''0000_BLACK.jpg''), which ''mediaList'' leaves out. Its ''onLayerN'' reads true while that layer is stopped, writing true stops the layer, and writing false plays the layer's selection again, so a panel can put a layer to black from the same list it picks media from. **Black has a member of its own**, ''media.root_0000'' (''0000_BLACK.jpg''), which ''mediaList'' leaves out. Its ''onLayerN'' reads true while that layer is stopped, writing true stops the layer, and writing false plays the layer's selection again, so a panel can put a layer to black from the same list it picks media from.
Line 255: Line 255:
 ''startSync(path)'' on a layer, or ''playlistStartSync(path)'', makes a Blocks TimeFlow property the master. The driver then follows position and, with ''syncRate'', rate. A drift beyond ''syncDrift'' is corrected; a change beyond ''syncJump'' counts as a seek. A dead master, a stopped Blocks timeline, is treated per ''syncStopAction''. ''startSync(path)'' on a layer, or ''playlistStartSync(path)'', makes a Blocks TimeFlow property the master. The driver then follows position and, with ''syncRate'', rate. A drift beyond ''syncDrift'' is corrected; a change beyond ''syncJump'' counts as a seek. A dead master, a stopped Blocks timeline, is treated per ''syncStopAction''.
  
-Hive has a usable rate control, PLAY SPEED, 0…1, where 0.5 is normal, so the driver can follow a master's rate rather than chase its position.+Hive has a usable rate control, PLAY SPEED, 0-1, where 0.5 is normal, so the driver can follow a master's rate rather than chase its position.
  
 ==== Password protection ==== ==== Password protection ====