Media Authoring
with Java API

tv.amwa.maj.enumeration
Enum UserDataModeType

java.lang.Object
  extended by java.lang.Enum<UserDataModeType>
      extended by tv.amwa.maj.enumeration.UserDataModeType
All Implemented Interfaces:
Serializable, Comparable<UserDataModeType>, AAFEnumerationValue

public enum UserDataModeType
extends Enum<UserDataModeType>
implements AAFEnumerationValue

Represents the value of the 4 bits of channel status indicating the format of user data of audio essence stored in the AES/EBU audio file format and described by a AES3 PCM descriptor.

The values defined here are as specified in section 4 of EBU tech. 3250.

Author:
Richard Cartwright
See Also:
TypeDefinitionEnumeration.UserDataModeType, AES3PCMDescriptor, AuxBitsModeType

Enum Constant Summary
_192BitBlockStructure
          192 bit block structure.
AES18
          Packet system based on HDLC protocol (ISO 13239).
IEC
          User data conforms to the general user data format defined in IEC 60958-3.
Metadata
          Reserved for metadata.
NotDefined
          No user information indicated.
Reserved0
          Reserved for future use and should not be used.
Reserved1
          Reserved for future use and should not be used.
Reserved2
          Reserved for future use and should not be used.
Reserved3
          Reserved for future use and should not be used.
Reserved4
          Reserved for future use and should not be used.
Reserved5
          Reserved for future use and should not be used.
Reserved6
          Reserved for future use and should not be used.
Reserved7
          Reserved for future use and should not be used.
Reserved8
          Reserved for future use and should not be used.
Reserved9
          Reserved for future use and should not be used.
UserDefined
          User defined.
 
Method Summary
static UserDataModeType fromOrdinal(int userDataModeValue)
          Returns the value of this enumerated type associated with the given ordinal.
 long value()
          Returns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.
static UserDataModeType valueOf(String name)
          Returns the enum constant of this type with the specified name.
static UserDataModeType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface tv.amwa.maj.enumeration.AAFEnumerationValue
name
 

Enum Constant Detail

NotDefined

public static final UserDataModeType NotDefined

No user information indicated. This is the default value.


_192BitBlockStructure

public static final UserDataModeType _192BitBlockStructure

192 bit block structure. Preamble "Z" indicates the start of a block.

Note that the name of this element starts with an underscore ('_') character as Java identifiers must start with an alphanumeric character or an underscore character. The specified name of this value is "192BitBlockStructure".


AES18

public static final UserDataModeType AES18

Packet system based on HDLC protocol (ISO 13239). This system is defined in supplement 1 to EBU Tech. 3250: format of the user data channel of the digital audio interface.


UserDefined

public static final UserDataModeType UserDefined

User defined.


IEC

public static final UserDataModeType IEC

User data conforms to the general user data format defined in IEC 60958-3.


Metadata

public static final UserDataModeType Metadata

Reserved for metadata.


Reserved0

public static final UserDataModeType Reserved0

Reserved for future use and should not be used.


Reserved1

public static final UserDataModeType Reserved1

Reserved for future use and should not be used.


Reserved2

public static final UserDataModeType Reserved2

Reserved for future use and should not be used.


Reserved3

public static final UserDataModeType Reserved3

Reserved for future use and should not be used.


Reserved4

public static final UserDataModeType Reserved4

Reserved for future use and should not be used.


Reserved5

public static final UserDataModeType Reserved5

Reserved for future use and should not be used.


Reserved6

public static final UserDataModeType Reserved6

Reserved for future use and should not be used.


Reserved7

public static final UserDataModeType Reserved7

Reserved for future use and should not be used.


Reserved8

public static final UserDataModeType Reserved8

Reserved for future use and should not be used.


Reserved9

public static final UserDataModeType Reserved9

Reserved for future use and should not be used.

Method Detail

values

public static final UserDataModeType[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:
for(UserDataModeType c : UserDataModeType.values())
        System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they're declared

valueOf

public static UserDataModeType valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name

value

@Int64
public long value()
Description copied from interface: AAFEnumerationValue

Returns the unique integer value associated with an enumeration value, either according to the AAF specification and/or the current AAF meta dictionary.

Specified by:
value in interface AAFEnumerationValue
Returns:
Unique integer value associated with an enumeration constant.

fromOrdinal

public static final UserDataModeType fromOrdinal(int userDataModeValue)

Returns the value of this enumerated type associated with the given ordinal.

Parameters:
userDataModeValue - Specified ordinal to use to find the associated value of this type.
Returns:
Value of this type with the given ordinal value.

Media Authoring
with Java API

(c) 2007-2008 Richard Cartwright, all rights reserved. Subject to the terms of the AAF SDK Public Source License.