offapi/com/sun/star/media/XFrameGrabber.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 #ifndef __com_sun_star_media_XFrameGrabber_idl__
  20 #define __com_sun_star_media_XFrameGrabber_idl__
  21
  22 #include <com/sun/star/graphic/XGraphic.idl>
  23
  24 module com {  module sun {  module star {  module media {
  25
  26 /** This interface provides an easy access to a stream images using
  27     their position in the time.
  28  */
  29 interface XFrameGrabber
  30 {
  31     /** returns the image of the underlying stream at a given position
  32
  33         @param fMediaTime
  34             the time in seconds of the image to get. This time has to
  35             be a positive value inferior to the stream duration.
  36      */
  37     ::com::sun::star::graphic::XGraphic grabFrame( [in] double fMediaTime );
  38 };
  39 }; }; }; };
  40
  41 #endif
  42
  43 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */