source/classes/inc/mh5root.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * 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 _MH5ROOT_H
#define _MH5ROOT_H

/*---includes for this file--------------------------------------------------*/

#include "mh5base.h"

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

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

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

typedef struct sMHEG5Root
{
   /* No base class for this class */

   /* Exchanged attributes */
   MHEG5Int id;

   /* Internal attributes */
   MHEG5Bool runningStatus;
   MHEG5Bool availabilityStatus;

   /* Engine data */
   MHEG5Final clazz;

   MH5GroupPtr grp;
} MHEG5Root;

/*---Global variable declarations for public use-----------------------------*/

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

/*
    Constructor
 */
void MHEG5rootInit(MHEG5Root *root);


void MHEG5rootFree(MHEG5Root *root);


/*
    Clone
 */
void MHEG5rootClone(MHEG5Root *destination, MHEG5Root *source);


/*
    Internal behaviours
 */
void MHEG5rootPrepare(MHEG5Root *root);


void MHEG5rootActivate(MHEG5Root *root);


void MHEG5rootDeactivate(MHEG5Root *root);


void MHEG5rootDestruct(MHEG5Root *root);

/*
    Actions
 */
MHEG5ErrorCode MHEG5getAvailabilityStatus(MHEG5Root *target, MHEG5GList *params);


MHEG5ErrorCode MHEG5getRunningStatus(MHEG5Root *target, MHEG5GList *params);


/*
   Debug
 */
#ifdef MH5PRINTOUT

void MHEG5rootPrint(MHEG5Root *root, char *out);
#endif  /* #ifdef MH5PRINTOUT */

#endif /*_MH5ROOT_H*/