<html> <head> <title>Interface XPlayer</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XPlayer-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">media</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XPlayer</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td/></tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>is the multimedia stream handling interface. This allows to perform every basic operation on videos and sounds. </dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#start">start</a></td> <td class="imsum_right">starts reading the stream from the current position. </td> </tr> <tr> <td class="imsum_left"><a href="#stop">stop</a></td> <td class="imsum_right">stops reading the stream and leave the cursor at its current position. </td> </tr> <tr> <td class="imsum_left"><a href="#isPlaying">isPlaying</a></td> <td class="imsum_right">indicates whether the stream is played or not. </td> </tr> <tr> <td class="imsum_left"><a href="#getDuration">getDuration</a></td> <td class="imsum_right">gets the stream length </td> </tr> <tr> <td class="imsum_left"><a href="#setMediaTime">setMediaTime</a></td> <td class="imsum_right">sets the new cursor position in the media stream. After using this method the stream is stopped. </td> </tr> <tr> <td class="imsum_left"><a href="#getMediaTime">getMediaTime</a></td> <td class="imsum_right">gets the current position of the cursor in the stream </td> </tr> <tr> <td class="imsum_left"><a href="#setStopTime">setStopTime</a></td> <td class="imsum_right">sets the time at which to stop reading the stream. </td> </tr> <tr> <td class="imsum_left"><a href="#getStopTime">getStopTime</a></td> <td class="imsum_right">gets the time at which the stream will stop. The result is not guaranteed if no stop time has been set. </td> </tr> <tr> <td class="imsum_left"><a href="#setRate">setRate</a></td> <td class="imsum_right">sets the speed of the stream reading relatively to the normal speed. </td> </tr> <tr> <td class="imsum_left"><a href="#getRate">getRate</a></td> <td class="imsum_right">gets the speed of the stream reading relatively to the normal reading. </td> </tr> <tr> <td class="imsum_left"><a href="#setPlaybackLoop">setPlaybackLoop</a></td> <td class="imsum_right">sets whether the stream reading should restart at the stream start after the end of the stream. </td> </tr> <tr> <td class="imsum_left"><a href="#isPlaybackLoop">isPlaybackLoop</a></td> <td class="imsum_right">indicates whether the stream reading will restart after the end of the stream. </td> </tr> <tr> <td class="imsum_left"><a href="#setVolumeDB">setVolumeDB</a></td> <td class="imsum_right">sets the audio volume in decibel. </td> </tr> <tr> <td class="imsum_left"><a href="#getVolumeDB">getVolumeDB</a></td> <td class="imsum_right">gets the current audio volume in decibel </td> </tr> <tr> <td class="imsum_left"><a href="#setMute">setMute</a></td> <td class="imsum_right">sets the volume to <code>0</code> or to its previous value. </td> </tr> <tr> <td class="imsum_left"><a href="#isMute">isMute</a></td> <td class="imsum_right">gets whether the volume is temporarily down to <code>0</code> or not. </td> </tr> <tr> <td class="imsum_left"><a href="#getPreferredPlayerWindowSize">getPreferredPlayerWindowSize</a></td> <td class="imsum_right">gets the preferred window size </td> </tr> <tr> <td class="imsum_left"><a href="#createPlayerWindow">createPlayerWindow</a></td> <td class="imsum_right">gets a new player window for this stream control </td> </tr> <tr> <td class="imsum_left"><a href="#createFrameGrabber">createFrameGrabber</a></td> <td class="imsum_right">gets a frame grabber for this stream. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="start" class="membertitle">start</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>start</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>starts reading the stream from the current position. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="stop" class="membertitle">stop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>stop</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>stops reading the stream and leave the cursor at its current position. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isPlaying" class="membertitle">isPlaying</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isPlaying</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>indicates whether the stream is played or not. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the stream is played, <b>false</b> otherwise </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDuration" class="membertitle">getDuration</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">double</td> </tr> <tr> <td valign="top"><b>getDuration</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the stream length </dd> <dt><b>Returns</b></dt> <dd>the stream length in second </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setMediaTime" class="membertitle">setMediaTime</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setMediaTime</b>(</td> <td valign="top">[in] double</td> <td valign="bottom"> fTime );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the new cursor position in the media stream. After using this method the stream is stopped. </dd> <dt><b>Parameter fTime</b></dt> <dd>the new position to set in seconds </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getMediaTime" class="membertitle">getMediaTime</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">double</td> </tr> <tr> <td valign="top"><b>getMediaTime</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the current position of the cursor in the stream </dd> <dt><b>Returns</b></dt> <dd>the cursor position in seconds </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setStopTime" class="membertitle">setStopTime</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setStopTime</b>(</td> <td valign="top">[in] double</td> <td valign="bottom"> fTime );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the time at which to stop reading the stream. </dd> <dt><b>Parameter fTime</b></dt> <dd>the time at which to stop reading the stream in seconds </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getStopTime" class="membertitle">getStopTime</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">double</td> </tr> <tr> <td valign="top"><b>getStopTime</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the time at which the stream will stop. The result is not guaranteed if no stop time has been set. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setRate" class="membertitle">setRate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setRate</b>(</td> <td valign="top">[in] double</td> <td valign="bottom"> fRate );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the speed of the stream reading relatively to the normal speed. </dd> <dt><b>Parameter fRate</b></dt> <dd>the stream reading rate. <code>1.0</code> means normal speed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getRate" class="membertitle">getRate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">double</td> </tr> <tr> <td valign="top"><b>getRate</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the speed of the stream reading relatively to the normal reading. </dd> <dt><b>Returns</b></dt> <dd>the relative speed. <code>1.0</code> is the normal speed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setPlaybackLoop" class="membertitle">setPlaybackLoop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setPlaybackLoop</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bSet );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets whether the stream reading should restart at the stream start after the end of the stream. </dd> <dt><b>Parameter bSet</b></dt> <dd>loops if set to <b>true</b>, otherwise stops at the end of the stream. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isPlaybackLoop" class="membertitle">isPlaybackLoop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isPlaybackLoop</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>indicates whether the stream reading will restart after the end of the stream. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the stream will loop, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setVolumeDB" class="membertitle">setVolumeDB</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setVolumeDB</b>(</td> <td valign="top">[in] short</td> <td valign="bottom"> nDB );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the audio volume in decibel. </dd> <dt><b>Parameter nDB</b></dt> <dd>the new volume in Decibel </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getVolumeDB" class="membertitle">getVolumeDB</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">short</td> </tr> <tr> <td valign="top"><b>getVolumeDB</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the current audio volume in decibel </dd> <dt><b>Returns</b></dt> <dd>the volume in decibel </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="setMute" class="membertitle">setMute</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>setMute</b>(</td> <td valign="top">[in] boolean</td> <td valign="bottom"> bSet );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>sets the volume to <code>0</code> or to its previous value. </dd> <dt><b>Parameter bSet</b></dt> <dd>sets the volume to <code>0</code> if <b>true</b>, and switch to the previous non-null value if <b>false</b> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isMute" class="membertitle">isMute</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isMute</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets whether the volume is temporarily down to <code>0</code> or not. </dd> <dt><b>Returns</b></dt> <dd><b>true</b> if the volume is temporarily set to <code>0</code>, <b>false</b> otherwise. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getPreferredPlayerWindowSize" class="membertitle">getPreferredPlayerWindowSize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a></td> </tr> <tr> <td valign="top"><b>getPreferredPlayerWindowSize</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the preferred window size </dd> <dt><b>Returns</b></dt> <dd>the ::com::sun::star::<a href="../awt/module-ix.html">awt</a>::<a href="../awt/Size.html">Size</a> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createPlayerWindow" class="membertitle">createPlayerWindow</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XPlayerWindow.html">XPlayerWindow</a></td> </tr> <tr> <td valign="top"><b>createPlayerWindow</b>(</td> <td valign="top">[in] sequence< any ></td> <td valign="bottom"> aArguments );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets a new player window for this stream control </dd> <dt><b>Parameter aArguments</b></dt> <dd>arguments passed to the window during its creation. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createFrameGrabber" class="membertitle">createFrameGrabber</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XFrameGrabber.html">XFrameGrabber</a></td> </tr> <tr> <td valign="top"><b>createFrameGrabber</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets a frame grabber for this stream. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
4242
