collection.h

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2013 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
// pre-processor mechanism so multiple inclusions don't cause compilation error
#ifndef _COLLECTION_H
#define _COLLECTION_H

#include "npapi.h"
#include "npfunctions.h"
#include "plugin.h"

//---Constant and macro definitions for public use-----------------------------


//---Enumerations for public use-----------------------------------------------
typedef enum
{
   COLLECTION_STRING, /* Returns objects of type HBBTV_JSObjType_String */
   COLLECTION_CHANNELLIST, /* Returns objects of type HBBTV_JSObjType_Channel */
   COLLECTION_PROGRAMME, /* Returns objects of type HBBTV_JSObjType_Programme */
   COLLECTION_AVCOMPONENT, /* Returns objects of type HBBTV_JSObjType_AVComponent */
   COLLECTION_PARENTALRATING, /* Returns objects of type HBBTV_JSObjType_ParentalRating */
   COLLECTION_PARENTALRATINGSCHEME, /* Returns objects of type HBBTV_JSObjType_ParentalRatingScheme */
   COLLECTION_SCHEDULEDRECORDING, /* Returns objects of type HBBTV_JSObjType_ScheduledRecording */
   COLLECTION_NETWORKINTERFACE, /* Returns objects of type HBBTV_JSObjType_NetworkInterface */
   COLLECTION_COLLECTION, /* Returns objects of type HBBTV_JSObjType_Collection */
   COLLECTION_SEARCHRESULTS, /* Returns objects of type HBBTV_JSObjType_Programme */
   COLLECTION_MAX /* Not valid */
} S_COLLECTION_TYPE;


//---Global type defs for public use-------------------------------------------

//---Global Function prototypes for public use---------------------------------

NPObject* CollectionCreate(NPP instance, void *handle, S_COLLECTION_TYPE type);

#endif /*_COLLECTION_H*/