Media Authoring
with Java API

tv.amwa.maj.record
Interface EdgecodeValue

All Known Implementing Classes:
EdgecodeValue

public interface EdgecodeValue

Specifies a value that represents film edge code information. A film edge code is described by its code format, the film kind, a header and a start frame.

Author:
Richard Cartwright
See Also:
EdgecodeSegment, EdgecodeValue, AAFFactory.makeEdgecodeValue(long, FilmType, EdgeType)

Method Summary
 EdgeType getCodeFormat()
          Returns the format of the edge code.
 FilmType getFilmKind()
          Returns the film type of this edge code.
 byte[] getHeader()
          Returns the text prefix that identifies the film.
 long getStartFrame()
          Returns the edge code at the beginning of the corresponding segment.
 void setCodeFormat(EdgeType codeFormat)
          Sets the format of the edge code.
 void setFilmKind(FilmType filmKind)
          Sets the type of film for this edge code.
 void setHeader(byte[] header)
          Sets the text prefix that identifies the film.
 void setStartFrame(long startFrame)
          Sets the edge code at the beginning of the corresponding segment.
 

Method Detail

getCodeFormat

EdgeType getCodeFormat()

Returns the format of the edge code.

Returns:
Format of the edge code.

setCodeFormat

void setCodeFormat(EdgeType codeFormat)
                   throws NullPointerException

Sets the format of the edge code.

Parameters:
codeFormat - Format of the edge code.
Throws:
NullPointerException - The given edge code format is null.

getFilmKind

FilmType getFilmKind()

Returns the film type of this edge code.

Returns:
Type of film for this edge code.

setFilmKind

void setFilmKind(FilmType filmKind)
                 throws NullPointerException

Sets the type of film for this edge code.

Parameters:
filmKind - Type of film for this edge code.
Throws:
NullPointerException - The given film type for the edge code is null.

getHeader

@EdgecodeHeader
byte[] getHeader()

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.

Returns:
Text prefix that identifies the film.
Throws:
PropertyNotPresentException - The optional header property is not present for this edgecode value.

setHeader

void setHeader(@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 optoinal property.

To convert a String to an array of bytes, use String.getBytes(String).

Parameters:
header - Text prefix that identifies the film.

getStartFrame

@FrameOffset
long getStartFrame()

Returns the edge code at the beginning of the corresponding segment.

Returns:
Edge code the the beginning of the corresponding segment.

setStartFrame

void setStartFrame(@FrameOffset
                   long startFrame)

Sets the edge code at the beginning of the corresponding segment.

Parameters:
startFrame - Edge code the the beginning of the corresponding segment.

Media Authoring
with Java API

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