libenatsc3lls

libentasc3lls is a collection of functions which parse low-level signaling XML documents into a compact representation using EnXML. Definitions and functions are provided for parsing AEAT, OnScreenMessage, RRT, SLT, and SystemTime documents.

Function Reference

ENATSC3Status ATSC3LLSParseAEAT(
    const char *pXML, 
    int32_t sXML,
    ATSC3LLSAEAT_AEATNode *pParsedATSC3LLSAEAT
);

Parses an AEAT document to an EnXML representation.

Parameters
    • pXML: The XML document.
    • sXML: The number of bytes in the XML document.
    • pParsedATSC3LLSAEAT: A pointer to an ATSC3LLSAEAT_AEATNode. On successful return it is populated with the parsed document. pParsedATSC3LLSAEAT must be freed using  ATSC3LLSFreeParsedAEAT when the application is done with the parsed representation. On failure the contents of pParsedATSC3LLSAEAT is undefined and ATSC3LLSFreeParsedAEAT must not be called on it.
Return Values
    • ENATSC3Status_Success: The document was successfully parsed.
    • ENATSC3Status_Failure: An error was encountered parsing the document.
ENATSC3Status ATSC3LLSFreeParsedAEAT(
    ATSC3LLSAEAT_AEATNode *pParsedATSC3LLSAEAT
);

ATSC3LLSFreeParsedAEAT frees the memory associated with an  ATSC3LLSAEAT_AEATNode  that was parsed using ATSC3LLSParseAEAT.

Parameters
    • pParsedATSC3LLSAEAT: A pointer to the ATSC3LLSAEAT_AEATNode .
Return Values
    • ENATSC3Status_Success: The object was freed.
    • ENATSC3Status_Failure: An error was encountered while freeing the object.
ENATSC3Status ATSC3LLSParseOnscreenMessageNotification(
    const char *pXML, 
    int32_t sXML,
    ATSC3LLSOSMN_OnscreenMessageNotificationNode *pParsedOnscreenMessageNotification
);

Parses an OnScreenMessageNotification document to an EnXML representation.

Parameters
    • pXML: The XML document.
    • sXML: The number of bytes in the XML document.
    • pParsedOnscreenMessageNotification: A pointer to an ATSC3LLSOSMN_OnscreenMessageNotificationNode. On successful return it is populated with the parsed document. pParsedOnscreenMessageNotification must be freed using  ATSC3LLSFreeParsedOnscreenMessageNotification when the application is done with the parsed representation. On failure the contents of pParsedOnscreenMessageNotification is undefined and ATSC3LLSFreeParsedOnscreenMessageNotification must not be called on it.
Return Values
    • ENATSC3Status_Success: The document was successfully parsed.
    • ENATSC3Status_Failure: An error was encountered parsing the document.
ENBATSC3Status ATSC3LLSFreeParsedOnscreenMessageNotification(
    ATSC3LLSOSMN_OnscreenMessageNotificationNode *pParsedOnscreenMessageNotification
);

ATSC3LLSFreeParsedOnscreenMessageNotificationfrees the memory associated with an  ATSC3LLSOSMN_OnscreenMessageNotificationNode that was parsed using ATSC3LLSParseOnscreenMessageNotification.

Parameters
    • pParsedOnscreenMessageNotification: A pointer to the ATSC3LLSOSMN_OnscreenMessageNotificationNode .
Return Values
    • ENATSC3Status_Success: The object was freed.
    • ENATSC3Status_Failure: An error was encountered while freeing the object.
ENATSC3Status ATSC3LLSParseRRT(
    const char *pXML, 
    int32_t sXML,
    ATSC3LLSRRT_RatingRegionTablesNode *
pRatingRegionTablesNode);

Parses an RRT document to an EnXML representation.

