/***************************************************************************
 *     Copyright (c) 2003-2006, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * $brcm_Workfile:  $
 * $brcm_Revision:  $
 * $brcm_Date: $
 *
 * Module Description:
 *
 * Revision History:
 *
 * $brcm_Log:  $
 *
 ***************************************************************************/

#ifndef BSETTOP_H__
#define BSETTOP_H__

#include "bsettop_types.h"
#include "bsettop_pcm.h"
#include "bsettop_stream.h"
#include "bsettop_decode.h"
#include "bsettop_display.h"
#include "bsettop_graphics.h"
#include "bsettop_user_io.h"
#include "bsettop_decode_audio.h"

/*=********************************
Universal include file for the Settop API.

In order to call any function from the Settop API from your application,
you should include this and only this file.
***********************************/


#ifdef __cplusplus
extern "C"
{
#endif

/*
Summary:
	Use the BSETTOP_VERSION macro and ignore this type.
*/
typedef unsigned bsettop_version;

/*
Summary: 
	Version macro which must be passed to bsettop_init().
*/
#define BSETTOP_VERSION ((bsettop_version)0x0038)

/*
Summary:
	Initializes the settop API.

Description:
	Required before any other call. If you don't call it, some key functions will fail;
	others will succeed but will result in undefined behavior.

	Use the BSETTOP_VERSION macro to pass the correct version. This verifies
	at run-time that the correct shared library is being used.
*/
	
bresult bsettop_init(bsettop_version version);


/*
Summary:
	Releases resources

Description:
	This function is used to release resources allocated during bsettop_init.
	User should call this function before exit from an application.
*/

void bsettop_uninit(void);


/*
Summary:
	Perform periodic power monitoring functions
*/

void bsettop_pvt(void);

#ifdef __cplusplus
}
#endif

#endif /* BSETTOP_H__ */