summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/media4svg/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/media4svg/README.md')
-rw-r--r--macros/latex/contrib/media4svg/README.md33
1 files changed, 22 insertions, 11 deletions
diff --git a/macros/latex/contrib/media4svg/README.md b/macros/latex/contrib/media4svg/README.md
index 7612ec0ddf..ffd660a6b1 100644
--- a/macros/latex/contrib/media4svg/README.md
+++ b/macros/latex/contrib/media4svg/README.md
@@ -1,6 +1,6 @@
# The `media4svg` LaTeX Package
-Version 0.9, 2022/08/12
+Version 0.10, 2022/09/12
© 2020--today, Alexander Grahn
@@ -8,10 +8,12 @@ https://gitlab.com/agrahn/media4svg
## Introduction
-This package implements an interface for embedding video and audio files in SVG
-(Scalable Vector Graphics) output. SVG with embedded media is very portable,
-as it is supported by all modern Web browsers across a variety of operating
-systems and platforms, including portable devices.
+This package implements an interface for embedding video and audio files and
+the YouTube player in SVG (Scalable Vector Graphics) output.
+
+SVG with embedded media is very portable, as it is supported by all modern
+Web browsers across a variety of operating systems and platforms, including
+portable devices.
The most portable media formats are as follows:
@@ -68,8 +70,8 @@ information.
Here is an
[example presentation](http://mirrors.ctan.org/macros/latex/contrib/media4svg/example/beamer-example-1.svg)
([source code](http://mirrors.ctan.org/macros/latex/contrib/media4svg/example/beamer-example.tex))
-with an embedded video file and a streamed video. It also explains how to use
-the mouse and the keyboard for playback control.
+with an embedded local video file as well as with video streamed from a URL and a YouTube player. It also
+explains how to use the mouse and the keyboard for playback control.
----
@@ -92,7 +94,11 @@ Note that `media4svg` is incompatible with package `media9`.
The command for media inclusion is
````latex
-\includemedia[<options>]{<poster text>}{<media file or URL>}
+\includemedia[<options>[, url]]{<poster text>}{<media file or URL>}
+````
+or
+````latex
+\includemedia[<options>, youtube]{<poster text>}{<YT video ID>[,<YT video ID 2>[, ...]]}
````
Command options:
````latex
@@ -110,9 +116,9 @@ document instead of the media display.
autoplay
````
Media playback is started after the page has been loaded in the web browser.
-Depending on their settings, browsers may refuse to autoplay audio and
-video with unmuted audio. Option `muted` may need to be set as well to allow
-automatically start of video playback.
+Depending on their settings, browsers may refuse to autoplay multimedia with
+unmuted audio. Option `muted` may need to be set as well to allow playback to
+be started automatically.
````latex
loop
````
@@ -140,6 +146,11 @@ url
The last argument of `\includemedia` is taken as a URL and media data will not
be embedded in the SVG file.
````latex
+youtube
+````
+This embeds a YouTube player. The last argument of `\includemedia` is a single
+or a comma-separated list of YouTube video IDs.
+````latex
embed=false
````
By default, a local media file, given as the last argument of `\includemedia`, is