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 <Cocoa/Cocoa.h>
  26 #import "VLCAudio.h"
  27 #import "VLCMediaList.h"
  28 #import "VLCMedia.h"
  29
  30 @class VLCAudio;
  31
  32 /**
  33  * The VLCLibrary is the base library of the VLCKit.framework.  This object provides a shared instance that exposes the
  34  * internal functionalities of libvlc and libvlc-control. The VLCLibrary object is instantiated automatically when
  35  * VLCKit.framework is loaded into memory.  Also, it is automatically destroyed when the VLCKit.framework is unloaded
  36  * from memory.
  37  *
  38  * Currently, the framework does not support multiple instances of VLCLibrary.  Furthermore, you cannot destroy any
  39  * instiantiation of VLCLibrary, as previously noted, this is done automatically by the dynamic link loader.
  40  */
  41 @interface VLCLibrary : NSObject
  42 {
  43     void * instance;
  44     VLCAudio * audio;
  45 }
  46
  47 /* Factories */
  48 /**
  49  * Returns the library's shared instance.
  50  * \return The library's shared instance.
  51  */
  52 + (VLCLibrary *)sharedLibrary;
  53
  54 /* Properties */
  55 /**
  56  * Returns the library's audio object.  This object is used to manipulate the global audio properities of the shared
  57  * library.
  58  * \return The library's shared audio instance.
  59  */
  60 @property (readonly) VLCAudio * audio;
  61
  62
  63 /**
  64  * Returns the library's version
  65  * \return The library version example "0.9.0-git Grishenko".
  66  */
  67
  68 @property (readonly) NSString * version;
  69
  70 /**
  71  * Returns the library's changeset
  72  * \return The library version example "adfee99".
  73  */
  74
  75 @property (readonly) NSString * changeset;
  76
  77 @end