@MediaClass(uuid1=218169601, uuid2=257, uuid3=11520, uuid4={6,14,43,52,2,6,1,1}, definedName="FilmDescriptor", description="The FilmDescriptor class describes film media.", symbol="FilmDescriptor") public class FilmDescriptorImpl extends EssenceDescriptorImpl implements FilmDescriptor, Serializable, Cloneable
Implements the description of film media. A SourcePackage described by a film descriptor is known as a film source package.
ObjectClassPropertyID| Constructor and Description |
|---|
FilmDescriptorImpl()
Creates and initializes a film descriptor that describes film media.
|
| Modifier and Type | Method and Description |
|---|---|
FilmDescriptor |
clone()
Create a cloned copy of this interchange object.
|
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 |
getFilmAspectRatioString() |
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 |
setFilmAspectRatioString(String filmAspectRatio) |
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, clearSubDescriptors, countLocators, countSubDescriptors, getComment, getLocatorAt, getLocators, getSubDescriptorAt, getSubDescriptors, insertLocatorAt, insertSubDescriptorAt, prependLocator, prependSubDescriptor, removeLocatorAt, removeSubDescriptorAtaddApplicationPlugin, appendXMLChildren, clearApplicationPlugins, containsApplicationPlugin, containsApplicationPlugin, countApplicationPlugins, deepEquals, disableGenerationTracking, enableGenerationTracking, equals, getApplicationPlugins, getGeneration, getLinkedGenerationID, getLinkedGenerationIDString, getObjectClass, getPersistentID, getPersistentIndex, hashCode, isGenerationTracked, removeApplicationPlugin, removeApplicationPlugin, setLinkedGenerationID, setLinkedGenerationIDString, setObjectClass, setPersistentID, setPersistentIndex, toStringappendLocator, 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, setPersistentIndexpublic FilmDescriptorImpl()
Creates and initializes a film descriptor that describes film media.
@MediaProperty(uuid1=68157699, uuid2=515, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="FilmAspectRatio", typeName="Rational", optional=true, uniqueIdentifier=false, pid=14596, symbol="FilmAspectRatio") public Rational getFilmAspectRatio() throws PropertyNotPresentException
FilmDescriptorReturns 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.
getFilmAspectRatio in interface FilmDescriptorPropertyNotPresentException - The optional image aspect ratio
for this film descriptor is not present.@MediaPropertySetter(value="FilmAspectRatio") public void setFilmAspectRatio(Rational aspectRatio)
FilmDescriptorSets 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.
setFilmAspectRatio in interface FilmDescriptoraspectRatio - Image aspect ratio of the described film.@MediaProperty(uuid1=68157699, uuid2=264, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="FilmFormat", typeName="FilmType", optional=true, uniqueIdentifier=false, pid=14593, symbol="FilmFormat") public FilmType getFilmFormat() throws PropertyNotPresentException
FilmDescriptorReturns the film format of the described film, according to its film type.
Typical values include:
getFilmFormat in interface FilmDescriptorPropertyNotPresentException - The optional film format property is not
present for this film descriptor.@MediaPropertySetter(value="FilmFormat") public void setFilmFormat(FilmType filmFormat)
FilmDescriptorSets the film format of the described film, according to its
film type. Set this optional
property to null to omit it.
Typical values include:
setFilmFormat in interface FilmDescriptorfilmFormat - Film format of the described film.@MediaProperty(uuid1=68157699, uuid2=262, uuid3=256, uuid4={6,14,43,52,1,1,1,2}, definedName="FilmStockManufacturer", aliases={"Manufacturer","FilmDescriptorManufacturer"}, typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=14597, symbol="FilmStockManufacturer") public String getFilmStockManufacturer() throws PropertyNotPresentException
FilmDescriptorReturns 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.
getFilmStockManufacturer in interface FilmDescriptorPropertyNotPresentException - The optional film manufacturer property is not
present for this film descriptor.@MediaPropertySetter(value="FilmStockManufacturer") public void setFilmStockManufacturer(String filmStockManufacturer)
FilmDescriptorSets 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.
setFilmStockManufacturer in interface FilmDescriptorfilmStockManufacturer - Film manufacturer of the described film.@MediaProperty(uuid1=68157699, uuid2=261, uuid3=256, uuid4={6,14,43,52,1,1,1,2}, definedName="FilmStockKind", aliases={"Model","FilmDescriptorModel"}, typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=14598, symbol="FilmStockKind") public String getFilmStockKind() throws PropertyNotPresentException
FilmDescriptorReturns 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.
getFilmStockKind in interface FilmDescriptorPropertyNotPresentException - The optional film model property is
not present for this film descriptor.@MediaPropertySetter(value="FilmStockKind") public void setFilmStockKind(String filmStockKind)
FilmDescriptorSets 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.
setFilmStockKind in interface FilmDescriptorfilmStockKind - Kind of film stock of the described film.@MediaProperty(uuid1=67176450, uuid2=768, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="FrameRate", typeName="UInt32", optional=true, uniqueIdentifier=false, pid=14594, symbol="FrameRate") public int getFrameRate() throws PropertyNotPresentException
FilmDescriptorReturns 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.
getFrameRate in interface FilmDescriptorPropertyNotPresentException - The optional frame rate property is not
present for this film descriptor.@MediaPropertySetter(value="FrameRate") public void setFrameRate(Integer rate) throws IllegalArgumentException
FilmDescriptorSet 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.
setFrameRate in interface FilmDescriptorrate - Frame rate of the described film.IllegalArgumentException - The given frame rate is negative.@MediaProperty(uuid1=68157699, uuid2=259, uuid3=0, uuid4={6,14,43,52,1,1,1,2}, definedName="PerforationsPerFrame", typeName="UInt8", optional=true, uniqueIdentifier=false, pid=14595, symbol="PerforationsPerFrame") public byte getPerfortionsPerFrame() throws PropertyNotPresentException
FilmDescriptorReturns the number of perforations per frame on the film stock of the described film. This is an optional property.
getPerfortionsPerFrame in interface FilmDescriptorPropertyNotPresentException - The optional perforations per
frame property is not present for this film descriptor.@MediaPropertySetter(value="PerforationsPerFrame") public void setPerforationsPerFrame(Byte perforationsPerFrame) throws IllegalArgumentException
FilmDescriptorSet the number of perforations per frame on the film stock of the described
film. Set this optional property to null to omit it.
setPerforationsPerFrame in interface FilmDescriptorperforationsPerFrame - Perforations per frame of the described film.IllegalArgumentException@MediaProperty(uuid1=68157699, uuid2=263, uuid3=256, uuid4={6,14,43,52,1,1,1,2}, definedName="FilmBatchNumber", typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=14600, symbol="FilmBatchNumber") public String getFilmBatchNumber() throws PropertyNotPresentException
FilmDescriptorReturns the film batch number for this film descriptor. This is an optional property.
getFilmBatchNumber in interface FilmDescriptorPropertyNotPresentException - The optional film batch number is
not present for this film descriptor.@MediaPropertySetter(value="FilmBatchNumber") public void setFilmBatchNumber(String filmBatchNumber)
FilmDescriptorSets the film batch number for the described film. Set this optional
property to null to omit it.
setFilmBatchNumber in interface FilmDescriptorfilmBatchNumber - Film batch number of the described film.@MediaProperty(uuid1=68157699, uuid2=260, uuid3=256, uuid4={6,14,43,52,1,1,1,2}, definedName="FilmFormatName", aliases="FilmGaugeFormat", typeName="UTF16String", optional=true, uniqueIdentifier=false, pid=14599, symbol="FilmFormatName") public String getFilmFormatName() throws PropertyNotPresentException
FilmDescriptorReturns the film gauge format of the described film. This is an optional property.
getFilmFormatName in interface FilmDescriptorPropertyNotPresentException - This optional film gauge property
is not present for this film descriptor.@MediaPropertySetter(value="FilmFormatName") public void setFilmFormatName(String filmFormatName)
FilmDescriptorSets the film gauge format of the described film. Set this optional property
to null to omit it.
setFilmFormatName in interface FilmDescriptorfilmFormatName - Film gauge format of the described film.public FilmDescriptor clone()
InterchangeObjectCreate a cloned copy of this interchange object.
clone in interface MediaEntityclone in interface EssenceDescriptorclone in interface FilmDescriptorclone in interface InterchangeObjectclone in class EssenceDescriptorImplpublic String getFilmAspectRatioString()
public void setFilmAspectRatioString(String filmAspectRatio)
(c)2007-2016 Richard Cartwright, all rights reserved. Licensed under Apache 2 license and subject to the AMWA IPR policy.