mheg5_events.h

Go to the documentation of this file.

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

#include "techtype.h"
#include "dvbevents.h"

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

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

typedef enum
{
   KS_RED = 0x1,
   KS_GREEN = 0x2,
   KS_YELLOW = 0x4,
   KS_BLUE = 0x8,
   KS_NAVIGATION = 0x10,
   KS_VCR = 0x20,
   KS_SCROLL = 0x40,
   KS_INFO = 0x80,
   KS_NUMERIC = 0x100,
   KS_ALPHA = 0x200,
   KS_OTHER = 0x400
} E_KeySet;

/* Events generated by MHEG5 engine and passed to receiver */
typedef enum
{
   /* Engine sucessfully started an MHEG5 application from DSM-CC. */
   MHEG_EVENT_DSM_APPLICATION_STARTED,

   /* The currently running application has stopped running and there
    * are no other applications on the application stack. If this event is
    * generated as a result of an application Quit action, the component will
    * start trying to load the autoboot application for the selected service.
    */
   MHEG_EVENT_DSM_APPLICATION_STOPPED,

   MHEG_EVENT_DSM_APPLICATION_START_FAILED,

   /* MHEG5 CI application started successfully. */
   MHEG_EVENT_CI_APPLICATION_STARTED,

   /* MHEG5 CI application has stopped, either as a result of an external request,
    * or as the result of application terminating for any other reason.
    */
   MHEG_EVENT_CI_APPLICATION_STOPPED,

   /* Attempted CI module start application failed. */
   MHEG_EVENT_CI_APPLICATION_START_FAILED,

   /* The data associated with this event is defined by E_KeySet. This is
    * consistant with keyset values used within HbbTv */
   MHEG_EVENT_KEYSET_CHANGE,

   MHEG_EVENT_STATE_PAUSED,
   MHEG_EVENT_STATE_RESUME,

} E_MhegEvent;


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

typedef void (*F_NotifyMhegEvent)( E_MhegEvent event, U32BIT data );

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

BOOLEAN MHEG5_DvbRegisterEventHandler( F_NotifyMhegEvent handler );
void MHEG5_DvbUnregisterEventHandler( F_NotifyMhegEvent handler );

E_MhegErr MHEG5_NotifyDvbEvent( E_DvbEvent eType, U32BIT eData );


#endif /* _MHEG5_EVENTS_H */