IToiDvbEitCache Interface Reference
Description
This interface provides access to the event information table (EIT) which is fetched from transport streams in all media sessions. This includes present/following and schedule events.
EIT events may be broadcasted using different languages. In that case, the EIT cache will store only data from one language. The language used is decided by the configuration variable "cfg.locale.ui" (deprecated alias is "config.uilanguage").
Note that the EIT described here conforms to ETSI EN 300 468 version 1.8.1. References to ISO 639 means ISO 639-2.
- See also:
- IToiDvbEitService
-
IToiDvbEitCacheObserver
-
IToiMediaService
import "IToiDvbEitCache.idl";
List of all members.
Public Member Functions |
void | SetFilterMode (in long filterMode) |
void | ClearServices () |
void | ClearEvents () |
void | AddService (in TToiServiceItem service) |
void | GetEvents (in TToiServiceItem service, in unsigned long time, in long duration, out TToiEventInfoSequence infoSequence, out boolean more) raises (TToiInvalidArgumentException) |
void | GetPresentEvent (in TToiServiceItem service, out TToiEventInfo event) raises (TToiInvalidArgumentException) |
void | GetFollowingEvent (in TToiServiceItem service, out TToiEventInfo event) raises (TToiInvalidArgumentException) |
void | GetPrivateData (in TToiServiceItem service, in long eventId, out Binary privData, out long privDataDataSize, in long privDataMaxSize) raises (TToiInvalidArgumentException) |
void | GetExtendedEventInfo (in TToiServiceItem service, in long eventId, out TToiExtendedEventInfo eventInfo) raises (TToiInvalidArgumentException) |
void | GetEventItemInfo (in TToiServiceItem service, in long eventId, out TToiEventItemInfoSequence eventItems) raises (TToiInvalidArgumentException) |
void | GetVideoComponentList (in TToiServiceItem service, in long eventId, out TToiComponentSequence components) raises (TToiInvalidArgumentException) |
void | GetAudioComponentList (in TToiServiceItem service, in long eventId, in TToiLanguageCode languageCode, out TToiComponentSequence components) raises (TToiInvalidArgumentException) |
void | GetSubtitleComponentList (in TToiServiceItem service, in long eventId, in TToiLanguageCode languageCode, out TToiComponentSequence components) raises (TToiInvalidArgumentException) |
void | ReleaseInstance () |
void | RegisterObserver (in IToiApplicationService::TToiApplicationId applicationId, in string address) raises (TToiInvalidArgumentException) |
void | ReleaseObserver (in string address) raises (TToiInvalidArgumentException) |
Public Attributes |
|
|
const long | NO_EVENT_ID = 2147483647 |
|
|
const long | FILTER_MODE_PF_ONLY = 1 |
const long | FILTER_MODE_PF_AND_SCHEDULE = 2 |
Classes |
struct | TToiComponent |
struct | TToiDvbEitUpdateInfo |
struct | TToiEventInfo |
struct | TToiEventItemInfo |
struct | TToiExtendedEventInfo |
struct | TToiServiceItem |
Public Types |
typedef sequence< TToiEventInfo > | TToiEventInfoSequence |
typedef sequence
< TToiEventItemInfo > | TToiEventItemInfoSequence |
typedef sequence< octet > | Binary |
typedef sequence
< TToiDvbEitUpdateInfo > | TToiDvbEitUpdateInfoSequence |
typedef string | TToiLanguageCode |
typedef sequence< TToiComponent > | TToiComponentSequence |
Member Typedef Documentation
Sequence of octet structures.
ISO 639 language code. It is 3-character code, e.g. "FRE" for French.
Member Function Documentation
Adds a service to the list of services to be cached. The service is identified uniquely by three parameters: original network identifier, transport stream identifier and service identifier.
- Parameters:
-
| service | The service to be added. |
void IToiDvbEitCache::ClearEvents |
( |
|
) |
|
Clears the list of events for all services. Note that if there are several instances of the EIT cache, the events for all instances will be cleared.
void IToiDvbEitCache::ClearServices |
( |
|
) |
|
Clears the list of services to be cached.
Gets the audio components of specific langauge in component descriptor for a specific event from a specific service. If languageCode is empty, all audio components for the event are fetched.
- Parameters:
-
| service | The service to get information for. |
| eventId | The event identifier to get information for. |
| languageCode | The ISO 639 langauge code (a 3-character code); If empty, it means any language. |
- Return values:
-
- Exceptions:
-
Gets the items in extended event desciptor for a specific event from a specific service.
- Parameters:
-
| service | The service to get information for. |
| eventId | The event identifier to get information for. |
- Return values:
-
| eventItems | The sequence of TEventItemInfo. |
- Exceptions:
-
Gets events from the cache for a specific service and a specific time interval.
The returned events are sorted in cronological order. Due to limitations in the platform, the entire interval might not be able to fit into the sequence. In this case, it is up to the user to see how much is received and request the rest of the interval in a new request. Note then that the date, time and duration parameters need to be set the point to the missing interval.
- Parameters:
-
| service | The service to get informaiont for. |
| time | The start time of the interval, given in seconds since the Unix epoch. |
| duration | The length of the interval in seconds. |
- Return values:
-
| infoSequence | The sequence of EIT events |
| more | Set to true if entire interval could not fit in sequence. False otherwise. |
- Exceptions:
-
Gets extended information about a EIT eventi from a specific service.
- Parameters:
-
| service | The service to get information for. |
| eventId | The event identifier to get information for. |
- Return values:
-
| eventInfo | The extended EIT event info. |
- Exceptions:
-
Gets following event from the cache for a specific service.
- Parameters:
-
| service | The service to get information for. |
- Return values:
-
| event | The following EIT event. |
- Exceptions:
-
Gets present event from the cache for a specific service.
- Parameters:
-
| service | The service to get information for. |
- Return values:
-
| event | The present EIT event. |
- Exceptions:
-
Gets private data about an EIT event from a specific service which is identified uniquely by three parameters: original network identifier, transport stream identifier and service identifier.
- Parameters:
-
| service | The service to get extended EIT event for. |
| eventId | The event identifier to get information for. |
- Return values:
-
| privDataDataSize | The buffer size of privData |
- Parameters:
-
| privDataMaxSize | The maximum size of privData |
- Return values:
-
| privData | The private data extracted from EIT. |
- Exceptions:
-
Gets the subtitle components of specific langauge in component descriptor for a specific event from a specific service. If languageCode is empty, all subtitle components for the event are fetched.
- Parameters:
-
| service | The service to get information for. |
| eventId | The event identifier to get information for. |
| languageCode | The ISO 639 langauge code (a 3-character code); If empty, it means any language. |
- Return values:
-
- Exceptions:
-
Gets the video components in component descriptor for a specific event from a specific service.
- Parameters:
-
| service | The service to get information for. |
| eventId | The event identifier to get information for. |
- Return values:
-
- Exceptions:
-
void IToiDvbEitCache::ReleaseInstance |
( |
|
) |
|
When an application is done using a EIT cache instance it should gracefully release it by calling this function.
void IToiDvbEitCache::SetFilterMode |
( |
in long |
filterMode |
) |
|
Start the filtering mode of EIT events.
- Parameters:
-
| filterMode | The filter to use for EIT data, see filtermode flags above. |
- Exceptions:
-
| IToiTypes::TInvalidArgumentException | Raised if any of the parameters to the call are invalid. |
Member Data Documentation
Filter mode for EIT p/f and EIT schedule.
This constant can also be accessed from toi.consts.IToiDvbEitCache.FILTER_MODE_PF_AND_SCHEDULE.
Filtering modes
Modes for filtering. Used in the SetFilterMode method. Filter mode for EIT p/f only.
This constant can also be accessed from toi.consts.IToiDvbEitCache.FILTER_MODE_PF_ONLY.
Empty event identity
NO_EVENT_ID is used by Javascript to identify an empty event. Empty event identity.
This constant can also be accessed from toi.consts.IToiDvbEitCache.NO_EVENT_ID.