% makeindex < aebpro_man.idx > aebpro_man.ind
\documentclass{article}
\usepackage[fleqn]{amsmath}
\usepackage[
    web={centertitlepage,designv,tight,usetemplates,
        forcolorpaper,latextoc,pro},%usesf,
        eforms,aebxmp
]{aeb_pro}
%\usepackage{multicol}
\usepackage{aeb_mlink}
\usepackage{array}
\usepackage[altbullet]{lucidbry}

\usepackage{makeidx}
\makeindex
\usepackage{acroman}

\usepackage[active]{srcltx}

\def\expath{../examples}

\urlstyle{rm}

\makeatletter
\renewcommand{\paragraph}
    {\@startsection{paragraph}{4}{0pt}{6pt}{-3pt}{\bfseries}}
\makeatother

%\def\tutpath{doc/tutorial}
%\def\tutpathi{tutorial}

\DeclareDocInfo
{
    university={\AcroTeX.Net},
    title={The \texorpdfstring{\textsf{yt4PDF} Package\\[1em]}{: }
        Playing YouTube Videos in PDF},
    author={D. P. Story},
    email={dpstory@acrotex.net},
    subject={Playing YouTube Videos in PDF},
    talksite={\url{www.acrotex.net}},
    version={1.0},
    keywords={AcroTeX, PDF, YouTube, rmannot},
    copyrightStatus=True,
    copyrightNotice={Copyright (C) \the\year, D. P. Story},
    copyrightInfoURL={http://www.acrotex.net}
}

\def\dps{$\hbox{$\mathfrak D$\kern-.3em\hbox{$\mathfrak P$}%
   \kern-.6em \hbox{$\mathcal S$}}$}

\universityLayout{fontsize=Large}
\titleLayout{fontsize=LARGE}
\authorLayout{fontsize=Large}
\tocLayout{fontsize=Large,color=aeb}
\sectionLayout{indent=-40pt,fontsize=large,color=aeb,afterskip=1sp}
\subsectionLayout{indent=-20pt,color=aeb,afterskip=1sp}
\subsubsectionLayout{indent=0pt,color=aeb,afterskip=1sp}
\subsubDefaultDing{\texorpdfstring{$\bullet$}{\textrm\textbullet}}

\newenvironment{eqComments}[1][\strut]{\smallskip\leftskip-\labelwidth
\item[]\textbf{\textcolor{blue}{#1}}}{\par\smallskip}




%\pagestyle{empty}
\parindent0pt\parskip\medskipamount

\definePath\bgPath{"C:/Users/Public/Documents/ManualBGs/Manual_BG_Print_AeB.pdf"}
\begin{docassembly}
\addWatermarkFromFile({
    bOnTop:false,
    cDIPath:\bgPath
});
\executeSave();
\end{docassembly}

\begin{document}

\maketitle

\selectColors{linkColor=black}
\tableofcontents
\selectColors{linkColor=webgreen}

\section{Introduction}\label{s:intro}

 I believe that I was vaguely aware of the \href{http://code.google.com/apis/youtube/flash_api_reference.html}
{YouTube ActionScript 3.0 Player}, but never pursued it because of my
general lack of interest in YouTube (\url{www.youtube.com}). Recently, I
came across a very nice demo PDF that used the API, see
\mlhref{http://www.uvsar.com/pdftube/}{PDF Tube - YouTube API wrapper for PDF
documents}. The SWF file and JavaScript are made freely available, so I
downloaded it, and was sufficiently impressed to port the example to
{\LaTeX} using various members of the {Acro\negthinspace\TeX} Fine Family of Software
\verb!:-{)!. The SWF file and JavaScript are due to the good folks at
\textbf{UVSAR} (\url{www.uvsar.com}). The \textbf{UVSAR}'s sample demo also appeared in the forums of
the \href{http://acrobatusers.com/forums/aucbb/viewtopic.php?pid=62134}{Acrobat User
Community}.

The \textsf{yt4pdf} package uses the \textsf{rmannot} to embed the \textsf{SWF}
file that plays the YouTube videos.  There is a complete set of buttons
that come with the package to control the video: play, pause, stop
loading, rewind, load a video by its YouTube video ID, and a button to
view a video on the YouTube web site.\footnote{Some videos do not allow
embedded playback, and must be viewed on the YouTube web site.}

% http://acrobatusers.com/news/youtube-widget-acrobat

\subsection{Sample files}

The following are the sample files shipped with \textsf{yt4pdf}:
\begin{itemize}
    \item \texttt{yt4pdf-1.tex} demonstrates the basic functionality of
    the YouTube RMA: the use of the poster, including \cs{ytComboList},
    \cs{ytComboBtn}, and \cs{ytvId}.
    \item \texttt{yt4pdf-2.tex} experiments with different ways the
    YouTube annotation can be displayed
    \begin{itemize}
        \item As a small icon, videos are played in a floating window,
        buttons displayed in the running footer.
        \item[] This one uses a rollover, popup menu system (as opposed to
        a combo box). The \textsf{popupmenu} package is used.
        \item Using a built-in poster, with the combo box under the
        annotation, control buttons in running footer.
        \item Same as above, but control buttons moved to a two column
        format.
        \item Using the custom YouTube for PDF poster with combo box and
        control buttons under the RMA.
    \end{itemize}
    \item \texttt{yt4pdf-3.tex} illustrates the usage of the \texttt{play} and \texttt{load}
    keys that are passed in the optional parameter of \cs{ytRmAnnot}.
\end{itemize}
Advanced examples \href{http://www.math.uakron.edu/~dpstory/aebblog.html}{AeB Blog site}.

\section{Requirements}

This package is part of \textsf{AeB Pro}, which means Acrobat Distiller is
used to create the PDF; the package requires \textsf{rmannot}, which
creates rich media annotations. Therefore, we require
\begin{equation*}
    \boxed{\text{\large\bfseries Adobe Acrobat, version 9.0 or later}}
\end{equation*}
To use this package, the document author must have AeB and AeB Pro
installed, as well as \textsf{rmannot}. The manual for \textsf{rmannot}
needs to be read closely to properly install it and to function correctly.

\section{Configuring your installation}

In addition to configuring the \textsf{rmannot} package correctly, the
\textsf{yt4pdf} package needs configuring as well. The \textsf{yt4pdf} package
comes with a configuration file \texttt{yt4pdf.cfg}.  Open this file in
your favorite editor to see
\begin{Verbatim}[fontsize=\small]
% yt4pdf config file. Delete the \endinput below and replace the path
% provided with the path to the swf folder of your yt4pdf installation.
% This path is used to locate the pdf_tube_basic.swf file, used to play
% YouTube videos.
\endinput
\renewcommand{\ytFolder}{C:/Users/Public/Documents/My TeX Files/%
tex/latex/aeb/aebpro/yt4pdf/swf}
\end{Verbatim}
Edit this file so that \cs{ytFolder} points to the \texttt{swf} folder on
your computer.

\section{The Rich Mediation Annotation for YouTube}

The Rich Media Annotation (RMA) used is \cs{ytRmAnnot}, its definition
uses the command \cs{rmAnnot}, which is defined in the \textsf{rmannot} package.
\begin{dCmd*}{.67\linewidth}
\ytRmAnnot[<kv-pairs>]{<name>}{width}{height}
\end{dCmd*}
\PD
\begin{enumerate}
    \item The first (optional) parameter is used to pass the key-value pairs of the
    \cs{rmAnnot} command. Additionally, there are two other kv-pairs
    recognized, specialized to the \cs{ytRmAnnot} command.
    \begin{itemize}
        \item \texttt{play=<vID>} Loads and plays the YouTube video with
            video ID of \texttt{<vID>}.
        \item \texttt{load=<vID>} Loads the specified video's thumbnail
            (as specified by \texttt{<vID>}) and prepares the player to play
            the video. The player does not request the \textsf{FLV} until the play
            button is pressed.
    \end{itemize}
    When you want to play a YouTube video when the page containing
    the annotation is opened, use the \texttt{play} key; for example
    \texttt{play=GZ9e3Dy7obA} causes the video whose video ID is
    \texttt{GZ9e3Dy7obA} to play when the page is opened.

    \item[] See the manual for the \textsf{rmannot} package for more details on the
    key-value pairs that can be passed through the optional first
    parameter.

    \item The \texttt{<name>} parameter is a name used to refer to the
    annotation through underlying JavaScript code. The \texttt{<name>}
    should consist of only letters and numbers. The value of this
    parameter is placed in the macro \cs{ytCurrRMAName}. This macro is
    used internally by the various control buttons.

    \item The width of the annotation.

    \item The height of the annotation.
\end{enumerate}

\paragraph*{Annot Dimensions.}
The width and height of the YouTube annotation should be \texttt{571bp}
and \texttt{330bp}, respectively, or any re-scaling of these dimensions.

Examples,
\begin{Verbatim}
    \ytRmAnnot[posternote=AcroTeX PDF Tube,play=eNzrn8-JFSE,
        deactivated=pageclose]{YouTube1}{571bp}{330bp}
\end{Verbatim}
is a ``full-size'' annotation, while
\begin{Verbatim}
    \ytRmAnnot[posternote=AcroTeX PDF Tube,load=eNzrn8-JFSE,
        deactivated=pageclose]{YouTube1}{571bp/2}{330bp/2}
\end{Verbatim}
is half that size. The first example above plays a video when
the page is opened, the second example loads the thumbnail, and waits play
the video.

You can also re-scale using either \cs{resizebox} or
\cs{scalebox} from the \textsf{graphicx} package.
\begin{Verbatim}
    \resizebox{2in}{!}{\ytRmAnnot[posternote=AcroTeX PDF Tube,
        deactivated=pageclose]{YouTube1}{571bp}{330bp}}
\end{Verbatim}
or, using \cs{scalebox},
\begin{Verbatim}
    \scalebox{.5}{\ytRmAnnot[posternote=AcroTeX PDF Tube,
        deactivated=pageclose]{YouTube1}{571bp}{330bp}}
\end{Verbatim}

\textbf{Running multiple videos at once.} At the time of this writing, the
\textbf{yt4pdf} package is not designed to run more than one video at a
time, that's not saying it cannot be done, however. It is not recommended,
indeed, why would you want to look at two YouTube videos at the same
time?

For documents with multiple YouTube annotations over
several pages it is recommended, therefore, that the \texttt{deactivated=pageclose}
should be used in the optional parameter list of the \cs{ytRmAnnot}
command.

\subsection{The \texorpdfstring{\protect\textsf{yt4pdf}}{yt4pdf} Poster}

The \textsf{rmannot} package provides a standard poster (a gray rectangle
with text in the lower left corner). However, there is an especially
designed poster, designed by the folks at \textbf{UVSAR}. (See
Figure~\ref*{pdfytPoster}, page~\pageref*{pdfytPoster}.)

\begin{figure}[htb]
\begin{center}
    \includegraphics[scale=.5]{graphics/pdfyt_poster}\\
    \caption{YouTube for PDF poster}\label{pdfytPoster}
\end{center}
\end{figure}

\goodbreak
\textbf{To use this really cool poster:}
\begin{enumerate}
    \item Insert the following line into the preamble,
\begin{Verbatim}[fontsize=\small]
    \makePoster[bb=0 0 570.794 329.887]{pdfyt_poster}{pdfyt_poster}
\end{Verbatim}
The optional parameter should remain as it is, it adjusts the bounding
box so that the poster is properly placed.

\item Use the \texttt{poster} key in the first optional parameter of
\cs{ytRmAnnot}, like so,
\begin{Verbatim}
    \ytRmAnnot[poster=pdfyt_poster,
        deactivated=pageclose]{YouTube}{571bp}{330bp}}
\end{Verbatim}
\end{enumerate}

\subsection{Control Buttons}

The YouTube rich media annotation (as created by \cs{ytRmAnnot}), comes
with six (optional) control buttons.

\begin{dCmd*}{.75\linewidth}
\ytPlayToggle[<kv-pairs>]{<width>}{<height>}
\ytStopLoading[<kv-pairs>]{<width>}{<height>}
\ytMuteToggle[<kv-pairs>]{<width>}{<height>}
\ytRewind[<kv-pairs>]{<width>}{<height>}
\ytSelect[<kv-pairs>]{<vID>}{<width>}{<height>}
\ytOpenWeb[<kv-pairs>]{<width>}{<height>}
\end{dCmd*}
\PD The labels are self-explanatory, the \texttt{<kv-pairs>} parameter is
the standard \textsf{eforms} optional parameter for changing the
appearance of the form. The \texttt{<vID>} parameter for \cs{ytSelect} is
a YouTube video ID.

\goodbreak
\CmdDescription We give brief descriptions of each of the six control
buttons.
\begin{itemize}
    \item \cs{ytPlayToggle}:
    This button has several functions, \textsf{PAUSE}, \textsf{PLAY}, \textsf{BUFFERING}, and \textsf{REPLAY}.
    Initially the button label is on \textsf{PAUSE} (pressing it pauses a playing video);
    the button label reads \textsf{PLAY} when the video is loaded and paused (pressing it plays or resumes
    the video); while the video is loading, the button label is
    \textsf{BUFFERING\dots}. After the video finishes playing, the button
    label is changed to \textsf{Replay}.
    \item \cs{ytStopLoading}: Pressing this button stops the streaming of the currently playing
    video. If the video is started again, there will be some buffering before the play begins.
    \item \cs{ytMuteToggle}: This button toggles and sound off and on. Button labels are
    \textsf{MUTE} and \textsf{UNMUTE}.
    \item \cs{ytRewind}: If the video is playing, this button
       stops the video, rewinds it to the beginning, and starts play again. If the video
       is paused, this button rewinds the video to the beginning, the video remains paused.
    \item \cs{ytSelect}: When this button is pressed, a response dialog opens.
       The user enters a YouTube video ID into the field. On pressing OK, this video is played.

       \item[] The second parameter \texttt{<vID>} is the default video
       that is displayed in the input box of the response box that opens.
   \item[] \textbf{Note:} Some YouTube videos are security
       restricted and cannot be played through an embedded player, such as the one used here.
       If video ID of a video that does not allow embedded playback, a dialog appears giving
       the user the opportunity to view the video on the web.
    \item \cs{ytOpenWeb}: The user has the option of pressing this button to view the
       current video on the web at \texttt{www.youtube.com}.
\end{itemize}

The first (optional) parameter can be used to modify the appearance of the
individual buttons. To modify the appearances of the buttons as a group,
use
\begin{dCmd*}{.4\linewidth}
\ytBtnPresets{<kv-values>}
\end{dCmd*}
The key-value pairs are ones defined for form fields created by the \textsf{eforms}
package. The default definition is
\begin{dCmd*}{.7\linewidth}
\ytBtnPresets{\BC{.5 0 0}\S{S}\textFont{HeBo}}
\end{dCmd*}

The second parameter of \cs{ytRmAnnot} is the name to be associated with
that annot; the name of the annot is not known until after the annot is
defined. The command \cs{DeclareYTName}
\begin{dCmd*}{.4\linewidth}
\DeclareYTName{<name>}
\end{dCmd*}
allows you to define the name prior to the creation of the annot. This is
useful if you want to place the control buttons above the annot itself. By
specifying the name, the control buttons will know the name of the annot
they are to control.

\subsection{Controls for playing a YouTube video}

To actually play a video, you must pass a video ID to the underlying SWF
file. We present two methods here, through links and through a combo box.
One of the example files, \texttt{yt4pdf-2.pdf}, illustrates another method
using a popup menu.

\subsubsection{Playing a video through a link}

The command \cs{ytvId} creates a list such that when you click on it, the
video specified by the second parameter of the command is played in the
associated Rich Media annotation created by \cs{ytRmAnnot}. The associated
RMA is the one most recently defined prior to the link. If the link occurs
before the target RMA, you can use \cs{DeclareYTName} to set the name of
the target RMA for the link.
\begin{dCmd*}{.5\linewidth}
\ytvId[<kv-pairs>]{<vID>}{<text>}
\end{dCmd*}
\PD The first parameter takes the usual key-value pairs for links created
by the \textsf{eforms} package. The second parameter is the video ID to be
played. The third parameter is the text to be displayed by the link,
usually the title of the YouTube video.

\cs{ytvId} loads and plays the specified video; there is an
\texttt{*}-form of this command,
\begin{dCmd*}{.5\linewidth}
\ytvId*[<kv-pairs>]{<vID>}{<text>}
\end{dCmd*}
When this form is used, the YouTube thumbnail image for the video is
displayed,  the player to play the video. The player does not
request the \textsf{FLV} until the play button is pressed.

You can set the appearances for a all links created by \cs{ytvId} by using
\cs{ytvIdPresets}
\begin{dCmd*}{.4\linewidth}
\ytvIdPresets{<kv-values>}
\end{dCmd*}
The key-value pairs are ones defined for form fields created by the \textsf{eforms}
package. The default definition is
\begin{dCmd*}{.7\linewidth}
\ytvIdPresets{\linktxtcolor{webbrown}}
\end{dCmd*}

\subsubsection{Playing a video using a combo box}

You can created a combo box with a play list. There are three commands
that create the combo list, \cs{ytPlayList}, \cs{ytComboList}, and
\cs{ytComboBtn}.

\begin{dCmd*}{\linewidth}
\ytPlayList{<default_vId>}{<playlist>}
\end{dCmd*}
This command sets the play list to be displayed in the combo box, it needs
to be executed before the actual creation of the combo box (using
\cs{ytComboList}). The first parameter is he default video ID, this title
will be initially displayed by the combo box. The \texttt{<playlist>} is
an array of video IDs and title pairs. The following example illustrates
the format for the array:
\begin{Verbatim}
\newcommand{\playList}{%
    [(GZ9e3Dy7obA)(Kung-Fu Fighting (Bruce Lee version))]
    [(eNzrn8-JFSE)(Open at Adobe)]
    [(5y9-EVmreU4)(Lori's Corner: Episode \#1)]
}
\end{Verbatim}
The format for each pair is \verb![(<vId>)(<title>)]!.

In the example above, the array, in its correct format, is loaded
conveniently into a macro \cs{playList}. The macro may then be passed as the
second parameter of \cs{ytPlayList}. Thus, an example of the use of
\cs{ytPlayList} is
\begin{dCmd}{.6\linewidth}
\ytPlayList{eNzrn8-JFSE}{\playList}
\end{dCmd}

\newtopic The syntax for the combox box itself is

\begin{dCmd*}{.67\linewidth}
\ytComboList[<kv-pairs>]{<width>}{<height>}
\end{dCmd*}
The \cs{ytComboList} is a combo box of video Ids and titles. The user
selects a video based on its title, then presses the \textsf{PLAY} button
(see \cs{ytComboBtn} below). This command is executed \emph{before}
\cs{ytComboBtn} to set the play list, and the default value.
\PD
\begin{itemize}
   \item \texttt{[<kv-pairs>]}: (optional) The key-value pairs associated with an
   \textsf{eforms} form field, used to change the appearance of the field.
   \item \texttt{<width>}: The width of the combo box
   \item \texttt{<height>}: The height of the combo box
\end{itemize}

The appearance can be changed locally by the optional first parameter. The
command \cs{ytComboListPresets} is used to change all combo lists create
by \cs{ytComboList}. The command takes has one parameter, the key-value
pairs for changing the appearance. The default definition is
\verb!\ytComboListPresets{}!.

\newtopic Once the selection has been made from the combo box, the user
can play the selection by pressing the button created by \cs{ytComboBtn}.
\begin{dCmd*}{.67\linewidth}
\ytComboBtn[<kv-pairs>]{<width>}{<height>}
\end{dCmd*}
\textbf{\textcolor{red}{Note:}} If you hold down the shift key and click on
the button, the thumbnail poster is loaded, and the player is ready to
play the video.
\PD
\begin{itemize}
   \item \texttt{[<kv-pairs>]}: (optional) The key-value pairs associated with an
   \textsf{eforms} form field, used to change the appearance of the field.
   \item \texttt{<width>}: The width of the combo box
   \item \texttt{<height>}: The height of the combo box
\end{itemize}

The appearance can be changed locally by the optional first parameter. The
command \cs{ytComboBtnPresets} is used to change all combo lists create
by \cs{ytComboBtn}. The command takes has one parameter, the key-value
pairs for changing the appearance. The default definition is
\verb!\ytComboBtnPresets{}!.

\section{Language localizations}

The default language for \textsf{yt4pdf} is English; the English strings
that \textsf{yt4pdf} uses are listed below. These can be redefined as
desired.
\begin{Verbatim}
\newcommand{\ytStrPLAY}{PLAY}
\newcommand{\ytStrREPLAY}{REPLAY}
\newcommand{\ytStrPAUSE}{PAUSE}
\newcommand{\ytStrBuffering}{Buffering...}
\newcommand{\ytStrStopLoading}{Stop Loading}
\newcommand{\ytStrMUTE}{MUTE}
\newcommand{\ytStrUNMUTE}{UNMUTE}
\newcommand{\ytStrREWIND}{REWIND}
\newcommand{\ytStrLoadVideo}{Load Video}
\newcommand{\ytStrWatchOnWeb}{Watch on YouTube}
% response dialog box associated with ytSelect()
\newcommand{\ytRespQues}{Enter the YouTube Video ID}
\newcommand{\ytRespTitle}{Load a Video}
\newcommand{\ytRespLabel}{ID:}
% alert error messages
\newcommand{\ytStrErrorVideoNotFound}{Error: Video not found}
\newcommand{\ytStrErrorNoEmbed}{Error: This video does not allow
    embedded playback \r\r Would you like to view this video
    on the web?}
\newcommand{\ytStrConnecTimedOut}{Connection timed out, try again.}
\end{Verbatim}

\bigskip

That's all for now, I simply must get back to my retirement. {\dps}

\end{document}
