ts::TeletextFrame Class Reference

#include <tsTeletextFrame.h>

Public Member Functions
	TeletextFrame ()=default
template<class Rep1, class Period1, class Rep2, class Period2>
	TeletextFrame (PID pid, int page, int frame_count, const cn::duration< Rep1, Period1 > &show_timestamp, const cn::duration< Rep2, Period2 > &hide_timestamp, const UStringList &lines=UStringList())
void	addLine (const UString &line)
int	frameCount () const
cn::milliseconds	hideTimestamp () const
const UStringList &	lines () const
int	page () const
PID	pid () const
cn::milliseconds	showTimestamp () const

Detailed Description

Description of one Teletext frame.

Constructor & Destructor Documentation

TeletextFrame() [1/2]

ts::TeletextFrame::TeletextFrame ( )

default

Default constructor.

TeletextFrame() [2/2]

template<class Rep1, class Period1, class Rep2, class Period2>

ts::TeletextFrame::TeletextFrame	(	PID	pid,
		int	page,
		int	frame_count,
		const cn::duration< Rep1, Period1 > &	show_timestamp,
		const cn::duration< Rep2, Period2 > &	hide_timestamp,
		const UStringList &	lines = UStringList() )

Full constructor.

Parameters

[in]	pid	PID number.
[in]	page	Teletext page number.
[in]	frame_count	Frame counter in this page, starting at 1.
[in]	show_timestamp	Show frame at this timestamp (in ms from start of stream)
[in]	hide_timestamp	Hide frame at this timestamp (in ms from start of stream)
[in]	lines	Text lines.

Member Function Documentation

lines()

const UStringList & ts::TeletextFrame::lines ( ) const

inline

Get the text lines. May contain embedded HTML tags.

Returns

A constant reference to the text lines.

addLine()

void ts::TeletextFrame::addLine ( const UString & line )

inline

Add a line of text to the frame.

Parameters

[in]

line

Text line to add.

pid()

PID ts::TeletextFrame::pid ( ) const

inline

Get the PID from which the frame originates.

Returns

The PID from which the frame originates.

page()

int ts::TeletextFrame::page ( ) const

inline

Get the Teletext page number.

Returns

The Teletext page number.

frameCount()

int ts::TeletextFrame::frameCount ( ) const

inline

Get the frame number in this page, starting at 1.

Returns

The frame number in this page, starting at 1.

showTimestamp()

cn::milliseconds ts::TeletextFrame::showTimestamp ( ) const

inline

Get the "show" timestamp in ms from start of stream.

Returns

The "show" timestamp in ms from start of stream.

hideTimestamp()

cn::milliseconds ts::TeletextFrame::hideTimestamp ( ) const

inline

Get the "hide" timestamp in ms from start of stream.

Returns

The "hide" timestamp in ms from start of stream.

---

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

• tsTeletextFrame.h