1 /*****************************************************************************
2 * VLCLibrary.h: VLCKit.framework VLCLibrary header
3 *****************************************************************************
4 * Copyright (C) 2007 Pierre d'Herbemont
5 * Copyright (C) 2007 the VideoLAN team
8 * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
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.
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.
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 *****************************************************************************/
26 #import "VLCMediaList.h"
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
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.
40 @interface VLCLibrary : NSObject
48 * Returns the library's shared instance.
49 * \return The library's shared instance.
51 + (VLCLibrary *)sharedLibrary;
55 * Returns the library's audio object. This object is used to manipulate the global audio properities of the shared
57 * \return The library's shared audio instance.
59 @property (readonly) VLCAudio * audio;
63 * Returns the library's version
64 * \return The library version example "0.9.0-git Grishenko".
67 @property (readonly) NSString * version;
70 * Returns the library's changeset
71 * \return The library version example "adfee99".
74 @property (readonly) NSString * changeset;