VLCKit
VLCMediaDiscoverer.h
1 /*****************************************************************************
2  * VLCMediaDiscoverer.h: VLCKit.framework VLCMediaDiscoverer header
3  *****************************************************************************
4  * Copyright (C) 2007 Pierre d'Herbemont
5  * Copyright (C) 2015 Felix Paul Kühne
6  * Copyright (C) 2007, 2015 VLC authors and VideoLAN
7  * $Id$
8  *
9  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
10  * Felix Paul Kühne <fkuehne # videolan.org>
11  *
12  * This program is free software; you can redistribute it and/or modify it
13  * under the terms of the GNU Lesser General Public License as published by
14  * the Free Software Foundation; either version 2.1 of the License, or
15  * (at your option) any later version.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20  * GNU Lesser General Public License for more details.
21  *
22  * You should have received a copy of the GNU Lesser General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
25  *****************************************************************************/
26 
27 #import <Foundation/Foundation.h>
28 
29 @class VLCLibrary, VLCMediaList;
30 
31 NS_ASSUME_NONNULL_BEGIN
32 
33 
34 typedef NS_ENUM(unsigned, VLCMediaDiscovererCategoryType)
35 {
36  VLCMediaDiscovererCategoryTypeDevices = 0,
37  VLCMediaDiscovererCategoryTypeLAN,
38  VLCMediaDiscovererCategoryTypePodcasts,
39  VLCMediaDiscovererCategoryTypeLocalDirectories
40 };
41 
42 /* discoverer keys */
43 extern NSString *const VLCMediaDiscovererName;
44 extern NSString *const VLCMediaDiscovererLongName;
45 extern NSString *const VLCMediaDiscovererCategory;
46 
51 @interface VLCMediaDiscoverer : NSObject
52 
57 @property (nonatomic, readonly) VLCLibrary *libraryInstance;
58 
64 + (NSArray *)availableMediaDiscoverer __attribute__((deprecated));
65 
70 + (NSArray *)availableMediaDiscovererForCategoryType:(VLCMediaDiscovererCategoryType)categoryType;
71 
72 /* Initializers */
79 - (instancetype)initWithName:(NSString *)aServiceName;
80 
85 - (instancetype)initWithName:(NSString *)aServiceName libraryInstance:(VLCLibrary *)libraryInstance;
86 
91 - (int)startDiscoverer;
92 
96 - (void)stopDiscoverer;
97 
101 @property (weak, readonly, nullable) VLCMediaList *discoveredMedia;
102 
107 @property (readonly, copy) NSString *localizedName __attribute__((deprecated));
108 
113 @property (readonly) BOOL isRunning;
114 @end
115 
116 NS_ASSUME_NONNULL_END
VLCMediaDiscoverer::libraryInstance
VLCLibrary * libraryInstance
Definition: VLCMediaDiscoverer.h:57
VLCMediaList
Definition: VLCMediaList.h:68
-[VLCMediaDiscoverer stopDiscoverer]
void stopDiscoverer()
VLCMediaDiscoverer::isRunning
BOOL isRunning
Definition: VLCMediaDiscoverer.h:113
VLCMediaDiscoverer
Definition: VLCMediaDiscoverer.h:51
+[VLCMediaDiscoverer __attribute__]
(deprecated __attribute__()
VLCLibrary
Definition: VLCLibrary.h:44
VLCMediaDiscoverer::discoveredMedia
VLCMediaList * discoveredMedia
Definition: VLCMediaDiscoverer.h:101
-[VLCMediaDiscoverer startDiscoverer]
int startDiscoverer()