source/ics/inc/mh5streamer.h

Go to the documentation of this file.

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

/*---includes for this file--------------------------------------------------*/
#include "mh5base.h"
#include "mh5stream.h"
#include "mh5program.h"
#include "mherrors.h"

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

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

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

typedef enum
{
   MHEG5_STREAMER_EVENT_HTTP_HEADERS_DONE,
   MHEG5_STREAMER_EVENT_HTTP_DOWNLOAD_DONE,
   MHEG5_STREAMER_EVENT_MSP_DOWNLOAD_DONE,
   MHEG5_STREAMER_EVENT_TASK_STREAM_UNDERFLOW,
   MHEG5_STREAMER_EVENT_TASK_STREAM_UNDERFLOW_RESUME,
   MHEG5_STREAMER_EVENT_TASK_STREAM_PLAYING,
   MHEG5_STREAMER_EVENT_TASK_STREAM_STOPPED,
   MHEG5_STREAMER_EVENT_CONTENT_AVAILABLE,
   MHEG5_STREAMER_EVENT_COUNTER_TRIGGER
} MHEG5StreamerEventType;

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

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

E_MhegErr MHEG5StreamerOpen(void *buffer, U32BIT size, U32BIT taskPriority);

void MHEG5StreamerReset(void);


void MHEG5StreamerPrepare(MHEG5Stream *stream);


S32BIT MHEG5StreamerGetCounterPosition(MHEG5Stream *stream);


void MHEG5StreamerSetCounterPosition(MHEG5Stream *stream);


void MHEG5StreamerSetCounterEndPosition(MHEG5Stream *stream);


S32BIT MHEG5StreamerGetCounterMaxPosition(MHEG5Stream *stream);


void MHEG5StreamerSetCounterTrigger(MHEG5Stream *stream, S32BIT triggerId,
   S32BIT newValue);


S32BIT MHEG5StreamerGetCounterMaxPosition(MHEG5Stream *stream);


void MHEG5StreamerRun(MHEG5Stream *stream);


void MHEG5StreamerStop(MHEG5Stream *stream);


void MHEG5StreamerPause(MHEG5Stream *stream);


void MHEG5StreamerResume(MHEG5Stream *stream);


BOOLEAN MHEG5StreamerIsRunable(MHEG5Stream *stream);


void MHEG5StreamerRemove(MHEG5Stream *stream);


void MHEG5StreamerNotifyStreamStarted(MHEG5Stream *stream);


void MHEG5StreamerNotifyStreamStopped(MHEG5Stream *stream);

void MHEG5StreamerMeasurePerformance(MHEG5String *url, MHEG5Int maxBytes,
   MHEG5Program *program);


void MHEG5StreamerAbortMeasurement(MHEG5Program *program);


void MHEG5StreamerSetActiveState(BOOLEAN activeState);


void MHEG5StreamerClose(void);

void MHEG5streamerNotifyStreamingReady(void);


#endif /*_MH5STREAMER_H*/