Loading...
 
Skip to main content

History: PluginOEmbed

Source of version: 20 (current)

Copy to clipboard
            ! Plugin OEmbed
This ((wiki plugin)) enables embedding of external videos or media into Tiki pages using the oEmbed protocol. It fetches metadata from the provided media URL and generates an embedded media player to display the content on your Tiki page. This is useful for integrating platforms like -+PeerTube+-, -+YouTube+-, -+Vimeo+-, and others that support the oEmbed standard.

!! Parameters
Embed a video or media using oEmbed protocol
''Introduced in Tiki 29.'''' Required parameters are in'' -+__bold__+-.
[https://gitlab.com/tikiwiki/tiki/-/blob/master/lib/wiki-plugins/wikiplugin_oembed.php|Go to the source code]
''Preferences required:'' wikiplugin_oembed
 

||__Parameters__|__Accepted Values__|__Description__|__Default__|__Since__
 -+__url__+-|url|Complete URL to the oEmbed video or media| | 
 -+height+-|digits|Height in pixels. Default: -+315+-|315| 
 -+start+-|digits|Start time offset in seconds|0| 
 -+width+-|digits|Width in pixels. Default: -+560+-|560| 
 -+privacyEnhanced+-|y %%% n|Enable privacy-enhanced mode (if applicable)| | 
 -+allowFullScreen+-|y %%% n|Enlarge video to full screen size|y| 
 -+background+-| |Object background color. Use an HTML color code. Example: -+ffffff+-| | 
 -+border+-| |Object border color. Use an HTML color code. Example: -+ffffff+-| | ||

Note : You can use the provided parameters like width, height, allowFullScreen, etc. to customize the oEmbed output. Refer to the [https://oembed.com/|oEmbed documentation] for additional details.

!! Show a video
''Here is an example of how to use the oEmbed plugin:''
{CODE(colors="tiki")}
{oembed url="https://videos.evoludata.com/w/2aGghaFr12Cg1Nj1ckqznH" background="000000" border="ff0000" allowFullScreen="y"}
{CODE}

''Important Notes'': 
* This plugin is only available starting from -+Tiki 29+-.  
* It is not possible to display the video here because doc.tiki.org is currently running Tiki 28.
* This integration works with -+PeerTube+- instances that follow the oEmbed specification and provide the -+/services/oembed+- endpoint.
* No automatic discovery protocol is currently implemented. Only services using the -+/services/oembed+- URL are supported in this version.
* Example videos can be found on public PeerTube instances like [https://videos.evoludata.com|Evoludata's PeerTube].

!! Known Limitations:
* The current implementation only supports PeerTube instances with oEmbed endpoints (e.g., `/services/oembed`).
* No automatic URL discovery is available for PeerTube. Users must provide the exact URL for oEmbed integration.
* Only services that provide an iframe in the HTML attribute are supported for embedding.


!! To Do:
* Consider adding a more complex URL discovery mechanism in future versions.
* Test the implementation with multiple PeerTube instances to ensure compatibility.