CA
The UnifiedCAS module provides Conditional Access System functions for NSTV, Conax, CryptoGuard and Verimatrix.
Conditional Access System.
Basic Info.
Call getCASVendor function to know the name of CAS installed. Call getCASVersion function to know the CAS Version. Call getCardSN function to know the SmartCard Number. Call getSTBID function to know the ChipID of the STB.
MMI Info.
Call getMMI function to get the MMI Info from CryptoGuard Lib. The MMI Info is defined by CryptoGuard Documentation and structured into multiple levels to get status of the Program Card. ie. About CA, Subscription Status, PPV Status, Parental Control. In the example page, We first get the Info for Level 0. Later, based on the selection, individual Level info are retreived. Level 0 outputs: N00-Cryptoguard CA\nS01-Subscription\nS02-Pay-per-view\nS03-About CA\n. Level 1 ouputs the subscription information that should be displayed on the screen. If no subscription is available the ouput will be like this:N00-No subscriptions.\n Level 2 ouputs the PPV event information that should be displayed on the screen. If no PPV events exists the ouput will be like this:N00-No subscriptions.\n Level 3 outputs Parental control information that should be displayed on the screen. Level 4 outputs CA information that should be displayed on the screen.
Loader Info.
Call getLoaderParam function to get the Loader Info from Loader. Loader Info such as HWVersion, SWVersion and Loader Version are read independently of the CAS.
Get Rating.
Call getRating function to get the Maturity Level set in the Card.
Set Rating.
Call setRating function to set the Maturity Level in the Card.
Verify PIN.
Call verifyPin function to verify the PIN set in the Card.
Change PIN.
Call changePin function to change the PIN set in the Card.
Check SmartCard Status.
Call getCardStatus function to get the SmartCard Status.
Check CryptGuard IP.
Call setServerURL function to set the Server URL to fetch EMM . Call play function to play the CryptoGuard IP MultiCast Stream.
We can receive Messages from CyrptoGuard Server or STB by setting following signals. onShowFingerMessageExt . Set this callback to receive fingerprint message. onShowOSDMessage . Set this callback to receive show osd message. onHideOSDMessage . Set this callback to receive hide osd message. onShowEMMMessage . Set this callback to receive show emm message. onNotifySmcStatus . Set this callback to receive smc status message. onLockService . Set this callback to receive force tune message.
Members
onAttributeMessage
Signals that the Show Attribute Message has been received (for Irdeto). The listener will be passed the following arguments:
- msgType: The attributeMessage osd message to display.'0' is normal Attribute Message; '1' is Forced Text
- duration: The attributeMessage duration for the osd message.
- isFlashing: The attributeMessage Flashing or Not-Flashing.
- isTitleBar: The attributeMessage Whether display the message with title bar.'0' is without; '1' is with
- coverageCode: The attributeMessage This is the amount of screen space that should be obscured/blocked by the OSD used to display the message
- textMsg: The attributeMessage Text message to display.
onBluetoothEvent
Signal fired when some bluetooth event occurs with a device. The listener will be passed the following arguments:
- eventData: A EventData object containing event related data.
onDecoderControl
Signals that the Show Decoder Control Message has been received (for Irdeto). The listener will be passed the following arguments:
- decType: The decoderControl Decoder Control message type.'0' is Download control;'1' is Call back;'2' is Special monitor mode;'3' is Read Smartcard User Data;'4' is Change PIN code;'5' is Decoder recovery;'6' is User Payload.
- allowed: The decoderControl Available when type = 1. Whether the download option is to be enabled. 1 is enabled, else disabled.
- forcedDownload: The decoderControl Available when type = 1. Whether to force a download. 1 to let STB start downloading immediately.
- profdecForcedDownload: The decoderControl Available when type = 1. Whether to force a download on a Profdec. 1 to let STB start downloading immediately.
- index: The decoderControl Available when type = 4. The index of the PIN that is stored in NVRAM.It is always set to 0.
- pinCode: The decoderControl Available when type = 4. The parental PIN Code in NVRAM.
- recoveryType: The decoderControl Available when type = 6. The actual Decoder Recovery message type.'0' is Reset IRD;'1' is Reset Channel Order;'2' is Re-Scan;'3' is Erase service lists;'4' is Reconnect to current service;'5' is Force tune;'6' is Force set installer PIN code.
- bouquetID: The decoderControl Available when type = 6 and recoveryType = 1. The bouquetID.
- onID: The decoderControl Available when type = 6 and recoveryType = 5. oiginal_network_id of the Service.
- tsID: The decoderControl Available when type = 6 and recoveryType = 5. transport_stream of the Service.
- serviceID: The decoderControl Available when type = 6 and recoveryType = 5. Service ID of the Service.
- installerPinCode: The decoderControl Available when type = 6 and recoveryType = 6. The Force set installer PIN code.
onEcmMonitoringInfo
Signals that the Ecm Monitoring has been changed (for Irdeto). The listener will be passed the following arguments:
- serviceHandle: The ecmMonitoring service handle of this ECM.
- caSystemID: The ecmMonitoring Ca sytem ID of this ECM.
- monitorInfo: The ecmMonitoring Text of Monitoring.
onEcmStatusUpdate
Signals that the Ecm status has been changed (for Irdeto). The listener will be passed the following arguments:
- serviceHandle: The ecmMonitoring service handle of this ECM.
- status: The ecmStatus Text of Status.
onEmmMonitoringInfo
Signals that the Emm Monitoring has been changed (for Irdeto). The listener will be passed the following arguments:
- serviceHandle: The emmMonitoring service handle of this EMM.
- caSystemID: The emmMonitoring Ca sytem ID of this EMM.
- monitorInfo: The emmMonitoring Text of Monitoring.
onEmmStatusUpdate
Signals that the Emm status has been changed (for Irdeto). The listener will be passed the following arguments:
- serviceHandle: The emmStatus service handle of this EMM.
- status: The emmStatus Text of Status.
onFlexiflashMessage
Signals that the Show Flexi flash message has been received (for Irdeto). The listener will be passed the following arguments:
- secureCoreListStatus: The flexiflashMessage This string shows the secure core status.
- packagesDownloadProgressInfo: The flexiflashMessage When a Cloaked CA package download is triggered, this string indicates the download progress of the Cloaked CA package.
onFSUAction
Signals that the FSU action has been received (for Irdeto). The listener will be passed the following arguments:
- actionType: TThe FSUAction FSU Action type.'0' is receive data;'1' is display message and tune; '2' is report result and tune back.
- caSystemID: The FSUAction The ca system ID.
- forcedUpdate: The FSUAction Available when actionType = 0.
- onID: The FSUAction Available when actionType = 1,onID of the forcetuned stream.
- tsID: The FSUAction Available when actionType = 1,tsID of the forcetuned stream.
- serviceID: The FSUAction Available when actionType = 1,serviceID of the forcetuned stream.
onHideOSDMessage
Signals that the Hide OSD Message has been received. The listener will be passed the following arguments:
- message: The osdMessage message is NULL.
- duration: The osdMessage duration is 0.
onIFCPImageMessage
Signals that the Show Flexi flash message has been received (for Irdeto). The listener will be passed the following arguments:
- imageStatus: The IFCPImageMessage This is a string that indicates the status of the IFCP Image.
- packagesDownloadProgressInfo: The IFCPImageMessage When an IFCP Image download is triggered, this string indicates the progress of the IFCP Image download.
onLockService
Signals that the Force Tune Message has been received (for Irdeto). The listener will be passed the following arguments:
- onID: The forcetuneMessage onID of the forcetuned stream.
- tsID: The forcetuneMessage tsID of the forcetuned stream.
- serviceID: The forcetuneMessage serviceID of the forcetuned stream.
onNotifySmcStatus
Signals that the Smart Card status has been changed. The listener will be passed the following arguments:
- smcStatus: The module:Platform.CA.smcStatus SmartCard Status.
onOTATrigger
Signals that the OTA Trigger has been received. The listener will be passed the following arguments:
- SIType: The OTATrigger Which SI the trigger is from.'NIT','BAT' or 'PMT'.
- validUpdate: The OTATrigger '1' is update valid;'0' is invalid.
- downloadMode: The OTATrigger Download mode.'0' is Forced; '1' is background;'2' is delayed.
- triggerControlMode: The OTATrigger Trigger mode.'1' is EMM; '2' is Menu;'3' is EMM and Menu;'4' is Auto;'5' is Auto and EMM;'6' is Auto and Menu;'7' is Auto and EMM and Menu.
- onID: The OTATrigger onID of the forcetuned stream.
- tsID: The OTATrigger tsID of the forcetuned stream.
- serviceID: The OTATrigger serviceID of the forcetuned stream.
onServiceStatus
Signals that the Show Service status has been received (for Irdeto). The listener will be passed the following arguments:
- serviceHandle: The serviceStatus Service handle which the status belongs to.
- statusMessage: The serviceStatus Status message to display.
onShowEMMMessage
Signals that the Show EMM Message has been received (for Irdeto). The listener will be passed the following arguments:
- Text: The emmMessage Text for EMM Message to display.
- Duration: The emmMessage Duration in Ms for the EMM Message.
onShowFingerMessageExt
Signals that the FingerPrint message has been received. The listener will be passed the following arguments:
- xpos: The fingerprintMessage absolute x position of Fingerprint .
- ypos: The fingerprintMessage abslute ypos of Fingerprint .
- isOptions: The fingerprintMessage '0' is Fingerprint, '1' is Fingerprint Options.
- DurationMs: The fingerprintMessage Duration in Ms of Fingerprint.
- isFlashing: The fingerprintMessage Flashing or Not-Flashing of Fingerprint.
- fgType: The fingerprintMessage For Fingerprint, '0' is Overt, '1' is Covert.
- coverageCode: The fingerprintMessage Covert: Percentage of dot matrix area to the total screen area.- Overt: Percentage of banner width to the screen width.
- FontTra: The fingerprintMessage Font Transparency of FingerPrint.
- FontColor: The fingerprintMessage Font Color of FingerPrint.
- BackgroundTra: The fingerprintMessage Background Transparency of FingerPrint .
- BackgroundColor: The fingerprintMessage Background Color of FingerPrint .
- DisplayText: The fingerprintMessage Text of the Fingerprint .
onShowOSDMessage
Signals that the Show OSD Message has been received. The listener will be passed the following arguments:
- message: The osdMessage Text message type.
- duration: The osdMessage duration for the osd message.
onTextMessage
Signals that the Show Text message has been received (for Irdeto). The listener will be passed the following arguments:
- textType: The textMessage Type of text. '0' is Mail; '1' is Announcement; '2' is Club Numbers.
- msgClass: The textMessage Class of text. '0' is Noraml; '1' is Timed; '2' is Forced Display.
- isFlush: The textMessage Whether the message buffer in the decoder should be flushed.
- isCompressed: The textMessage Whether the message data is compressed.
- club: The textMessage Whether the received message was actually a club message.
- priority: The textMessage The message priority. Higher priority messages push lower priority messages out of the message buffer.
- textMsg: The textMessage The test message.
- dt_Year: The textMessage The year in the date for the message to be automatically deleted. The values 95 - 99 imply 1945 to 1999, and the values 00 - 94 imply 2000 to 2094.
- dt_Month: The textMessage The month in the date for the message to be automatically deleted. The values range from 1 to 12.
- dt_Day: The textMessage The day in the date for the message to be automatically deleted. The values range from 1 to 31.
- dt_Hour: The textMessage The hour in the time for the message to be automatically deleted. The values range from 0 to 23.
- dt_Minute: The textMessage The ten-minute period of the time for the message to be automatically deleted. The values range from 0 to 5.
Methods
analyzeOTAStream()
Analyze OTA Stream (for Irdeto).
Parameters:
| Name | Type | Description |
|---|---|---|
param.serviceId | String | The serviceId to analyze. |
Returns:
| Type | Description |
|---|---|
| A promise. | No arguments are passed to the completion handler. |
changePin()
Change the PIN for the Card.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - OldPinCode: The current changedPin. - NewPinCode: The current changePin. |
eraseModule()
Erase the CA files in flash (for Irdeto).
Parameters:
| Name | Type | Description |
|---|---|---|
param.moduleID | Number | The module ID.'0' is Secure Core;'3' is Config;'6' is IFCP;'8' is PrivateData. |
Returns:
| Type | Description |
|---|---|
| A promise. | No arguments are passed to the completion handler. |
fsuNotifyCAT()
Nodify CAT to CA lib for FSU (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | No arguments are passed to the completion handler. |
fsuSetAction()
Set FSU Action (for Irdeto).
Parameters:
| Name | Type | Description |
|---|---|---|
param.caSystemID | The caSystemID to set. | |
param.isTuningActionCancelled | If cancel curent FSU tuning. |
Returns:
| Type | Description |
|---|---|
| A promise. | No arguments are passed to the completion handler. |
getBuildInfo()
Get Build Info of CAS Lib (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - buildInformation: The current getBuildInfo. |
getCapabilities()
Get capabilities of CAS Lib (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - capabilities: The current getCapabilities. |
getCardSN()
Gets the SmartCard Number.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - cardSN: The current getCardSN. |
getCASVendor()
Gets the name of CAS Vendor.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - casVendor: The current getCASVendor. |
getCASVersion()
Gets the CAS Version.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - caVer: The current getCASVersion. |
getCDSN()
Gets the CDSN of STB (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - cdsn: The current getCDSN. |
getClientIDString()
Get clientID String List for all products (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - caSystemID: The current getClientIDString. - clientIDString: The current getClientIDString. |
getCSSN()
Gets the CSSN of STB (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - cssn: The current getCSSN. |
getFlexiflashMsg()
Get flexi flash message from CAS Lib.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following members: - secureCoreListStatus: The getFlexiflashMsg This string shows the secure core status. - packagesDownloadProgressInfo: The getFlexiflashMsg When a Cloaked CA package download is triggered, this string indicates the download progress of the Cloaked CA package. |
getIFCPImageMsg()
Get IFCP image message from CAS Lib.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following members: - imageStatus: The getIFCPImageMsg This is a string that indicates the status of the IFCP Image. - packagesDownloadProgressInfo: The getIFCPImageMsg When an IFCP Image download is triggered, this string indicates the progress of the IFCP Image download. |
getLoaderParam()
Gets the Loader Parameters.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - swVer: The current getLoaderParam. - hwVer: The current getLoaderParam. - ldrVer: The current getLoaderParam. |
getLockId()
Get LockId of CAS Lib (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - lockID: The current getLockId. |
getMMI()
Gets the MMI data (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - message: The current getMMI. |
getNationality()
Get nationality List for all products (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed a list includes the following members: - caSystemID: The current getNationality. - nationality: The current getNationality. |
getOperatorInfo()
Get Operator Info List for all products (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed a list includes the following members: - active: The current getOperatorInfo. - activeCaSystemID: The current getOperatorInfo. - caSystemIDStart: The current getOperatorInfo. - caSystemIDEnd: The current getOperatorInfo. - operatorName: The current getOperatorInfo. |
getProductStatus()
Gets the service status of STB (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - productCount: The current getProductStatus. - productList: An Array of productList. |
getRating()
Gets the Maturity Rating Level of the Card.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - rating: The current getRating. |
getSectionCount()
Get count of ECM and EMM List for all products (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed a list includes the following members: - caSystemID: The current getSectionCount. - emmCount: The current getSectionCount. - ecmCount: The current getSectionCount. |
getSecureType()
Get secureType.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - secureType: The current getSecureType. |
getSerialNumber()
Get SerialNumber from CAS Lib List for all products.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed a list includes the following members: - caSystemID: The current getSerialNumber. - sn: The current getSerialNumber. |
getServiceHandles()
Gets the all service handles of STB (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed a list which includes the following members: - serviceHandle: The current getServiceHandles. - name: The current getServiceHandles. |
getServiceStatus()
Gets the service status of STB (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - serviceStatus: The current getServiceStatus. - shareableStatus: The current getServiceStatus. - isSpeRemainingTimeValid: The current getServiceStatus. - remainingTime: The current getServiceStatus. - productID: The current getServiceStatus. - streamCount: The current getServiceStatus. - streamList: The current getServiceStatus. |
getSTBID()
Gets the Chip ID of STB.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - stbID: The current getSTBID. |
getTmsData()
Get tms Data List for all products (for Irdeto).
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed a list includes the following members: - caSystemID: The current getTmsData. - tmsData: The current getTmsData. |
setLoaderParam()
Sets the Loader Parameters.
Parameters:
| Name | Type | Description |
|---|---|---|
param.upgradeType | Number | The upgrade type.'0' is USB;'1' is OTA;'2' is HTTP;'3' is Forced. |
param.tunerType | Number | The tuner type.'1' is cable;'2' is terrestrial;'3' is satellite. |
param.pid | Number | The download PID. |
param.tableId | Number | The download tableID. |
param.frequency | Number | The download frequency. |
param.symbolRate | Number | The download symbolRate. |
Returns:
No arguments are passed to the completion handler.
setRating()
Sets the Maturity Rating Level in the Card.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - pinCode: The current setRating. - rating: The current setRating. |
setServerURL()
Sets the Server URL to fetch EMM for CryptoGuard IP.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - server_url: The current setServerURL. |
switchServiceMonitoring()
Switch the monitoring of ECM and EMM (for Irdeto).
verifyPin()
Verify PIN for the Card.
Returns:
| Type | Description |
|---|---|
| A promise. | The completion handler will be passed the following arguments: - pinCode: The current verifyPin. |
writeModule()
Write the CA files to flash (for Irdeto).
Parameters:
| Name | Type | Description |
|---|---|---|
param.moduleID | Number | The module ID.'0' is Secure Core;'3' is Config;'6' is IFCP;'8' is PrivateData. |
Returns:
No arguments are passed to the completion handler.