git.sesse.net Git - vlc/blob - bindings/libvlcpp/src/audio.hpp

   1 /*****************************************************************************
   2  * audio.hpp: audio part of the media player
   3  *****************************************************************************
   4  * Copyright (C) 2010 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Rémi Duraffort <ivoire@videolan.org>
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22  *****************************************************************************/
  23
  24 #ifndef LIBVLCPP_AUDIO_HPP
  25 #define LIBVLCPP_AUDIO_HPP
  26
  27 #include <vlc/libvlc.h>
  28 #include <vlc/libvlc_media.h>
  29 #include <vlc/libvlc_media_player.h>
  30
  31 #include "libvlc.hpp"
  32
  33 namespace libvlc
  34 {
  35
  36 class Audio
  37 {
  38 public:
  39     /**
  40      * Constructor
  41      * @param player: the player handling the audio
  42      */
  43     Audio( libvlc_media_player_t *player );
  44
  45     /** Destructor */
  46     ~Audio();
  47
  48     /**
  49      * Toggle mute status
  50      */
  51     void toggleMute();
  52
  53     /**
  54      * Get the mute status
  55      * @return true if the sound is muted
  56      */
  57     int mute();
  58
  59     /**
  60      * Set the mute status
  61      * @param mute: true to mute, otherwise unmute
  62      */
  63     void setMute( int mute );
  64
  65     /**
  66      * Get the current volume
  67      * @return the current volume
  68      */
  69     int volume();
  70
  71     /**
  72      * Set the volume
  73      * @param volume: the new volume
  74      */
  75     void setVolume( int volume );
  76
  77
  78     /**
  79      * Get the current track
  80      * @return the current audio track
  81      */
  82     int track();
  83
  84     /**
  85      * Get the number of audio tracks
  86      * @return the number of audio tracks
  87      */
  88     int trackCount();
  89
  90     /**
  91      * Set the audio track
  92      * @param track: the audio track
  93      */
  94     void setTrack( int track );
  95
  96     /**
  97      * Get the current audio channel
  98      * @return the current audio channel
  99      */
 100     int channel();
 101
 102     /**
 103      * Set the audio channel
 104      * @param channel: the new audio channel
 105      */
 106     void setChannel( int channel );
 107
 108     /** trackDescription */
 109
 110 private:
 111     /** The media player instance of libvlc */
 112     libvlc_media_player_t *m_player;
 113 };
 114
 115 };
 116
 117 #endif // LIBVLCPP_AUDIO_HPP
 118