VLCAudio.h 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. /*****************************************************************************
  2. * VLCAudio.h: VLCKit.framework VLCAudio header
  3. *****************************************************************************
  4. * Copyright (C) 2007 Faustino E. Osuna
  5. * Copyright (C) 2007, 2014 VLC authors and VideoLAN
  6. * $Id$
  7. *
  8. * Authors: Faustino E. Osuna <enrique.osuna # gmail.com>
  9. *
  10. * This program is free software; you can redistribute it and/or modify it
  11. * under the terms of the GNU Lesser General Public License as published by
  12. * the Free Software Foundation; either version 2.1 of the License, or
  13. * (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Lesser General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Lesser General Public License
  21. * along with this program; if not, write to the Free Software Foundation,
  22. * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23. *****************************************************************************/
  24. #import <Foundation/Foundation.h>
  25. /* Notification Messages */
  26. /**
  27. * Standard notification messages that are emitted by VLCAudio object.
  28. */
  29. OBJC_VISIBLE OBJC_EXTERN
  30. NSString *const VLCMediaPlayerVolumeChanged;
  31. /**
  32. * basic class to control audio output
  33. */
  34. OBJC_VISIBLE
  35. @interface VLCAudio : NSObject
  36. /**
  37. * Property to mute the current audio output
  38. * \note decoding continues when muted, so consider disabling the audio track if you don't want audio for a long time
  39. */
  40. @property (getter=isMuted) BOOL muted;
  41. /**
  42. * control the current audio output volume */
  43. @property (assign) int volume;
  44. /**
  45. * enable passthrough mode for the current audio device
  46. * \note There is no warrenty that it succeeds as it depends on the capabilities of the hardware audio decoder / receiver attached by the user */
  47. @property (readwrite) BOOL passthrough;
  48. /**
  49. * lower the current audio output volume */
  50. - (void)volumeDown;
  51. /**
  52. * higher the current audio output volume */
  53. - (void)volumeUp;
  54. @end