]> git.sesse.net Git - vlc/blob - projects/macosx/framework/Headers/Public/VLCMediaDiscoverer.h
osx/framework: extended API to cover titles, fps, playback modes and some convienienc...
[vlc] / projects / macosx / framework / Headers / Public / VLCMediaDiscoverer.h
1 /*****************************************************************************
2  * VLCMediaDiscoverer.h: VLCKit.framework VLCMediaDiscoverer 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 <VLCKit/VLCMediaList.h>
26
27 @class VLCMediaList;
28
29 /**
30  * TODO: Documentation VLCMediaDiscoverer
31  */
32 @interface VLCMediaDiscoverer : NSObject
33 {
34     NSString * localizedName;       //< TODO: Documentation VLCMediaDiscoverer.localizedName
35     VLCMediaList * discoveredMedia; //< TODO: Documentation VLCMediaDiscoverer.discoveredMedia
36     void * mdis;                    //< TODO: Documentation VLCMediaDiscoverer.mdis
37     BOOL running;                   //< TODO: Documentation VLCMediaDiscoverer.running
38 }
39
40 /**
41  * Maintains a list of available media discoverers.  This list is populated as new media
42  * discoverers are created.
43  * \return A list of available media discoverers.
44  */
45 + (NSArray *)availableMediaDiscoverer;
46
47 /* Initializers */
48 /**
49  * Initializes new object with specified name.
50  * \param aSerchName Name of the service for this VLCMediaDiscoverer object.
51  * \returns Newly created media discoverer.
52  */
53 - (id)initWithName:(NSString *)aServiceName;
54
55 /**
56  * TODO: Documentation VLCMediaDiscoverer.discoveredMedia
57  */
58 @property (readonly) VLCMediaList * discoveredMedia;
59
60 /**
61  * TODO: Documentation VLCMediaDiscoverer.localizedName
62  */
63 @property (readonly) NSString * localizedName;
64
65 /**
66  * TODO: Documentation VLCMediaDiscoverer.isRunning
67  */
68 @property (readonly) BOOL isRunning;
69 @end