stbdsapi.h File Reference

Header file - Function prototypes for DVB subtitles api. More...

#include "techtype.h"

Go to the source code of this file.

Functions
void	STB_SUBEnable (U8BIT path, BOOLEAN enable)
	Enables or disables subtitling display. More...
void	STB_SUBStart (U8BIT path, U16BIT pid, U16BIT composition_id, U16BIT ancillary_id)
	Starts subtitling display. More...
void	STB_SUBStop (U8BIT path)
	Stops subtitling display.
void	STB_SUBSetStream (U8BIT path, U16BIT pid, U16BIT composition_id, U16BIT ancillary_id)
	Sets the stream IDs to be decoded. More...
void	STB_SUBStatus (BOOLEAN *started, BOOLEAN *shown)
	returns the current status information More...
void	STB_SUBReadSettings (BOOLEAN *running, U16BIT *pid, U16BIT *comp_id, U16BIT *anc_id, BOOLEAN *enabled)
	returns the current status information More...

Detailed Description

Header file - Function prototypes for DVB subtitles api.

Date

27/02/2004

Author

Ocean Blue

Function Documentation

void STB_SUBEnable	(	U8BIT	path,
		BOOLEAN	enable
	)

Enables or disables subtitling display.

Parameters

BOOLEAN

enable - TRUE to enable display

void STB_SUBReadSettings	(	BOOLEAN *	started,
		U16BIT *	pid,
		U16BIT *	comp_id,
		U16BIT *	anc_id,
		BOOLEAN *	enabled
	)

returns the current status information

Parameters

started	- returns TRUE if subtitles are decoding, FALSE otherwise
pid	- returns the pid in use. Not valid if running is FALSE
comp_id	- returns the comp page id. Not valid if running is FALSE
anc_id	- returns the ancillary page id. Not valid if running is FALSE
enabled	- returns TRUE if subtitle display is enabled, FALSE otherwise

void STB_SUBSetStream	(	U8BIT	path,
		U16BIT	pid,
		U16BIT	composition_id,
		U16BIT	ancillary_id
	)

Sets the stream IDs to be decoded.

EN 300 468 version 1.3.1 clause 6.2.30 Subtitling descriptor The values in the ancillary_page_id and the composition_page_id fields shall be the same if no ancillary page is provided.

Parameters

U16BIT	pid - The PID of the subtitle data
U16BIT	composition_id - The ID of the composition page
U16BIT	ancillary_id - The ID of the ancillary page

void STB_SUBStart	(	U8BIT	path,
		U16BIT	pid,
		U16BIT	composition_id,
		U16BIT	ancillary_id
	)

Starts subtitling display.

Parameters

U16BIT	pid - The PID of the subtitle data
U16BIT	composition_id - The ID of the composition page
U16BIT	ancillary_id - The ID of the ancillary page

void STB_SUBStatus	(	BOOLEAN *	started,
		BOOLEAN *	shown
	)

returns the current status information

Parameters