- Parameters:
-
vbi | Initialized vbi decoding context. |
pg | Place to store the formatted page. |
pgno | Page number 1 ... 8 of the page to fetch, see vbi_pgno. |
reset | TRUE resets the vbi_page dirty fields in cache after fetching. Pass FALSE only if you plan to call this function again to update other displays. |
Fetches a Closed Caption page designated by pgno from the cache, formats and stores it in pg. CC pages are transmitted basically in two modes: at once and character by character ("roll-up" mode). Either way you get a snapshot of the page as it should appear on screen at present. With vbi_event_handler_add() you can request a VBI_EVENT_CAPTION
event to be notified about pending changes (in case of "roll-up" mode that is with each new word received) and the vbi_page->dirty fields will mark the lines actually in need of updates, to speed up rendering.
Although safe to do, this function is not supposed to be called from an event handler, since rendering may block decoding for extended periods of time.
- Returns:
FALSE
if some error occured.