|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface EssenceFormat
Specifies a collection of parameters (such as image height/width, audio sample width) which describes a piece of essence. Each parameter is specified by an AUID, and contains a variable length piece of data.
When creating a piece of essence, you should call
addFormatSpecifier(AUID, byte[])
for each required or known
parameter, and the codec will supply defaults for other optional
parameters.
Note that the current version of the MAJ API has no built-in codec support, large essence is not supported and the methods of this interface do nothing.
EssenceAccess
Method Summary | |
---|---|
void |
addFormatSpecifier(AUID essenceFormatCode,
byte[] value)
Appends a format specifier to the essence format. |
byte[] |
getFormatSpecifier(AUID essenceFormatCode)
Data value representing the essence format of the given essence format code. |
AUID |
getIndexedEssenceFormatCode(int index)
Returns the essence format code associated with the format specifier at the given index. |
byte[] |
getIndexedFormatSpecifier(int index)
Returns the data value at the given index. |
int |
numSpecifiers()
Returns the number of specifiers present in this essence format. |
Method Detail |
---|
void addFormatSpecifier(AUID essenceFormatCode, @DataBuffer byte[] value) throws NullPointerException
Appends a format specifier to the essence format. If a particular essence format code has already been added, then this call replaces the value, otherwise the value is added.
essenceFormatCode
- Essence format code (as defined in
"aafdefuids.h
").value
- Data value for format specifier.
NullPointerException
- One or more of the arguments is null.@DataBuffer byte[] getFormatSpecifier(AUID essenceFormatCode) throws NullPointerException
Data value representing the essence format of the given essence format code.
essenceFormatCode
- Essence format code (as defined in
"aafdefuids.h
").
NullPointerException
- Argument is null.@UInt32 int numSpecifiers()
Returns the number of specifiers present in this essence format.
@DataBuffer byte[] getIndexedFormatSpecifier(@Int32 int index) throws IndexOutOfBoundsException
Returns the data value at the given index.
index
- 0-based index for the format specifier to retrieve.
IndexOutOfBoundsException
- The specified index is
outside the acceptable range for the current number of specifiers.AUID getIndexedEssenceFormatCode(@Int32 int index) throws IndexOutOfBoundsException
Returns the essence format code associated with the format specifier at the given index.
index
- 0-based index for the format specifier to retrieve.
IndexOutOfBoundsException
- The specified index is
outside the acceptable range for the current number of specifiers.
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |