VLCKit
VLCMediaMetaData.h
1 /*****************************************************************************
2  * VLCMediaMetaData.h: VLCKit.framework VLCMediaMetaData header
3  *****************************************************************************
4  * Copyright (C) 2022 VLC authors and VideoLAN
5  * $Id$
6  *
7  * Authors:
8  *
9  * This program is free software; you can redistribute it and/or modify it
10  * under the terms of the GNU Lesser General Public License as published by
11  * the Free Software Foundation; either version 2.1 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23 
24 #import <Foundation/Foundation.h>
25 
29 typedef
30 #if TARGET_OS_IPHONE
31 UIImage
32 #else
33 NSImage
34 #endif
35 VLCPlatformImage;
36 
37 NS_ASSUME_NONNULL_BEGIN
38 
42 NS_SWIFT_NAME(VLCMedia.MetaData)
43 @interface VLCMediaMetaData : NSObject
44 
48 @property(nonatomic, copy, nullable) NSString *title;
49 
53 @property(nonatomic, copy, nullable) NSString *artist;
54 
58 @property(nonatomic, copy, nullable) NSString *genre;
59 
63 @property(nonatomic, copy, nullable) NSString *copyright;
64 
68 @property(nonatomic, copy, nullable) NSString *album;
69 
73 @property(nonatomic) unsigned trackNumber;
74 
78 @property(nonatomic, copy, nullable) NSString *metaDescription;
79 
83 @property(nonatomic, copy, nullable) NSString *rating;
84 
88 @property(nonatomic, copy, nullable) NSString *date;
89 
93 @property(nonatomic, copy, nullable) NSString *setting;
94 
98 @property(nonatomic, nullable) NSURL *url;
99 
103 @property(nonatomic, copy, nullable) NSString *language;
104 
108 @property(nonatomic, copy, nullable) NSString *nowPlaying;
109 
113 @property(nonatomic, copy, nullable) NSString *publisher;
114 
118 @property(nonatomic, copy, nullable) NSString *encodedBy;
119 
123 @property(nonatomic, nullable) NSURL *artworkURL;
124 
128 @property(nonatomic) unsigned trackID;
129 
133 @property(nonatomic) unsigned trackTotal;
134 
138 @property(nonatomic, copy, nullable) NSString *director;
139 
143 @property(nonatomic) unsigned season;
144 
148 @property(nonatomic) unsigned episode;
149 
153 @property(nonatomic, copy, nullable) NSString *showName;
154 
158 @property(nonatomic, copy, nullable) NSString *actors;
159 
163 @property(nonatomic, copy, nullable) NSString *albumArtist;
164 
168 @property(nonatomic) unsigned discNumber;
169 
173 @property(nonatomic) unsigned discTotal;
174 
178 @property(nonatomic, readonly, nullable) VLCPlatformImage *artwork;
179 
180 
181 + (instancetype)new NS_UNAVAILABLE;
182 - (instancetype)init NS_UNAVAILABLE;
183 
188 - (BOOL)save;
189 
193 - (void)prefetch;
194 
195 
196 - (void)clearCache;
197 
198 @end
199 
200 NS_ASSUME_NONNULL_END
VLCMediaMetaData::artwork
VLCPlatformImage * artwork
Definition: VLCMediaMetaData.h:178
VLCMediaMetaData::language
NSString * language
Definition: VLCMediaMetaData.h:103
VLCMediaMetaData::episode
unsigned episode
Definition: VLCMediaMetaData.h:148
VLCMedia
Definition: VLCMedia.h:112
-[VLCMediaMetaData prefetch]
void prefetch()
VLCMediaMetaData::setting
NSString * setting
Definition: VLCMediaMetaData.h:93
VLCMediaMetaData::date
NSString * date
Definition: VLCMediaMetaData.h:88
VLCMediaMetaData::trackNumber
unsigned trackNumber
Definition: VLCMediaMetaData.h:73
VLCMediaMetaData::discTotal
unsigned discTotal
Definition: VLCMediaMetaData.h:173
VLCMediaMetaData::actors
NSString * actors
Definition: VLCMediaMetaData.h:158
VLCMediaMetaData::showName
NSString * showName
Definition: VLCMediaMetaData.h:153
VLCMediaMetaData::title
NSString * title
Definition: VLCMediaMetaData.h:48
VLCMediaMetaData::genre
NSString * genre
Definition: VLCMediaMetaData.h:58
-[VLCMediaMetaData save]
BOOL save()
VLCMediaMetaData::trackTotal
unsigned trackTotal
Definition: VLCMediaMetaData.h:133
VLCMediaMetaData::discNumber
unsigned discNumber
Definition: VLCMediaMetaData.h:168
VLCMediaMetaData::artworkURL
NSURL * artworkURL
Definition: VLCMediaMetaData.h:123
VLCMediaMetaData::trackID
unsigned trackID
Definition: VLCMediaMetaData.h:128
VLCMediaMetaData::director
NSString * director
Definition: VLCMediaMetaData.h:138
VLCMediaMetaData::rating
NSString * rating
Definition: VLCMediaMetaData.h:83
VLCMediaMetaData::season
unsigned season
Definition: VLCMediaMetaData.h:143
VLCMediaMetaData::copyright
NSString * copyright
Definition: VLCMediaMetaData.h:63
VLCMediaMetaData
Definition: VLCMediaMetaData.h:43
VLCMediaMetaData::publisher
NSString * publisher
Definition: VLCMediaMetaData.h:113
VLCMediaMetaData::album
NSString * album
Definition: VLCMediaMetaData.h:68
VLCMediaMetaData::albumArtist
NSString * albumArtist
Definition: VLCMediaMetaData.h:163
VLCMediaMetaData::encodedBy
NSString * encodedBy
Definition: VLCMediaMetaData.h:118
VLCMediaMetaData::artist
NSString * artist
Definition: VLCMediaMetaData.h:53
VLCMediaMetaData::url
NSURL * url
Definition: VLCMediaMetaData.h:98
VLCMediaMetaData::metaDescription
NSString * metaDescription
Definition: VLCMediaMetaData.h:78
VLCMediaMetaData::nowPlaying
NSString * nowPlaying
Definition: VLCMediaMetaData.h:108