offapi/com/sun/star/media/XPlayer.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XPlayer.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_media_XPlayer_idl__
  31 #define __com_sun_star_media_XPlayer_idl__
  32
  33 #ifndef __com_sun_star_awt_Size_idl__
  34 #include <com/sun/star/awt/Size.idl>
  35 #endif
  36 #ifndef __com_sun_star_media_XPlayerWindow_idl__
  37 #include <com/sun/star/media/XPlayerWindow.idl>
  38 #endif
  39 #ifndef __com_sun_star_media_XFrameGrabber_idl__
  40 #include <com/sun/star/media/XFrameGrabber.idl>
  41 #endif
  42
  43 module com {  module sun {  module star {  module media {
  44
  45 /** is the multimedia stream handling interface. This allows to
  46     perform every basic operation on videos and sounds.
  47  */
  48 interface XPlayer
  49 {
  50     /** starts reading the stream from the current position.
  51      */
  52     void start();
  53
  54     /** stops reading the stream and leave the cursor at its current
  55         position.
  56      */
  57     void stop();
  58
  59     /** indicates whether the stream is played or not.
  60
  61         @returns
  62             <TRUE/> if the stream is played, <FALSE/> otherwise
  63      */
  64     boolean isPlaying();
  65
  66     /** gets the stream length
  67
  68         @returns
  69             the stream length in second
  70      */
  71     double getDuration();
  72
  73     /** sets the new cursor position in the media stream. After using
  74         this method the stream is stopped.
  75
  76         @param fTime
  77             the new position to set in seconds
  78      */
  79     void setMediaTime( [in] double fTime );
  80
  81     /** gets the current position of the cursor in the stream
  82
  83         @returns
  84             the cursor position in seconds
  85      */
  86     double getMediaTime();
  87
  88     /** sets the time at which to stop reading the stream.
  89
  90         @param fTime
  91             the time at which to stop reading the stream in seconds
  92      */
  93     void setStopTime( [in] double fTime );
  94
  95     /** gets the time at which the stream will stop. The result
  96         is not guaranteed if no stop time has been set.
  97      */
  98     double getStopTime();
  99
 100     /** sets the speed of the stream reading relatively to the normal
 101         speed.
 102
 103         @param fRate
 104             the stream reading rate. <code>1.0</code> means normal speed.
 105      */
 106     void setRate( [in] double fRate );
 107
 108     /** gets the speed of the stream reading relatively to the normal
 109         reading.
 110
 111         @returns
 112             the relative speed. <code>1.0</code> is the normal speed.
 113      */
 114     double getRate();
 115
 116     /** sets whether the stream reading should restart at the stream
 117         start after the end of the stream.
 118
 119         @param bSet
 120             loops if set to <TRUE/>, otherwise stops at the end of the
 121             stream.
 122      */
 123     void setPlaybackLoop( [in] boolean bSet );
 124
 125     /** indicates whether the stream reading will restart after the
 126         end of the stream.
 127
 128         @returns
 129             <TRUE/> if the stream will loop, <FALSE/> otherwise.
 130      */
 131     boolean isPlaybackLoop();
 132
 133     /** sets the audio volume in decibel.
 134
 135         @param nDB
 136             the new volume in Decibel
 137      */
 138     void setVolumeDB( [in] short nDB );
 139
 140     /** gets the current audio volume in decibel
 141
 142         @returns
 143             the volume in decibel
 144      */
 145     short getVolumeDB();
 146
 147     /** sets the volume to <code>0</code> or to its previous value.
 148
 149         @param bSet
 150             sets the volume to <code>0</code> if <TRUE/>, and switch
 151             to the previous non-null value if <FALSE/>
 152      */
 153     void setMute( [in] boolean bSet );
 154
 155     /** gets whether the volume is temporarily down to <code>0</code>
 156         or not.
 157
 158         @returns
 159             <TRUE/> if the volume is temporarily set to <code>0</code>,
 160             <FALSE/> otherwise.
 161      */
 162     boolean isMute();
 163
 164     /** gets the preferred window size
 165
 166         @returns
 167             the <type scope="com::sun::star::awt">Size</type>
 168      */
 169     ::com::sun::star::awt::Size getPreferredPlayerWindowSize();
 170
 171     /** gets a new player window for this stream control
 172
 173         @param aArguments
 174             arguments passed to the window during its creation.
 175      */
 176     XPlayerWindow createPlayerWindow( [in] sequence< any > aArguments );
 177
 178     /** gets a frame grabber for this stream.
 179      */
 180     XFrameGrabber createFrameGrabber();
 181 };
 182
 183 }; }; }; };
 184
 185 #endif