• Quick Start
  • Booting
  • Platform
  • Portals
  • References
    • API Reference TOI3
    • IIP Reference
  • Resources
ARRIS Enterprises, Inc. Confidential Information

Technical Previews

Method ToiApplicationService#signData( keyName , userData )

This method is used to RSA sign user data. The method signs a hash of the supplied user data as specified in PKCS #1 2.0. The current limit for the data to sign is 4 KiB.

Method ToiApplicationService#verifySignature( keyName , userData , signature )

This method is used to RSA verify signatures for user data. The current limit for the data to verify is 4 KiB.

Method ToiAudioOutputService#getLatency( connectionId )

Returns the audio latency of a connection.

Method ToiAudioOutputService#setLatency( connectionId , latency )

Set an audio connection audio latency. latency is in milliseconds. This should affect all audio formats. If the latency parameter is out of range, the closest supported value is set. Setting the latency for one connection may impact the latency for other connections. In this case, the ToiAudioOutputLatencyChangedEvent will be notified on the impacted connections.

Class ToiDrmService

The ToiDrmService provides application access to the DRM service.

Class ToiHdmiCecDeviceInfoChangedEvent

Called when CEC information of the devices on the CEC bus is changed.

Class ToiHdmiCecFeatureStatusChangedEvent

Called when any CEC feature status is changed.

Method ToiHdmiService#getCecDevices( )

This method is used for the application to know what other devices that are connected to the CEC bus.

Method ToiHdmiService#getCecFeatures( )

The method is used to check the status of the CEC features. All CEC features that can be enabled (by current HW/configuration) are returned.

Method ToiHdmiService#sendCecUserControlPressed( destination , uiCommand )

This method is used for the CEC remote control pass through when the remote control button is pressed. It sends "User control pressed" and remote control UI command to the HDMI sink. When the user presses and holds the same remote control button for a long time, the application shall call ToiHdmiService#sendCecUserControlPressed with the same UI command repeatedly. In this case, the application need not call ToiHdmiService#sendCecUserControlReleased, but it shall call ToiHdmiService#sendCecUserControlReleased immediately when the user releases the key.

Method ToiHdmiService#sendCecUserControlReleased( destination )

This method is used for the CEC remote control pass through. The application shall call this method when the remote control button is released. It sends "User control released" to the HDMI sink.

Method ToiHdmiService#sendCecWakeup( destination )

This method shall be used to take advantage of the One Touch Play feature. It will wake up the attached HDMI sink and tell it to use the STB as the active source.

Method ToiHdmiService#setCecFeatures( features )

The method is used to enable or disable CEC features. It shall only change the provided features.

typedef ToiHdmiService.ToiCecFeature

CEC feature definition.

typedef ToiHdmiService.ToiCecLogicalAddress

Defines the CEC logical address as specified in CEC Table 5 in HDMI specification version 1.4a.

typedef ToiHdmiService.ToiCecUiCommand

Remote control pass through user interface command.

Member ToiHdmiService.ToiCecFeatureInfo

The CEC feature information.

Member ToiHdmiService.ToiCecInfo

The CEC information of the device on the CEC bus.

Method ToiMediaPlayer#getPresentationInfo( )

Returns the presentation information about current video and audio lock status. Audio locked means audio decoder is started, sample rate is locked and no sync loss. Video locked means video decoder is started and no sync loss.

Method ToiMediaPlayerBase#getPresentationInfo( )

Returns the presentation information about current video and audio lock status. Audio locked means audio decoder is started, sample rate is locked and no sync loss. Video locked means video decoder is started and no sync loss.

Member ToiMediaPlayerBase.COMPONENT_SUBTITLE_CAPTION

This is an ARIB specific type of subtitles.

Member ToiMediaPlayerBase.COMPONENT_SUBTITLE_SUPERIMPOSE

This is an ARIB specific type of subtitles and used mainly for displaying alert messages on screen.

Member ToiMediaPlayerBase.ToiPresentationInfo

