LibreOffice
LibreOffice 6.4 SDK API Reference
XPlayer.idl
Go to the documentation of this file.
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_XPlayer_idl__
20 #define __com_sun_star_media_XPlayer_idl__
21 
25 
26 module com { module sun { module star { module media {
27 
31 interface XPlayer
32 {
35  void start();
36 
40  void stop();
41 
47  boolean isPlaying();
48 
54  double getDuration();
55 
62  void setMediaTime( [in] double fTime );
63 
69  double getMediaTime();
70 
78  void setPlaybackLoop( [in] boolean bSet );
79 
86  boolean isPlaybackLoop();
87 
93  void setVolumeDB( [in] short nDB );
94 
100  short getVolumeDB();
101 
108  void setMute( [in] boolean bSet );
109 
117  boolean isMute();
118 
125 
131  XPlayerWindow createPlayerWindow( [in] sequence< any > aArguments );
132 
136 };
137 
138 }; }; }; };
139 
140 #endif
141 
142 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::media::XPlayer
is the multimedia stream handling interface.
Definition: XPlayer.idl:32
com::sun::star::media::XPlayer::isPlaybackLoop
boolean isPlaybackLoop()
indicates whether the stream reading will restart after the end of the stream.
com::sun::star::media::XPlayer::setMediaTime
void setMediaTime([in] double fTime)
sets the new cursor position in the media stream.
com::sun::star::media::XPlayer::setVolumeDB
void setVolumeDB([in] short nDB)
sets the audio volume in decibel.
com::sun::star::media::XPlayer::getPreferredPlayerWindowSize
::com::sun::star::awt::Size getPreferredPlayerWindowSize()
gets the preferred window size
com::sun::star::media::XPlayer::isMute
boolean isMute()
gets whether the volume is temporarily down to 0 or not.
com::sun::star::media::XPlayer::setMute
void setMute([in] boolean bSet)
sets the volume to 0 or to its previous value.
com::sun::star::media::XPlayer::getVolumeDB
short getVolumeDB()
gets the current audio volume in decibel
com::sun::star::media::XPlayer::start
void start()
starts reading the stream from the current position.
com::sun::star::media::XPlayer::getMediaTime
double getMediaTime()
gets the current position of the cursor in the stream
com::sun::star::media::XPlayer::stop
void stop()
stops reading the stream and leave the cursor at its current position.
Size.idl
com::sun::star::media::XPlayerWindow
interacts with the media player window
Definition: XPlayerWindow.idl:30
XPlayerWindow.idl
com::sun::star::awt::Size
specifies the 2-dimensional size of an area using width and height.
Definition: Size.idl:30
com::sun::star::media::XPlayer::createPlayerWindow
XPlayerWindow createPlayerWindow([in] sequence< any > aArguments)
gets a new player window for this stream control
com::sun::star::media::XPlayer::isPlaying
boolean isPlaying()
indicates whether the stream is played or not.
com::sun::star::media::XPlayer::createFrameGrabber
XFrameGrabber createFrameGrabber()
gets a frame grabber for this stream.
com
Definition: Ambiguous.idl:22
com::sun::star::media::XPlayer::setPlaybackLoop
void setPlaybackLoop([in] boolean bSet)
sets whether the stream reading should restart at the stream start after the end of the stream.
com::sun::star::media::XFrameGrabber
This interface provides an easy access to a stream images using their position in the time.
Definition: XFrameGrabber.idl:30
com::sun::star::media::XPlayer::getDuration
double getDuration()
gets the stream length
XFrameGrabber.idl