hbbtv_sif_pvr.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_PVR_H

#define _HBBTV_SIF_PVR_H

#include "hbbtv_sif_service.h"


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

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

typedef enum
{
   HBBTV_RECPLAYER_NO_ERROR = -1,              /* no error */
   HBBTV_RECPLAYER_FORMAT_NOT_SUPPORTED = 0,   /* 0 - A/V format not supported */
   HBBTV_RECPLAYER_UNDEFINED = 2,              /* 2 - unidentified error */
   HBBTV_RECPLAYER_NO_RESOURCES,               /* 3 – insufficient resources */
   HBBTV_RECPLAYER_CORRUPT,                    /* 4 – content corrupt or invalid */
   HBBTV_RECPLAYER_NOT_AVAILABLE,              /* 5 – content not available */
   HBBTV_RECPLAYER_NOT_AVAILABLE_POSITION,     /* 6 – content not available at given position */
   HBBTV_RECPLAYER_BLOCKED                     /* 7 - content blocked due to parental control */
} E_HBBTV_RECPLAYER_ERROR;


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

typedef struct
{
   U32BIT timer_id;
   U32BIT start_time;
   U32BIT duration;
   S_HBBTV_STRING description;
   S_HBBTV_STRING name;
   U32BIT parental_rating;
   U16BIT lcn;
   S32BIT start_padding;
   S32BIT end_padding;
} S_HBBTV_SCHEDULED_RECORDING_DETAILS;

typedef struct
{
   U32BIT recording_id;
   U32BIT recording_start_time;
   U32BIT recording_duration;
   BOOLEAN in_progress;
   U32BIT sched_start_time;
   U32BIT sched_duration;
   S_HBBTV_STRING description;
   S_HBBTV_STRING name;
   U32BIT parental_rating;
   U16BIT lcn;
   S32BIT start_padding;
   S32BIT end_padding;
} S_HBBTV_RECORDING_DETAILS;


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

E_HBBTV_ERR HBBTV_PVRRecordCRID(S_HBBTV_STRING *crid, S_HBBTV_STRING *fqdn, U16BIT *service_lcn,
   U32BIT *id);

E_HBBTV_ERR HBBTV_PVRRecordEventID(U16BIT event_id, U16BIT service_lcn, S_HBBTV_STRING *fqdn, 
   U32BIT *id);

E_HBBTV_ERR HBBTV_PVRRecordAt(U16BIT service_lcn, U32BIT start_time, U32BIT duration,
   U8BIT repeat_days, S_HBBTV_STRING *fqdn, S_HBBTV_EVENT_DETAILS *details, U32BIT *id);

E_HBBTV_ERR HBBTV_PVRGetRecordingId(U32BIT scheduled_recording_id, U32BIT *recording_id);

E_HBBTV_ERR HBBTV_PVRStopRecording(U32BIT recording_id);

E_HBBTV_ERR HBBTV_PVRSetScheduledRecordingName(U32BIT id, S_HBBTV_STRING *name);

E_HBBTV_ERR HBBTV_PVRSetScheduledRecordingDescription(U32BIT id, S_HBBTV_STRING *description);

E_HBBTV_ERR HBBTV_PVRGetScheduledRecordingDetails(U32BIT id, 
   S_HBBTV_SCHEDULED_RECORDING_DETAILS *details);

void HBBTV_PVRReleaseScheduledRecordingDetails(S_HBBTV_SCHEDULED_RECORDING_DETAILS *details);

E_HBBTV_ERR HBBTV_PVRGetScheduledRecordingList(S_HBBTV_STRING *fqdn, U32BIT *num_ptr,
   S_HBBTV_SCHEDULED_RECORDING_DETAILS **list_ptr);

void HBBTV_PVRReleaseScheduledRecordingList(U32BIT num, S_HBBTV_SCHEDULED_RECORDING_DETAILS *list);

E_HBBTV_ERR HBBTV_PVRRemoveScheduledRecording(U32BIT id, S_HBBTV_STRING *fqdn);

E_HBBTV_ERR HBBTV_PVRSetScheduledRecordingStartPadding(U32BIT id, S32BIT start_padding);

E_HBBTV_ERR HBBTV_PVRSetScheduledRecordingEndPadding(U32BIT id, S32BIT end_padding);

E_HBBTV_ERR HBBTV_PVRGetRecordingDetails(U32BIT id, S_HBBTV_RECORDING_DETAILS *details);

void HBBTV_PVRReleaseRecordingDetails(S_HBBTV_RECORDING_DETAILS *details);

E_HBBTV_ERR HBBTV_PVRGetRecordingList(S_HBBTV_STRING *fqdn, U32BIT *num_ptr,
   S_HBBTV_RECORDING_DETAILS **list_ptr);

void HBBTV_PVRReleaseRecordingList(U32BIT num, S_HBBTV_RECORDING_DETAILS *list);

E_HBBTV_ERR HBBTV_PVRPlayInit(U32BIT recording_id, void **handle);

E_HBBTV_ERR HBBTV_PVRPlayExit(void *handle);

E_HBBTV_ERR HBBTV_PVRPlayStart(void *handle);

E_HBBTV_ERR HBBTV_PVRPlayStop(void *handle);

E_HBBTV_ERR HBBTV_PVRPlayPause(void *handle);

E_HBBTV_ERR HBBTV_PVRPlayResume(void *handle);

E_HBBTV_ERR HBBTV_PVRPlaySeek(void *handle, U32BIT position);

E_HBBTV_ERR HBBTV_PVRPlayGetPosition(void *handle, U32BIT *position);

E_HBBTV_ERR HBBTV_PVRPlayGetLength(void *handle, U32BIT *length);

E_HBBTV_ERR HBBTV_PVRPlayGetComponentList(void *handle, E_HBBTV_COMPONENT_TYPE type,
   U32BIT *num_ptr,
   S_HBBTV_COMPONENT_DETAILS **list_ptr);

void HBBTV_PVRPlayReleaseComponentList(void *handle, S_HBBTV_COMPONENT_DETAILS *list_ptr);

E_HBBTV_ERR HBBTV_PVRPlaySelectComponent(void *handle,
   S_HBBTV_COMPONENT_DETAILS *component);

E_HBBTV_ERR HBBTV_PVRPlayUnselectComponent(void *handle,
   S_HBBTV_COMPONENT_DETAILS *component);

E_HBBTV_ERR HBBTV_PVRPlaySetRectangle(void *handle, S_HBBTV_RECT *rect);

E_HBBTV_RECPLAYER_ERROR HBBTV_PVRPlayGetError(void *handle);

BOOLEAN HBBTV_PVRIsStorageDeviceAvailable(void);

void HBBTV_PVRRecordingStarted(U32BIT timer);

#endif /* _HBBTV_SIF_PVR_H */