CencInfo (Wowza Streaming Engine 4 API)

Object
- com.wowza.wms.drm.cenc.CencInfo

All Implemented Interfaces:: IDvrEncryptionInfo, com.wowza.wms.httpstreamer.util.IEncryptionInfo, Cloneable

public class CencInfo
extends Object
implements IDvrEncryptionInfo, com.wowza.wms.httpstreamer.util.IEncryptionInfo

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ALGORITHMID_CBC`
`static int`	`ALGORITHMID_CTR`
`static int`	`ALGORITHMID_NONE`
`static int`	`KEY_ROTATION_TYPE_EXTERNAL`
`static int`	`KEY_ROTATION_TYPE_INTERNAL_RANDOM`
`static int`	`KEY_ROTATION_TYPE_INTERNAL_STATIC`
`static int`	`KEY_ROTATION_TYPE_NONE`
`static int`	`PSSH_VERSION_0`
`static int`	`PSSH_VERSION_1`

Fields inherited from interface com.wowza.wms.dvr.IDvrEncryptionInfo
ENCRYPTION_TYPE_CENC, ENCRYPTION_TYPE_CUPERTINO, ENCRYPTION_TYPE_PLAYREADY

Constructor Summary

Constructors
Constructor and Description

CencInfo()

Constructors
Constructor and Description
`CencInfo()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addDRM(String hashKey, ICencDRMInfo drm)` Adds a DRM system info instance to the list of DRM systems associated with the stream encryption.
`Object`	`clone()`
`static CencInfo`	`deserialize(byte[] data)`
`static CencInfo`	`deserialize(java.nio.ByteBuffer buffer)`
`static String`	`formatKID(String KID)`
`String`	`generateRandomKID()`
`int`	`getAlgorithm()`
`String`	`getAlgorithmString()`
`String`	`getCencMp4ProtSchemeString()`
`String`	`getCencMpegTsProtSchemeString()`
`java.util.Map<String,ICencDRMInfo>`	`getDRMs()`
`byte[]`	`getEncIVBytes()`
`byte[]`	`getEncKeyBytes()`
`java.util.List<byte[]>`	`getEncKeyBytesList()`
`String`	`getEncKeyString()`
`byte[]`	`getEncRepeaterBytes()`
`int`	`getEncryptionType()` Serialize encryption info.
`boolean`	`getIsRotatingKeys()`
`java.util.Map<Integer,com.wowza.wms.drm.cenc.CencInfo.KeyPair>`	`getKeyPairs()`
`int`	`getKeyRotationType()`
`String`	`getKID()`
`byte[]`	`getKIDBytes()`
`byte[]`	`getKIDBytesSwapped()`
`java.util.List<byte[]>`	`getKIDsBytesList()`
`java.util.List<byte[]>`	`getKIDsBytesListSwapped()`
`java.util.List<String>`	`getKIDsList()`
`String`	`getNameSpaceString()`
`int`	`getPSSHFlags()`
`int`	`getPSSHVersion()`
`int`	`getSerializeSize()` Return number of bytes required to serialize this encryption info.
`boolean`	`isValid()`
`static boolean`	`loadFromKeyFile(IApplicationInstance appInstance, String streamName, CencInfo cencInfo, long chunkId, int chunkDurationTarget, String keyFileParamPrefix)`
`byte[]`	`serialize()` Serialize the encryption info, returning a byte buffer containing the serialized data.
`int`	`serialize(byte[] buffer, int pos)` Serialize the encryption info into buffer starting at position 'pos'.
`void`	`setAlgorithm(int algorithm)` Sets the encryption algorithm to be used.
`void`	`setAppInstance(IApplicationInstance appInstance)`
`void`	`setEncKeyBytes(byte[] keyBytes)` Sets the encryption content key as a byte buffer.
`void`	`setEncKeyBytesList(java.util.List<byte[]> keyBytesList)`
`void`	`setEncRepeaterBytes(byte[] encRepeaterBytes)`
`void`	`setIVBytes(byte[] encIVBytes)`
`void`	`setKeyPairs(java.util.Map<Integer,com.wowza.wms.drm.cenc.CencInfo.KeyPair> keyPairs)`
`void`	`setKeyRotationInterval(int interval)`
`void`	`setKeyRotationType(int keyRotationType)`
`void`	`setKID(byte[] KIDbytes)` Sets the encryption key id.
`void`	`setKID(String KID)` Sets the encryption key id.
`void`	`setKIDsList(java.util.List<String> KIDList)` Sets the list of encryption key id strings.
`void`	`setPSSHFlags(int psshFlags)`
`void`	`setPSSHVersion(int psshVersion)`
`static byte[]`	`swapKIDBytes(byte[] KID)`
`String`	`toString()`
`void`	`updateKey(long chunkId, int chunkDurationTarget)`

Methods inherited from class Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ALGORITHMID_CBC
```
public static final int ALGORITHMID_CBC
```
    See Also:
    Constant Field Values
  - ALGORITHMID_CTR
```
public static final int ALGORITHMID_CTR
```
    See Also:
    Constant Field Values
  - ALGORITHMID_NONE
```
public static final int ALGORITHMID_NONE
```
    See Also:
    Constant Field Values
  - KEY_ROTATION_TYPE_EXTERNAL
```
public static final int KEY_ROTATION_TYPE_EXTERNAL
```
    See Also:
    Constant Field Values
  - KEY_ROTATION_TYPE_INTERNAL_RANDOM
```
public static final int KEY_ROTATION_TYPE_INTERNAL_RANDOM
```
    See Also:
    Constant Field Values
  - KEY_ROTATION_TYPE_INTERNAL_STATIC
```
public static final int KEY_ROTATION_TYPE_INTERNAL_STATIC
```
    See Also:
    Constant Field Values
  - KEY_ROTATION_TYPE_NONE
```
public static final int KEY_ROTATION_TYPE_NONE
```
    See Also:
    Constant Field Values
  - PSSH_VERSION_0
```
public static final int PSSH_VERSION_0
```
    See Also:
    Constant Field Values
  - PSSH_VERSION_1
```
public static final int PSSH_VERSION_1
```
    See Also:
    Constant Field Values
- Constructor Detail
  - CencInfo
```
public CencInfo()
```
- Method Detail
  - addDRM
```
public void addDRM(String hashKey,
          ICencDRMInfo drm)
