ToiDvbEitCache 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:
ToiDvbEitService
IToiDvbEitCacheObserver
ToiMediaService

import "ToiDvbEitCache.idl";

List of all members.

Public Member Functions

void addEventListener (in long type, in ToiEventListener listener) raises (TToiInvalidArgumentException)
void removeEventListener (in long type, in ToiEventListener listener) raises (TToiInvalidArgumentException)

Public Attributes

Events

const long ON_CACHE_UPDATED = 700

const long NO_EVENT_ID = 2147483647



typedef sequence
< ToiDvbEitCacheEventInfo > 		TToiEventInfoSequence
typedef sequence
< ToiDvbEitCacheEventItemInfo > 		TToiEventItemInfoSequence
typedef sequence< octet > Binary
typedef sequence
< ToiDvbEitCacheDvbEitUpdateInfo > 		TToiDvbEitUpdateInfoSequence
typedef string TToiLanguageCode
typedef sequence
< ToiDvbEitCacheComponent > 		TToiComponentSequence
const long FILTER_MODE_PF_ONLY = 1
const long FILTER_MODE_PF_AND_SCHEDULE = 2
void setFilterMode (in long filterMode)
void clearServices ()
void clearEvents ()
void addService (in ToiDvbEitCacheServiceItem service)
ToiMultipleResult getEvents (in ToiDvbEitCacheServiceItem service, in unsigned long time, in long duration) raises (TToiInvalidArgumentException)
ToiDvbEitCacheEventInfo getPresentEvent (in ToiDvbEitCacheServiceItem service) raises (TToiInvalidArgumentException)
ToiDvbEitCacheEventInfo getFollowingEvent (in ToiDvbEitCacheServiceItem service) raises (TToiInvalidArgumentException)
Binary getPrivateData (in ToiDvbEitCacheServiceItem service, in long eventId) raises (TToiInvalidArgumentException)
ToiDvbEitCacheExtendedEventInfo getExtendedEventInfo (in ToiDvbEitCacheServiceItem service, in long eventId) raises (TToiInvalidArgumentException)
TToiEventItemInfoSequence getEventItemInfo (in ToiDvbEitCacheServiceItem service, in long eventId) raises (TToiInvalidArgumentException)
TToiComponentSequence getVideoComponentList (in ToiDvbEitCacheServiceItem service, in long eventId) raises (TToiInvalidArgumentException)
TToiComponentSequence getAudioComponentList (in ToiDvbEitCacheServiceItem service, in long eventId, in TToiLanguageCode languageCode) raises (TToiInvalidArgumentException)
TToiComponentSequence getSubtitleComponentList (in ToiDvbEitCacheServiceItem service, in long eventId, in TToiLanguageCode languageCode) raises (TToiInvalidArgumentException)
void releaseInstance ()

Member Typedef Documentation

typedef sequence< octet > ToiDvbEitCache::Binary

Sequence of octet structures.

typedef sequence< ToiDvbEitCacheComponent > ToiDvbEitCache::TToiComponentSequence

Sequence of ToiDvbEitCacheComponent structures.

typedef sequence< ToiDvbEitCacheDvbEitUpdateInfo > ToiDvbEitCache::TToiDvbEitUpdateInfoSequence

Sequence of ToiDvbEitCacheDvbEitUpdateInfo structures.

typedef sequence< ToiDvbEitCacheEventInfo > ToiDvbEitCache::TToiEventInfoSequence

Sequence of ToiDvbEitCacheEventInfo structures.

typedef sequence< ToiDvbEitCacheEventItemInfo > ToiDvbEitCache::TToiEventItemInfoSequence

Sequence of ToiDvbEitCacheEventItemInfo structures.

typedef string ToiDvbEitCache::TToiLanguageCode

ISO 639 language code. It is 3-character code, e.g. "FRE" for French.

Member Function Documentation

void ToiEventTarget::addEventListener ( in long  type,
in ToiEventListener  listener 
) raises (TToiInvalidArgumentException) [inherited]

This method registers an event listener for a specific event. Multiple listeners can be added for the same event. Events are broadcast to all registered listeners.

