Embed URL Guide

Base URL Structure

All Vuframe embed URLs start with:

https://embed.vuframe.com/[embedCode]

where [embedCode] is your unique embed identifier.

URL Patterns

The following URL patterns are all valid and will work with your embed:

Basic Usage

https://embed.vuframe.com/12345678
https://embed.vuframe.com/12345678/
https://embed.vuframe.com/12345678/something

Embed Path (deprecated)

https://embed.vuframe.com/12345678/embed

Custom Slug

You can add any custom slag after the [embedCode] portion of the url:

https://embed.vuframe.com/12345678/something

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/12345678?hide_sidebar=0
https://embed.vuframe.com/12345678/embed?hide_sidebar=0

Available Query Parameters

The following query parameters can be used to customize your embed.

Example with Multiple Parameters

https://embed.vuframe.com/12345678/embed?hide_sidebar=0&enable_shadows=0&hide_applink=1&autoplay=1&format=aura&resolution=2048

Best Practices

1. Query Parameters: Parameters can be used with or without the /embed path segment.
2. Trailing Slashes: URLs work with or without trailing slashes.
3. 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/12345678

Hidden Sidebar

https://embed.vuframe.com/12345678?hide_sidebar=1

Autoplay with Custom Resolution

https://embed.vuframe.com/12345678?autoplay=1&resolution=2048

Full Configuration

https://embed.vuframe.com/12345678/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