include/dvb_pvr.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2012 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
 *******************************************************************************/
#ifndef _DVB_PVR_H
#define _DVB_PVR_H

#include "techtype.h"
#include "dtvstring.h"
#include "mherrors.h"

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

/*---Enumerations for public use-----------------------------------------------*/

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

/*************************************************
 *** start of AUSTRALIA profile specific types ***/
typedef struct
{
   U16BIT year;
   U8BIT month;
   U8BIT day;
} S_PVR_DATE;

typedef struct
{
   U8BIT hour;
   U8BIT minute;
} S_PVR_TIME;

typedef struct s_location
{
   S_DVB_LOCATOR dvb_loc;
   S_PVR_DATE date;
   S_PVR_TIME time;
   S_PVR_TIME offset;
   S_PVR_TIME duration;
} S_LOCATION;

typedef struct s_booking
{
   struct s_booking *next;
   U32BIT num_locs;
   S_LOCATION *p_locs;
} S_BOOKING;
/**** end of AUSTRALIA profile specific types ***
 ************************************************/

/* CRID details structure */
typedef struct
{
   /* general information */
   S32BIT type;
   S_STRING title;
   S_STRING description;

   /* for AUSTRALIA profile */
   S_BOOKING *bookings;      /* NULL, unless AUS profile */
} S_CRID_DETAILS;


/* CRID string - this has format:
 *    Scheme + Authority + Unique Identifier
 * and for NZ profile, this could additionally have
 *    '#' + Instance Identifier
 * Also, in the NZ profile CRID type is always supplied with the string.
 */
typedef struct s_crid_rec
{
   S_STRING crid;
   S32BIT type;
} S_CRID_REC;

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

E_MhegErr PVR_MakeBooking( S_STRING crid, S_CRID_DETAILS *details );


E_MhegErr PVR_CancelBooking( S_STRING crid, U16BIT crid_type );


S_CRID_REC* PVR_ListBookings( U16BIT *number );


void PVR_ReleaseList( S_CRID_REC *crid_array );


S_CRID_DETAILS* PVR_GetDetails( S_STRING crid );


void PVR_ReleaseDetails( S_CRID_DETAILS *details );

#endif /* _DVB_PVR_H */