Teletext control

Collaboration diagram for Teletext control:

Functions
bool	vlc_player_HasTeletextMenu (vlc_player_t *player)
	Check if the media has a teletext menu.
void	vlc_player_SetTeletextEnabled (vlc_player_t *player, bool enabled)
	Enable or disable teletext.
bool	vlc_player_IsTeletextEnabled (vlc_player_t *player)
	Check if teletext is enabled.
void	vlc_player_SelectTeletextPage (vlc_player_t *player, unsigned page)
	Select a teletext page or do an action from a key.
unsigned	vlc_player_GetTeletextPage (vlc_player_t *player)
	Get the current teletext page.
void	vlc_player_SetTeletextTransparency (vlc_player_t *player, bool enabled)
	Enable or disable teletext transparency.
bool	vlc_player_IsTeletextTransparent (vlc_player_t *player)
	Check if teletext is transparent.

Detailed Description

Function Documentation

vlc_player_GetTeletextPage()

unsigned vlc_player_GetTeletextPage

(

vlc_player_t *

player

)

Get the current teletext page.

See also

vlc_player_cbs.on_teletext_page_changed

Parameters

player

locked player instance

References vlc_player_input::player, vlc_player_input::teletext_page, vlc_player_get_input_locked(), and vlc_player_IsTeletextEnabled().

vlc_player_HasTeletextMenu()

bool vlc_player_HasTeletextMenu

(

vlc_player_t *

player

)

Check if the media has a teletext menu.

See also

vlc_player_cbs.on_teletext_menu_changed

Parameters

player

locked player instance

Returns

true if the media has a teletext menu

References vlc_player_input::player, vlc_player_input::teletext_source, and vlc_player_get_input_locked().

vlc_player_IsTeletextEnabled()

bool vlc_player_IsTeletextEnabled

(

vlc_player_t *

player

)

Check if teletext is enabled.

See also

vlc_player_cbs.on_teletext_enabled_changed

Parameters

player

locked player instance

References vlc_player_input::player, vlc_player_input::teletext_enabled, vlc_player_input::teletext_source, and vlc_player_get_input_locked().

Referenced by vlc_player_GetTeletextPage(), and vlc_player_IsTeletextTransparent().

vlc_player_IsTeletextTransparent()

bool vlc_player_IsTeletextTransparent

(

vlc_player_t *

player

)

Check if teletext is transparent.

Parameters

player

locked player instance

References vlc_player_input::player, vlc_player_input::teletext_transparent, vlc_player_get_input_locked(), and vlc_player_IsTeletextEnabled().

vlc_player_SelectTeletextPage()

void vlc_player_SelectTeletextPage	(	vlc_player_t *	player,
		unsigned	page
	)

Select a teletext page or do an action from a key.

This function has an effect only if the player has a teletext menu.

Note

Page keys can be the following: VLC_PLAYER_TELETEXT_KEY_RED, VLC_PLAYER_TELETEXT_KEY_GREEN, VLC_PLAYER_TELETEXT_KEY_YELLOW, VLC_PLAYER_TELETEXT_KEY_BLUE or VLC_PLAYER_TELETEXT_KEY_INDEX.

A successful call will trigger the vlc_player_cbs.on_teletext_page_changed event.

Parameters

player	locked player instance
page	a page in the range ]0;888] or a valid key

References INPUT_CONTROL_SET_VBI_PAGE, input_ControlPush(), vlc_player_input::player, vlc_player_input::teletext_source, vlc_player_input::thread, and vlc_player_get_input_locked().

vlc_player_SetTeletextEnabled()

void vlc_player_SetTeletextEnabled	(	vlc_player_t *	player,
		bool	enabled
	)

Enable or disable teletext.

This function has an effect only if the player has a teletext menu.

Note

A successful call will trigger the vlc_player_cbs.on_teletext_enabled_changed event.

Parameters

player	locked player instance
enabled	true to enable

References vlc_player_track::es_id, vlc_player_input::player, vlc_player_track_priv::t, vlc_player_input::teletext_source, vlc_player_get_input_locked(), VLC_PLAYER_SELECT_EXCLUSIVE, vlc_player_SelectEsId(), and vlc_player_UnselectEsId().

vlc_player_SetTeletextTransparency()

void vlc_player_SetTeletextTransparency	(	vlc_player_t *	player,
		bool	enabled
	)

Enable or disable teletext transparency.

This function has an effect only if the player has a teletext menu.

Note

A successful call will trigger the vlc_player_cbs.on_teletext_transparency_changed event.

Parameters

player	locked player instance
enabled	true to enable

References INPUT_CONTROL_SET_VBI_TRANSPARENCY, input_ControlPush(), vlc_player_input::player, vlc_player_input::teletext_source, vlc_player_input::thread, and vlc_player_get_input_locked().