Parameters
    • pXML: The XML document.
    • sXML: The number of bytes in the XML document.
    • pRatingRegionTablesNode: A pointer to an ATSC3LLSRRT_RatingRegionTablesNodeOn successful return it is populated with the parsed document. pRatingRegionTablesNode must be freed using  ATSC3LLSFreeParsedRRT when the application is done with the parsed representation. On failure the contents of pRatingRegionTablesNode  is undefined and ATSC3LLSFreeParsedRRT must not be called on it.
Return Values
    • ENATSC3Status_Success: The document was successfully parsed.
    • ENATSC3Status_Failure: An error was encountered parsing the document.
ENATSC3Status ATSC3LLSFreeParsedRRT(
    ATSC3LLSRRT_RatingRegionTablesNode *pRatingRegionTablesNode
);

ATSC3LLSFreeParsedRRT frees the memory associated with an  ATSC3LLSRRT_RatingRegionTablesNode that was parsed using ATSC3LLSParseRRT.

Parameters
    • pRatingRegionTablesNode: A pointer to the ATSC3LLSRRT_RatingRegionTablesNode .
Return Values
    • ENATSC3Status_Success: The object was freed.
    • ENATSC3Status_Failure: An error was encountered while freeing the object.
ENATSC3Status ATSC3LLSParseSLT(
    const char *pXML, 
    int32_t sXML,
    ATSC3LLSSLT_SLTNode *pParsedSLT
);

Parses an SLT document to an EnXML representation.

Parameters
    • pXML: The XML document.
    • sXML: The number of bytes in the XML document.
    • pParsedSLT: A pointer to an ATSC3LLSSLT_SLTNode. On successful return it is populated with the parsed document. pParsedSLT must be freed using  ATSC3LLSFreeParsedSLT when the application is done with the parsed representation. On failure the contents of pParsedSLT is undefined and ATSC3LLSFreeParsedSLT must not be called on it.
Return Values
    • ENATSC3Status_Success: The document was successfully parsed.
    • ENATSC3Status_Failure: An error was encountered parsing the document.
ENATSC3Status ATSC3LLSFreeParsedSLT(
    ATSC3LLSSLT_SLTNode *pParsedSLT
);

ATSC3LLSFreeParsedSLT frees the memory associated with an  ATSC3LLSSLT_SLTNode  that was parsed using ATSC3LLSParseSLT.

Parameters
    • pParsedSLT: A pointer to the ATSC3LLSSLT_SLTNode .
Return Values
    • ENATSC3Status_Success: The object was freed.
    • ENATSC3Status_Failure: An error was encountered while freeing the object.
ENATSC3Status ATSC3LLSParseSystemTime(
    const char *pXML, 
    int32_t sXML,
    ATSC3LLSSystemTime_SystemTimeNode *pParsedSystemTime
);

Parses a SystemTimw document to an EnXML representation.

Parameters
    • pXML: The XML document.
    • sXML: The number of bytes in the XML document.
    • pParsedSystemTime: A pointer to an ATSC3LLSSystemTime_SystemTimeNode . On successful return it is populated with the parsed document. pParsedSystemTime must be freed using  ATSC3LLSFreeParsedSystemTime when the application is done with the parsed representation . On failure the contents of pParsedSystemTime is undefined and ATSC3LLSFreeParsedSystemTime must not be called on it.
Return Values
    • ENATSC3Status_Success: The document was successfully parsed.
    • ENATSC3Status_Failure: An error was encountered parsing the document.
ENATSC3Status ATSC3LLSFreeParsedSystemTime(
    ATSC3LLSSystemTime_SystemTimeNode *pParsedSystemTime
);

ATSC3LLSFreeParsedSystemTime frees the memory associated with an  ATSC3LLSSystemTime_SystemTimeNode that was parsed using ATSC3LLSParseSystemTime.

Parameters
    • pParsedSystemTime: A pointer to the ATSC3LLSSystemTime_SystemTimeNode .
Return Values
    • ENATSC3Status_Success: The object was freed.
    • ENATSC3Status_Failure: An error was encountered while freeing the object.