Commit bc2e3177 authored by Felix Paul Kühne's avatar Felix Paul Kühne
Browse files

document class use-cases

parent 16f9b075
......@@ -30,6 +30,9 @@
*/
extern NSString *const VLCMediaPlayerVolumeChanged;
/**
* basic class to control audio output
*/
@interface VLCAudio : NSObject
/**
......
......@@ -29,6 +29,9 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
VLCDialogQuestionCritical,
};
/**
* the protocol to use if you decide to run a custom dialog appearance
*/
@protocol VLCCustomDialogRendererProtocol <NSObject>
/**
......@@ -104,6 +107,11 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
@end
/**
* dialog provider base class
* \note For iOS and tvOS, there are useable implementations available which don't require the use of a custom renderer
*/
@interface VLCDialogProvider : NSObject
/**
......
......@@ -23,6 +23,9 @@
#import <Cocoa/Cocoa.h>
#import <vlc_extensions.h>
/**
* wrapper class for lua extensions within VLCKit
*/
@interface VLCExtension : NSObject
- (instancetype)initWithInstance:(struct extension_t *)instance NS_DESIGNATED_INITIALIZER; // FIXME: Should be internal
......
......@@ -25,6 +25,9 @@
@class VLCExtension;
@class VLCMediaPlayer;
/**
* manager class for lua extensions within VLC
*/
@interface VLCExtensionsManager : NSObject
+ (VLCExtensionsManager *)sharedManager;
......
......@@ -36,6 +36,9 @@ typedef NS_ENUM(NSInteger, VLCRepeatMode) {
VLCRepeatAllItems
};
/**
* A media list player, which eases the use of playlists */
*/
@interface VLCMediaListPlayer : NSObject
@property (readwrite) VLCMediaList *mediaList;
......
......@@ -127,7 +127,9 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
@end
// TODO: Should we use medialist_player or our own flavor of media player?
/**
* The player base class needed to do any playback
*/
@interface VLCMediaPlayer : NSObject
@property (nonatomic, readonly) VLCLibrary *libraryInstance;
......
......@@ -29,6 +29,9 @@
@class VLCLibrary;
@protocol VLCMediaThumbnailerDelegate;
/**
* a facility allowing you to do thumbnails in an efficient manner
*/
@interface VLCMediaThumbnailer : NSObject
+ (VLCMediaThumbnailer *)thumbnailerWithMedia:(VLCMedia *)media andDelegate:(id<VLCMediaThumbnailerDelegate>)delegate;
......@@ -65,6 +68,9 @@
@property (readwrite, assign, nonatomic) float snapshotPosition;
@end
/**
* the required delegate protocol for VLCMediaThumbnailer
*/
@protocol VLCMediaThumbnailerDelegate
@required
- (void)mediaThumbnailerDidTimeOut:(VLCMediaThumbnailer *)mediaThumbnailer;
......
......@@ -25,7 +25,8 @@
#import <VLC/VLCPlaylist.h>
#import <VLC/VLCVideoView.h>
/* This class can be used as a data source for an NSOutlineView
/**
* This class can be used as a data source for an NSOutlineView
* it will display the playlist content. If provided the videoView
* will automatically be associated to the given playlist, and actions
* in the outlineView will trigger the videoView, visual feedback of the
......
......@@ -26,6 +26,9 @@ extern NSString * VLCDefaultStreamOutputRTSP;
extern NSString * VLCDefaultStreamOutputRTP;
extern NSString * VLCDefaultStreamOutputRTP;
/**
* a class allowing you to stream media based on predefined definitions
*/
@interface VLCStreamOutput : NSObject
- (instancetype)initWithOptionDictionary:(NSDictionary *)dictionary NS_DESIGNATED_INITIALIZER;
......
......@@ -26,7 +26,9 @@
#import <VLCKit/VLCMediaPlayer.h>
#import <VLCKit/VLCMedia.h>
/**
* control class for streaming sessions
*/
@interface VLCStreamSession : VLCMediaPlayer
+ (instancetype)streamSession;
......
......@@ -24,6 +24,9 @@
#import <QuartzCore/QuartzCore.h>
/**
* a custom layer for rendering video in a CoreAnimation environment
*/
@interface VLCVideoLayer : CALayer
@property (nonatomic, readonly) BOOL hasVideo;
......
......@@ -25,6 +25,9 @@
#import <Cocoa/Cocoa.h>
#import <QuartzCore/QuartzCore.h>
/**
* a custom view suitable for video rendering in AppKit environments
*/
@interface VLCVideoView : NSView
/* Properties */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment