public interface EdgeCodeValue
Specifies a value that represents film edge code information. A film edge code is described by a start frame, its edge code format, the film format and an optional header.
EdgeCodeSegment| Modifier and Type | Method and Description |
|---|---|
EdgeCodeValue |
clone()
Create a cloned copy of this edgecode value.
|
FilmType |
getEdgeCodeFilmFormat()
Returns the film format of the edge code.
|
EdgeType |
getEdgeCodeFormat()
Returns the format of the edge code.
|
byte[] |
getEdgeCodeHeader()
Returns the text prefix that identifies the film.
|
String |
getEdgeCodeHeaderAsString()
Returns the text prefix the identifies the film as a string value.
|
long |
getEdgeCodeStart()
Returns the edge code at the beginning of the corresponding segment.
|
void |
setEdgeCodeFilmFormat(FilmType filmKind)
Sets the film format for this edge code.
|
void |
setEdgeCodeFormat(EdgeType codeFormat)
Sets the format of the edge code.
|
void |
setEdgeCodeHeader(byte[] header)
Sets the text prefix that identifies the film.
|
void |
setEdgeCodeHeader(String header)
Set the value of the edge code header from the given string.
|
void |
setEdgeCodeStart(long startFrame)
Sets the edge code at the beginning of the corresponding segment.
|
String |
toString()
Formats this edgecode value in a pseudo-XML representation that is compatible with
the AAF XML schema.
|
EdgeType getEdgeCodeFormat()
Returns the format of the edge code.
EdgeTypevoid setEdgeCodeFormat(EdgeType codeFormat) throws NullPointerException
Sets the format of the edge code.
codeFormat - Format of the edge code.NullPointerException - The given edge code format is null.FilmType getEdgeCodeFilmFormat()
Returns the film format of the edge code.
FilmTypevoid setEdgeCodeFilmFormat(FilmType filmKind) throws NullPointerException
Sets the film format for this edge code.
filmKind - Film format for this edge code.NullPointerException - The given film type for the edge code is null.@EdgecodeHeader byte[] getEdgeCodeHeader() throws PropertyNotPresentException
Returns the text prefix that identifies the film. Typically, this is a text string of no more than 8 7-bit ISO characters. This is an optional property.
PropertyNotPresentException - The optional header property is not present for this edgecode
value.getEdgeCodeHeaderAsString()String getEdgeCodeHeaderAsString() throws PropertyNotPresentException
Returns the text prefix the identifies the film as a string value. Typically, this is a text string of no more than 8 7-bit ISO characters. This is an optional property.
PropertyNotPresentException - The optional header property is not present for this edgecode
value.getEdgeCodeHeader(),
setEdgeCodeHeader(String)void setEdgeCodeHeader(@EdgecodeHeader byte[] header)
Sets the text prefix that identifies the film. Typically, this is a text string of no
more than 8 7-bit ISO characters. Set the value to null to omit this
optional property.
To convert a String to an array of bytes, use
String.getBytes(String).
header - Text prefix that identifies the film.setEdgeCodeHeader(String)void setEdgeCodeHeader(String header) throws NullPointerException
Set the value of the edge code header from the given string. Conversion to bytes takes
place using the platforms default character set, according to
String.String(byte[]).
header - String representation of the edge code header.NullPointerExceptionsetEdgeCodeHeader(byte[])@FrameOffset long getEdgeCodeStart()
Returns the edge code at the beginning of the corresponding segment.
void setEdgeCodeStart(@FrameOffset long startFrame)
Sets the edge code at the beginning of the corresponding segment.
startFrame - Edge code the the beginning of the corresponding segment.EdgeCodeValue clone()
Create a cloned copy of this edgecode value.
String toString()
Formats this edgecode value in a pseudo-XML representation that is compatible with the AAF XML schema. For example:
<EdgecodeValue>
<EdgeCodeStart>321</EdgeCodeStart>
<FilmKind>Ft35MM</FilmKind>
<CodeFormat>EtKeycode</CodeFormat>
<!--Header as text: 'abcdefgh'-->
<EdgeCodeHeader>6162636465666768</EdgeCodeHeader>
</EdgecodeValue>
toString in class ObjectObject.toString()(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.