DVBCore  17.9.0
Open Source DVB Engine
 All Data Structures Files Functions Typedefs Macros Pages
stbdsapi.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2004 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
26 // pre-processor mechanism so multiple inclusions don't cause compilation error
27 
28 #ifndef _STBDSAPI_H
29 #define _STBDSAPI_H
30 
31 #include "techtype.h"
32 
33 //---Constant and macro definitions for public use-----------------------------
34 
35 //---Enumerations for public use-----------------------------------------------
36 
37 //---Global type defs for public use-------------------------------------------
38 
39 //---Global Function prototypes for public use---------------------------------
40 
41 // From the file stbdsc.c
42 // DVB subtitle functions
43 void STB_SUBEnable(U8BIT path, BOOLEAN enable);
44 void STB_SUBStart(U8BIT path, U16BIT pid, U16BIT composition_id, U16BIT ancillary_id);
45 void STB_SUBStop(U8BIT path);
46 void STB_SUBSetStream(U8BIT path, U16BIT pid, U16BIT composition_id, U16BIT ancillary_id);
47 void STB_SUBStatus(BOOLEAN *started, BOOLEAN *shown);
48 void STB_SUBReadSettings(BOOLEAN *running, U16BIT *pid, U16BIT *comp_id, U16BIT *anc_id, BOOLEAN *enabled);
49 
50 #endif // _STBDSAPI_H
51 
52 //*****************************************************************************
53 // End of file
54 //*****************************************************************************
55 
void STB_SUBStop(U8BIT path)
Stops subtitling display.
Definition: stbdsc.c:1070
void STB_SUBSetStream(U8BIT path, U16BIT pid, U16BIT composition_id, U16BIT ancillary_id)
Sets the stream IDs to be decoded.
Definition: stbdsc.c:1105
void STB_SUBEnable(U8BIT path, BOOLEAN enable)
Enables or disables subtitling display.
Definition: stbdsc.c:996
void STB_SUBStart(U8BIT path, U16BIT pid, U16BIT composition_id, U16BIT ancillary_id)
Starts subtitling display.
Definition: stbdsc.c:1045
System Wide Global Technical Data Type Definitions.
void STB_SUBStatus(BOOLEAN *started, BOOLEAN *shown)
returns the current status information
Definition: stbdsc.c:1190
void STB_SUBReadSettings(BOOLEAN *running, U16BIT *pid, U16BIT *comp_id, U16BIT *anc_id, BOOLEAN *enabled)
returns the current status information
Definition: stbdsc.c:1215