ts::TeletextDescriptor::Entry Struct Reference

An item entry. More...

#include <tsTeletextDescriptor.h>

Collaboration diagram for ts::TeletextDescriptor::Entry:

Public Member Functions
	Entry (const UChar *code=nullptr, uint8_t type=0, uint16_t page=0)
	Default constructor.
	Entry (const UString &code, uint8_t type=0, uint16_t page=0)
	Default constructor.
uint8_t	magazineNumber () const
	Extract magazine number from the full Teletext page number.
uint8_t	pageNumber () const
	Extract page number from then full Teletext page number.
void	setFullNumber (uint8_t teletext_magazine_number, uint8_t teletext_page_number)
	Build a full Teletext page number from magazine and page numbers.

Public Attributes
UString	language_code {}
	ISO-639 language code, 3 characters.
uint16_t	page_number = 0
	Teletext page number, combination of page and magazine number.
uint8_t	teletext_type = 0
	Teletext type, 5 bits.

Detailed Description

An item entry.

Constructor & Destructor Documentation

Entry() [1/2]

ts::TeletextDescriptor::Entry::Entry	(	const UChar *	code = nullptr,
		uint8_t	type = 0,
		uint16_t	page = 0
	)

Default constructor.

Parameters

[in]	code	ISO-639 language code, 3 characters. Can be null.
[in]	type	Teletext type, 5 bits.
[in]	page	Teletext page number, combination of page and magazine number.

Entry() [2/2]

ts::TeletextDescriptor::Entry::Entry	(	const UString &	code,
		uint8_t	type = 0,
		uint16_t	page = 0
	)

Default constructor.

Parameters

[in]	type	Teletext type, 5 bits.
[in]	page	Teletext page number, combination of page and magazine number.
[in]	code	ISO-639 language code, 3 characters.

Member Function Documentation

setFullNumber()

void ts::TeletextDescriptor::Entry::setFullNumber	(	uint8_t	teletext_magazine_number,
		uint8_t	teletext_page_number
	)

Build a full Teletext page number from magazine and page numbers.

In Teletext, a "page number" is built from two data, the magazine and page numbers. The binary descriptor contains these two values.

Parameters

[in]	teletext_magazine_number	Teletext magazine number, 3-bit value from descriptor.
[in]	teletext_page_number	Teletext page number, 8-bit value from descriptor.

magazineNumber()

uint8_t ts::TeletextDescriptor::Entry::magazineNumber

(

)

const

Extract magazine number from the full Teletext page number.

Returns

Teletext magazine number, 3-bit value from descriptor.

See also

setFullNumber()

pageNumber()

uint8_t ts::TeletextDescriptor::Entry::pageNumber

(

)

const

Extract page number from then full Teletext page number.

Returns

Teletext page number, 8-bit value from descriptor.

See also

setFullNumber()

---

The documentation for this struct was generated from the following file:

• tsTeletextDescriptor.h