hbbtv_sif_mediaplayer.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
 *******************************************************************************/
/* pre-processor mechanism so multiple inclusions don't cause compilation error*/

#ifndef _HBBTV_SIF_MEDIAPLAYER_H

#define _HBBTV_SIF_MEDIAPLAYER_H

#include "techtype.h"
#include "hbbtv_types.h"


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

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

typedef enum
{
   HBBTV_MP_NO_ERROR = -1,              /* no error */
   HBBTV_MP_FORMAT_NOT_SUPPORTED = 0,   /* 0 - A/V format not supported */
   HBBTV_MP_CONNECTION_ERROR,           /* 1 - cannot connect to server or connection lost.*/
   HBBTV_MP_UNDEFINED,                  /* 2 - unidentified error */
   HBBTV_MP_NO_RESOURCES,               /* 3 – insufficient resources */
   HBBTV_MP_CORRUPT,                    /* 4 – content corrupt or invalid */
   HBBTV_MP_NOT_AVAILABLE,              /* 5 – content not available */
   HBBTV_MP_NOT_AVAILABLE_POSITION,     /* 6 – content not available at given position */
   HBBTV_MP_BLOCKED                     /* 7 - content blocked due to parental control */
} E_HBBTV_MP_ERROR;


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

typedef struct
{
   /* If TRUE, the media player is supposed to load the file and play it from memory */
   BOOLEAN cache;
   /* Number of times the file has to be played, -1 means infinite */
   S32BIT loops;
} S_HBBTV_MP_START_PARAMS;


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

#if defined(__cplusplus)
extern "C" {
#endif


void* HBBTV_MPInit(U8BIT *source_url);

void HBBTV_MPExit(void *ihdl);

E_HBBTV_ERR HBBTV_MPStart(void *ihdl, S_HBBTV_MP_START_PARAMS *params);

E_HBBTV_ERR HBBTV_MPStop(void *ihdl);

E_HBBTV_ERR HBBTV_MPPause(void *ihdl);

E_HBBTV_ERR HBBTV_MPResume(void *ihdl);

E_HBBTV_ERR HBBTV_MPResize(void *ihdl, S_HBBTV_RECT *rect);

E_HBBTV_ERR HBBTV_MPGetTimes(void *ihdl, U32BIT *begin, U32BIT *current, U32BIT *end);

E_HBBTV_ERR HBBTV_MPSeek(void *ihdl, U32BIT position);

E_HBBTV_ERR HBBTV_MPObtainComponentList(void *ihdl, E_HBBTV_COMPONENT_TYPE type, U32BIT *num_ptr,
   S_HBBTV_COMPONENT_DETAILS **list_ptr);

void HBBTV_MPReleaseComponentList(void *ihdl, S_HBBTV_COMPONENT_DETAILS *list_ptr);

E_HBBTV_ERR HBBTV_MPSelectComponent(void *ihdl, S_HBBTV_COMPONENT_DETAILS *component);

E_HBBTV_ERR HBBTV_MPUnselectComponent(void *ihdl, S_HBBTV_COMPONENT_DETAILS *component);

E_HBBTV_MP_ERROR HBBTV_MPGetError(void *ihdl);

#if defined(__cplusplus)
}
#endif

#endif /* _HBBTV_SIF_MEDIAPLAYER_H */