mheg5_keypress.h

Go to the documentation of this file.

/*******************************************************************************
 * 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
 *******************************************************************************/
#ifndef _MHEG5_KEYPRESS_H
#define _MHEG5_KEYPRESS_H

#include "techtype.h"

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

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

/* User interface key presses given to MHEG5 engine */
typedef enum
{
   MHEG5_KEY_UP,
   MHEG5_KEY_DOWN,
   MHEG5_KEY_LEFT,
   MHEG5_KEY_RIGHT,
   MHEG5_KEY_0,
   MHEG5_KEY_1,
   MHEG5_KEY_2,
   MHEG5_KEY_3,
   MHEG5_KEY_4,
   MHEG5_KEY_5,
   MHEG5_KEY_6,
   MHEG5_KEY_7,
   MHEG5_KEY_8,
   MHEG5_KEY_9,
   MHEG5_KEY_SELECT,
   MHEG5_KEY_CANCEL,
   MHEG5_KEY_HELP,
   MHEG5_KEY_RED,
   MHEG5_KEY_GREEN,
   MHEG5_KEY_YELLOW,
   MHEG5_KEY_BLUE,
   MHEG5_KEY_TEXT,
   MHEG5_KEY_INFO,
   MHEG5_KEY_EPG,
   MHEG5_KEY_STOP,
   MHEG5_KEY_PLAY,
   MHEG5_KEY_PAUSE,
   MHEG5_KEY_SKIP_FWD,
   MHEG5_KEY_SKIP_BACK,
   MHEG5_KEY_FAST_FWD,
   MHEG5_KEY_REWIND,
   MHEG5_KEY_PLAY_PAUSE,
   MHEG5_KEY_RECORD,

   /* Last item is not a real key and should not be passed as a key press
    * It is only useful as definitive value for total number of keys */
   TOTAL_MHEG5_KEYS
} E_MHEG5_KEY;

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

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

BOOLEAN MHEG5_IsKeyNeeded( E_MHEG5_KEY key );

BOOLEAN MHEG5_NotifyKeyPress( E_MHEG5_KEY key );

BOOLEAN MHEG5_IsPromotionalLinkingEnabled(void);

BOOLEAN DVB_MhegIsKeySupported( E_MHEG5_KEY key );

#endif // _MHEG5_KEYPRESS_H