```
    Adds a DRM system info instance to the list of DRM systems associated with the stream encryption. The hashKey should be some unique string to identify the DRM System, such as a concatenation of the DRM system's system name and systemId
    Example hashKey: "myDRM:12345678-1234-1234-1234-123456789123"
    
    Parameters:
    hashKey - hash key
    drm - the drm info instance
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Specified by:
    
    clone in interface IDvrEncryptionInfo
    
    Overrides:
    
    clone in class Object
    
    Throws:
    
    CloneNotSupportedException
  - deserialize
```
public static CencInfo deserialize(byte[] data)
```
  - deserialize
```
public static CencInfo deserialize(java.nio.ByteBuffer buffer)
```
  - formatKID
```
public static String formatKID(String KID)
```
  - generateRandomKID
```
public String generateRandomKID()
```
  - getAlgorithm
```
public int getAlgorithm()
```
  - getAlgorithmString
```
public String getAlgorithmString()
```
  - getCencMp4ProtSchemeString
```
public String getCencMp4ProtSchemeString()
```
  - getCencMpegTsProtSchemeString
```
public String getCencMpegTsProtSchemeString()
```
  - getDRMs
```
public java.util.Map<String,ICencDRMInfo> getDRMs()
```
  - getEncIVBytes
```
public byte[] getEncIVBytes()
```
    Specified by:
    
    getEncIVBytes in interface com.wowza.wms.httpstreamer.util.IEncryptionInfo
  - getEncKeyBytes
```
public byte[] getEncKeyBytes()
```
    Specified by:
    
    getEncKeyBytes in interface com.wowza.wms.httpstreamer.util.IEncryptionInfo
  - getEncKeyBytesList
```
public java.util.List<byte[]> getEncKeyBytesList()
```
  - getEncKeyString
```
public String getEncKeyString()
```
  - getEncRepeaterBytes
```
public byte[] getEncRepeaterBytes()
```
  - getEncryptionType
```
public int getEncryptionType()
```
    Description copied from interface: IDvrEncryptionInfo
    Serialize encryption info.
    The encryption should consist of the following:
    - version (1 byte)
    - encryption type (1 byte)
    - length of 'blob' (2 bytes)
    - byte blob (n bytes)
    Specified by:
    
    getEncryptionType in interface IDvrEncryptionInfo
    
    Returns:
    encryption type (constants defined in this class)
  - getIsRotatingKeys
```
public boolean getIsRotatingKeys()
```
  - getKeyPairs
```
public java.util.Map<Integer,com.wowza.wms.drm.cenc.CencInfo.KeyPair> getKeyPairs()
```
  - getKeyRotationType
```
public int getKeyRotationType()
```
  - getKID
```
public String getKID()
```
  - getKIDBytes
```
public byte[] getKIDBytes()
```
  - getKIDBytesSwapped
```
public byte[] getKIDBytesSwapped()
```
  - getKIDsBytesList
```
public java.util.List<byte[]> getKIDsBytesList()
```
  - getKIDsBytesListSwapped
```
public java.util.List<byte[]> getKIDsBytesListSwapped()
```
  - getKIDsList
```
public java.util.List<String> getKIDsList()
```
  - getNameSpaceString
```
public String getNameSpaceString()
```
  - getPSSHFlags
```
public int getPSSHFlags()
```
  - getPSSHVersion
```
public int getPSSHVersion()
```
  - getSerializeSize
```
public int getSerializeSize()
```
    Description copied from interface: IDvrEncryptionInfo
    
    Return number of bytes required to serialize this encryption info.
    
    Specified by:
    
    getSerializeSize in interface IDvrEncryptionInfo
    
    Returns:
    number of bytes to serialize.
  - isValid
```
public boolean isValid()
```
  - loadFromKeyFile
```
public static boolean loadFromKeyFile(IApplicationInstance appInstance,
                      String streamName,
                      CencInfo cencInfo,
                      long chunkId,
                      int chunkDurationTarget,
                      String keyFileParamPrefix)
