Commit 14c7ec5a authored by Felix Paul Kühne's avatar Felix Paul Kühne

Fix doxygen documentation

parent d0847e04
......@@ -30,7 +30,7 @@
/**
* initializer method to run the dialog provider instance on a specific library instance
*
* \param the library instance
* \param library instance
* \note if param is NULL, [VLCLibrary sharedLibrary] will be used
* \return the dialog provider instance, can be NULL on malloc failures
*/
......
......@@ -28,7 +28,7 @@
/**
* initializer method to run the dialog provider instance on a specific library instance
*
* \param the library instance
* \param library instance
* \note if param is NULL, [VLCLibrary sharedLibrary] will be used
* \return the dialog provider instance, can be NULL on malloc failures
*/
......
......@@ -50,8 +50,7 @@
* have a significant return value and should take a single argument of type NSNotification,
* or no arguments.
*
* See “Selectors” for a description of the SEL type.
* \param aNotificiationName The name of the notification that should be sent to the
* \param aNotificationName The name of the notification that should be sent to the
* distributed notification center.
*/
- (void)callOnMainThreadDelegateOfObject:(id)aTarget
......
......@@ -51,7 +51,7 @@
- (id)initWithLibVLCMediaList:(void *)p_new_mlist;
/* Properties */
@property (readonly) void * libVLCMediaList; //< LibVLC media list pointer.
@property (readonly) void * libVLCMediaList; ///< LibVLC media list pointer.
@end
/**
......@@ -89,7 +89,7 @@
@interface VLCMediaPlayer (LibVLCBridging)
/* Properties */
@property (readonly) void * libVLCMediaPlayer; //< LibVLC media list pointer.
@property (readonly) void * libVLCMediaPlayer; ///< LibVLC media list pointer.
@end
/**
......@@ -99,7 +99,7 @@
/**
* Set's the length of the media object. This value becomes available once the
* media object is being played.
* \param value
* \param value the length value
*/
- (void)setLength:(VLCTime *)value;
@end
......
......@@ -31,7 +31,7 @@
/**
* initializer method to run the dialog provider instance on a specific library instance
*
* \param the library instance
* \param library the library instance
* \note if param is NULL, [VLCLibrary sharedLibrary] will be used
* \return the dialog provider instance, can be NULL on malloc failures
*/
......
......@@ -33,8 +33,8 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
/**
* called when VLC wants to show an error
* \param the dialog title
* \param the error message
* \param error the dialog title
* \param message the error message
*/
- (void)showErrorWithTitle:(NSString * _Nonnull)error
message:(NSString * _Nonnull)message;
......@@ -42,10 +42,10 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
/**
* called when user logs in to something
* If VLC includes a keychain module for your platform, a user can store stuff
* \param login title
* \param an explaining message
* \param a default username within context
* \param indicator whether storing is even a possibility
* \param title login dialog title
* \param message an explaining message
* \param username a default username within context
* \param askingForStorage indicator whether storing is even a possibility
* \param reference you need to send the results to
*/
- (void)showLoginWithTitle:(NSString * _Nonnull)title
......@@ -56,12 +56,12 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
/**
* called when VLC needs the user to decide something
* \param the dialog title
* \param an explaining message text
* \param a question type
* \param cancel button text
* \param action 1 text
* \param action 2 text
* \param title the dialog title
* \param message an explaining message text
* \param questionType a question type
* \param cancelString cancel button text
* \param action1String action 1 text
* \param action2String action 2 text
* \param reference you need to send the action to
*/
- (void)showQuestionWithTitle:(NSString * _Nonnull)title
......@@ -74,11 +74,11 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
/**
* called when VLC wants to show some progress
* \param the dialog title
* \param an explaining message
* \param indicator whether progress indeterminate
* \param initial progress position
* \param optional string for cancel button if operation is cancellable
* \param title the dialog title
* \param message an explaining message
* \param isIndeterminate indicator whether progress indeterminate
* \param position initial progress position
* \param cancelString optional string for cancel button if operation is cancellable
* \param reference VLC will include in updates
*/
- (void)showProgressWithTitle:(NSString * _Nonnull)title
......@@ -90,8 +90,8 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
/** called when VLC wants to update an existing progress dialog
* \param reference to the existing progress dialog
* \param updated message
* \param current position
* \param message updated message
* \param position current position
*/
- (void)updateProgressWithReference:(NSValue * _Nonnull)reference
message:(NSString * _Nullable)message
......@@ -109,8 +109,8 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
/**
* initializer method to run the dialog provider instance on a specific library instance
*
* \param the library instance
* \param enable custom UI mode
* \param library the VLCLibrary instance
* \param customUI enable custom UI mode
* \note if library param is NULL, [VLCLibrary sharedLibrary] will be used
* \return the dialog provider instance, can be NULL on malloc failures
*/
......@@ -120,7 +120,6 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
/**
* initializer method to run the dialog provider instance on a specific library instance
*
* \param an object implementing the custom dialog rendering API
* \return the object set
*/
@property (weak, readwrite, nonatomic, nullable) id<VLCCustomDialogRendererProtocol> customRenderer;
......@@ -129,8 +128,8 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
* if you requested custom UI mode for dialogs, use this method respond to a login dialog
* \param username or NULL if cancelled
* \param password or NULL if cancelled
* \param reference to the dialog you respond to
* \param shall VLC store the login securely?
* \param dialogReference reference to the dialog you respond to
* \param store shall VLC store the login securely?
* \note This method does not have any effect if you don't use custom UI mode */
- (void)postUsername:(NSString * _Nonnull)username
andPassword:(NSString * _Nonnull)password
......@@ -139,15 +138,15 @@ typedef NS_ENUM(NSUInteger, VLCDialogQuestionType) {
/**
* if you requested custom UI mode for dialogs, use this method respond to a question dialog
* \param the button number the user pressed, use 3 if s/he cancelled, otherwise respectively 1 or 2 depending on the selected action
* \param reference to the dialog you respond to
* \param buttonNumber the button number the user pressed, use 3 if s/he cancelled, otherwise respectively 1 or 2 depending on the selected action
* \param dialogReference reference to the dialog you respond to
* \note This method does not have any effect if you don't use custom UI mode */
- (void)postAction:(int)buttonNumber
forDialogReference:(NSValue * _Nonnull)dialogReference;
/**
* if you requested custom UI mode for dialogs, use this method to cancel a progress dialog
* \param reference to the dialog you want to cancel
* \param dialogReference reference to the dialog you want to cancel
* \note This method does not have any effect if you don't use custom UI mode */
- (void)dismissDialogWithReference:(NSValue * _Nonnull)dialogReference;
......
......@@ -49,14 +49,14 @@
/**
* returns an individual instance which can be customized with options
* \param a NSArray with NSString instance containing the options
* \param options a NSArray with NSString instance containing the options
* \return the individual library instance
*/
- (instancetype)initWithOptions:(NSArray*)options;
/**
* enables/disables debug logging
* \param BOOL value to enable/disable
* param: debugLogging BOOL value to enable/disable
* \note we will always log using NSLog
* \return debug logging state
*/
......@@ -64,7 +64,7 @@
/**
* gets/sets the debug logging level
* \param int set level from 0 (all) to 4 (just error messages)
* param: debugLoggingLevel set level from 0 (all) to 4 (just error messages)
* \return int debug level
*/
@property (readwrite, nonatomic) int debugLoggingLevel;
......
......@@ -63,17 +63,17 @@ extern NSString *const VLCMetaInformationDiscNumber; /* NSString */
/**
* Available notification messages.
*/
extern NSString *const VLCMediaMetaChanged; //< Notification message for when the media's meta data has changed
extern NSString *const VLCMediaMetaChanged; ///< Notification message for when the media's meta data has changed
// Forward declarations, supresses compiler error messages
@class VLCMediaList;
@class VLCMedia;
typedef NS_ENUM(NSInteger, VLCMediaState) {
VLCMediaStateNothingSpecial, //< Nothing
VLCMediaStateBuffering, //< Stream is buffering
VLCMediaStatePlaying, //< Stream is playing
VLCMediaStateError, //< Can't be played because an error occurred
VLCMediaStateNothingSpecial, ///< Nothing
VLCMediaStateBuffering, ///< Stream is buffering
VLCMediaStatePlaying, ///< Stream is playing
VLCMediaStateError, ///< Can't be played because an error occurred
};
/**
......@@ -143,8 +143,8 @@ typedef NS_ENUM(NSInteger, VLCMediaState) {
/**
* convienience method to return a user-readable codec name for the given FourCC
* \param uint32_t the FourCC to process
* \param NSString a VLC track type if known to speed-up the name search
* \param fourcc the FourCC to process
* \param trackType a VLC track type if known to speed-up the name search
* \return a NSString containing the codec name if recognized, else an empty string
*/
+ (NSString *)codecNameForFourCC:(uint32_t)fourcc trackType:(NSString *)trackType;
......@@ -161,7 +161,7 @@ typedef NS_ENUM(NSInteger, VLCMediaState) {
/* Initializers */
/**
* Initializes a new VLCMedia object to use the specified URL.
* \param aPath Path to media to be accessed.
* \param anURL the URL to media to be accessed.
* \return A new VLCMedia object, only if there were no errors.
*/
- (instancetype)initWithURL:(NSURL *)anURL;
......@@ -267,8 +267,8 @@ typedef NS_ENUM(unsigned, VLCMediaParsedStatus)
/**
* set meta property for key
* \param metadata to set as NSString
* \param metadata key
* \param data the metadata to set as NSString
* \param key the metadata key
* \see dictionary keys above
*/
- (void)setMetadata:(NSString *)data forKey:(NSString *)key;
......@@ -299,16 +299,19 @@ typedef NS_ENUM(unsigned, VLCMediaParsedStatus)
*/
/**
* \returns a NSNumber
* Codec information
* \note returns a NSNumber
*/
extern NSString *const VLCMediaTracksInformationCodec;
/**
* \returns a NSNumber
* tracks information ID
* \note returns a NSNumber
*/
extern NSString *const VLCMediaTracksInformationId;
/**
* \returns a NSString
* track information type
* \note returns a NSString
* \see VLCMediaTracksInformationTypeAudio
* \see VLCMediaTracksInformationTypeVideo
* \see VLCMediaTracksInformationTypeText
......@@ -317,65 +320,79 @@ extern NSString *const VLCMediaTracksInformationId;
extern NSString *const VLCMediaTracksInformationType;
/**
* \returns a NSNumber
* codec profile
* \note returns a NSNumber
*/
extern NSString *const VLCMediaTracksInformationCodecProfile;
/**
* \returns a NSNumber
* codec level
* \note returns a NSNumber
*/
extern NSString *const VLCMediaTracksInformationCodecLevel;
/**
* \returns the bitrate as NSNumber
* track bitrate
* \note returns the bitrate as NSNumber
*/
extern NSString *const VLCMediaTracksInformationBitrate;
/**
* \returns the language as NSString
* track language
* \note returns the language as NSString
*/
extern NSString *const VLCMediaTracksInformationLanguage;
/**
* \returns the description as NSString
* track description
* \note returns the description as NSString
*/
extern NSString *const VLCMediaTracksInformationDescription;
/**
* \returns the audio channel number as NSNumber
* number of audio channels of a given track
* \note returns the audio channel number as NSNumber
*/
extern NSString *const VLCMediaTracksInformationAudioChannelsNumber;
/**
* \returns the audio rate as NSNumber
* audio rate
* \note returns the audio rate as NSNumber
*/
extern NSString *const VLCMediaTracksInformationAudioRate;
/**
* \returns the height as NSNumber
* video track height
* \note returns the height as NSNumber
*/
extern NSString *const VLCMediaTracksInformationVideoHeight;
/**
* \returns the width as NSNumber
* video track width
* \note the width as NSNumber
*/
extern NSString *const VLCMediaTracksInformationVideoWidth;
/**
* \returns the source aspect ratio as NSNumber
* source aspect ratio
* \note returns the source aspect ratio as NSNumber
*/
extern NSString *const VLCMediaTracksInformationSourceAspectRatio;
/**
* \returns the source aspect ratio denominator as NSNumber
* source aspect ratio denominator
* \note returns the source aspect ratio denominator as NSNumber
*/
extern NSString *const VLCMediaTracksInformationSourceAspectRatioDenominator;
/**
* \returns the frame rate as NSNumber
* frame rate
* \note returns the frame rate as NSNumber
*/
extern NSString *const VLCMediaTracksInformationFrameRate;
/**
* \returns the frame rate denominator as NSNumber
* frame rate denominator
* \note returns the frame rate denominator as NSNumber
*/
extern NSString *const VLCMediaTracksInformationFrameRateDenominator;
/**
* \returns the text encoding as NSString
* text encoding
* \note returns the text encoding as NSString
*/
extern NSString *const VLCMediaTracksInformationTextEncoding;
......@@ -454,7 +471,7 @@ typedef int VLCMediaParsingOptions;
/**
* triggers an asynchronous parse of the media item
* using the given options
* \param the option mask based on VLCMediaParsingOptions
* \param options the option mask based on VLCMediaParsingOptions
* \see VLCMediaParsingOptions
* \return an int. 0 on success, -1 in case of error
* \note listen to the "parsed" key value or the mediaDidFinishParsing:
......@@ -466,8 +483,8 @@ typedef int VLCMediaParsingOptions;
/**
* triggers an asynchronous parse of the media item
* using the given options
* \param the option mask based on VLCMediaParsingOptions
* \param a time-out value in milliseconds (-1 for default, 0 for infinite)
* \param options the option mask based on VLCMediaParsingOptions
* \param timeoutValue a time-out value in milliseconds (-1 for default, 0 for infinite)
* \see VLCMediaParsingOptions
* \return an int. 0 on success, -1 in case of error
* \note listen to the "parsed" key value or the mediaDidFinishParsing:
......
......@@ -59,8 +59,8 @@ extern NSString *const VLCMediaDiscovererCategory;
+ (NSArray *)availableMediaDiscoverer __attribute__((deprecated));
/**
* \param The VLCMediaDiscovererCategory you are looking for
* \return returns an array of dictionaries describing the available discoverers for the requested type
* \param categoryType VLCMediaDiscovererCategory you are looking for
* \return an array of dictionaries describing the available discoverers for the requested type
*/
+ (NSArray *)availableMediaDiscovererForCategoryType:(VLCMediaDiscovererCategoryType)categoryType;
......
......@@ -41,17 +41,17 @@ extern NSString *const VLCMediaListItemDeleted;
/**
* delegate method triggered when a media was added to the list
*
* \param the media list
* \param the media object that was added
* \param the index the media object was added at
* \param aMediaList the media list
* \param media the media object that was added
* \param index the index the media object was added at
*/
- (void)mediaList:(VLCMediaList *)aMediaList mediaAdded:(VLCMedia *)media atIndex:(NSInteger)index;
/**
* delegate method triggered when a media was removed from the list
*
* \param the media list
* \param the index a media item was deleted at
* \param aMediaList the media list
* \param index the index a media item was deleted at
*/
- (void)mediaList:(VLCMediaList *)aMediaList mediaRemovedAtIndex:(NSInteger)index;
@end
......@@ -77,7 +77,7 @@ extern NSString *const VLCMediaListItemDeleted;
/**
* add a media to a read-write list
*
* \param the media object to add
* \param media the media object to add
* \return the index of the newly added media
* \note this function silently fails if the list is read-only
*/
......@@ -86,8 +86,8 @@ extern NSString *const VLCMediaListItemDeleted;
/**
* add a media to a read-write list at a given position
*
* \param the media object to add
* \param the index where to add the given media
* \param media the media object to add
* \param index the index where to add the given media
* \note this function silently fails if the list is read-only
*/
- (void)insertMedia:(VLCMedia *)media atIndex:(NSInteger)index;
......@@ -95,7 +95,7 @@ extern NSString *const VLCMediaListItemDeleted;
/**
* remove a media from a given position
*
* \param the index of the media to remove
* \param index the index of the media to remove
* \note this function silently fails if the list is read-only
*/
- (void)removeMediaAtIndex:(NSInteger)index;
......@@ -103,7 +103,7 @@ extern NSString *const VLCMediaListItemDeleted;
/**
* retrieve a media from a given position
*
* \param the index of the media you want
* \param index the index of the media you want
* \return the media object
*/
- (VLCMedia *)mediaAtIndex:(NSInteger)index;
......@@ -111,14 +111,14 @@ extern NSString *const VLCMediaListItemDeleted;
/**
* retrieve the position of a media item
*
* \param the media object to search for
* \param media the media object to search for
* \return the index position of the media in the list or -1 if not found
*/
- (NSInteger)indexOfMedia:(VLCMedia *)media;
/* Properties */
/**
* number of media items in the list
* count number of media items in the list
* \return the number of media objects
*/
@property (readonly) NSInteger count;
......
......@@ -51,13 +51,13 @@ extern NSString *const VLCMediaPlayerChapterChanged;
*/
typedef NS_ENUM(NSInteger, VLCMediaPlayerState)
{
VLCMediaPlayerStateStopped, //< Player has stopped
VLCMediaPlayerStateOpening, //< Stream is opening
VLCMediaPlayerStateBuffering, //< Stream is buffering
VLCMediaPlayerStateEnded, //< Stream has ended
VLCMediaPlayerStateError, //< Player has generated an error
VLCMediaPlayerStatePlaying, //< Stream is playing
VLCMediaPlayerStatePaused //< Stream is paused
VLCMediaPlayerStateStopped, ///< Player has stopped
VLCMediaPlayerStateOpening, ///< Stream is opening
VLCMediaPlayerStateBuffering, ///< Stream is buffering
VLCMediaPlayerStateEnded, ///< Stream has ended
VLCMediaPlayerStateError, ///< Player has generated an error
VLCMediaPlayerStatePlaying, ///< Stream is playing
VLCMediaPlayerStatePaused ///< Stream is paused
};
/**
......@@ -157,7 +157,7 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
/**
* Set/Get current video aspect ratio.
*
* \param psz_aspect new video aspect-ratio or NULL to reset to default
* param: psz_aspect new video aspect-ratio or NULL to reset to default
* \note Invalid aspect ratios are ignored.
* \return the video aspect ratio or NULL if unspecified
* (the result must be released with free()).
......@@ -167,7 +167,7 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
/**
* Set/Get current crop filter geometry.
*
* \param psz_geometry new crop filter geometry (NULL to unset)
* param: psz_geometry new crop filter geometry (NULL to unset)
* \return the crop filter geometry or NULL if unset
*/
@property (NS_NONATOMIC_IOSONLY) char *videoCropGeometry;
......@@ -179,7 +179,7 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
* dimension. Zero is a special value; it will adjust the video to the output
* window/drawable (in windowed mode) or the entire screen.
*
* \param relative scale factor as float
* param: relative scale factor as float
*/
@property (nonatomic) float scaleFactor;
......@@ -193,7 +193,7 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
* \param width the snapshot's width
* \param height the snapshot's height
*/
- (void)saveVideoSnapshotAt: (NSString *)path withWidth:(int)width andHeight:(int)height;
- (void)saveVideoSnapshotAt:(NSString *)path withWidth:(int)width andHeight:(int)height;
/**
* Enable or disable deinterlace filter
......@@ -205,50 +205,49 @@ extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
/**
* Enable or disable adjust video filter (contrast, brightness, hue, saturation, gamma)
*
* \param bool value
* \return bool value
*/
@property (nonatomic) BOOL adjustFilterEnabled;
/**
* Set/Get the adjust filter's contrast value
*
* \param float value (range: 0-2, default: 1.0)
* \return float value (range: 0-2, default: 1.0)
*/
@property (nonatomic) float contrast;
/**
* Set/Get the adjust filter's brightness value
*
* \param float value (range: 0-2, default: 1.0)
* \return float value (range: 0-2, default: 1.0)
*/
@property (nonatomic) float brightness;
@property (nonatomic) float brightness;
/**
* Set/Get the adjust filter's hue value
*
* \param float value (range: -180-180, default: 0.)
* \return float value (range: -180-180, default: 0.)
*/
@property (nonatomic) float hue;
@property (nonatomic) float hue;
/**
* Set/Get the adjust filter's saturation value
*
* \param float value (range: 0-3, default: 1.0)
* \return float value (range: 0-3, default: 1.0)
*/
@property (nonatomic) float saturation;
@property (nonatomic) float saturation;
/**
* Set/Get the adjust filter's gamma value
*
* \param float value (range: 0-10, default: 1.0)
* \return float value (range: 0-10, default: 1.0)
*/
@property (nonatomic) float gamma;
@property (nonatomic) float gamma;
/**
* Get the requested movie play rate.
* @warning Depending on the underlying media, the requested rate may be
* different from the real playback rate. Due to limitations of some protocols
* this option may not be taken into account at all, if set.
* \param rate movie play rate to set
*
* \return movie play rate
*/
@property (nonatomic) float rate;
@property (nonatomic) float rate;
@property (nonatomic, readonly, weak) VLCAudio * audio;
......@@ -370,9 +369,9 @@ typedef NS_ENUM(unsigned, VLCMediaPlaybackSlaveType)
* Add additional input sources to a playing media item
* This way, you can add subtitles or audio files to an existing input stream
* For the user, it will appear as if they were part of the existing stream
* \param URL of the content to be added
* \param content type
* \param switch to the added accessory content
* \param slaveURL of the content to be added
* \param slaveType content type
* \param enforceSelection switch to the added accessory content
*/
- (int)addPlaybackSlave:(NSURL *)slaveURL type:(VLCMediaPlaybackSlaveType)slaveType enforce:(BOOL)enforceSelection;
......@@ -503,13 +502,13 @@ extern NSString *const VLCTitleDescriptionIsMenu;
/**
* Toggle equalizer state
* \param bool value to enable/disable the equalizer
* param: bool value to enable/disable the equalizer
* \return current state */
@property (readwrite) BOOL equalizerEnabled;
/**
* Set amplification level
* \param The supplied amplification value will be clamped to the -20.0 to +20.0 range.
* param: The supplied amplification value will be clamped to the -20.0 to +20.0 range.
* \note this will create and enabled an Equalizer instance if not present
* \return current amplification level */
@property (readwrite) CGFloat preAmplification;
......@@ -521,6 +520,7 @@ extern NSString *const VLCTitleDescriptionIsMenu;
/**
* frequency of equalizer band
* \param index the band index
* \return frequency of the requested equalizer band */
- (CGFloat)frequencyOfBandAtIndex:(unsigned)index;
......@@ -546,7 +546,7 @@ extern NSString *const VLCTitleDescriptionIsMenu;
#pragma mark playback operations
/**
* Plays a media resource using the currently selected media controller (or
* default controller. If feed was paused then the feed resumes at the position
* default controller. If feed was paused then the feed resumes at the position
* it was paused in.
*/
- (void)play;
......@@ -670,11 +670,11 @@ extern NSString *const VLCTitleDescriptionIsMenu;
* \return movie position as percentage between 0.0 and 1.0.
*/
@property (NS_NONATOMIC_IOSONLY) float position;
/**
* Set movie position. This has no effect if playback is not enabled.
* \param movie position as percentage between 0.0 and 1.0.
* \note movie position as percentage between 0.0 and 1.0.
*/
@property (NS_NONATOMIC_IOSONLY, getter=isSeekable, readonly) BOOL seekable;
@property (NS_NONATOMIC_IOSONLY, readonly) BOOL canPause;
......
......@@ -2,7 +2,7 @@
* VLCTime.h: VLCKit.framework VLCTime header
*****************************************************************************
* Copyright (C) 2007 Pierre d'Herbemont
* Copyright (C) 2007 VLC authors and VideoLAN
* Copyright (C) 2007-2016 VLC authors and VideoLAN
* $Id$
*
* Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
......@@ -39,7 +39,7 @@
- (instancetype)initWithInt:(int)aInt;
/* Properties */
@property (nonatomic, readonly) NSNumber * value; //< Holds, in milliseconds, the VLCTime value
@property (nonatomic, readonly) NSNumber * value; ///< Holds, in milliseconds, the VLCTime value
@property (readonly) NSNumber * numberValue; // here for backwards compatibility
@property (readonly) NSString * stringValue;
@property (readonly) NSString * verboseStringValue;
......
......@@ -30,9 +30,9 @@
*/
typedef enum
{
VLCNotification, //< Standard NSNotification.
VLCObjectMethodWithObjectArg, //< Method with an object argument.
VLCObjectMethodWithArrayArg //< Method with an array argument.
VLCNotification, ///< Standard NSNotification.
VLCObjectMethodWithObjectArg, ///< Method with an object argument.
VLCObjectMethodWithArrayArg ///< Method with an array argument.
} message_type_t;
/**
......@@ -40,11 +40,11 @@ typedef enum
*/
@interface message_t : NSObject
@property (nonatomic, strong) id target; //< Target object that should receive the message (retained until method is called).
@property (nonatomic) SEL sel; //< A selector that identifies the message to be sent to the target.
@property (nonatomic, copy) NSString * name; //< Name to be used for NSNotification
@property (nonatomic, strong) id object; //< Object argument to pass to the target via the selector.
@property (nonatomic) message_type_t type; //< Type of queued message.
@property (nonatomic, strong) id target; ///< Target object that should receive the message (retained until method is called).
@property (nonatomic) SEL sel; ///< A selector that identifies the message to be sent to the target.
@property (nonatomic, copy) NSString * name; ///< Name to be used for NSNotification
@property (nonatomic, strong) id object; ///< Object argument to pass to the target via the selector.
@property (nonatomic) message_type_t type; ///< Type of queued message.
@end
......@@ -70,12 +70,12 @@ typedef enum
@interface VLCEventManager ()
{
NSMutableArray *_messageQueue; //< Holds a queue of messages.
NSMutableArray *_pendingMessagesOnMainThread; //< Holds the message that are being posted on main thread.
NSMutableArray *_messageQueue; ///< Holds a queue of messages.
NSMutableArray *_pendingMessagesOnMainThread; ///< Holds the message that are being posted on main thread.
NSLock *_pendingMessagesLock;
pthread_t _dispatcherThread; //< Thread responsible for dispatching messages.
pthread_mutex_t _queueLock; //< Queue lock.
pthread_cond_t _signalData; //< Data lock.
pthread_t _dispatcherThread; ///< Thread responsible for dispatching messages.
pthread_mutex_t _queueLock; ///< Queue lock.
pthread_cond_t _signalData; ///< Data lock.
}
- (void)startEventLoop;
......@@ -194,7 +194,7 @@ static void * EventDispatcherMainLoop(void * user_data)
[newArg addObjectsFromArray:message_newer.object];
[_messageQueue removeObjectAtIndex:(NSUInteger) i];
}
/* It shouldn be a good idea not to collapse event with other kind of event in-between.
/* It shouldn't be a good idea not to collapse event with other kind of event in-between.
* This could be particulary problematic when the same object receive two related events
* (for instance Added and Removed).
* Ignore for now only if target is the same */
......
......@@ -68,11 +68,11 @@ NSString *const VLCMediaMetaChanged = @"VLCMediaMetaChanged";
*/
@interface VLCMedia()
{
void * p_md; //< Internal media descriptor instance
BOOL isArtFetched; //< Value used to determine of the artwork has been parsed
BOOL areOthersMetaFetched; //< Value used to determine of the other meta has been parsed
BOOL isArtURLFetched; //< Value used to determine of the other meta has been preparsed
NSMutableDictionary *_metaDictionary;
void * p_md; ///< Internal media descriptor instance
BOOL isArtFetched; ///< Value used to determine of the artwork has been parsed
BOOL areOthersMetaFetched; ///< Value used to determine of the other meta has been parsed
BOOL isArtURLFetched; ///< Value used to determine of the other meta has been preparsed
NSMutableDictionary *_metaDictionary; ///< Dictionary to cache metadata read from libvlc
}
/* Make our properties internally readwrite */
......