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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 module com {  module sun {  module star {  module media {
  21
  22 /** is the multimedia stream handling interface. This allows to
  23     perform every basic operation on videos and sounds.
  24  */
  25 interface XPlayer
  26 {
  27     /** starts reading the stream from the current position.
  28      */
  29     void start();
  30
  31     /** stops reading the stream and leave the cursor at its current
  32         position.
  33      */
  34     void stop();
  35
  36     /** indicates whether the stream is played or not.
  37
  38         @returns
  39             `TRUE` if the stream is played, `FALSE` otherwise
  40      */
  41     boolean isPlaying();
  42
  43     /** gets the stream length
  44
  45         @returns
  46             the stream length in second
  47      */
  48     double getDuration();
  49
  50     /** sets the new cursor position in the media stream. After using
  51         this method the stream is stopped.
  52
  53         @param fTime
  54             the new position to set in seconds
  55      */
  56     void setMediaTime( [in] double fTime );
  57
  58     /** gets the current position of the cursor in the stream
  59
  60         @returns
  61             the cursor position in seconds
  62      */
  63     double getMediaTime();
  64
  65     /** sets whether the stream reading should restart at the stream
  66         start after the end of the stream.
  67
  68         @param bSet
  69             loops if set to `TRUE`, otherwise stops at the end of the
  70             stream.
  71      */
  72     void setPlaybackLoop( [in] boolean bSet );
  73
  74     /** indicates whether the stream reading will restart after the
  75         end of the stream.
  76
  77         @returns
  78             `TRUE` if the stream will loop, `FALSE` otherwise.
  79      */
  80     boolean isPlaybackLoop();
  81
  82     /** sets the audio volume in decibel.
  83
  84         @param nDB
  85             the new volume in Decibel
  86      */
  87     void setVolumeDB( [in] short nDB );
  88
  89     /** gets the current audio volume in decibel
  90
  91         @returns
  92             the volume in decibel
  93      */
  94     short getVolumeDB();
  95
  96     /** sets the volume to <code>0</code> or to its previous value.
  97
  98         @param bSet
  99             sets the volume to <code>0</code> if `TRUE`, and switch
 100             to the previous non-null value if `FALSE`
 101      */
 102     void setMute( [in] boolean bSet );
 103
 104     /** gets whether the volume is temporarily down to <code>0</code>
 105         or not.
 106
 107         @returns
 108             `TRUE` if the volume is temporarily set to <code>0</code>,
 109             `FALSE` otherwise.
 110      */
 111     boolean isMute();
 112
 113     /** gets the preferred window size
 114
 115         @returns
 116             the com::sun::star::awt::Size
 117      */
 118     ::com::sun::star::awt::Size getPreferredPlayerWindowSize();
 119
 120     /** gets a new player window for this stream control
 121
 122         @param aArguments
 123             arguments passed to the window during its creation.
 124      */
 125     XPlayerWindow createPlayerWindow( [in] sequence< any > aArguments );
 126
 127     /** gets a frame grabber for this stream.
 128      */
 129     XFrameGrabber createFrameGrabber();
 130 };
 131
 132 }; }; }; };
 133
 134 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */