mirror of
https://github.com/heygen-com/hyperframes.git
synced 2026-09-12 15:20:13 +00:00
docs: make Catalog visual and reproducible
This commit is contained in:
@@ -3,23 +3,24 @@ title: "On-Screen Display Effect"
|
||||
description: "Grid, scanline, vignette, and sheen overlay plus a 3D-warp wrapper class that makes footage read as if playing on a physical display"
|
||||
---
|
||||
|
||||
# On-Screen Display Effect
|
||||
|
||||
Grid, scanline, vignette, and sheen overlay plus a 3D-warp wrapper class that makes footage read as if playing on a physical display
|
||||
|
||||
`effect` `overlay` `texture`
|
||||
|
||||
<video className="w-full aspect-video rounded-xl object-cover bg-zinc-100 dark:bg-zinc-800" src="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/components/yt-screen-warp.mp4" poster="https://static.heygen.ai/hyperframes-oss/docs/images/catalog/components/yt-screen-warp.png" autoPlay muted loop playsInline />
|
||||
|
||||
## Install
|
||||
## Add it to a project
|
||||
|
||||
<CodeGroup>
|
||||
### Ask your agent
|
||||
|
||||
```bash Terminal
|
||||
npx hyperframes add yt-screen-warp
|
||||
```text
|
||||
Add the On-Screen Display Effect component from the HyperFrames Catalog to this project.
|
||||
Replace the demo content with mine and match the existing design and timing.
|
||||
```
|
||||
|
||||
</CodeGroup>
|
||||
### Install from the terminal
|
||||
|
||||
```bash
|
||||
npx hyperframes add yt-screen-warp
|
||||
```
|
||||
|
||||
## Details
|
||||
|
||||
@@ -27,12 +28,20 @@ npx hyperframes add yt-screen-warp
|
||||
| --- | --- |
|
||||
| Type | Component |
|
||||
|
||||
## Files
|
||||
**Installed files**
|
||||
|
||||
| File | Target | Type |
|
||||
| --- | --- | --- |
|
||||
| `yt-screen-warp.html` | `compositions/components/yt-screen-warp.html` | hyperframes:snippet |
|
||||
|
||||
## Usage
|
||||
## Use it
|
||||
|
||||
Open `compositions/components/yt-screen-warp.html` and paste its contents into your composition. See the comment header in the file for detailed instructions.
|
||||
Ask your agent to apply the component to the intended element and preserve the project’s existing timing.
|
||||
|
||||
**Wiring it by hand.** Open `compositions/components/yt-screen-warp.html` and paste its contents into your composition. The comment header in that file contains any item-specific instructions.
|
||||
|
||||
## Related topics
|
||||
|
||||
- [Browse the complete Catalog](/catalog)
|
||||
- [Add assets and Catalog items in Studio](/studio/assets-and-blocks)
|
||||
- [Build a richer composition](/go-further)
|
||||
|
||||
Reference in New Issue
Block a user