VLCKit
VLCLibrary.h
1 /*****************************************************************************
2  * VLCLibrary.h: VLCKit.framework VLCLibrary header
3  *****************************************************************************
4  * Copyright (C) 2007 Pierre d'Herbemont
5  * Copyright (C) 2007-2019 VLC authors and VideoLAN
6  * $Id$
7  *
8  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
9  * Felix Paul Kühne <fkuehne # videolan.org>
10  *
11  * This program is free software; you can redistribute it and/or modify it
12  * under the terms of the GNU Lesser General Public License as published by
13  * the Free Software Foundation; either version 2.1 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Lesser General Public License for more details.
20  *
21  * You should have received a copy of the GNU Lesser General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24  *****************************************************************************/
25 
26 #import <Foundation/Foundation.h>
27 
30 
31 NS_ASSUME_NONNULL_BEGIN
32 
34 
44 @interface VLCLibrary : NSObject
45 
46 @property (class, nonatomic, nullable) id<VLCEventsConfiguring> sharedEventsConfiguration;
47 
56 @property (class, nonatomic, copy, nullable) NSString *currentErrorMessage;
57 
63 
69  - (instancetype)initWithOptions:(NSArray *)options;
70 
75 @property (readwrite, nonatomic, nullable) NSArray< id<VLCLogging> > *loggers;
76 
83 @property (readwrite, nonatomic) BOOL debugLogging __deprecated_msg("Set loggers with -[VLCLibrary setLoggers:] instead");
84 
95 @property (readwrite, nonatomic) int debugLoggingLevel __deprecated_msg("Use -[VLCLibrary setLogger:] with a VLCConsoleLogger instance instead");
96 
106 - (BOOL)setDebugLoggingToFile:(NSString *)filePath __deprecated_msg("Use -[VLCLibrary setLogger:] with a VLCFileLogger instance instead");
107 
113 @property (readwrite, nonatomic, nullable) id<VLCLibraryLogReceiverProtocol> debugLoggingTarget __deprecated_msg("Use -[VLCLibrary setLogger:] with an object conforming to VLCLogging protocol instead");
114 
119 @property (readonly, copy) NSString *version;
120 
125 @property (readonly, copy) NSString *compiler;
126 
131 @property (readonly, copy) NSString *changeset;
132 
139 - (void)setHumanReadableName:(NSString *)readableName withHTTPUserAgent:(NSString *)userAgent;
140 
147 - (void)setApplicationIdentifier:(NSString *)identifier withVersion:(NSString *)version andApplicationIconName:(NSString *)icon;
148 
153 @property (nonatomic, assign) void *instance;
154 
155 @end
156 
157 @protocol VLCLibraryLogReceiverProtocol <NSObject>
158 @optional
164 - (void)handleMessage:(NSString *)message
165  debugLevel:(int)level;
166 @end
167 
168 NS_ASSUME_NONNULL_END
VLCLibrary::instance
void * instance
Definition: VLCLibrary.h:153
+[VLCLibrary sharedLibrary]
VLCLibrary * sharedLibrary()
-[VLCLibrary __deprecated_msg]
BOOL debugLogging __deprecated_msg("Set loggers with -[VLCLibrary setLoggers:] instead")
Enables/disables logging to console \discussion Setting this to YES will assign a single VLCConsoleLo...
VLCMediaList
Definition: VLCMediaList.h:68
VLCMedia
Definition: VLCMedia.h:112
VLCEventsConfiguring-p
Definition: VLCEventsConfiguration.h:28
VLCLibrary::currentErrorMessage
NSString * currentErrorMessage
Definition: VLCLibrary.h:56
VLCLibraryLogReceiverProtocol-p
Definition: VLCLibrary.h:157
VLCLibrary::version
NSString * version
Definition: VLCLibrary.h:119
VLCFileLogger
A simple file logger to be used with a library instance.
Definition: VLCFileLogger.h:34
VLCLibrary::changeset
NSString * changeset
Definition: VLCLibrary.h:131
VLCAudio
Definition: VLCAudio.h:38
VLCLibrary
Definition: VLCLibrary.h:44
VLCLibrary::compiler
NSString * compiler
Definition: VLCLibrary.h:125
VLCLogging-p
Protocol implemented by any logger used in -[VLCLibrary loggers].
Definition: VLCLogging.h:134
VLCLibrary::loggers
NSArray< id< VLCLogging > > * loggers
The loggers array.
Definition: VLCLibrary.h:75