Embed URL parameters
Base URL Structure
All Vuframe embed URLs start with:
https://embed.vuframe.com/<embed-code>
where <embed-code> is the code of your embed (Embed Page link).
URL Patterns
The following URL patterns are all valid and will work with your embed:
Basic Usage
https://embed.vuframe.com/<embed-code>
https://embed.vuframe.com/<embed-code>/
https://embed.vuframe.com/<embed-code>/something
Embed Path (deprecated)
https://embed.vuframe.com/<embed-code>/embed
Tip
adding /embed is not required anymore as of January 1st, 2024
Custom Slug
You can add any custom slug after the <embed-code> part of the URL:
https://embed.vuframe.com/<embed-code>/something
The custom slug always will be ignored
Query Parameters
You can customize the embed behavior using various query parameters. Parameters can be added to any of the URL patterns above:
https://embed.vuframe.com/<embed-code>?hide_sidebar=0
https://embed.vuframe.com/<embed-code>/embed?hide_sidebar=0
Available Query Parameters
The following query parameters can be used to customize your embed.
For all available parameters see Embed API
| Parameter | Values | Description |
|---|---|---|
| hide_sidebar | 0, 1 | Controls the visibility of the sidebar |
| enable_shadows | 0, 1 | Toggles shadow effects |
| hide_applink | 0, 1 | Controls the visibility of app links |
| autoplay | 0, 1 | Enables/disables autoplay |
| format | aura | Specifies the visualization format |
| resolution | 2048, etc. | Sets the display resolution |
Example with Multiple Parameters
https://embed.vuframe.com/<embed-code>/embed?hide_sidebar=0&enable_shadows=0&hide_applink=1&autoplay=1&format=aura&resolution=2048
Best Practices
- Query Parameters : Parameters can be used with or without the
/embedpath segment. - Trailing Slashes : URLs work with or without trailing slashes.
- Parameter Order : The order of query parameters doesn't matter.
Examples
Here are some common use cases with example URLs:
Basic Embed
https://embed.vuframe.com/<embed-code>
Hidden Sidebar
https://embed.vuframe.com/<embed-code>?hide_sidebar=1
Autoplay with Custom Resolution
https://embed.vuframe.com/<embed-code>?autoplay=1&resolution=2048
Full Configuration
https://embed.vuframe.com/<embed-code>/embed?hide_sidebar=0&enable_shadows=0&hide_applink=1&autoplay=1&format=aura&resolution=2048
Technical Notes
- All query parameters are optional
- Parameters use values 0 and 1 for boolean options (0 = off, 1 = on)
- Multiple parameters should be separated with the & symbol
- The first parameter after the embed code should be preceded by a ? symbol