com.netflix.imflibrary

Class KLVPacket.Header

java.lang.Object

com.netflix.imflibrary.KLVPacket.Header

Enclosing class:

KLVPacket

@Immutable
public static final class KLVPacket.Header
extends java.lang.Object

A class that represents a KLV packet header

Constructor Summary

Constructors

Constructor and Description
Header(ByteProvider byteProvider, long byteOffset) Instantiates a new Header.

Method Summary

Modifier and Type	Method and Description
boolean	categoryDesignatorIsDictionaries() Checks if the category designator in the key of this KLV packet is set to the value corresponding to dictionaries as defined in st336:2007
boolean	categoryDesignatorIsGroups() Checks if the category designator in the key of this KLV packet is set to the value corresponding to groups as defined in st336:2007
boolean	categoryDesignatorIsLabels() Checks if the category designator in the key corresponds to labels
boolean	categoryDesignatorIsWrappersAndContainers() Checks if the category designator in the key of this KLV packet is set to the value corresponding to wrappers and containers as defined in st336:2007
long	getByteOffset() Gets the byteOffset in the underlying resource.
byte[]	getKey() Getter for the key of the KLV packet
long	getKLSize() Getter for the size of the Key and Length fields of the KLV packet
long	getLSize() Getter for the size of the length field of the KLV packet
java.lang.Integer	getRegistryDesignator() Gets the RegistryDesignator value in the key
java.lang.Integer	getSetOrPackKindKey() Gets the Set/Pack kind
long	getVSize() Getter for the value field of the KLV packet
java.lang.String	toString() A method that returns a string representation of a KLV packet header object

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Header

public Header(ByteProvider byteProvider,
              long byteOffset)
       throws java.io.IOException

Instantiates a new Header.

Parameters:

byteProvider - the mxf byte provider

byteOffset - corresponding to the MXF KLV header

Throws:

java.io.IOException - - any I/O related error will be exposed through an IOException

Method Detail

getKey

public byte[] getKey()

Getter for the key of the KLV packet

Returns:

a copy of the key array

getVSize

public long getVSize()

Getter for the value field of the KLV packet

Returns:

the size of the value field

getLSize

public long getLSize()

Getter for the size of the length field of the KLV packet

Returns:

the size of the length field

getByteOffset

public long getByteOffset()

Gets the byteOffset in the underlying resource.

Returns:

the byteOffset

getKLSize

public long getKLSize()

Getter for the size of the Key and Length fields of the KLV packet

Returns:

the kL size

categoryDesignatorIsDictionaries

public boolean categoryDesignatorIsDictionaries()

Checks if the category designator in the key of this KLV packet is set to the value corresponding to dictionaries as defined in st336:2007

Returns:

the boolean

categoryDesignatorIsGroups

public boolean categoryDesignatorIsGroups()

Checks if the category designator in the key of this KLV packet is set to the value corresponding to groups as defined in st336:2007

Returns:

the boolean

categoryDesignatorIsWrappersAndContainers

public boolean categoryDesignatorIsWrappersAndContainers()

Checks if the category designator in the key of this KLV packet is set to the value corresponding to wrappers and containers as defined in st336:2007

Returns:

the boolean

getSetOrPackKindKey

public java.lang.Integer getSetOrPackKindKey()

Gets the Set/Pack kind

Returns:

the pack kind interpreted as an Integer

getRegistryDesignator

public java.lang.Integer getRegistryDesignator()

Gets the RegistryDesignator value in the key

Returns:

the pack kind interpreted as an Integer

categoryDesignatorIsLabels

public boolean categoryDesignatorIsLabels()

Checks if the category designator in the key corresponds to labels

Returns:

the boolean

toString

public java.lang.String toString()

A method that returns a string representation of a KLV packet header object

Overrides:

toString in class java.lang.Object

Returns:

string representing the object