<refentry id="videodata.element" revision='3.1'>
<?dbhtml filename="videodata.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>

<refmeta>
<indexterm><primary>elements</primary>
<secondary>videodata</secondary></indexterm>
<refentrytitle>videodata</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>videodata</refname>
<refpurpose>&videodata.purpose;</refpurpose>
</refnamediv>

&videodata.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>

<para>
This element points to an external entity containing video data.
</para>

<refsect2 id="dbreproc.videodata"><title>Processing expectations</title>
<para>
&format.context; Rendering a video is usually accomplished by reserving
a rectangular area on the display and <quote>running</quote> the video in
that frame.
</para>
<para>
There are two ways to provide content for <sgmltag>VideoData</sgmltag>:
<sgmltag class='attribute'>EntityRef</sgmltag> or <sgmltag
class='attribute'>FileRef</sgmltag>.  It is best to use only one of these
methods. However, if multiple sources are provided, 
<sgmltag class='attribute'>EntityRef</sgmltag> will be used in favor of 
<sgmltag class='attribute'>FileRef</sgmltag>.
</para>
</refsect2> 


&videodata.parents.gen;
</refsect1>
<refsect1 condition='ref.elem.attrdesc'><title>Attributes</title>
<variablelist>
<varlistentry><term>align</term>
<listitem>
<para>
<sgmltag class="attribute">Align</sgmltag> specifies the horizontal alignment
of the image data on the page or within the element that frames it.
</para>
</listitem>
</varlistentry>
<varlistentry><term>depth</term>
<listitem>
<para>
<sgmltag class="attribute">Depth</sgmltag> specifies the desired depth (vertical
distance, at least in horizontal writing systems) of the
video data.
</para>
</listitem>
</varlistentry>
<varlistentry><term>entityref</term>
<listitem>
<para>
<sgmltag class="attribute">EntityRef</sgmltag> identifies the general entity
which points to the content of the video data.
</para>
</listitem>
</varlistentry>
<varlistentry><term>fileref</term>
<listitem>
<para>
<sgmltag class="attribute">FileRef</sgmltag> specifies the name of the file
which contains the content of the video data.
</para>
</listitem>
</varlistentry>
<varlistentry><term>format</term>
<listitem>
<para>
<sgmltag class="attribute">Format</sgmltag> identifies the format of the video
data. The <sgmltag class="attribute">Format</sgmltag> must be a defined
notation.
</para>
</listitem>
</varlistentry>
<varlistentry><term>scale</term>
<listitem>
<para>
<sgmltag class="attribute">Scale</sgmltag> specifies integer representing a 
percentage scaling factor (retaining the relative dimensions of the 
original video frame). If unspecified, the value 100 (100&percnt;) is assumed.
</para>
</listitem>
</varlistentry>
<varlistentry><term>scalefit</term>
<listitem>
<para>
If <sgmltag class="attribute">ScaleFit</sgmltag> has the value 1 (true), then
the video frame is to be scaled (uniformly) to the specified width or depth.
The default value of 0 (false) indicates that the image will not be
scaled to fit (although it may still be scaled by the
<sgmltag class="attribute">Scale</sgmltag> attribute).
</para>
</listitem>
</varlistentry>
<varlistentry><term>srccredit</term>
<listitem>
<para>
<sgmltag class="attribute">SrcCredit</sgmltag> contains details about the source 
of the video data.
</para>
</listitem>
</varlistentry>
<varlistentry><term>width</term>
<listitem>
<para>
<sgmltag class="attribute">Width</sgmltag> indicates the width of the graphic.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
</refentry>

