@allyhub/sdk 0.1.0-alpha.8 → 0.2.0-next.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +241 -0
- package/NOTICE +85 -0
- package/client.d.ts +45 -1
- package/dist/anim.js +2 -75
- package/dist/define.d.ts +10 -4
- package/dist/define.js +2 -95
- package/dist/dom.d.ts +1 -1
- package/dist/dom.js +2 -457
- package/dist/fit.js +2 -60
- package/dist/free.d.ts +18 -0
- package/dist/free.js +2 -0
- package/dist/index.d.ts +28 -13
- package/dist/index.js +2 -11
- package/dist/input.d.ts +306 -0
- package/dist/input.js +2 -0
- package/dist/media.d.ts +3 -6
- package/dist/media.js +2 -27
- package/dist/messages.d.ts +3 -2
- package/dist/messages.js +2 -2
- package/dist/module.d.ts +24 -0
- package/dist/module.js +2 -0
- package/dist/noise.js +2 -233
- package/dist/parts.d.ts +98 -22
- package/dist/parts.js +2 -414
- package/dist/paths.d.ts +1 -1
- package/dist/paths.js +2 -720
- package/dist/phone.d.ts +26 -0
- package/dist/phone.js +2 -0
- package/dist/piece.d.ts +106 -35
- package/dist/piece.js +2 -38
- package/dist/props.d.ts +1 -1
- package/dist/props.js +2 -35
- package/dist/scenery.d.ts +2 -0
- package/dist/scenery.js +2 -0
- package/dist/text.js +2 -38
- package/dist/written.d.ts +12 -0
- package/dist/written.js +2 -0
- package/docs/README.md +18 -0
- package/docs/batches.md +148 -0
- package/docs/contract.md +51 -0
- package/docs/defaults.md +703 -0
- package/docs/docs.md +148 -0
- package/docs/footage.md +249 -0
- package/docs/layers.md +317 -0
- package/docs/modeling.md +143 -0
- package/docs/project.md +265 -0
- package/docs/scenery.md +308 -0
- package/docs/sheets.md +119 -0
- package/docs/slides.md +111 -0
- package/docs/sound.md +170 -0
- package/docs/speech.md +289 -0
- package/docs/video.md +265 -0
- package/node_modules/@allyhub-next/audio/LICENSE +241 -0
- package/node_modules/@allyhub-next/audio/dist/at-cut.d.ts +52 -0
- package/node_modules/@allyhub-next/audio/dist/at-cut.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/decode.d.ts +33 -0
- package/node_modules/@allyhub-next/audio/dist/decode.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/envelope.d.ts +37 -0
- package/node_modules/@allyhub-next/audio/dist/envelope.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/index.d.ts +17 -0
- package/node_modules/@allyhub-next/audio/dist/index.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/levels.d.ts +97 -0
- package/node_modules/@allyhub-next/audio/dist/levels.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/master.d.ts +29 -0
- package/node_modules/@allyhub-next/audio/dist/master.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/music.d.ts +11 -0
- package/node_modules/@allyhub-next/audio/dist/music.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/node/decode.d.ts +39 -0
- package/node_modules/@allyhub-next/audio/dist/node/decode.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/node/ebur128.d.ts +25 -0
- package/node_modules/@allyhub-next/audio/dist/node/ebur128.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/node/ffmpeg.d.ts +31 -0
- package/node_modules/@allyhub-next/audio/dist/node/ffmpeg.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/node/index.d.ts +8 -0
- package/node_modules/@allyhub-next/audio/dist/node/index.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/node/loudness.d.ts +18 -0
- package/node_modules/@allyhub-next/audio/dist/node/loudness.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/node/master.d.ts +42 -0
- package/node_modules/@allyhub-next/audio/dist/node/master.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/node/measure.d.ts +60 -0
- package/node_modules/@allyhub-next/audio/dist/node/measure.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/node/mix.d.ts +31 -0
- package/node_modules/@allyhub-next/audio/dist/node/mix.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/plan.d.ts +143 -0
- package/node_modules/@allyhub-next/audio/dist/plan.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recorded.d.ts +26 -0
- package/node_modules/@allyhub-next/audio/dist/recorded.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/bandwidth.d.ts +47 -0
- package/node_modules/@allyhub-next/audio/dist/recording/bandwidth.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/chain.d.ts +89 -0
- package/node_modules/@allyhub-next/audio/dist/recording/chain.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/dynamics.d.ts +64 -0
- package/node_modules/@allyhub-next/audio/dist/recording/dynamics.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/fft.d.ts +26 -0
- package/node_modules/@allyhub-next/audio/dist/recording/fft.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/filters.d.ts +42 -0
- package/node_modules/@allyhub-next/audio/dist/recording/filters.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/fit.d.ts +56 -0
- package/node_modules/@allyhub-next/audio/dist/recording/fit.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/index.d.ts +10 -0
- package/node_modules/@allyhub-next/audio/dist/recording/index.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/loudness.d.ts +12 -0
- package/node_modules/@allyhub-next/audio/dist/recording/loudness.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/measure.d.ts +67 -0
- package/node_modules/@allyhub-next/audio/dist/recording/measure.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/mic.d.ts +32 -0
- package/node_modules/@allyhub-next/audio/dist/recording/mic.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/noise.d.ts +27 -0
- package/node_modules/@allyhub-next/audio/dist/recording/noise.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/presets.d.ts +64 -0
- package/node_modules/@allyhub-next/audio/dist/recording/presets.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/room.d.ts +78 -0
- package/node_modules/@allyhub-next/audio/dist/recording/room.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/setup.d.ts +111 -0
- package/node_modules/@allyhub-next/audio/dist/recording/setup.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/recording/vec.d.ts +3 -0
- package/node_modules/@allyhub-next/audio/dist/recording/vec.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/render.d.ts +26 -0
- package/node_modules/@allyhub-next/audio/dist/render.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/sfx.d.ts +10 -0
- package/node_modules/@allyhub-next/audio/dist/sfx.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/shape.d.ts +118 -0
- package/node_modules/@allyhub-next/audio/dist/shape.js +2 -0
- package/node_modules/@allyhub-next/audio/dist/voice.d.ts +45 -0
- package/node_modules/@allyhub-next/audio/dist/voice.js +2 -0
- package/node_modules/@allyhub-next/audio/package.json +17 -0
- package/node_modules/@allyhub-next/formats/LICENSE +241 -0
- package/node_modules/@allyhub-next/formats/dist/data/comments.d.ts +94 -0
- package/node_modules/@allyhub-next/formats/dist/data/comments.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/config.d.ts +10 -0
- package/node_modules/@allyhub-next/formats/dist/data/config.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/edits.d.ts +28 -0
- package/node_modules/@allyhub-next/formats/dist/data/edits.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/elements.d.ts +6 -0
- package/node_modules/@allyhub-next/formats/dist/data/elements.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/faces.d.ts +38 -0
- package/node_modules/@allyhub-next/formats/dist/data/faces.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/file.d.ts +11 -0
- package/node_modules/@allyhub-next/formats/dist/data/file.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/gen.d.ts +31 -0
- package/node_modules/@allyhub-next/formats/dist/data/gen.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/messages.d.ts +34 -0
- package/node_modules/@allyhub-next/formats/dist/data/messages.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/reference.d.ts +676 -0
- package/node_modules/@allyhub-next/formats/dist/data/reference.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/script.d.ts +37 -0
- package/node_modules/@allyhub-next/formats/dist/data/script.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/sheet.d.ts +214 -0
- package/node_modules/@allyhub-next/formats/dist/data/sheet.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/data/words.d.ts +25 -0
- package/node_modules/@allyhub-next/formats/dist/data/words.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/index.d.ts +16 -0
- package/node_modules/@allyhub-next/formats/dist/index.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/items.d.ts +94 -0
- package/node_modules/@allyhub-next/formats/dist/items.js +2 -0
- package/node_modules/@allyhub-next/formats/dist/layout.d.ts +50 -0
- package/node_modules/@allyhub-next/formats/dist/layout.js +5 -0
- package/node_modules/@allyhub-next/formats/dist/schemas.d.ts +301 -0
- package/node_modules/@allyhub-next/formats/dist/schemas.js +2 -0
- package/node_modules/@allyhub-next/formats/package.json +14 -0
- package/node_modules/@allyhub-next/protocol/LICENSE +241 -0
- package/node_modules/@allyhub-next/protocol/dist/app.d.ts +98 -0
- package/node_modules/@allyhub-next/protocol/dist/app.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/auth.d.ts +116 -0
- package/node_modules/@allyhub-next/protocol/dist/auth.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/cli.d.ts +59 -0
- package/node_modules/@allyhub-next/protocol/dist/cli.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/cloud.d.ts +274 -0
- package/node_modules/@allyhub-next/protocol/dist/cloud.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/editor.d.ts +405 -0
- package/node_modules/@allyhub-next/protocol/dist/editor.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/files.d.ts +101 -0
- package/node_modules/@allyhub-next/protocol/dist/files.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/index.d.ts +12 -0
- package/node_modules/@allyhub-next/protocol/dist/index.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/jsonrpc.d.ts +83 -0
- package/node_modules/@allyhub-next/protocol/dist/jsonrpc.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/registry.d.ts +53 -0
- package/node_modules/@allyhub-next/protocol/dist/registry.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/runtimes.d.ts +93 -0
- package/node_modules/@allyhub-next/protocol/dist/runtimes.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/teams.d.ts +67 -0
- package/node_modules/@allyhub-next/protocol/dist/teams.js +2 -0
- package/node_modules/@allyhub-next/protocol/dist/tools.d.ts +345 -0
- package/node_modules/@allyhub-next/protocol/dist/tools.js +2 -0
- package/node_modules/@allyhub-next/protocol/package.json +13 -0
- package/node_modules/@allyhub-next/runtimes/LICENSE +241 -0
- package/node_modules/@allyhub-next/runtimes/dist/bundled.d.ts +10 -0
- package/node_modules/@allyhub-next/runtimes/dist/bundled.js +2 -0
- package/node_modules/@allyhub-next/runtimes/dist/download.d.ts +15 -0
- package/node_modules/@allyhub-next/runtimes/dist/download.js +2 -0
- package/node_modules/@allyhub-next/runtimes/dist/errors.d.ts +16 -0
- package/node_modules/@allyhub-next/runtimes/dist/errors.js +2 -0
- package/node_modules/@allyhub-next/runtimes/dist/home.d.ts +2 -0
- package/node_modules/@allyhub-next/runtimes/dist/home.js +2 -0
- package/node_modules/@allyhub-next/runtimes/dist/index.d.ts +9 -0
- package/node_modules/@allyhub-next/runtimes/dist/index.js +2 -0
- package/node_modules/@allyhub-next/runtimes/dist/lock.d.ts +6 -0
- package/node_modules/@allyhub-next/runtimes/dist/lock.js +2 -0
- package/node_modules/@allyhub-next/runtimes/dist/manifest.d.ts +3 -0
- package/node_modules/@allyhub-next/runtimes/dist/manifest.js +2 -0
- package/node_modules/@allyhub-next/runtimes/dist/runtimes.d.ts +63 -0
- package/node_modules/@allyhub-next/runtimes/dist/runtimes.js +3 -0
- package/node_modules/@allyhub-next/runtimes/dist/unpack.d.ts +7 -0
- package/node_modules/@allyhub-next/runtimes/dist/unpack.js +2 -0
- package/node_modules/@allyhub-next/runtimes/manifest.json +395 -0
- package/node_modules/@allyhub-next/runtimes/package.json +14 -0
- package/node_modules/@allyhub-next/runtimes/schemas/runtimes.schema.json +153 -0
- package/node_modules/@allyhub-next/scenery/LICENSE +241 -0
- package/node_modules/@allyhub-next/scenery/NOTICE +42 -0
- package/node_modules/@allyhub-next/scenery/dist/aim.d.ts +55 -0
- package/node_modules/@allyhub-next/scenery/dist/aim.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/bake.d.ts +203 -0
- package/node_modules/@allyhub-next/scenery/dist/bake.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/camera.d.ts +150 -0
- package/node_modules/@allyhub-next/scenery/dist/camera.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/curve.d.ts +40 -0
- package/node_modules/@allyhub-next/scenery/dist/curve.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/define.d.ts +164 -0
- package/node_modules/@allyhub-next/scenery/dist/define.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/fit.d.ts +64 -0
- package/node_modules/@allyhub-next/scenery/dist/fit.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/glass.d.ts +34 -0
- package/node_modules/@allyhub-next/scenery/dist/glass.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/handheld.d.ts +184 -0
- package/node_modules/@allyhub-next/scenery/dist/handheld.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/hull.d.ts +23 -0
- package/node_modules/@allyhub-next/scenery/dist/hull.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/index.d.ts +22 -0
- package/node_modules/@allyhub-next/scenery/dist/index.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/lens.d.ts +48 -0
- package/node_modules/@allyhub-next/scenery/dist/lens.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/moire.d.ts +136 -0
- package/node_modules/@allyhub-next/scenery/dist/moire.js +93 -0
- package/node_modules/@allyhub-next/scenery/dist/motion.d.ts +48 -0
- package/node_modules/@allyhub-next/scenery/dist/motion.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/move.d.ts +260 -0
- package/node_modules/@allyhub-next/scenery/dist/move.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/noise.d.ts +41 -0
- package/node_modules/@allyhub-next/scenery/dist/noise.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/phone.d.ts +34 -0
- package/node_modules/@allyhub-next/scenery/dist/phone.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/report.d.ts +677 -0
- package/node_modules/@allyhub-next/scenery/dist/report.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/screen-focus.d.ts +55 -0
- package/node_modules/@allyhub-next/scenery/dist/screen-focus.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/screen.d.ts +71 -0
- package/node_modules/@allyhub-next/scenery/dist/screen.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/solve.d.ts +82 -0
- package/node_modules/@allyhub-next/scenery/dist/solve.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/timing.d.ts +26 -0
- package/node_modules/@allyhub-next/scenery/dist/timing.js +2 -0
- package/node_modules/@allyhub-next/scenery/dist/vec.d.ts +19 -0
- package/node_modules/@allyhub-next/scenery/dist/vec.js +2 -0
- package/node_modules/@allyhub-next/scenery/package.json +13 -0
- package/node_modules/@allyhub-next/video-core/LICENSE +241 -0
- package/node_modules/@allyhub-next/video-core/dist/anchors.d.ts +164 -0
- package/node_modules/@allyhub-next/video-core/dist/anchors.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/audio-types.d.ts +148 -0
- package/node_modules/@allyhub-next/video-core/dist/audio-types.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/backdrop.d.ts +87 -0
- package/node_modules/@allyhub-next/video-core/dist/backdrop.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/captions.d.ts +122 -0
- package/node_modules/@allyhub-next/video-core/dist/captions.js +11 -0
- package/node_modules/@allyhub-next/video-core/dist/console.d.ts +91 -0
- package/node_modules/@allyhub-next/video-core/dist/console.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/contrast.d.ts +98 -0
- package/node_modules/@allyhub-next/video-core/dist/contrast.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/cut-report.d.ts +77 -0
- package/node_modules/@allyhub-next/video-core/dist/cut-report.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/edit.d.ts +77 -0
- package/node_modules/@allyhub-next/video-core/dist/edit.js +13 -0
- package/node_modules/@allyhub-next/video-core/dist/edits.d.ts +163 -0
- package/node_modules/@allyhub-next/video-core/dist/edits.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/export.d.ts +96 -0
- package/node_modules/@allyhub-next/video-core/dist/export.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/fact.d.ts +965 -0
- package/node_modules/@allyhub-next/video-core/dist/fact.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/footage-motion.d.ts +168 -0
- package/node_modules/@allyhub-next/video-core/dist/footage-motion.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/formats.d.ts +240 -0
- package/node_modules/@allyhub-next/video-core/dist/formats.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/gen.d.ts +37 -0
- package/node_modules/@allyhub-next/video-core/dist/gen.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/index.d.ts +40 -0
- package/node_modules/@allyhub-next/video-core/dist/index.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/look.d.ts +66 -0
- package/node_modules/@allyhub-next/video-core/dist/look.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/marks.d.ts +34 -0
- package/node_modules/@allyhub-next/video-core/dist/marks.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/matrix.d.ts +289 -0
- package/node_modules/@allyhub-next/video-core/dist/matrix.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/measure.d.ts +465 -0
- package/node_modules/@allyhub-next/video-core/dist/measure.js +5 -0
- package/node_modules/@allyhub-next/video-core/dist/media.d.ts +226 -0
- package/node_modules/@allyhub-next/video-core/dist/media.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/messages.d.ts +88 -0
- package/node_modules/@allyhub-next/video-core/dist/messages.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/motion.d.ts +56 -0
- package/node_modules/@allyhub-next/video-core/dist/motion.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/music.d.ts +110 -0
- package/node_modules/@allyhub-next/video-core/dist/music.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/piece.d.ts +1146 -0
- package/node_modules/@allyhub-next/video-core/dist/piece.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/placement.d.ts +37 -0
- package/node_modules/@allyhub-next/video-core/dist/placement.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/problem.d.ts +262 -0
- package/node_modules/@allyhub-next/video-core/dist/problem.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/render-types.d.ts +49 -0
- package/node_modules/@allyhub-next/video-core/dist/render-types.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/schema.d.ts +352 -0
- package/node_modules/@allyhub-next/video-core/dist/schema.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/script-edit.d.ts +176 -0
- package/node_modules/@allyhub-next/video-core/dist/script-edit.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/script.d.ts +67 -0
- package/node_modules/@allyhub-next/video-core/dist/script.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/seams.d.ts +214 -0
- package/node_modules/@allyhub-next/video-core/dist/seams.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/slides.d.ts +37 -0
- package/node_modules/@allyhub-next/video-core/dist/slides.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/sound-under.d.ts +72 -0
- package/node_modules/@allyhub-next/video-core/dist/sound-under.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/speech.d.ts +83 -0
- package/node_modules/@allyhub-next/video-core/dist/speech.js +5 -0
- package/node_modules/@allyhub-next/video-core/dist/timeline.d.ts +616 -0
- package/node_modules/@allyhub-next/video-core/dist/timeline.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/timing.d.ts +88 -0
- package/node_modules/@allyhub-next/video-core/dist/timing.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/transcript.d.ts +288 -0
- package/node_modules/@allyhub-next/video-core/dist/transcript.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/transition.d.ts +289 -0
- package/node_modules/@allyhub-next/video-core/dist/transition.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/voice.d.ts +175 -0
- package/node_modules/@allyhub-next/video-core/dist/voice.js +2 -0
- package/node_modules/@allyhub-next/video-core/dist/words.d.ts +128 -0
- package/node_modules/@allyhub-next/video-core/dist/words.js +2 -0
- package/node_modules/@allyhub-next/video-core/package.json +14 -0
- package/package.json +52 -41
- package/README.md +0 -17
- package/dist/anim.d.ts.map +0 -1
- package/dist/anim.js.map +0 -1
- package/dist/define.d.ts.map +0 -1
- package/dist/define.js.map +0 -1
- package/dist/dom.d.ts.map +0 -1
- package/dist/dom.js.map +0 -1
- package/dist/fit.d.ts.map +0 -1
- package/dist/fit.js.map +0 -1
- package/dist/index.d.ts.map +0 -1
- package/dist/index.js.map +0 -1
- package/dist/media.d.ts.map +0 -1
- package/dist/media.js.map +0 -1
- package/dist/messages.d.ts.map +0 -1
- package/dist/messages.js.map +0 -1
- package/dist/noise.d.ts.map +0 -1
- package/dist/noise.js.map +0 -1
- package/dist/parts.d.ts.map +0 -1
- package/dist/parts.js.map +0 -1
- package/dist/paths.d.ts.map +0 -1
- package/dist/paths.js.map +0 -1
- package/dist/piece.d.ts.map +0 -1
- package/dist/piece.js.map +0 -1
- package/dist/props.d.ts.map +0 -1
- package/dist/props.js.map +0 -1
- package/dist/text.d.ts.map +0 -1
- package/dist/text.js.map +0 -1
package/docs/defaults.md
ADDED
|
@@ -0,0 +1,703 @@
|
|
|
1
|
+
# Defaults
|
|
2
|
+
|
|
3
|
+
Every default of the piece API that is a constant in the code, with what it holds and the option that changes it. This file is written from those constants (`pnpm docs:defaults`), so its values are the code's. A default that is one plain value is also named where its option is documented. A command's defaults are in `allyhub help <command>`; a starter component's are props with defaults, in its source.
|
|
4
|
+
|
|
5
|
+
## A piece
|
|
6
|
+
|
|
7
|
+
### Formats
|
|
8
|
+
|
|
9
|
+
The presets (`PRESETS`) and page formats (`PAGE_FORMATS`, at 150 dpi): pixels, and the edges a platform's interface covers (`ctx.dims.safe`), changed by `format: { format, safe }`. A `WIDTHxHEIGHT` format covers none.
|
|
10
|
+
|
|
11
|
+
| Format | Pixels | Covered: top, bottom, left, right |
|
|
12
|
+
| --- | --- | --- |
|
|
13
|
+
| `16x9` | 1920 × 1080 | 60, 90, 80, 80 |
|
|
14
|
+
| `9x16` | 1080 × 1920 | 150, 400, 40, 140 |
|
|
15
|
+
| `1x1` | 1080 × 1080 | 50, 90, 40, 40 |
|
|
16
|
+
| `4x5` | 1080 × 1350 | 60, 120, 40, 40 |
|
|
17
|
+
| `a4` (slides only) | 1240 × 1754 | none |
|
|
18
|
+
| `letter` (slides only) | 1275 × 1650 | none |
|
|
19
|
+
|
|
20
|
+
The platform profiles (`PROFILES`): the frame, the edges the platform's interface covers, the longest video in seconds (AK-F001; `format: { format, maxDuration }`), the loudness its sound is mastered to in LUFS (`format: { format, loudness }`, `video({ master })`), and the crf and most video bitrate in kbit/s `allyhub render` encodes its mp4 at.
|
|
21
|
+
|
|
22
|
+
| Profile | Platform | Pixels | Covered: top, bottom, left, right | Longest | Loudness | crf | Most kbit/s |
|
|
23
|
+
| --- | --- | --- | --- | --- | --- | --- | --- |
|
|
24
|
+
| `tiktok` | TikTok | 1080 × 1920 | 240, 660, 120, 180 | 600 | -14 | 20 | 6000 |
|
|
25
|
+
| `reels` | Instagram Reels | 1080 × 1920 | 269, 672, 65, 65 | 180 | -14 | 20 | 6000 |
|
|
26
|
+
| `shorts` | YouTube Shorts | 1080 × 1920 | 288, 672, 48, 192 | 180 | -14 | 20 | 8000 |
|
|
27
|
+
| `meta-feed` | Facebook and Instagram feed | 1080 × 1350 | 60, 120, 40, 40 | 14460 | -14 | 20 | 6000 |
|
|
28
|
+
| `amazon` | Amazon Sponsored Brands video | 1920 × 1080 | 60, 90, 80, 80 | 45 | -14 | 20 | 8000 |
|
|
29
|
+
| `linkedin` | LinkedIn | 1080 × 1080 | 50, 90, 40, 40 | 1800 | -14 | 20 | 6000 |
|
|
30
|
+
|
|
31
|
+
### `FPS`
|
|
32
|
+
|
|
33
|
+
Frames per second of a video. `video({ fps })`.
|
|
34
|
+
|
|
35
|
+
Value: `30`
|
|
36
|
+
|
|
37
|
+
### `LOAD_LIMIT`
|
|
38
|
+
|
|
39
|
+
Seconds loading a version may take (AK-P002). `video({ loadLimit })`.
|
|
40
|
+
|
|
41
|
+
Value: `10`
|
|
42
|
+
|
|
43
|
+
### `SEEK_LIMIT`
|
|
44
|
+
|
|
45
|
+
Seconds one moment may take to draw (AK-P003). `video({ seekLimit })`.
|
|
46
|
+
|
|
47
|
+
Value: `30`
|
|
48
|
+
|
|
49
|
+
### `LOAD_WAITS`
|
|
50
|
+
|
|
51
|
+
How many seek limits loading waits for its layers' work (`ctx.wait`).
|
|
52
|
+
|
|
53
|
+
Value: `4`
|
|
54
|
+
|
|
55
|
+
### `CLEAN_LOOK`
|
|
56
|
+
|
|
57
|
+
The built-in look, `clean`, which `allyhub.config.ts`'s `look` is laid over. Its colours and fonts are the `--ak-color-*` and `--ak-font-*` CSS variables.
|
|
58
|
+
|
|
59
|
+
| Key | Value |
|
|
60
|
+
| --- | --- |
|
|
61
|
+
| `name` | `"clean"` |
|
|
62
|
+
| `color.bg` | `"#ffffff"` |
|
|
63
|
+
| `color.fg` | `"#16181d"` |
|
|
64
|
+
| `color.accent` | `"#2f5bea"` |
|
|
65
|
+
| `color.muted` | `"#5d6470"` |
|
|
66
|
+
| `color.surface` | `"#f3f4f6"` |
|
|
67
|
+
| `font.display` | `"\"Inter Variable\", \"Noto Sans SC\", \"Noto Sans CJK SC\", sans-serif"` |
|
|
68
|
+
| `font.body` | `"\"Inter Variable\", \"Noto Sans SC\", \"Noto Sans CJK SC\", sans-serif"` |
|
|
69
|
+
| `font.mono` | `"ui-monospace, \"SF Mono\", Menlo, monospace"` |
|
|
70
|
+
| `font.emoji` | `"\"Noto Color Emoji\""` |
|
|
71
|
+
| `motion.beat` | `0.5` |
|
|
72
|
+
| `sfx` | `{}` |
|
|
73
|
+
|
|
74
|
+
## Parts and transitions
|
|
75
|
+
|
|
76
|
+
### `PART_DEFAULTS`
|
|
77
|
+
|
|
78
|
+
A part's length without speech, and the seconds before its first word and after its last. `part({ dur, lead, tail })`, `video({ defaults: { part } })`, `defineConfig({ defaults: { part } })`.
|
|
79
|
+
|
|
80
|
+
| Key | Value |
|
|
81
|
+
| --- | --- |
|
|
82
|
+
| `dur` | `4` |
|
|
83
|
+
| `lead` | `0.2` |
|
|
84
|
+
| `tail` | `0.3` |
|
|
85
|
+
|
|
86
|
+
### `TRANSITION_DEFAULTS`
|
|
87
|
+
|
|
88
|
+
A transition's window in seconds, the share of it before the join, a slide's, push's or wipe's way, and a zoom's scale. `part({ transition: { dur, split, direction, scale } })`.
|
|
89
|
+
|
|
90
|
+
| Key | Value |
|
|
91
|
+
| --- | --- |
|
|
92
|
+
| `dur` | `0.4` |
|
|
93
|
+
| `split` | `0.5` |
|
|
94
|
+
| `direction` | `"left"` |
|
|
95
|
+
| `scale` | `1.2` |
|
|
96
|
+
|
|
97
|
+
## Speech and captions
|
|
98
|
+
|
|
99
|
+
### `ROOM_MATCH`
|
|
100
|
+
|
|
101
|
+
How a room tone fill meets the take: the seconds measured each side of a join, the least of the take's own room measured, the cross-fade, the most gain in dB. `take(…).roomTone({ match, gainDb, limitDb, fade })`.
|
|
102
|
+
|
|
103
|
+
| Key | Value |
|
|
104
|
+
| --- | --- |
|
|
105
|
+
| `near` | `0.3` |
|
|
106
|
+
| `least` | `0.1` |
|
|
107
|
+
| `fade` | `0.04` |
|
|
108
|
+
| `limitDb` | `6` |
|
|
109
|
+
|
|
110
|
+
### `SPEECH_RATE_DEFAULTS`
|
|
111
|
+
|
|
112
|
+
Seconds a word, and a Chinese, Japanese or Korean character, take to say: how long a line is estimated to last before it has sound.
|
|
113
|
+
|
|
114
|
+
| Key | Value |
|
|
115
|
+
| --- | --- |
|
|
116
|
+
| `word` | `0.38` |
|
|
117
|
+
| `cjk` | `0.22` |
|
|
118
|
+
|
|
119
|
+
### `CAPTION_CUE_DEFAULTS`
|
|
120
|
+
|
|
121
|
+
How the subtitles `allyhub render` writes are cut when no layer asked `ctx.captions()` for other cues.
|
|
122
|
+
|
|
123
|
+
| Key | Value |
|
|
124
|
+
| --- | --- |
|
|
125
|
+
| `maxChars` | `42` |
|
|
126
|
+
| `maxCharsCjk` | `16` |
|
|
127
|
+
| `minSeconds` | `0.8` |
|
|
128
|
+
| `maxSeconds` | `6` |
|
|
129
|
+
| `gapFrames` | `2` |
|
|
130
|
+
|
|
131
|
+
## Sound
|
|
132
|
+
|
|
133
|
+
### `MIX_DEFAULTS`
|
|
134
|
+
|
|
135
|
+
Each stem's loudness target in LUFS, the music's dip under words and its fades in seconds. `video({ mix })`.
|
|
136
|
+
|
|
137
|
+
| Key | Value |
|
|
138
|
+
| --- | --- |
|
|
139
|
+
| `speech` | `-16` |
|
|
140
|
+
| `music` | `-20` |
|
|
141
|
+
| `musicAlone` | `-16` |
|
|
142
|
+
| `sfx` | `-22` |
|
|
143
|
+
| `footage` | `-16` |
|
|
144
|
+
| `footageUnderSpeech` | `-22` |
|
|
145
|
+
| `duck.db` | `-8` |
|
|
146
|
+
| `duck.attack` | `0.3` |
|
|
147
|
+
| `duck.release` | `1` |
|
|
148
|
+
| `duck.hold` | `2` |
|
|
149
|
+
| `musicFade.in` | `0.3` |
|
|
150
|
+
| `musicFade.out` | `1.5` |
|
|
151
|
+
|
|
152
|
+
### `MASTER_DEFAULTS`
|
|
153
|
+
|
|
154
|
+
The master's loudness in LUFS (a platform profile's loudness comes first) and its true-peak ceiling in dBTP. `video({ master })`.
|
|
155
|
+
|
|
156
|
+
| Key | Value |
|
|
157
|
+
| --- | --- |
|
|
158
|
+
| `lufs` | `-14` |
|
|
159
|
+
| `truePeak` | `-3` |
|
|
160
|
+
|
|
161
|
+
### `MASTER_MECHANICS`
|
|
162
|
+
|
|
163
|
+
How the master reaches its targets: the limiter's attack and release, its oversampling, the gain's corrections and their tolerance. Mechanics, not options.
|
|
164
|
+
|
|
165
|
+
| Key | Value |
|
|
166
|
+
| --- | --- |
|
|
167
|
+
| `attack` | `0.002` |
|
|
168
|
+
| `release` | `0.04` |
|
|
169
|
+
| `oversample` | `4` |
|
|
170
|
+
| `rounds` | `4` |
|
|
171
|
+
| `tolerance` | `0.1` |
|
|
172
|
+
|
|
173
|
+
### `MUSIC_DEFAULTS`
|
|
174
|
+
|
|
175
|
+
A seam's cross-fade between stretches, beats a bar, and the seam of the whole file looped. `music: { seam, meter }`.
|
|
176
|
+
|
|
177
|
+
| Key | Value |
|
|
178
|
+
| --- | --- |
|
|
179
|
+
| `seam` | `0.03` |
|
|
180
|
+
| `meter` | `4` |
|
|
181
|
+
| `loopSeam` | `0.25` |
|
|
182
|
+
|
|
183
|
+
### `COMPRESS_DEFAULTS`
|
|
184
|
+
|
|
185
|
+
A compressor's settings, its threshold in dB over the sound's loudness. `music: { compress }`, a sound effect's `shape: { compress }`.
|
|
186
|
+
|
|
187
|
+
| Key | Value |
|
|
188
|
+
| --- | --- |
|
|
189
|
+
| `ratio` | `2` |
|
|
190
|
+
| `knee` | `6` |
|
|
191
|
+
| `attack` | `0.01` |
|
|
192
|
+
| `release` | `0.15` |
|
|
193
|
+
| `window` | `0.01` |
|
|
194
|
+
|
|
195
|
+
## How the voice was recorded
|
|
196
|
+
|
|
197
|
+
The presets `mic` names: `video({ mic })`, `part({ mic })`, a setup's name or `{ setup, …changes }`. A response is `[Hz, dB]` points, a band `[low, high]` in Hz.
|
|
198
|
+
|
|
199
|
+
### `SETUP_PRESETS`
|
|
200
|
+
|
|
201
|
+
Each setup: its microphone, room, room tone, automatic gain and finishing.
|
|
202
|
+
|
|
203
|
+
| Key | Value |
|
|
204
|
+
| --- | --- |
|
|
205
|
+
| `studio.pattern` | `"cardioid"` |
|
|
206
|
+
| `studio.distance` | `0.2` |
|
|
207
|
+
| `studio.angle` | `0` |
|
|
208
|
+
| `studio.below` | `0` |
|
|
209
|
+
| `studio.response` | `[[125,-3.5],[250,-3],[500,-0.5],[1000,0],[2000,-2],[4000,-1.5],[8000,-4],[12500,-4]]` |
|
|
210
|
+
| `studio.band` | `[20,20000]` |
|
|
211
|
+
| `studio.stereo` | `false` |
|
|
212
|
+
| `studio.room` | `false` |
|
|
213
|
+
| `studio.noise` | `false` |
|
|
214
|
+
| `studio.agc` | `false` |
|
|
215
|
+
| `studio.post` | `"finish"` |
|
|
216
|
+
| `phone.pattern` | `"omni"` |
|
|
217
|
+
| `phone.distance` | `0.35` |
|
|
218
|
+
| `phone.angle` | `0` |
|
|
219
|
+
| `phone.below` | `25` |
|
|
220
|
+
| `phone.response` | `[[125,-8.5],[250,-3.5],[500,-0.5],[1000,0],[2000,0],[4000,0],[8000,-3.5],[12500,-2.5]]` |
|
|
221
|
+
| `phone.band` | `[100,16000]` |
|
|
222
|
+
| `phone.stereo` | `0.1` |
|
|
223
|
+
| `phone.room.preset` | `"bedroom"` |
|
|
224
|
+
| `phone.room.rt60` | `0.2` |
|
|
225
|
+
| `phone.noise.tilt` | `-4` |
|
|
226
|
+
| `phone.noise.rumble` | `8` |
|
|
227
|
+
| `phone.noise.top` | `16000` |
|
|
228
|
+
| `phone.noise.below` | `42` |
|
|
229
|
+
| `phone.agc.target` | `0` |
|
|
230
|
+
| `phone.agc.most` | `10` |
|
|
231
|
+
| `phone.agc.attack` | `0.3` |
|
|
232
|
+
| `phone.agc.release` | `1.5` |
|
|
233
|
+
| `phone.agc.window` | `2` |
|
|
234
|
+
| `phone.agc.gate` | `-25` |
|
|
235
|
+
| `phone.post` | `false` |
|
|
236
|
+
| `lav.pattern` | `"omni"` |
|
|
237
|
+
| `lav.distance` | `0.22` |
|
|
238
|
+
| `lav.angle` | `0` |
|
|
239
|
+
| `lav.below` | `70` |
|
|
240
|
+
| `lav.response` | `[[125,-2],[250,-3],[500,0.5],[1000,0],[2000,-1],[4000,-1],[8000,-3.5],[12500,-4]]` |
|
|
241
|
+
| `lav.band` | `[70,18000]` |
|
|
242
|
+
| `lav.stereo` | `false` |
|
|
243
|
+
| `lav.room.preset` | `"bedroom"` |
|
|
244
|
+
| `lav.room.rt60` | `0.13` |
|
|
245
|
+
| `lav.noise.tilt` | `-4` |
|
|
246
|
+
| `lav.noise.rumble` | `4` |
|
|
247
|
+
| `lav.noise.top` | `18000` |
|
|
248
|
+
| `lav.noise.below` | `50` |
|
|
249
|
+
| `lav.agc` | `false` |
|
|
250
|
+
| `lav.post` | `"finish"` |
|
|
251
|
+
|
|
252
|
+
### `ROOM_PRESETS`
|
|
253
|
+
|
|
254
|
+
Each room a setup or `mic: { room }` names.
|
|
255
|
+
|
|
256
|
+
| Key | Value |
|
|
257
|
+
| --- | --- |
|
|
258
|
+
| `bedroom.size` | `[3.4,2.6,4]` |
|
|
259
|
+
| `bedroom.walls` | `"plasterboard"` |
|
|
260
|
+
| `bedroom.floor` | `"carpet"` |
|
|
261
|
+
| `bedroom.ceiling` | `"plasterboard-ceiling"` |
|
|
262
|
+
| `bedroom.rt60` | `0.4` |
|
|
263
|
+
| `bedroom.talker` | `[1.5,1.2,1.5]` |
|
|
264
|
+
| `bedroom.order` | `3` |
|
|
265
|
+
| `living-room.size` | `[5,2.7,6]` |
|
|
266
|
+
| `living-room.walls` | `"plasterboard"` |
|
|
267
|
+
| `living-room.floor` | `"wood"` |
|
|
268
|
+
| `living-room.ceiling` | `"plasterboard-ceiling"` |
|
|
269
|
+
| `living-room.rt60` | `0.55` |
|
|
270
|
+
| `living-room.talker` | `[2.2,1.2,2.5]` |
|
|
271
|
+
| `living-room.order` | `3` |
|
|
272
|
+
| `office.size` | `[4,2.8,5]` |
|
|
273
|
+
| `office.walls` | `"plasterboard"` |
|
|
274
|
+
| `office.floor` | `"carpet-thin"` |
|
|
275
|
+
| `office.ceiling` | `"ceiling-tiles"` |
|
|
276
|
+
| `office.rt60` | `0.45` |
|
|
277
|
+
| `office.talker` | `[1.8,1.2,2]` |
|
|
278
|
+
| `office.order` | `3` |
|
|
279
|
+
| `kitchen.size` | `[3,2.6,4]` |
|
|
280
|
+
| `kitchen.walls` | `"tiles"` |
|
|
281
|
+
| `kitchen.floor` | `"tiles"` |
|
|
282
|
+
| `kitchen.ceiling` | `"plasterboard-ceiling"` |
|
|
283
|
+
| `kitchen.rt60` | `0.75` |
|
|
284
|
+
| `kitchen.talker` | `[1.4,1.6,1.6]` |
|
|
285
|
+
| `kitchen.order` | `3` |
|
|
286
|
+
| `treated.size` | `[3,2.6,3.5]` |
|
|
287
|
+
| `treated.walls` | `"foam"` |
|
|
288
|
+
| `treated.floor` | `"carpet"` |
|
|
289
|
+
| `treated.ceiling` | `"foam"` |
|
|
290
|
+
| `treated.rt60` | `0.2` |
|
|
291
|
+
| `treated.talker` | `[1.4,1.2,1.4]` |
|
|
292
|
+
| `treated.order` | `3` |
|
|
293
|
+
| `car.size` | `[1.4,1.15,1.9]` |
|
|
294
|
+
| `car.walls` | `"glass"` |
|
|
295
|
+
| `car.floor` | `"upholstery"` |
|
|
296
|
+
| `car.ceiling` | `"upholstery"` |
|
|
297
|
+
| `car.rt60` | `0.08` |
|
|
298
|
+
| `car.talker` | `[0.45,0.85,0.9]` |
|
|
299
|
+
| `car.order` | `6` |
|
|
300
|
+
| `outdoor.size` | `[60,30,60]` |
|
|
301
|
+
| `outdoor.walls` | `"hard"` |
|
|
302
|
+
| `outdoor.floor` | `"hard"` |
|
|
303
|
+
| `outdoor.ceiling` | `"hard"` |
|
|
304
|
+
| `outdoor.rt60` | `0.4` |
|
|
305
|
+
| `outdoor.talker` | `[30,1.6,30]` |
|
|
306
|
+
| `outdoor.open` | `true` |
|
|
307
|
+
| `outdoor.order` | `1` |
|
|
308
|
+
|
|
309
|
+
### `POST_PRESETS`
|
|
310
|
+
|
|
311
|
+
Each finishing chain a setup or `mic: { post }` names.
|
|
312
|
+
|
|
313
|
+
| Key | Value |
|
|
314
|
+
| --- | --- |
|
|
315
|
+
| `finish.highpass` | `70` |
|
|
316
|
+
| `finish.eq` | `[]` |
|
|
317
|
+
| `finish.deess.hz` | `5500` |
|
|
318
|
+
| `finish.deess.threshold` | `-12` |
|
|
319
|
+
| `finish.deess.ratio` | `3` |
|
|
320
|
+
| `finish.deess.attack` | `0.002` |
|
|
321
|
+
| `finish.deess.release` | `0.06` |
|
|
322
|
+
| `finish.compress.threshold` | `-3` |
|
|
323
|
+
| `finish.compress.ratio` | `4` |
|
|
324
|
+
| `finish.compress.knee` | `6` |
|
|
325
|
+
| `finish.compress.attack` | `0.005` |
|
|
326
|
+
| `finish.compress.release` | `0.3` |
|
|
327
|
+
| `finish.compress.window` | `0.01` |
|
|
328
|
+
| `phone-app.highpass` | `90` |
|
|
329
|
+
| `phone-app.eq` | `[{"type":"peak","hz":300,"db":-2,"q":1},{"type":"peak","hz":4000,"db":3,"q":0.8},{"type":"highshelf","hz":10000,"db":1}]` |
|
|
330
|
+
| `phone-app.deess.hz` | `5500` |
|
|
331
|
+
| `phone-app.deess.threshold` | `-12` |
|
|
332
|
+
| `phone-app.deess.ratio` | `3` |
|
|
333
|
+
| `phone-app.deess.attack` | `0.002` |
|
|
334
|
+
| `phone-app.deess.release` | `0.06` |
|
|
335
|
+
| `phone-app.compress.threshold` | `0` |
|
|
336
|
+
| `phone-app.compress.ratio` | `3` |
|
|
337
|
+
| `phone-app.compress.knee` | `6` |
|
|
338
|
+
| `phone-app.compress.attack` | `0.005` |
|
|
339
|
+
| `phone-app.compress.release` | `0.12` |
|
|
340
|
+
| `phone-app.compress.window` | `0.01` |
|
|
341
|
+
|
|
342
|
+
## The picture
|
|
343
|
+
|
|
344
|
+
### `CAPTURE_DEFAULTS`
|
|
345
|
+
|
|
346
|
+
A camera filming the picture: a mark's values when it is asked for without them. `video({ capture })`.
|
|
347
|
+
|
|
348
|
+
| Key | Value |
|
|
349
|
+
| --- | --- |
|
|
350
|
+
| `bloom.threshold` | `0.8` |
|
|
351
|
+
| `bloom.radius` | `24` |
|
|
352
|
+
| `bloom.strength` | `0.35` |
|
|
353
|
+
| `exposure.drift` | `0.12` |
|
|
354
|
+
| `exposure.period` | `6` |
|
|
355
|
+
| `grain.amount` | `0.02` |
|
|
356
|
+
| `grain.size` | `1.2` |
|
|
357
|
+
| `grain.shadows` | `1.8` |
|
|
358
|
+
| `grain.highlights` | `0.6` |
|
|
359
|
+
| `grain.chroma` | `0.35` |
|
|
360
|
+
| `grain.chromaSize` | `3` |
|
|
361
|
+
| `grain.static` | `false` |
|
|
362
|
+
|
|
363
|
+
### `SHARE_ENCODE`
|
|
364
|
+
|
|
365
|
+
How `allyhub render` and an editor's Export encode an mp4 whose format is no platform profile, ready to share on social media: H.264's crf, and the most video bitrate in kbit/s for a frame of `width` × `height` at `fps`, scaled by the pixels a second of the video's own (16000 at 1080p 60, 32000 at 4K 30). `--param crf`, `--param max-bitrate` (0 for none).
|
|
366
|
+
|
|
367
|
+
| Key | Value |
|
|
368
|
+
| --- | --- |
|
|
369
|
+
| `crf` | `20` |
|
|
370
|
+
| `maxKbps` | `8000` |
|
|
371
|
+
| `width` | `1920` |
|
|
372
|
+
| `height` | `1080` |
|
|
373
|
+
| `fps` | `30` |
|
|
374
|
+
|
|
375
|
+
### `MATTE_FEATHER`
|
|
376
|
+
|
|
377
|
+
The softness of the person's edge, px at 1080p. `footage({ background: { feather } })`.
|
|
378
|
+
|
|
379
|
+
Value: `2`
|
|
380
|
+
|
|
381
|
+
### `MATTE_SHRINK`
|
|
382
|
+
|
|
383
|
+
How far the person's edge is pulled in, px at 1080p. `footage({ background: { shrink } })`.
|
|
384
|
+
|
|
385
|
+
Value: `4`
|
|
386
|
+
|
|
387
|
+
## Layout, text and input
|
|
388
|
+
|
|
389
|
+
### `MARK_STYLES`
|
|
390
|
+
|
|
391
|
+
How `marked()` draws each inline mark. `marked(line, styles)`.
|
|
392
|
+
|
|
393
|
+
| Key | Value |
|
|
394
|
+
| --- | --- |
|
|
395
|
+
| `strong.fontWeight` | `700` |
|
|
396
|
+
| `em.color` | `"var(--ak-color-accent)"` |
|
|
397
|
+
| `strike.textDecoration` | `"line-through"` |
|
|
398
|
+
| `code.fontFamily` | `"var(--ak-font-mono)"` |
|
|
399
|
+
| `code.fontSize` | `"0.9em"` |
|
|
400
|
+
|
|
401
|
+
### `FIT_LINES_PRECISION`
|
|
402
|
+
|
|
403
|
+
The font size step, in px, `fitLines()` stops at. `fitLines(el, { precision })`.
|
|
404
|
+
|
|
405
|
+
Value: `0.5`
|
|
406
|
+
|
|
407
|
+
### `INPUT_DEFAULTS`
|
|
408
|
+
|
|
409
|
+
A person's input: an aimed movement's shape and time (`reach`), a press, a drag, a scroll, typing. Each input function's options.
|
|
410
|
+
|
|
411
|
+
| Key | Value |
|
|
412
|
+
| --- | --- |
|
|
413
|
+
| `reach.overshoot` | `0.06` |
|
|
414
|
+
| `reach.peak` | `0.38` |
|
|
415
|
+
| `reach.vary` | `0.5` |
|
|
416
|
+
| `reach.fitts.a` | `0.2` |
|
|
417
|
+
| `reach.fitts.b` | `0.15` |
|
|
418
|
+
| `reach.scatter` | `0.1` |
|
|
419
|
+
| `reach.jitter` | `0.02` |
|
|
420
|
+
| `reach.bow` | `0.06` |
|
|
421
|
+
| `reach.tremor.px` | `0.3` |
|
|
422
|
+
| `reach.tremor.frequency` | `9` |
|
|
423
|
+
| `reach.seed` | `1` |
|
|
424
|
+
| `size` | `40` |
|
|
425
|
+
| `dwell` | `0.12` |
|
|
426
|
+
| `hold` | `0.1` |
|
|
427
|
+
| `drag.settle` | `0.08` |
|
|
428
|
+
| `drag.release` | `0.06` |
|
|
429
|
+
| `drag.fitts.a` | `0.25` |
|
|
430
|
+
| `drag.fitts.b` | `0.2` |
|
|
431
|
+
| `drag.tremor.px` | `0.8` |
|
|
432
|
+
| `drag.tremor.frequency` | `8` |
|
|
433
|
+
| `tap.slide` | `1.2` |
|
|
434
|
+
| `tap.grow` | `0.03` |
|
|
435
|
+
| `wheel.notch` | `100` |
|
|
436
|
+
| `wheel.animate` | `0.15` |
|
|
437
|
+
| `wheel.interval` | `0.05` |
|
|
438
|
+
| `wheel.pause` | `0.25` |
|
|
439
|
+
| `wheel.burst` | `4` |
|
|
440
|
+
| `flick.contact` | `0.12` |
|
|
441
|
+
| `flick.decay` | `0.4995` |
|
|
442
|
+
| `flick.band` | `800` |
|
|
443
|
+
| `flick.spring` | `0.12` |
|
|
444
|
+
| `typing.cps` | `9` |
|
|
445
|
+
| `typing.spread` | `0.35` |
|
|
446
|
+
| `typing.word` | `1.5` |
|
|
447
|
+
| `typing.mark` | `2` |
|
|
448
|
+
| `typing.think.chance` | `0.08` |
|
|
449
|
+
| `typing.think.seconds` | `0.35` |
|
|
450
|
+
| `typing.notice` | `0.3` |
|
|
451
|
+
| `typing.backspace` | `0.07` |
|
|
452
|
+
| `typing.seed` | `1` |
|
|
453
|
+
|
|
454
|
+
## 3D sceneries
|
|
455
|
+
|
|
456
|
+
### `SCENERY_LAYER_DEFAULTS`
|
|
457
|
+
|
|
458
|
+
A `scenery()` layer's drawing scale, its name and its depth of field's levels. `scenery(s, { quality: { scale }, name })`.
|
|
459
|
+
|
|
460
|
+
| Key | Value |
|
|
461
|
+
| --- | --- |
|
|
462
|
+
| `scale` | `0.5` |
|
|
463
|
+
| `name` | `"scenery"` |
|
|
464
|
+
| `focusLevels` | `8` |
|
|
465
|
+
|
|
466
|
+
### `SCREEN_DEFAULTS`
|
|
467
|
+
|
|
468
|
+
A screen of graphic layers: its picture's size in px and its background. `screen(layers, { size, background })`.
|
|
469
|
+
|
|
470
|
+
| Key | Value |
|
|
471
|
+
| --- | --- |
|
|
472
|
+
| `size` | `[1920,1080]` |
|
|
473
|
+
| `background` | `"#000000"` |
|
|
474
|
+
|
|
475
|
+
### `SCENERY_RENDERER_DEFAULTS`
|
|
476
|
+
|
|
477
|
+
How the renderer is made, and a camera's depth of field. `defineScenery({ renderer })`.
|
|
478
|
+
|
|
479
|
+
| Key | Value |
|
|
480
|
+
| --- | --- |
|
|
481
|
+
| `antialias` | `false` |
|
|
482
|
+
| `transmissionScale` | `0.25` |
|
|
483
|
+
| `focus.samples` | `64` |
|
|
484
|
+
| `focus.maxRadius` | `64` |
|
|
485
|
+
|
|
486
|
+
### `CAMERA_DEFAULTS`
|
|
487
|
+
|
|
488
|
+
A camera's lens (mm, 35 mm equivalent), the frame the lens is measured on, its near and far planes, up and roll. `CameraState`.
|
|
489
|
+
|
|
490
|
+
| Key | Value |
|
|
491
|
+
| --- | --- |
|
|
492
|
+
| `lens` | `26` |
|
|
493
|
+
| `lensFrame` | `"diagonal"` |
|
|
494
|
+
| `near` | `0.05` |
|
|
495
|
+
| `far` | `500` |
|
|
496
|
+
| `up` | `[0,1,0]` |
|
|
497
|
+
| `roll` | `0` |
|
|
498
|
+
|
|
499
|
+
### `PHONE_CAMERA`
|
|
500
|
+
|
|
501
|
+
A phone's main camera held in a hand: its lens, sensor and hand. `phoneCamera(changes)`.
|
|
502
|
+
|
|
503
|
+
| Key | Value |
|
|
504
|
+
| --- | --- |
|
|
505
|
+
| `lens.lens` | `26` |
|
|
506
|
+
| `lens.lensFrame` | `"phone"` |
|
|
507
|
+
| `lens.aperture` | `8` |
|
|
508
|
+
| `sensor.photosites` | `4032` |
|
|
509
|
+
| `sensor.lens` | `0.35` |
|
|
510
|
+
| `sensor.moire` | `1` |
|
|
511
|
+
| `sensor.chroma` | `0.3` |
|
|
512
|
+
| `sensor.distortion` | `-0.03` |
|
|
513
|
+
| `hand.angle` | `0.25` |
|
|
514
|
+
| `hand.roll` | `0.6` |
|
|
515
|
+
| `hand.shift` | `0.001` |
|
|
516
|
+
| `hand.sway` | `0.65` |
|
|
517
|
+
| `hand.tremor.angle` | `0.1` |
|
|
518
|
+
| `hand.tremor.frequency` | `8.5` |
|
|
519
|
+
| `hand.drift.angle` | `0.15` |
|
|
520
|
+
| `hand.drift.shift` | `0.001` |
|
|
521
|
+
| `hand.drift.period` | `8` |
|
|
522
|
+
| `hand.stabilizer.strength` | `0.7` |
|
|
523
|
+
| `hand.stabilizer.cutoff` | `1.5` |
|
|
524
|
+
| `hand.autofocus` | `{}` |
|
|
525
|
+
| `hand.exposure` | `{}` |
|
|
526
|
+
|
|
527
|
+
### `PATH_DEFAULTS`
|
|
528
|
+
|
|
529
|
+
A camera path's options. `path(points, opts)`.
|
|
530
|
+
|
|
531
|
+
| Key | Value |
|
|
532
|
+
| --- | --- |
|
|
533
|
+
| `start` | `0` |
|
|
534
|
+
| `ahead` | `1` |
|
|
535
|
+
| `alpha` | `0.5` |
|
|
536
|
+
|
|
537
|
+
### `FIT_DEFAULTS`
|
|
538
|
+
|
|
539
|
+
How `fitCamera()` frames what it is given. `fitCamera(opts)`.
|
|
540
|
+
|
|
541
|
+
| Key | Value |
|
|
542
|
+
| --- | --- |
|
|
543
|
+
| `fill` | `1` |
|
|
544
|
+
| `axis` | `"both"` |
|
|
545
|
+
| `adjust` | `"distance"` |
|
|
546
|
+
|
|
547
|
+
### `AIM_DEFAULTS`
|
|
548
|
+
|
|
549
|
+
An aimed movement's shape. `aimed(opts)`.
|
|
550
|
+
|
|
551
|
+
| Key | Value |
|
|
552
|
+
| --- | --- |
|
|
553
|
+
| `overshoot` | `0.08` |
|
|
554
|
+
| `peak` | `0.38` |
|
|
555
|
+
| `primary` | `0.72` |
|
|
556
|
+
| `vary` | `0.5` |
|
|
557
|
+
| `seed` | `1` |
|
|
558
|
+
| `index` | `0` |
|
|
559
|
+
|
|
560
|
+
### `HANDHELD_DEFAULTS`
|
|
561
|
+
|
|
562
|
+
A hand holding the camera. `handheld(camera, opts)`.
|
|
563
|
+
|
|
564
|
+
| Key | Value |
|
|
565
|
+
| --- | --- |
|
|
566
|
+
| `angle` | `0.25` |
|
|
567
|
+
| `roll` | `0.5` |
|
|
568
|
+
| `shift` | `0.003` |
|
|
569
|
+
| `sway` | `0.7` |
|
|
570
|
+
| `tremor.angle` | `0.02` |
|
|
571
|
+
| `tremor.frequency` | `9` |
|
|
572
|
+
| `tremor.spread` | `1.5` |
|
|
573
|
+
| `tremor.vary` | `0.12` |
|
|
574
|
+
| `tremor.swell` | `0.3` |
|
|
575
|
+
| `tremor.period` | `3` |
|
|
576
|
+
| `drift.angle` | `0.15` |
|
|
577
|
+
| `drift.shift` | `0.002` |
|
|
578
|
+
| `drift.period` | `8` |
|
|
579
|
+
| `reframe.duration` | `0.5` |
|
|
580
|
+
| `reframe.overshoot` | `0.1` |
|
|
581
|
+
| `reframe.peak` | `0.36` |
|
|
582
|
+
| `reframe.bow` | `0.1` |
|
|
583
|
+
| `reframe.vary` | `0.5` |
|
|
584
|
+
| `jolt.turn` | `[0.15,-0.35,0.1]` |
|
|
585
|
+
| `jolt.ring` | `5` |
|
|
586
|
+
| `jolt.decay` | `0.09` |
|
|
587
|
+
| `jolt.vary` | `0.3` |
|
|
588
|
+
| `seed` | `1` |
|
|
589
|
+
|
|
590
|
+
### `STABILIZER_DEFAULTS`
|
|
591
|
+
|
|
592
|
+
The stabiliser's strength and cut-off. `handheld(camera, { stabilizer })`.
|
|
593
|
+
|
|
594
|
+
| Key | Value |
|
|
595
|
+
| --- | --- |
|
|
596
|
+
| `strength` | `0.8` |
|
|
597
|
+
| `cutoff` | `1.5` |
|
|
598
|
+
|
|
599
|
+
### `AUTOFOCUS_DEFAULTS`
|
|
600
|
+
|
|
601
|
+
Focus hunting after a cut, a reframe or a jolt. `handheld(camera, { autofocus })`.
|
|
602
|
+
|
|
603
|
+
| Key | Value |
|
|
604
|
+
| --- | --- |
|
|
605
|
+
| `miss` | `-0.02` |
|
|
606
|
+
| `hunt` | `0.12` |
|
|
607
|
+
| `rate` | `2.3` |
|
|
608
|
+
| `decay` | `0.3` |
|
|
609
|
+
| `after.cut` | `1` |
|
|
610
|
+
| `after.reframe` | `0.7` |
|
|
611
|
+
| `after.jolt` | `0.3` |
|
|
612
|
+
|
|
613
|
+
### `AUTO_EXPOSURE_DEFAULTS`
|
|
614
|
+
|
|
615
|
+
Exposure following a new framing. `handheld(camera, { exposure })`.
|
|
616
|
+
|
|
617
|
+
| Key | Value |
|
|
618
|
+
| --- | --- |
|
|
619
|
+
| `delay` | `0.15` |
|
|
620
|
+
| `settle` | `0.7` |
|
|
621
|
+
| `cut` | `0.25` |
|
|
622
|
+
| `breathe` | `0.03` |
|
|
623
|
+
| `period` | `3` |
|
|
624
|
+
|
|
625
|
+
### `SENSOR_DEFAULTS`
|
|
626
|
+
|
|
627
|
+
A camera's sensor filming a screen (moiré). `scenery(s, { sensor })`.
|
|
628
|
+
|
|
629
|
+
| Key | Value |
|
|
630
|
+
| --- | --- |
|
|
631
|
+
| `photosites` | `4032` |
|
|
632
|
+
| `lens` | `0.35` |
|
|
633
|
+
| `moire` | `1` |
|
|
634
|
+
| `chroma` | `0.3` |
|
|
635
|
+
| `distortion` | `-0.03` |
|
|
636
|
+
|
|
637
|
+
### `PANEL_DEFAULTS`
|
|
638
|
+
|
|
639
|
+
A screen's physical pixels, which the sensor films. `screen(…, { pixels })`.
|
|
640
|
+
|
|
641
|
+
| Key | Value |
|
|
642
|
+
| --- | --- |
|
|
643
|
+
| `density` | `2` |
|
|
644
|
+
| `rows` | `0.15` |
|
|
645
|
+
|
|
646
|
+
### `SCREEN_LIGHT_DEFAULTS`
|
|
647
|
+
|
|
648
|
+
The light a screen drawn in the scenery casts. `screen(…, { inScenery: { light } })`.
|
|
649
|
+
|
|
650
|
+
| Key | Value |
|
|
651
|
+
| --- | --- |
|
|
652
|
+
| `cells` | `[8,5]` |
|
|
653
|
+
| `specular` | `true` |
|
|
654
|
+
| `base` | `null` |
|
|
655
|
+
|
|
656
|
+
### `SCREEN_FOCUS_DEFAULTS`
|
|
657
|
+
|
|
658
|
+
How a screen's depth of field is drawn.
|
|
659
|
+
|
|
660
|
+
| Key | Value |
|
|
661
|
+
| --- | --- |
|
|
662
|
+
| `levels` | `8` |
|
|
663
|
+
| `samples` | `65` |
|
|
664
|
+
| `sharp` | `0.05` |
|
|
665
|
+
|
|
666
|
+
### `GLASS_DEFAULTS`
|
|
667
|
+
|
|
668
|
+
A screen's glass. `screen(…, { glass })`.
|
|
669
|
+
|
|
670
|
+
| Key | Value |
|
|
671
|
+
| --- | --- |
|
|
672
|
+
| `reflectance` | `0.04` |
|
|
673
|
+
| `roughness` | `0.05` |
|
|
674
|
+
| `scale` | `1` |
|
|
675
|
+
|
|
676
|
+
### `BAKE_DEFAULTS`
|
|
677
|
+
|
|
678
|
+
A scenery's baked light. `defineScenery({ bake })`; `allyhub scenery bake` bakes it.
|
|
679
|
+
|
|
680
|
+
| Key | Value |
|
|
681
|
+
| --- | --- |
|
|
682
|
+
| `density` | `40` |
|
|
683
|
+
| `maxSize` | `2048` |
|
|
684
|
+
| `minTexels` | `128` |
|
|
685
|
+
| `islandTexels` | `16` |
|
|
686
|
+
| `ownUv` | `true` |
|
|
687
|
+
| `samples` | `16` |
|
|
688
|
+
| `bounces` | `4` |
|
|
689
|
+
| `denoise.radius` | `3` |
|
|
690
|
+
| `denoise.distance` | `0.02` |
|
|
691
|
+
| `clamp` | `40` |
|
|
692
|
+
| `tile` | `256` |
|
|
693
|
+
| `posedAt` | `[0.5,1,2,4,8,16,32]` |
|
|
694
|
+
| `probeSize` | `256` |
|
|
695
|
+
|
|
696
|
+
### `FIELD_DEFAULTS`
|
|
697
|
+
|
|
698
|
+
Meshing a distance field: `meshField` of `@allyhub-next/model`.
|
|
699
|
+
|
|
700
|
+
| Key | Value |
|
|
701
|
+
| --- | --- |
|
|
702
|
+
| `project` | `3` |
|
|
703
|
+
| `maxSamples` | `40000000` |
|