Data structure used to return presentation info. Indicates whether audio and video are ready for presentation.

Class ToiMediaPlayerPresentationStatusChangedEvent

Tells the observer when the video or audio locked status changes. Presentation information is also available through the function ToiMediaPlayerBase#getPresentationInfo.

Class ToiNetService

ToiNetService is used to configure and retrieving information about logical networks. A logical network (aka network) is a collection of everything in the system required to allow network access. This includes network interfaces, dns, routing and wifi management.

Class ToiNetwork

This interface represents a logical network. A logical network encapsulates a network interface and settings used to configure the network interface and the system's network related properties such as DNS and routes.

Class ToiPlatformPowerControllerStatusChangedEvent

Called when an application has registered or released for power control.

Method ToiPlatformService#getDatabases( )

Get information of the system's databases. Each entry indicates the outcome of the last attempt to open the database. Restarting the system will void previous status.

Method ToiPlatformService#getPowerControllerInfo( )

Returns information of available power controller.

typedef ToiPlatformService.ToiDatabaseFlag

The different outcomes when a database is opened. DATABASE_FLAG_OK and DATABASE_FLAG_FAILED are mutually exclusive. When DATABASE_FLAG_OK is set, other flags can be checked for more detailed database information.

typedef ToiPlatformService.ToiDatabaseType

Enumeration of the system's databases.

typedef ToiPlatformService.ToiTime

Type representing time in seconds since the Unix epoch (1970-01-01 00:00:00).

Member ToiPlatformService.REMOVE_BOOKINGS

Empties the scheduler database.

Member ToiPlatformService.REMOVE_CHANNELS

Remove the channel database.

Member ToiPlatformService.ToiDatabaseInfo

Status report for a specific database.

Class ToiPowerControl

ToiPowerControl is used for power management.

There are several regulating bodies with respect to power consumption, eg. Energy Star, EU, IEC, and this interface is intended to allow applications to be compliant with each.

Class ToiResourceService

This service expose the free system resources. This service is just for tracking the resources and notifying the application as and when there is any change in free resources through ToiResourceObserver.

Class ToiSchedulerScheduledDiscontinuityEvent

This function will be called in the rare condition when there has been a discontinuity in time and any notification timestamp (start, stop or trigger) of a booking has already expired (after adjusting time). The expired notifications will be missed and any remaining notifications will be sent as normal at the correct time.

Class ToiSchedulerSeriesChangedEvent

This function will be called when a series is changed.

Method ToiSchedulerService#getBookingIdsForSeries( seriesId )

Get the bookings associated with a series.

Method ToiSchedulerService#getSeries( id )

Get the info of the series with a certain series identifier

Method ToiSchedulerService#getSeriesConflicts( id , category , activity , start , duration , weekdays , occurrence )

Detect conflicts for a new series booking or a series booking about to be rescheduled, but without actually booking any activities.

Method ToiSchedulerService#getSeriesIds( categoryExpression )

Get the all series identifiers with the given category.

Method ToiSchedulerService#getSeriesParameter( id , name )

Get user defined parameters associated with a series.

Method ToiSchedulerService#getSeriesParameterNames( id )

Get all user defined parameters names associated with a series.

Method ToiSchedulerService#removeSeries( id )

Remove a booked recurrent scheduling.

Method ToiSchedulerService#scheduleSeries( category , activity , start , duration , weekdays , numberOfOccurrences , conflictStrategy )

Requests scheduling of a recurrent booking.

Method ToiSchedulerService#setSeriesParameter( id , name , value )

Add user defined parameters to a scheduled series.

Method ToiSchedulerService#unsetSeriesParameter( id , name )

Remove user defined parameters from a scheduled series.

Member ToiSchedulerService.ToiSeries

Structure containing information about an existing series

5.0.1

Copyright (c) 2016 ARRIS Enterprises, LLC. All Rights Reserved. ARRIS Enterprises, LLC. Confidential Information.