tv.amwa.maj.record
Interface AUID

All Known Implementing Classes:

AUID

public interface AUID

Specifies a 16-byte unique identifier whose value is a SMPTE 298M Universal Label or a UUID or GUID.

UUIDs are defined in rfc 4122. For media metadata, SMPTE have defined a dictionary for Universal Labels, which are representable by AUID values, that is defined according to SMPTE 335M "Metadata Dictionary Structure". This current version of the dictionary can be accessed via the SMPTE Registration Authority's website.

A Universal label is represented as an AUID by storing bytes 9 to 16 of the label in bytes 1 to 8 of an AUID and bytes 1 to 8 of the same Universal label in bytes 9 to 16 of the same AUID.

The terminology used to describe the methods of this interface is taken from the UUID specification.

Author:

Richard Cartwright

See Also:

AUID, TypeDefinitionRecord.AUID, MobID

Method Summary

int	getData1() Returns the time-low part of the AUID.
short	getData2() Returns the time-mid part of the AUID.
short	getData3() Returns the time-hi and version parts of the AUID.
byte[]	getData4() Returns the variant, clock sequence and node parts of the AUID as an 8-byte array.
boolean	isNil() Tests to see if the AUID is a nil value, which means that the value of each of its components is 0.
void	setData1(int data1) Sets the time-low part of the AUID.
void	setData2(short data2) Sets the time-mid part of the AUID.
void	setData3(short data3) Sets the time-hi and version parts of the AUID.
void	setData4(byte[] data4) Sets the variant, clock sequence and node parts of the AUID using an 8-byte array.

Method Detail

getData1

@UInt32
int getData1()

Returns the time-low part of the AUID.

Returns:

Time low part of the AUID.

setData1

void setData1(@UInt32
              int data1)

Sets the time-low part of the AUID.

Parameters:

data1 - Time-low part of the AUID.

getData2

@UInt16
short getData2()

Returns the time-mid part of the AUID.

Returns:

Time-mid part of the AUID.

setData2

void setData2(@UInt16
              short data2)

Sets the time-mid part of the AUID.

Parameters:

data2 - Time-mid part of the AUID.

getData3

@UInt16
short getData3()

Returns the time-hi and version parts of the AUID. This is the high part of the timestamp value of a UUID multiplexed with the version number, where the version number refers to what specified kind of UUID this is.

Returns:

Time-hi and version part of the AUID.

setData3

void setData3(@UInt16
              short data3)

Sets the time-hi and version parts of the AUID. This is the high part of the timestamp value of a UUID multiplexed with the version number, where the version number refers to the kind of UUID this is.

Parameters:

data3 - Time-hi and version part of the AUID.

getData4

@UInt8Array
byte[] getData4()

Returns the variant, clock sequence and node parts of the AUID as an 8-byte array.

Returns:

Variant, clock sequence and node parts of the AUID.

setData4

void setData4(@UInt8Array
              byte[] data4)

Sets the variant, clock sequence and node parts of the AUID using an 8-byte array.

Parameters:

data4 - Variant, clock sequence and node parts of the AUID.

isNil

boolean isNil()

Tests to see if the AUID is a nil value, which means that the value of each of its components is 0. As a UUID URN, this looks like:

urn:uuid:00000000-0000-0000-0000-000000000000

Returns:

Is the AUID a nil value?

See Also:

MobID.isZero()