ap_ci.h

Go to the documentation of this file.

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

#include "techtype.h"

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


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

/* Replies for starting an operator profile search */

typedef enum {
  CIP_START_OPERATOR_SEARCH_NO,
  CIP_START_OPERATOR_SEARCH_YES,
  CIP_START_OPERATOR_SEARCH_ASK
} E_CIP_START_OPERATOR_SEARCH;

typedef enum {
   CIP_NORMAL_TUNE,
   CIP_QUIET_TUNE,
   CIP_KEEP_APP_RUNING,
   CIP_QUIET_KEEP_APP
} E_CIP_TUNE_FLAGS;

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

typedef void (*F_NotifyStartTuning)(U32BIT module, U16BIT onet_id, U16BIT trans_id, U16BIT serv_id, E_CIP_TUNE_FLAGS flags);

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

U8BIT ACI_GetCamUpgradeMode(void);

void ACI_SetCamUpgradeMode(U8BIT upgrade_mode);

E_CIP_START_OPERATOR_SEARCH ACI_GetOperatorSearchMode(void);

void ACI_SetOperatorSearchMode(E_CIP_START_OPERATOR_SEARCH search_mode);

void ACI_OperatorSearchRequired(U32BIT module, BOOLEAN required);

void ACI_ScheduleOperatorSearch(U32BIT cicam_id, U16BIT date, U8BIT hour, U8BIT min);

BOOLEAN ACI_IsOperatorSearchRequired(void);

U32BIT ACI_GetOperatorSearchModule(void);

BOOLEAN ACI_GetFirstOperatorSearchModule(U32BIT *module);

BOOLEAN ACI_GetFirstScheduledOperatorSearch(U32BIT *module, U16BIT *date, U8BIT *hours, U8BIT *mins);

BOOLEAN ACI_StartOperatorSearchForModule(U32BIT module);

BOOLEAN ACI_AcquireCISlot(U8BIT path, void *s_ptr);

BOOLEAN ACI_AcquireCISlotForRecording(U8BIT path, void* s_ptr);

U8BIT ACI_FindCISlotForService(void *serv_ptr);

S32BIT ACI_ReadPinForSlot(U8BIT slot_id);

BOOLEAN ACI_WritePinForSlot(U8BIT slot_id, S32BIT pin);

BOOLEAN ACI_SendPinToCam(U8BIT slot_id, U32BIT pin);

void ACI_RegisterStartTuneNotifyCallback(F_NotifyStartTuning cb_func);

#endif