dsm_control.h File Reference

DSM-CC API functions to control DSM-CC instance. More...

#include "siqfuncs.h"
#include "dmxtypes.h"
#include "dsm_types.h"
#include "stdfuncs.h"

Go to the source code of this file.

Data Structures
struct	s_DsmccConfig

Typedefs
typedef void(*	F_CarouselLoad )(H_ObjCarousel hOC, E_OCLoadStatus result, U32BIT carouselId)
typedef struct s_DsmccConfig	S_DsmccConfig

Functions
H_DsmControl	DSMCC_Open (S_DsmccConfig *config)
	Open DSM-CC and create controling instance. More...
void	DSMCC_Close (H_DsmControl instance)
	Close DSM-CC controling instance, and destroy all resources. More...
BOOLEAN	DSMCC_Start (H_DsmControl instance, S_DvbLocator *locator, U32BIT boot_carousel_id, DMXREF dmxref)
	Start DSM-CC controling instance. This will start search for boot carousel on service specified by locator. More...
void	DSMCC_Stop (H_DsmControl instance, E_DsmRstMode mode)
	Stop DSM-CC controling instance. Causes all carousels to unload. More...
void	DSMCC_Reboot (H_DsmControl instance)
	Reboot DSM-CC controling instance. Causes all carousels to unload and initiate search for boot carousel. More...
H_ObjCarousel	DSMCC_CurrentCarousel (H_DsmControl dsmctrl)
	Get currently loaded carousel handle. More...
U32BIT	DSMCC_CurrentCarouselId (H_DsmControl dsmctrl)
	Get currently loaded carousel ID. More...
BOOLEAN	DSMCC_SetCurrentCarousel (H_DsmControl dsmctrl, H_ObjCarousel hOC)
	Set current carousel. This does not unload any previously loaded carousels. More...
void	DSMCC_UnloadCarousel (H_DsmControl dsmctrl, H_ObjCarousel hOC, E_DsmRstMode mode)
	Unload specified Carousel. More...
void	DSMCC_SiqCacheClearPmt (H_DsmControl dsmctrl, U16BIT serviceId)
	Clear cached PMT for particular service. More...

Detailed Description

DSM-CC API functions to control DSM-CC instance.

Date

23/01/2013

Author

Adam Sturtridge

Function Documentation

void DSMCC_Close

(

H_DsmControl

dsmctrl

)

Close DSM-CC controling instance, and destroy all resources.

Parameters

dsmctrl

DSM control instance handle

Returns

void

Parameters

H_DsmControl

dsmctrl DSM control instance handle

Returns

void

H_ObjCarousel DSMCC_CurrentCarousel

(

H_DsmControl

dsmctrl

)

Get currently loaded carousel handle.

Parameters

dsmctrl

DSM control instance handle

Returns

carousel handle - NULL if none loaded

Parameters

H_DsmControl

dsmctrl DSM control instance handle

Returns

H_ObjCarousel carousel handle - NULL if none loaded

U32BIT DSMCC_CurrentCarouselId

(

H_DsmControl

dsmctrl

)

Get currently loaded carousel ID.

Parameters

dsmctrl

DSM control instance handle

Returns

carousel id - INVALID_CAROUSEL_ID if none loaded

Parameters

H_DsmControl

dsmctrl DSM control instance handle

Returns

U32BIT carousel id - INVALID_CAROUSEL_ID if none loaded

H_DsmControl DSMCC_Open

(

S_DsmccConfig *

config

)

Open DSM-CC and create controling instance.

Parameters

config

Configuration of control instance.

Returns

void

Parameters

S_DsmccConfig

*config Configuration of control instance.

Returns

void

void DSMCC_Reboot

(

H_DsmControl

dsmctrl

)

Reboot DSM-CC controling instance. Causes all carousels to unload and initiate search for boot carousel.

Parameters

instance

DSM control instance handle

Returns

void

Parameters

H_DsmControl

instance DSM control instance handle

Returns

void

BOOLEAN DSMCC_SetCurrentCarousel	(	H_DsmControl	dsmctrl,
		H_ObjCarousel	hOC
	)

Set current carousel. This does not unload any previously loaded carousels.

Parameters

dsmctrl	DSM control instance handle
hOC	Handle to carousel

Returns

BOOLEAN - TRUE if success (i.e. had valid carousel handle)

Parameters

H_DsmControl	dsmctrl DSM control instance handle
H_ObjCarousel	hOC Handle to carousel

Returns

BOOLEAN - TRUE if success (i.e. had valid carousel handle)

void DSMCC_SiqCacheClearPmt	(	H_DsmControl	dsmctrl,
		U16BIT	serviceId
	)

Clear cached PMT for particular service.

Parameters

dsmctrl	DSM control instance handle.
serviceId	Service whose PMT needs to be cleared

Returns

void

Parameters

H_DsmControl	dsmctrl DSM control instance handle.
U16BIT	serviceId Service whose PMT needs to be cleared

Returns

void

BOOLEAN DSMCC_Start	(	H_DsmControl	dsmctrl,
		S_DvbLocator *	locator,
		U32BIT	boot_carousel_id,
		DMXREF	dmxref
	)

Start DSM-CC controling instance. This will start search for boot carousel on service specified by locator.

Parameters

instance	DSM control instance handle
locator	DVB location of service.
boot_carousel_id	carousel id. When set to invalid, DSM-CC will attempt to start on carousel specified by recognised data broadcast id descriptor.
DMXREF	dmxref demux reference to be used in section filter API

Returns

BOOLEAN - TRUE if success

Parameters

H_DsmControl	instance DSM control instance handle
S_DvbLocator	*locator DVB location of service.
U32BIT	boot_carousel_id carousel id. When set to invalid, DSM-CC will attempt to start on carousel specified by recognised data broadcast id descriptor.
DMXREF	dmxref demux reference to be used in section filter API

Returns

BOOLEAN - TRUE if success

void DSMCC_Stop	(	H_DsmControl	dsmctrl,
		E_DsmRstMode	mode
	)

Stop DSM-CC controling instance. Causes all carousels to unload.

Parameters

dsmctrl	DSM control instance handle
mode	Mode of operation when unloading

Returns

void

Parameters

H_DsmControl	dsmctrl DSM control instance handle
E_DsmRstMode	mode Mode of operation when unloading

Returns

void

void DSMCC_UnloadCarousel	(	H_DsmControl	dsmctrl,
		H_ObjCarousel	hOC,
		E_DsmRstMode	mode
	)

Unload specified Carousel.

Parameters

dsmctrl	DSM control instance handle
hOC	Handle to carousel
mode	Mode of operation when unloading

Returns

void

Parameters

H_DsmControl	dsmctrl DSM control instance handle
H_ObjCarousel	hOC Handle to carousel
E_DsmRstMode	mode Mode of operation when unloading

Returns

void