```
  - serialize
```
public byte[] serialize()
```
    Description copied from interface: IDvrEncryptionInfo
    
    Serialize the encryption info, returning a byte buffer containing the serialized data.
    
    Specified by:
    
    serialize in interface IDvrEncryptionInfo
    
    Returns:
    byte buffer of serialized data
  - serialize
```
public int serialize(byte[] buffer,
            int pos)
```
    Description copied from interface: IDvrEncryptionInfo
    
    Serialize the encryption info into buffer starting at position 'pos'.
    
    Specified by:
    
    serialize in interface IDvrEncryptionInfo
    
    Parameters:
    buffer - buffer to serialize to
    pos - position to start serializing
    
    Returns:
    new position into buffer
  - setAlgorithm
```
public void setAlgorithm(int algorithm)
```
    Sets the encryption algorithm to be used. Currently only CencInfo.ALGORITHMID_CTR is supported.
    
    Parameters:
    algorithm - encryption algorithm
  - setAppInstance
```
public void setAppInstance(IApplicationInstance appInstance)
```
  - setEncKeyBytes
```
public void setEncKeyBytes(byte[] keyBytes)
```
    Sets the encryption content key as a byte buffer.
    
    Parameters:
    keyBytes - the encryption content key as a byte buffer
  - setEncKeyBytesList
```
public void setEncKeyBytesList(java.util.List<byte[]> keyBytesList)
```
  - setEncRepeaterBytes
```
public void setEncRepeaterBytes(byte[] encRepeaterBytes)
```
  - setIVBytes
```
public void setIVBytes(byte[] encIVBytes)
```
  - setKeyPairs
```
public void setKeyPairs(java.util.Map<Integer,com.wowza.wms.drm.cenc.CencInfo.KeyPair> keyPairs)
```
  - setKeyRotationInterval
```
public void setKeyRotationInterval(int interval)
```
  - setKeyRotationType
```
public void setKeyRotationType(int keyRotationType)
```
  - setKID
```
public void setKID(byte[] KIDbytes)
```
    Sets the encryption key id.
    
    Parameters:
    KIDbytes - key id byte array
  - setKID
```
public void setKID(String KID)
```
    Sets the encryption key id. String must be in uuid form "F6005DCF-7F93-4B8E-85C7-F977740DA059" (big endian)
    
    Parameters:
    KID - key id
  - setKIDsList
```
public void setKIDsList(java.util.List<String> KIDList)
```
    Sets the list of encryption key id strings. Ids must be in uuid form "F6005DCF-7F93-4B8E-85C7-F977740DA059" (big endian)
    
    Parameters:
    KIDList - list of key id strings
  - setPSSHFlags
```
public void setPSSHFlags(int psshFlags)
```
  - setPSSHVersion
```
public void setPSSHVersion(int psshVersion)
```
  - swapKIDBytes
```
public static byte[] swapKIDBytes(byte[] KID)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - updateKey
```
public void updateKey(long chunkId,
             int chunkDurationTarget)
```

Class CencInfo

Field Summary

Fields inherited from interface com.wowza.wms.dvr.IDvrEncryptionInfo

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

ALGORITHMID_CBC

ALGORITHMID_CTR

ALGORITHMID_NONE

KEY_ROTATION_TYPE_EXTERNAL

KEY_ROTATION_TYPE_INTERNAL_RANDOM

KEY_ROTATION_TYPE_INTERNAL_STATIC

KEY_ROTATION_TYPE_NONE

PSSH_VERSION_0

PSSH_VERSION_1

Constructor Detail

CencInfo

Method Detail

addDRM

clone

deserialize

deserialize

formatKID

generateRandomKID

getAlgorithm

getAlgorithmString

getCencMp4ProtSchemeString

getCencMpegTsProtSchemeString

getDRMs

getEncIVBytes

getEncKeyBytes

getEncKeyBytesList

getEncKeyString

getEncRepeaterBytes

getEncryptionType

getIsRotatingKeys

getKeyPairs

getKeyRotationType

getKID

getKIDBytes

getKIDBytesSwapped

getKIDsBytesList

getKIDsBytesListSwapped

getKIDsList

getNameSpaceString

getPSSHFlags

getPSSHVersion

getSerializeSize

isValid

loadFromKeyFile

serialize

serialize

setAlgorithm

setAppInstance

setEncKeyBytes

setEncKeyBytesList

setEncRepeaterBytes

setIVBytes

setKeyPairs

setKeyRotationInterval

setKeyRotationType

setKID

setKID

setKIDsList

setPSSHFlags

setPSSHVersion

swapKIDBytes

toString

updateKey