tv.amwa.maj.iface
Interface KLVData

All Superinterfaces:

InterchangeObject

All Known Implementing Classes:

KLVData

public interface KLVData
extends InterchangeObject

Specifies a container for user data specified with a key (SMPTE label), length and value. SMPTE KLV's are specified in SMPTE&336M.

Author:

Richard Cartwright

See Also:

makeKLVData(), KLVDataDefinition, Component.getKLVData(), Mob.getKLVData(), TypeDefinitionOpaque

Method Summary

AUID	getKey() Returns the key of this KLV data.
int	getLength() Returns the size of the data buffer for this KLV data.
byte[]	getValue() Returns the value of this KLV data.
void	setValue(byte[] value) Sets the data value and length of the KLV data from the given value.

Methods inherited from interface tv.amwa.maj.iface.InterchangeObject

countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue

Method Detail

getKey

AUID getKey()

Returns the key of this KLV data.

Returns:

Key of the KLV data.

getValue

@DataBuffer
byte[] getValue()

Returns the value of this KLV data.

Returns:

Value of the KLV data.

getLength

@UInt32
int getLength()

Returns the size of the data buffer for this KLV data.

Returns:

Length of the value of the KLV data.

setValue

void setValue(@DataBuffer
              byte[] value)
              throws NullPointerException

Sets the data value and length of the KLV data from the given value.

Parameters:

value - Value to set for the KLV data.

Throws:

NullPointerException - The given buffer for the data value is null.