git.sesse.net Git - vlc/blob - projects/macosx/framework/Headers/Public/VLCLibrary.h

   1 /*****************************************************************************
   2  * VLCLibrary.h: VLCKit.framework VLCLibrary header
   3  *****************************************************************************
   4  * Copyright (C) 2007 Pierre d'Herbemont
   5  * Copyright (C) 2007 the VideoLAN team
   6  * $Id$
   7  *
   8  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 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 General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #import "VLCAudio.h"
  26 #import "VLCMediaList.h"
  27 #import "VLCMedia.h"
  28
  29 @class VLCAudio;
  30
  31 /**
  32  * The VLCLibrary is the base library of the VLCKit.framework.  This object provides a shared instance that exposes the
  33  * internal functionalities of libvlc and libvlc-control. The VLCLibrary object is instantiated automatically when
  34  * VLCKit.framework is loaded into memory.  Also, it is automatically destroyed when the VLCKit.framework is unloaded
  35  * from memory.
  36  *
  37  * Currently, the framework does not support multiple instances of VLCLibrary.  Furthermore, you cannot destroy any
  38  * instiantiation of VLCLibrary, as previously noted, this is done automatically by the dynamic link loader.
  39  */
  40 @interface VLCLibrary : NSObject
  41 {
  42     void * instance;
  43     VLCAudio * audio;
  44 }
  45
  46 /* Factories */
  47 /**
  48  * Returns the library's shared instance.
  49  * \return The library's shared instance.
  50  */
  51 + (VLCLibrary *)sharedLibrary;
  52
  53 /* Properties */
  54 /**
  55  * Returns the library's audio object.  This object is used to manipulate the global audio properities of the shared
  56  * library.
  57  * \return The library's shared audio instance.
  58  */
  59 @property (readonly) VLCAudio * audio;
  60
  61
  62 /**
  63  * Returns the library's version
  64  * \return The library version example "0.9.0-git Grishenko".
  65  */
  66
  67 @property (readonly) NSString * version;
  68
  69 /**
  70  * Returns the library's changeset
  71  * \return The library version example "adfee99".
  72  */
  73
  74 @property (readonly) NSString * changeset;
  75
  76 @end