public interface FilmDescriptor extends EssenceDescriptor
Specifies the description of film media. A SourcePackage described by a film descriptor is known as a film source package.
SourcePackage.getEssenceDescriptor()| Modifier and Type | Method and Description |
|---|---|
FilmDescriptor |
clone()
Create a cloned copy of this film descriptor.
|
Rational |
getFilmAspectRatio()
Returns the image aspect ratio of the described film, 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 the described film, according to its
film type.
|
String |
getFilmFormatName()
Returns the film gauge format of the described film.
|
String |
getFilmStockKind()
Returns the kind of film stock of the described film, which is a string to display to
end users indicating the manufacturer's brand designation for the film, such as "5247".
|
String |
getFilmStockManufacturer()
Returns the film stock manufacturer of the described film, which is
a string to display to end users indicating the manufacturer of the film stock.
|
int |
getFrameRate()
Returns the frame rate of the described film, 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 of the described
film.
|
void |
setFilmAspectRatio(Rational aspectRatio)
Sets the image aspect ratio of the described film, 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 the described film.
|
void |
setFilmFormat(FilmType filmFormat)
Sets the film format of the described film, according to its
film type.
|
void |
setFilmFormatName(String filmFormatName)
Sets the film gauge format of the described film.
|
void |
setFilmStockKind(String filmStockKind)
Sets the kind of film stock of the described film, which is a string to display to
end users indicating the manufacturer's brand designation for the film, such as "5247".
|
void |
setFilmStockManufacturer(String filmStockManufacturer)
Sets the film stock manufacturer property of the described film, which is
a string to display to end users indicating the manufacturer of the film stock.
|
void |
setFrameRate(Integer rate)
Set the frame rate of the described film, 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 of the described
film.
|
appendLocator, appendSubDescriptor, clearLocators, countLocators, countSubDescriptors, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAtaddApplicationPlugin, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getObjectClass, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setObjectClass, toStringgetPersistentID, setPersistentIndexvoid setFilmStockManufacturer(@AAFString String filmStockManufacturer)
Sets the film stock manufacturer property of the described film, which is
a string to display to end users indicating the manufacturer of the film stock. Set
this optional property to null to omit it.
filmStockManufacturer - Film manufacturer of the described film.@AAFString String getFilmStockManufacturer() throws PropertyNotPresentException
Returns the film stock manufacturer of the described film, which is a string to display to end users indicating the manufacturer of the film stock. This is an optional property.
PropertyNotPresentException - The optional film manufacturer property is not
present for this film descriptor.void setFilmStockKind(@AAFString String filmStockKind)
Sets the kind of film stock of the described film, 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.
filmStockKind - Kind of film stock of the described film.@AAFString String getFilmStockKind() throws PropertyNotPresentException
Returns the kind of film stock of the described film, 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.
PropertyNotPresentException - The optional film model property is
not present for this film descriptor.void setFilmFormat(FilmType filmFormat)
Sets the film format of the described film, according to its
film type. Set this optional
property to null to omit it.
Typical values include:
filmFormat - Film format of the described film.FilmType getFilmFormat() throws PropertyNotPresentException
Returns the film format of the described film, according to its film type.
Typical values include:
PropertyNotPresentException - The optional film format property is not
present for this film descriptor.void setFrameRate(@UInt32 Integer rate) throws IllegalArgumentException
Set the frame rate of the described film, which specifies the frame rate
of the film measured in frames per second. Set this optional property to null
to omit it.
rate - Frame rate of the described film.IllegalArgumentException - The given frame rate is negative.@UInt32 int getFrameRate() throws PropertyNotPresentException
Returns the frame rate of the described film, which specifies the frame rate of the film measured in frames per second. This is an optional property.
PropertyNotPresentException - The optional frame rate property is not
present for this film descriptor.void setPerforationsPerFrame(@UInt8 Byte perforationsPerFrame)
Set the number of perforations per frame on the film stock of the described
film. Set this optional property to null to omit it.
perforationsPerFrame - Perforations per frame of the described film.@UInt8 byte getPerfortionsPerFrame() throws PropertyNotPresentException
Returns the number of perforations per frame on the film stock of the described film. This is an optional property.
PropertyNotPresentException - The optional perforations per
frame property is not present for this film descriptor.void setFilmAspectRatio(Rational aspectRatio)
Sets the image aspect ratio of the described film, 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.
aspectRatio - Image aspect ratio of the described film.Rational getFilmAspectRatio() throws PropertyNotPresentException
Returns the image aspect ratio of the described film, 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.
PropertyNotPresentException - The optional image aspect ratio
for this film descriptor is not present.void setFilmFormatName(String filmFormatName)
Sets the film gauge format of the described film. Set this optional property
to null to omit it.
filmFormatName - Film gauge format of the described film.String getFilmFormatName() throws PropertyNotPresentException
Returns the film gauge format of the described film. This is an optional property.
PropertyNotPresentException - This optional film gauge property
is not present for this film descriptor.void setFilmBatchNumber(String filmBatchNumber)
Sets the film batch number for the described film. Set this optional
property to null to omit it.
filmBatchNumber - Film batch number of the described film.String getFilmBatchNumber() throws PropertyNotPresentException
Returns the film batch number for this film descriptor. This is an optional property.
PropertyNotPresentException - The optional film batch number is
not present for this film descriptor.FilmDescriptor clone()
Create a cloned copy of this film descriptor.
clone in interface EssenceDescriptorclone in interface InterchangeObjectclone in interface MediaEntity(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.