Verimatrix 3.3 adaptor for encryption
PROPERTIES
| Name | VerimatrixOMI |
| System ID | VO |
| Connection String | http://username:password@Verimatrix_ip:8090/services |
| Heartbeat Connection String | http://username:password@Verimatrix_ip:8090/services |
SUPPORTED NODE
DEFINITIONS
| Message UID | Node Definition Name |
| 01VO01 | SignOn |
| 01VO02 | LogOff |
| 01VO03 | AddContent |
| 01VO04 | StartEncryption |
| 01VO05 | GetEncryptionStatus |
| 01VO06 | WaitForEncryptionComplete |
| 01VO07 | GetNetworkContentIds |
| 01VO08 | RemoveContentFromNetwork |
| SuperState | Encrypt |
* The message has been deprecated. Please use the replacement message(s) instead.
NODE DEFINITION
DETAILS
This message Signs in a user to perform encryption operation
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| handle | Signon handle string after successful login to Verimatrix. |
This message logs off the user from the verimatrix sytem
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string obtained from successful login to Verimatrix service. |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Log off, 'Success' if successful |
Adds content to Vermatrix with a given contentId only if the contentId does not exist in the verimatrix. This contentId is used in other subsequent api calls.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id can used to reference the content |
| contentDescription | NO | description of the content |
| contentTag | NO | tag associated with the content |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Add Content, 'Success' if successful |
This message will start the encryption.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id used in AddContent message. |
| encryptionMode | NO | AES or RC4. Default is AES |
| outputLocation | NO | Output file directory |
| inputFilePath | NO | Complete Input file path |
| keyInsertionInterval | NO | Control word insertion interval for NULLS or ECMs (range: 0 - 2147483647). Default is 0 |
| audioEncryptionLevel | NO | Audio encryption percentage (range: 0 - 100%). The larger the number, greater the encryption. default is 0 |
| videoEncryptionLevel | NO | Video encryption percentage (range 0 - 100%). The larger the number, the greater the encryption. Default is 0 |
| ccCGMS_A | NO | Possible values are: 0 = Copy Freely, 1 = Copy No More, 2 = Copy Once, 3 = Copy Never defines the content protection. Default is 0 |
| ccACP | NO | Possible values are: 0 = Copy protection encoding off, 1 = AGC process on. Split burst off, 2 = AGC process on. 2 line split burst on, 3 = AGC process on. 4 line split burst on. Default is 0 |
| pcrCorrection | NO | PCR correction to correct jitter in a movie, true or false. Default is false |
| videoMark | NO | true = VideoMark enabled, false = VideoMark disabled. Default is false |
| ecmControlWord | NO | true = ECM, false = NULL. default is false |
| ccDwightCavendish | NO | true enables Dwight Cavendish protection.Default value is false |
| ccHDCP | NO | true enables HDCP high-bandwidth Digital Content Protection. Default value is false |
| ratingLevel | NO | Rating level value (range 1 - 255). Default is 1 |
| encryptionDescription | NO | Description related to encryption |
| keyMutationInterval | NO | Number of packets in which to modify a key (range: 1 - 2147483647). Default is 1 |
| movieName | NO | Name of the movie |
| tag1 | NO | first tag for the movie |
| tag2 | NO | Second tag of the movie |
| tag3 | NO | Third tag for the movie |
| fileSize | NO | file size of the movie |
| fileType | NO | file type of the movie |
| networkId | NO | Id of Network |
| contentType | NO | VOD or DTV. Default is VOD |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | Response of Start Encryption, 'Success' if successful |
| networkContentId | Id the Network uses to reference the content |
This message gets the current status of the encryption process.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id can used to reference the content |
| networkId | NO | Id of the network |
| networkContentId | NO | Id the Network uses to reference the content |
| networkContentType | NO | VOD or DTV. Default is VOD |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| percentComplete | Encryption % completion as integer |
| status | Encryption Status |
| response | response of thw message, 'Success' if successful |
checks status of a encryption process, every given interval till encryption completes
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id used in AddContent message. |
| delay | NO | wait period between verifying encryption status |
| outputLocation | NO | Output directory for encrypted file |
| networkContentId | NO | Id the Network uses to reference the content |
| networkId | NO | Id of Network |
| networkContentType | NO | VOD or DTV. Default is VOD |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| percentComplete | Encryption % completion as integer |
| status | Human readable Verimatrix status |
| encryptedFilePath | Encrypted FilePath |
| encryptionKeyBlock | Encryption Key Block |
This message gets the networkcontentId which can be used to get status of an Encryption process
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| contentId | NO | cms created id can used to reference the content |
| networkId | NO | Id of the network |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| networkContentIds | Comma Seperated Ids the Network uses to reference the content |
| response | response of thw message, 'Success' if successful |
Removes Content from a Network.
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
| contentId | NO | cms created id can used to reference the content |
| handle | NO | Signon handle string after successful login to Verimatrix service. |
| networkId | NO | Id of the network |
| networkContentType | NO | VOD or DTV. Default is VOD |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| response | response of thw message, 'Success' if successful |
REQUEST MESSAGE:
| Parameter Name | Blank Value Allowed? | Description / Value |
RESPONSE MESSAGE:
| Parameter Name | Description / Value |
| handle | Signon handle string after successful login to Verimatrix service. |
| contentId | cms created id can used to reference the content |
| contentDescription | description of the content |
| contentTag | tag associated with the content |
| response | Response of last executed internal Message node.'Success' if successful |
| encryptionMode | AES or RC4. Default is AES |
| outputLocation | Output location (specific to Verimatrix mount point) |
| inputFilePath | Complete Input file path |
| keyInsertionInterval | Control word insertion interval for NULLS or ECMs (range: 0 - 2147483647). Default is 0 |
| audioEncryptionLevel | Audio encryption percentage (range: 0 - 100%). The larger the number, greater the encryption. default is 0 |
| videoEncryptionLevel | Video encryption percentage (range 0 - 100%). The larger the number, the greater the encryption. Default is 0 |
| ccCGMS_A | Possible values are: 0 = Copy Freely, 1 = Copy No More, 2 = Copy Once, 3 = Copy Never defines the content protection. Default is 0 |
| ccACP | Possible values are: 0 = Copy protection encoding off, 1 = AGC process on. Split burst off, 2 = AGC process on. 2 line split burst on, 3 = AGC process on. 4 line split burst on. Default is 0 |
| pcrCorrection | PCR correction to correct jitter in a movie, true or false. Default is false |
| videoMark | true = VideoMark enabled, false = VideoMark disabled. Default is false |
| ecmControlWord | true = ECM, false = NULL. default is false |
| ccDwightCavendish | true enables Dwight Cavendish protection.Default value is false |
| ccHDCP | true enables HDCP high-bandwidth Digital Content Protection. Default value is false |
| ratingLevel | Rating level value (range 1 - 255). Default is 1 |
| encryptionDescription | Description related to encryption |
| keyMutationInterval | Number of packets in which to modify a key (range: 1 - 2147483647). Default is 1 |
| localOutputLocation | Output location (specific to CMS ) |
| movieName | Name of the movie |
| tag1 | first tag for the movie |
| tag2 | Second tag of the movie |
| tag3 | Third tag for the movie |
| fileSize | file size of the movie |
| fileType | file type of the movie |
| networkId | Id of Network |
| contentType | VOD or DTV. Default is VOD |
| networkContentId | Id the Network uses to reference the content |
| networkContentType | VOD or DTV. Default is VOD |
| delay | wait period between verifying encryption status |
| percentComplete | Encryption % completion as integer |
| status | Human readable Verimatrix status |
| encryptedFilePath | Encrypted FilePath |
| encryptionKeyBlock | Encryption Key Block |
| networkContentIds | already existing networkcontentIds for existing content |
| © 2002 - 2012 Ericsson Television Inc. |
| All Rights Reserved. |