summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/media9/media9.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2012-12-21 23:31:52 +0000
committerKarl Berry <karl@freefriends.org>2012-12-21 23:31:52 +0000
commit0dbb0a9f652efcecaf1d844cf8177d3b7a29fd03 (patch)
tree1cd05d55c941dc679049a1d5e0ff84df3980e74a /Master/texmf-dist/doc/latex/media9/media9.tex
parent8bcf0c7ef3cd19666c206271cea9280846b5c7e6 (diff)
media9 (21dec12)
git-svn-id: svn://tug.org/texlive/trunk@28609 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/media9/media9.tex')
-rw-r--r--Master/texmf-dist/doc/latex/media9/media9.tex32
1 files changed, 15 insertions, 17 deletions
diff --git a/Master/texmf-dist/doc/latex/media9/media9.tex b/Master/texmf-dist/doc/latex/media9/media9.tex
index 2c6971a7118..a1d796a8726 100644
--- a/Master/texmf-dist/doc/latex/media9/media9.tex
+++ b/Master/texmf-dist/doc/latex/media9/media9.tex
@@ -149,6 +149,7 @@ draft
final
activate=...
deactivate=...
+windowed=...
transparent
passcontext
3Dplaytype=...
@@ -250,6 +251,10 @@ final
\end{verbatim}
With `\verb+draft+' the media is not embedded. Instead, a box is inserted that has the dimensions of \verb+<poster text>+, subject to the resizing options `\verb+width+', `\verb+height+', `\verb+depth+' and `\verb+scale+'. Option `\verb+final+' does the opposite as it forces the media to be embedded. Both options can be used to reduce compilation time during authoring of a document. To get the most out of them it is recommended to set `\verb+draft+' globally as a package or class option and to set `\verb+final+' locally as a command option of the media annotation that is currently worked on. After the document has been finished, the global `\verb+draft+' option can be removed.
\begin{verbatim}
+windowed[=false | <width>x<height>]
+\end{verbatim}
+The media is played in a floating window, instead of being played in an embedded fashion. The floating window size is specified via the optional argument \verb+<width>x<height>+, where the \verb+<width>+ and \verb+<height>+ values are given in pixels (numbers without unit). If the size is not given, a default size is guessed from the annotation size. `\verb+false+' can be set to override a global setting via package options.
+\begin{verbatim}
transparent
\end{verbatim}
Indicates whether underlying page content is visible through transparent areas of the embedded media. Default is `\verb+transparent=false+'; media artwork is drawn over an opaque background prior to composition over the page content.
@@ -508,7 +513,7 @@ Playback of embedded video files is shown in Fig.~\ref{videoa}. Besides embedded
`VPlayer.swf' and `APlayer.swf' expose a number of ActionScript functions to the JavaScript engine of Adobe Reader, allowing for playback control of media through PDF interactive forms and various trigger events. The functions and their calling convention are listed in Table~\ref{AVPlayerMethods}. An example of playing and pausing a video clip and setting the video source via interactive push buttons is given in Fig.~\ref{videoa}.
-Sound files and streams in the MP3 format can be played with `APlayer.swf'. Fig.~\ref{radio} contains examples of an audio live stream and a remote MP3 sound file. Instead of being embedded, the player is loaded from a CTAN mirror during runtime because an internet connection is required anyway for streaming the audio. If a local sound file is to be embedded into the PDF this would have to be done in the same way as with the video file in one of the previous examples using the `\verb+addresource+' option.
+Sound files and streams in the MP3 format can be played with `APlayer.swf'. Fig.~\ref{radio} contains examples of an audio live stream and a remote MP3 sound file. In one of the sound examples, the player is loaded from a CTAN mirror during runtime because an internet connection is required anyway for streaming the audio. If a local sound file is to be embedded into the PDF this would have to be done in the same way as with the video file in one of the previous examples using the `\verb+addresource+' option.
\clearpage
\begin{table}
@@ -533,6 +538,7 @@ parameter & description\\\hline\hline
{\tt source=<file path or URL>} & (required) path to embedded media file (see option `{\tt addresource}'), or URL (http, rtmp) to online media file\\
{\tt autoPlay=true|false} & if {\tt=true}, automatically starts playback after activation (see option `{\tt activation})'\\
{\tt loop=true|false} & if {\tt=true}, media is played in a loop\\
+{\tt stepping=true|false} &(VPlayer.swf only) if {\tt=true}, the video advances by roughly one frame per mouse click\\
{\tt scaleMode=letterbox|none| \phantom{.}\hfill{}stretch|zoom} & default: {\tt stretch}; determines how to scale the video in order to fit into player\\
{\tt volume=<value between 0.0 \phantom{.}\hfill{}and 1.0>} & sets volume of the sound\\
{\tt balance=<value between \phantom{xxxx} \phantom{.}\hfill{}-1.0 and 1.0>} & (APlayer.swf only) sets balance of sound speakers\\\hline
@@ -547,6 +553,7 @@ function & argument &description\\\hline\hline
{\tt play} & & play media\\
{\tt pause} & & pause media\\
{\tt playPause} & & toggle between play and pause\\
+{\tt stepping} & & (VPlayer.swf only) toggle stepping mode (one frame per click)\\
{\tt setSource} & string & load another media file (path to file, embedded using option `{\tt addresource}', or URL)\\
{\tt seek} & number & move the play location to a time offset from the beginning of the media; argument measured in seconds\\
{\tt rewind} & & rewind media to the beginning (without pausing it)\\
@@ -695,24 +702,17 @@ http://mirrors.ibiblio.org/pub/mirrors/CTAN/macros/latex/contrib/media9/players/
source=http://www.openbsd.org/songs/song49.mp3
&autoPlay=true
},
- transparent,
- url
- ]{\color{blue}\fbox{Listen to OpenBSD 4.9 release song.}}{%
- http://mirrors.ibiblio.org/pub/mirrors/CTAN/macros/latex/%
- contrib/media9/players/APlayer.swf%
- }
+ transparent
+ ]{\color{blue}\fbox{Listen to OpenBSD 4.9 release song.}}{APlayer.swf}
\end{Verbatim}
\makebox[\linewidth]{b)\hfill\includemedia[
flashvars={
source=http://www.openbsd.org/songs/song49.mp3
&autoPlay=true
},
- transparent,
- url
-]{\color{blue}\fbox{Listen to OpenBSD 4.9 release song.}}{%
-http://mirrors.ibiblio.org/pub/mirrors/CTAN/macros/latex/contrib/media9/players/APlayer.swf%
-}\hfill}
-\caption{Example of (a) streamed audio and (b) progressively downloaded MP3. The sound player, APlayer.swf, is loaded from a CTAN mirror upon activation.}\label{radio}
+ transparent
+]{\color{blue}\fbox{Listen to OpenBSD 4.9 release song.}}{APlayer.swf}\hfill}
+\caption{Example of (a) streamed audio and (b) progressively downloaded MP3. In (a), the sound player, APlayer.swf, is loaded from a CTAN mirror upon activation.}\label{radio}
\end{figure}
\clearpage
@@ -720,11 +720,9 @@ http://mirrors.ibiblio.org/pub/mirrors/CTAN/macros/latex/contrib/media9/players/
\subsection{Introduction}\label{sec:3Dintro}
Adobe Acrobat/Reader 7 was the first version to allow for embedding 3-di\-men\-sion\-al graphic objects, such as CAD models or 3D scientific data, that can be manipulated interactively by the user. U3D was the first supported format and was mainly developed by Right Hemisphere and Adobe. U3D had some deficiencies and was later replaced by the PRC format after Adobe purchased the original developer, the French company `Trade and Technology France'. U3D is still supported, but PRC is preferred as it allows for exact representation of curved surfaces and better compression. Both, U3D and PRC specifications are public~\cite{u3d,prc}.
-Currently, the only open-source PRC writing software is Asymptote~\cite{asy}. It is a descriptive 2D and 3D vector graphics language and interpreter which uses \TeX{} to typeset labels and equations, allowing for high quality mathematical figures and technical drawings. An impressive gallery of examples can be found on its Web site.
-
-MathGL~\cite{mathgl} is an open-source library for the creation of mathematical drawings which can export to the intermediate IDTF format. IDTF can then be converted into U3D using the open-source `Universal 3D Sample Software'~\cite{u3dlib}.
+Currently, two open-source software packages are known to export into the PRC file format. The first one is Asymptote~\cite{asy}, which is a descriptive 2D and 3D vector graphics language and interpreter and which uses \TeX{} to typeset labels and equations. It allows for high quality mathematical figures and technical drawings. An impressive gallery of examples can be found on its Web site. The second one is MathGL~\cite{mathgl}, a library for scientific data visualization. It provides interfaces to a number of programming and scripting languages as well as an interpreter for its own command language `MGL'.
-MeshLab~\cite{meshlab} is an open-source conversion and processing software for 3D mesh data which can import from and export to a number of file formats. Its U3D export filter is based on~\cite{u3dlib}.
+MeshLab~\cite{meshlab} is an open-source conversion and processing software for 3D mesh data which can import from and export to a number of file formats. Its U3D export filter is based on the open-source `Universal 3D Sample Software'~\cite{u3dlib}.
There are a few options to \verb+\includemedia+ which define how the 3D object is positioned within the view port of a virtual camera, or conversely, how the virtual camera is positioned and oriented within a coordinate system, called `The World', which bears the 3D object at a fixed position. Fig.~\ref{3dscene} should help to visualize the scenery: The virtual camera is orbiting at a distance of $ROO$ (option `\verb+3Droo+') around the centre of orbit, specified by the position vector $\overrightarrow{COO}$ (option `\verb+3Dcoo+'); $\sphericalangle AAC$ (option `\verb+3Daac+') is the camera's aperture angle. The direction vector $\overrightarrow{C2C}$ (option `\verb+3Dc2c+') is needed to specify the initial camera position. The camera may be given an initial roll angle (option `\verb+3Droll+') around its optical axis $(-1)\cdot\overrightarrow{C2C}$.
\begin{figure}[ht]