Media Authoring
with Java API

tv.amwa.maj.iface
Interface FilmDescriptor

All Superinterfaces:
EssenceDescriptor, InterchangeObject
All Known Implementing Classes:
FilmDescriptor

public interface FilmDescriptor
extends EssenceDescriptor

Specifies the description of film media. A SourceMob described by a film descriptor is known as a film source mob.

Author:
Richard Cartwright
See Also:
AAFFactory.makeFilmDescriptor(), SourceMob.getEssenceDescriptor()

Method Summary
 Rational getFilmAspectRatio()
          Returns the image aspect ratio of this film descriptor, which specifies the ratio between the horizontal size of the frame image and the vertical size of the frame image.
 String getFilmBatchNumber()
          Returns the film batch number for this film descriptor.
 FilmType getFilmFormat()
          Returns the film format of this film descriptor, according to its film type.
 String getFilmGaugeFormat()
          Returns the film gauge format of this film descriptor.
 String getFilmManufacturer()
          Returns the film manufacturer associated with this film descriptor which is a string to display to end users, indicating the manufacturer of the film.
 String getFilmModel()
          Returns the film model associated with this film descriptor, which is a string to display to end users indicating the manufacturerÕs brand designation for the film, such as "5247".
 int getFrameRate()
          Returns the frame rate of this film descriptor, which specifies the frame rate of the film measured in frames per second.
 byte getPerfortionsPerFrame()
          Returns the number of perforations per frame on the film stock for this film descriptor.
 void setFilmAspectRatio(Rational aspectRatio)
          Sets the image aspect ratio of this film descriptor, which specifies the ratio between the horizontal size of the frame image and the vertical size of the frame image.
 void setFilmBatchNumber(String filmBatchNumber)
          Sets the film batch number for this film descriptor.
 void setFilmFormat(FilmType filmFormat)
          Sets the film format for this film descriptor, according to its film type.
 void setFilmGaugeFormat(String filmGuageFormat)
          Sets the film gauge format of this film descriptor.
 void setFilmManufacturer(String filmManufacturer)
          Sets the film manufacturer property of this film descriptor, which is a string to display to end users, indicating the manufacturer of the film.
 void setFilmModel(String filmModel)
          Sets the film model property of the film descriptor, which is a string to display to end users indicating the manufacturerÕs brand designation for the film, such as "5247".
 void setFrameRate(Integer rate)
          Set the frame rate for this film descriptor, which specifies the frame rate of the film measured in frames per second.
 void setPerforationsPerFrame(Byte perforationsPerFrame)
          Set the number of perforations per frame on the film stock for this film descriptor.
 
Methods inherited from interface tv.amwa.maj.iface.EssenceDescriptor
appendLocator, appendSubDescriptor, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAt
 
Methods inherited from interface tv.amwa.maj.iface.InterchangeObject
countProperties, createOptionalPropertyValue, disableGenerationTracking, enableGenerationTracking, getDefinition, getGeneration, getGenerationAUID, getProperties, getPropertyValue, isGenerationTracked, isPropertyPresent, omitOpionalProperty, setPropertyValue
 

Method Detail

setFilmManufacturer

void setFilmManufacturer(@AAFString
                         String filmManufacturer)

Sets the film manufacturer property of this film descriptor, which is a string to display to end users, indicating the manufacturer of the film. Set this optional property to null to omit it.

Parameters:
filmManufacturer - Film manufacturer of the described film.

getFilmManufacturer

@AAFString
String getFilmManufacturer()
                           throws PropertyNotPresentException

Returns the film manufacturer associated with this film descriptor which is a string to display to end users, indicating the manufacturer of the film. This is an optional property.

Returns:
Film manufacturer of this film descriptor.
Throws:
PropertyNotPresentException - The optional film manufacturer property is not present for this film descriptor.

setFilmModel

void setFilmModel(@AAFString
                  String filmModel)

Sets the film model property of the film descriptor, which is a string to display to end users indicating the manufacturerÕs brand designation for the film, such as "5247". Set this optional property to null to omit it.

Parameters:
filmModel - Film model to set for this film descriptor.