Parameters:
type The event type of the event to subscribe to.
listener The JavaScript function that will receive events.
Exceptions:
TInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the application calls addEventListener with the same combination of type and listener twice.
void ToiDvbEitCache::addService ( in ToiDvbEitCacheServiceItem  service  ) 

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 ToiDvbEitCache::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 ToiDvbEitCache::clearServices (  ) 

Clears the list of services to be cached.

TToiComponentSequence ToiDvbEitCache::getAudioComponentList ( in ToiDvbEitCacheServiceItem  service,
in long  eventId,
in TToiLanguageCode  languageCode 
) raises (TToiInvalidArgumentException)

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:
components The sequence of TToiComponent.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
TToiEventItemInfoSequence ToiDvbEitCache::getEventItemInfo ( in ToiDvbEitCacheServiceItem  service,
in long  eventId 
) raises (TToiInvalidArgumentException)

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:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
ToiMultipleResult ToiDvbEitCache::getEvents ( in ToiDvbEitCacheServiceItem  service,
in unsigned long  time,
in long  duration 
) raises (TToiInvalidArgumentException)

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.
Returns:
A multiple result object with the following properties: ToiDvbEitCache::TToiEventInfoSequence infoSequence The sequence of EIT events
  • bool more Set to true if entire interval could not fit in sequence. False otherwise.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
ToiDvbEitCacheExtendedEventInfo ToiDvbEitCache::getExtendedEventInfo ( in ToiDvbEitCacheServiceItem  service,
in long  eventId 
) raises (TToiInvalidArgumentException)

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:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
ToiDvbEitCacheEventInfo ToiDvbEitCache::getFollowingEvent ( in ToiDvbEitCacheServiceItem  service  )  raises (TToiInvalidArgumentException)

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:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
ToiDvbEitCacheEventInfo ToiDvbEitCache::getPresentEvent ( in ToiDvbEitCacheServiceItem  service  )  raises (TToiInvalidArgumentException)

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:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
Binary ToiDvbEitCache::getPrivateData ( in ToiDvbEitCacheServiceItem  service,
in long  eventId 
) raises (TToiInvalidArgumentException)

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:
privData The private data extracted from EIT.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
TToiComponentSequence ToiDvbEitCache::getSubtitleComponentList ( in ToiDvbEitCacheServiceItem  service,
in long  eventId,
in TToiLanguageCode  languageCode 
) raises (TToiInvalidArgumentException)

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:
components The sequence of TToiComponent.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
TToiComponentSequence ToiDvbEitCache::getVideoComponentList ( in ToiDvbEitCacheServiceItem  service,
in long  eventId 
) raises (TToiInvalidArgumentException)

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:
components The sequence of TToiComponent.
Exceptions:
TToiInvalidArgumentException Raised if any of the parameters to the call are invalid.
void ToiDvbEitCache::releaseInstance (  ) 

When an application is done using a EIT cache instance it should gracefully release it by calling this function.

void ToiEventTarget::removeEventListener ( in long  type,
in ToiEventListener  listener 
) raises (TToiInvalidArgumentException) [inherited]

This method removes an event listener for a specific event.

Parameters:
type The event type of the event to remove the listener from.
listener The JavaScript function that was previously added as an event listener.
Exceptions:
TInvalidArgumentException Raised if the event type is not supported by this object or if the listener is not a valid JavaScript function. This exception is also raised if the listener had not previously been added.
void ToiDvbEitCache::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:
ToiTypes::TInvalidArgumentException Raised if any of the parameters to the call are invalid.

Member Data Documentation

const long ToiDvbEitCache::FILTER_MODE_PF_AND_SCHEDULE = 2

Filter mode for EIT p/f and EIT schedule.

This constant can also be accessed from toi.consts.ToiDvbEitCache.FILTER_MODE_PF_AND_SCHEDULE.

const long ToiDvbEitCache::FILTER_MODE_PF_ONLY = 1

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.ToiDvbEitCache.FILTER_MODE_PF_ONLY.

const long ToiDvbEitCache::NO_EVENT_ID = 2147483647

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.ToiDvbEitCache.NO_EVENT_ID.

const long ToiDvbEitCache::ON_CACHE_UPDATED = 700

This is an Event identifier for ToiDvbEitCacheCacheUpdatedEvent.

This constant can also be accessed from toi.consts.ToiDvbEitCache.ON_CACHE_UPDATED.