git.sesse.net Git - vlc/blob - projects/macosx/framework/Headers/Public/VLCMediaDiscoverer.h

   1 /*****************************************************************************
   2  * VLCMediaDiscoverer.h: VLCKit.framework VLCMediaDiscoverer header
   3  *****************************************************************************
   4  * Copyright (C) 2007 Pierre d'Herbemont
   5  * Copyright (C) 2007 the VideoLAN team
   6  * $Id$
   7  *
   8  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 #import <Foundation/Foundation.h>
  26 #import "VLCMediaList.h"
  27
  28 @class VLCMediaList;
  29
  30 /**
  31  * TODO: Documentation VLCMediaDiscoverer
  32  */
  33 @interface VLCMediaDiscoverer : NSObject
  34 {
  35     NSString * localizedName;       //< TODO: Documentation VLCMediaDiscoverer.localizedName
  36     VLCMediaList * discoveredMedia; //< TODO: Documentation VLCMediaDiscoverer.discoveredMedia
  37     void * mdis;                    //< TODO: Documentation VLCMediaDiscoverer.mdis
  38     BOOL running;                   //< TODO: Documentation VLCMediaDiscoverer.running
  39 }
  40
  41 /**
  42  * Maintains a list of available media discoverers.  This list is populated as new media
  43  * discoverers are created.
  44  * \return A list of available media discoverers.
  45  */
  46 + (NSArray *)availableMediaDiscoverer;
  47
  48 /* Initializers */
  49 /**
  50  * Initializes new object with specified name.
  51  * \param aSerchName Name of the service for this VLCMediaDiscoverer object.
  52  * \returns Newly created media discoverer.
  53  */
  54 - (id)initWithName:(NSString *)aServiceName;
  55
  56 /**
  57  * TODO: Documentation VLCMediaDiscoverer.discoveredMedia
  58  */
  59 @property (readonly) VLCMediaList * discoveredMedia;
  60
  61 /**
  62  * TODO: Documentation VLCMediaDiscoverer.localizedName
  63  */
  64 @property (readonly) NSString * localizedName;
  65
  66 /**
  67  * TODO: Documentation VLCMediaDiscoverer.isRunning
  68  */
  69 @property (readonly) BOOL isRunning;
  70 @end