getFilmModel

@AAFString
String getFilmModel()
                    throws PropertyNotPresentException

Returns the film model associated with this film descriptor, which is a string to display to end users indicating the manufacturerÕs brand designation for the film, such as "5247". This is an optional property.

Returns:
Film model associated with this film descriptor.
Throws:
PropertyNotPresentException - The optional film model property is not present for this film descriptor.

setFilmFormat

void setFilmFormat(FilmType filmFormat)

Sets the film format for this film descriptor, according to its film type. Set this optional property to null to omit it.

Typical values include:

Parameters:
filmFormat - Film format to set for this film descriptor.

getFilmFormat

FilmType getFilmFormat()
                       throws PropertyNotPresentException

Returns the film format of this film descriptor, according to its film type.

Typical values include:

Returns:
Film format of the film descriptor.
Throws:
PropertyNotPresentException - The optional film format property is not present for this film descriptor.

setFrameRate

void setFrameRate(@UInt32
                  Integer rate)
                  throws IllegalArgumentException

Set the frame rate for this film descriptor, which specifies the frame rate of the film measured in frames per second. Set this optional property to null to omit it.

Parameters:
rate - Frame rate to set for this film descriptor.
Throws:
IllegalArgumentException - The given frame rate is negative.

getFrameRate

@UInt32
int getFrameRate()
                 throws PropertyNotPresentException

Returns the frame rate of this film descriptor, which specifies the frame rate of the film measured in frames per second. This is an optional property.

Returns:
Frame rate of the film descriptor.
Throws:
PropertyNotPresentException - The optional frame rate property is not present for this film descriptor.

setPerforationsPerFrame

void setPerforationsPerFrame(@UInt8
                             Byte perforationsPerFrame)

Set the number of perforations per frame on the film stock for this film descriptor. Set this optional property to null to omit it.

Parameters:
perforationsPerFrame - Perforations per frame for the film descriptor.

getPerfortionsPerFrame

@UInt8
byte getPerfortionsPerFrame()
                            throws PropertyNotPresentException

Returns the number of perforations per frame on the film stock for this film descriptor. This is an optional property.

Returns:
Number of perforations per frame for this film descriptor.
Throws:
PropertyNotPresentException - The optional perforations per frame property is not present for this film descriptor.

setFilmAspectRatio

void setFilmAspectRatio(Rational aspectRatio)

Sets the image aspect ratio of this film descriptor, which specifies the ratio between the horizontal size of the frame image and the vertical size of the frame image. Set this optional property to null to omit it.

Parameters:
aspectRatio - Image aspect ratio to set for film descriptor.

getFilmAspectRatio

Rational getFilmAspectRatio()
                            throws PropertyNotPresentException

Returns the image aspect ratio of this film descriptor, which specifies the ratio between the horizontal size of the frame image and the vertical size of the frame image. This is an optional property.

Returns:
Image aspect ration of the film descriptor.
Throws:
PropertyNotPresentException - The optional image aspect ratio for this film descriptor is not present.

setFilmGaugeFormat

void setFilmGaugeFormat(String filmGuageFormat)

Sets the film gauge format of this film descriptor. Set this optional property to null to omit it.

Parameters:
filmGuageFormat - Film gauge format if this film descriptor.

getFilmGaugeFormat

String getFilmGaugeFormat()
                          throws PropertyNotPresentException

Returns the film gauge format of this film descriptor. This is an optional property.

Returns:
Film gauge format if this film descriptor.
Throws:
PropertyNotPresentException - This optional film gauge property is not present for this film descriptor.

setFilmBatchNumber

void setFilmBatchNumber(String filmBatchNumber)

Sets the film batch number for this film descriptor. Set this optional property to null to omit it.

Parameters:
filmBatchNumber - Film batch number for this film descriptor.

getFilmBatchNumber

String getFilmBatchNumber()
                          throws PropertyNotPresentException

Returns the film batch number for this film descriptor. This is an optional property.

Returns:
Film batch number for this film descriptor.
Throws:
PropertyNotPresentException - The optional film batch number is not present for this film descriptor.

Media Authoring
with Java API

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