|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RGBADescriptor
Specifies the description of a file of video essence formatted with three color components or with three color components and an alpha component.
In addition to the parameters inherited from digital image descriptor, this interface adds pixel layout (order of R, B, G, alpha), pixel structure (sizes of the various components), palette, palette layout, and palette structure.
makeRGBADescriptor() no palette
,
makeRGBADescriptor() with palette
,
SourceMob.getEssenceDescriptor()
,
CodecConstant.RGBA
,
RGBALayout
Field Summary | |
---|---|
static int |
ALPHAMAXREF_DEFAULT
Default value for the alpha maximum reference level property, which is 255. |
static int |
ALPHAMINREF_DEFAULT
Default value for the alpha minimum reference level property, which is 0. |
static int |
COMPONENTMAXREF_DEFAULT
Default value for the component maximum reference level property, which is 255. |
static int |
COMPONENTMINREF_DEFAULT
Default value for the component minimum reference level property, which is 0. |
static ScanningDirectionType |
SCANNINGDIRECTION_DEFAULT
Default value for the scanning direction property, which is ScanningDirectionType.LeftToRightTopToBottom . |
Fields inherited from interface tv.amwa.maj.iface.DigitalImageDescriptor |
---|
ALPHATRANSPARENCY_DEFAULT, DISPLAYF2OFFSET_DEFAULT, FIELDENDOFFSET_DEFAULT, FIELDSTARTOFFSET_DEFAULT, IMAGEALIGNMENTFACTOR_DEFAULT, STOREDF2OFFSET_DEFAULT, Uncompressed |
Method Summary | |
---|---|
int |
countPaletteLayoutElements()
Returns the number of components per pixel in the palette of this RGBA descriptor. |
int |
countPixelLayoutElements()
Returns the number of components per pixel in data represented by this RGBA descriptor. |
int |
getAlphaMaxRef()
Returns the maximum alpha value of this RGBA descriptor, for example 239 or 959 (8 or 10 bits). |
int |
getAlphaMinRef()
Returns the minimum alpha value of the RGBA descriptor, for example 16 or 64 (8 or 10 bits). |
int |
getComponentMaxRef()
Returns the maximum value for RGB components of this RGBA descriptor, for example 239 or 959 (8 or 10 bits). |
int |
getComponentMinRef()
Returns the minimum value for RGB components of the RGBA descriptor, for example 16 or 64 (8 or 10 bits). |
byte[] |
getPalette()
Returns the palette property of the RGBA descriptor, which is an array of color values that are used to specify an image. |
RGBAComponent[] |
getPaletteLayout()
Returns the layout and structure of the components of a single entry for the palette of the RGBA descriptor. |
RGBAComponent[] |
getPixelLayout()
Returns the layout and structure of the components in a single pixel of data represented by the RGBA descriptor. |
ScanningDirectionType |
getScanningDirection()
Returns the scanning direction of this RGBA descriptor, which specifies the scanning direction of the image. |
void |
setAlphaMaxRef(Integer alphaMaxRef)
Sets the maximum alpha value of the RGBA descriptor, for example 239 or 959 (8 or 10 bits). |
void |
setAlphaMinRef(Integer alphaMinRef)
Sets the minimum alpha value of this RGBA descriptor, for example 16 or 64 (8 or 10 bits). |
void |
setComponentMaxRef(Integer componentMaxRef)
Sets the maximum value for RGB components of this RGBA descriptor, for example 239 or 959 (8 or 10 bits). |
void |
setComponentMinRef(Integer componentMinRef)
Sets the minimum value for RGB components of the RGBA descriptor, for example 16 or 64 (8 or 10 bits). |
void |
setPalette(byte[] palette)
Sets the palette property of the RGBA descriptor, which is an array of color values that are used to specify an image. |
void |
setPaletteLayout(RGBAComponent[] paletteLayoutArray)
Sets the layout and structure of the components of a single entry for the palette of the RGBA descriptor. |
void |
setPixelLayout(RGBAComponent[] pixelLayoutArray)
Sets the layout and structure of the components in a single pixel of data represented by the RGBA descriptor. |
void |
setScanningDirection(ScanningDirectionType scanningDirection)
Sets the scanning direction of this RGBA descriptor, which specifies the scanning direction of the image. |
Methods inherited from interface tv.amwa.maj.iface.AAFFileDescriptor |
---|
getCodecDefinition, getContainerFormat, getLength, getLinkedSlotID, getSampleRate, setCodecDefinition, setContainerFormat, setLength, setLinkedSlotID, setSampleRate |
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 |
Field Detail |
---|
static final int COMPONENTMINREF_DEFAULT
Default value for the component minimum reference level property, which is 0.
getComponentMinRef()
,
setComponentMinRef(Integer)
,
Constant Field Valuesstatic final int COMPONENTMAXREF_DEFAULT
Default value for the component maximum reference level property, which is 255.
getComponentMaxRef()
,
setComponentMaxRef(Integer)
,
Constant Field Valuesstatic final int ALPHAMINREF_DEFAULT
Default value for the alpha minimum reference level property, which is 0.
getAlphaMinRef()
,
setAlphaMinRef(Integer)
,
Constant Field Valuesstatic final int ALPHAMAXREF_DEFAULT
Default value for the alpha maximum reference level property, which is 255.
getAlphaMaxRef()
,
setAlphaMaxRef(Integer)
,
Constant Field Valuesstatic final ScanningDirectionType SCANNINGDIRECTION_DEFAULT
Default value for the scanning direction property, which is
ScanningDirectionType.LeftToRightTopToBottom
.
getScanningDirection()
,
setScanningDirection(ScanningDirectionType)
Method Detail |
---|
void setPixelLayout(@RGBALayout RGBAComponent[] pixelLayoutArray) throws NullPointerException
Sets the layout and structure of the components in a single pixel of data represented by the RGBA descriptor. The layout array contains RGBAComponent items. Each item defines a size in bits for a component and the kind of component (red, green etc.).
If you set less than 8 entries, the remaining entries will be padded with
RGBAComponentKind.None
and a size of zero.
pixelLayoutArray
- Array of RGBA components, indicating the order and size
of components in the data represented by the RGBA descriptor.
NullPointerException
- The given array of RGBA components is null
or
one or more of the elements of the array are null
.RGBAComponent
,
RGBAComponentKind
@UInt32 int countPixelLayoutElements()
Returns the number of components per pixel in data represented by this RGBA descriptor.
@RGBALayout RGBAComponent[] getPixelLayout()
Returns the layout and structure of the components in a single pixel of data represented by the RGBA descriptor. The layout array contains RGBAComponent items. Each item defines a size in bits for a component and the kind of component (red, green etc.).
void setPalette(byte[] palette) throws IllegalArgumentException
Sets the palette property of the RGBA descriptor, which is an array of color values that are used to specify an image. The palette must be in the form specified by the palette layout.
To omit this optional property, set this value to null
.
If the layout of this RGBA descriptor requires a palette, an
IllegalArgumentException
will be thrown if an attempt is made to
omit the palette property.
palette
- Palette of the RGBA descriptor.
IllegalArgumentException
- Cannot omit the palette for an RGBA descriptor that
requires a palette.getPixelLayout()
,
getPaletteLayout()
,
RGBAComponentKind.Palette
byte[] getPalette() throws PropertyNotPresentException
Returns the palette property of the RGBA descriptor, which is an array of color values that are used to specify an image. The palette is in the form specified by the palette layout. This property is optional.
PropertyNotPresentException
- The optional palette property is not present
in this RGBA descriptor.getPixelLayout()
,
getPaletteLayout()
,
RGBAComponentKind.Palette
@UInt32 int countPaletteLayoutElements() throws PropertyNotPresentException
Returns the number of components per pixel in the palette of this RGBA descriptor.
PropertyNotPresentException
- The optional palette layout property is
not present in this RGBA descriptor.getPaletteLayout()
void setPaletteLayout(@RGBALayout RGBAComponent[] paletteLayoutArray) throws IllegalArgumentException
Sets the layout and structure of the components of a single entry for the palette of the RGBA descriptor. The layout array contains RGBAComponent items. Each item defines a size in bits for a component and the kind of component (red, green etc.).
If you set less than 8 entries, the remaining entries will be padded with
RGBAComponentKind.None
and a size of zero.
To omit this optional property, call this method with null
. If
the RGBA descriptor requires a palette and an attempt is made to omit the property,
an IllegalArgumentException
will be thrown.
paletteLayoutArray
- Array of RGBA components, indicating the order and size
of components in the palette of the RGBA descriptor.
IllegalArgumentException
- Cannot omit the palette layout for an RGBA descriptor that
requires a palette, or the given layout refers to a palette.getPalette()
,
RGBAComponent
,
RGBAComponentKind.Palette
@RGBALayout RGBAComponent[] getPaletteLayout() throws PropertyNotPresentException
Returns the layout and structure of the components of a single entry for the palette of the RGBA descriptor. The layout array contains RGBAComponent items. Each item defines a size in bits for a component and the kind of component (red, green etc.).
PropertyNotPresentException
- The optional palette layout property is not
present for this RGBA descriptor.getPalette()
,
RGBAComponent
,
RGBAComponentKind.Palette
void setComponentMaxRef(@UInt32 Integer componentMaxRef) throws IllegalArgumentException
Sets the maximum value for RGB components of this RGBA descriptor, for example 239 or 959 (8 or 10 bits).
The default value for this optional property is 255. To
omit this optional property, call this method with null
.
componentMaxRef
- Maximum value for RGB components of this RGBA descriptor.
IllegalArgumentException
- The given component maximum reference level is negative.COMPONENTMAXREF_DEFAULT
,
setComponentMinRef(Integer)
,
RGBAComponentKind.Red
,
RGBAComponentKind.Green
,
RGBAComponentKind.Blue
@UInt32 int getComponentMaxRef()
Returns the maximum value for RGB components of this RGBA descriptor, for example 239 or 959 (8 or 10 bits).
If this optional property is not present, its default value of 255 is returned.
COMPONENTMAXREF_DEFAULT
,
getComponentMinRef()
,
RGBAComponentKind.Red
,
RGBAComponentKind.Green
,
RGBAComponentKind.Blue
void setComponentMinRef(@UInt32 Integer componentMinRef) throws IllegalArgumentException
Sets the minimum value for RGB components of the RGBA descriptor, for example 16 or 64 (8 or 10 bits).
The default value for this optional property is 0.
To omit this optional property, call this method with null
.
componentMinRef
- Minimum value for RGB components of the RGBA
descriptor.
IllegalArgumentException
- The given component minimum reference level is negative.COMPONENTMINREF_DEFAULT
,
setComponentMaxRef(Integer)
,
RGBAComponentKind.Red
,
RGBAComponentKind.Green
,
RGBAComponentKind.Blue
@UInt32 int getComponentMinRef()
Returns the minimum value for RGB components of the RGBA descriptor, for example 16 or 64 (8 or 10 bits).
If this optional property is not present, its default value of 0 is returned.
COMPONENTMINREF_DEFAULT
,
getComponentMaxRef()
,
RGBAComponentKind.Red
,
RGBAComponentKind.Green
,
RGBAComponentKind.Blue
void setAlphaMaxRef(@UInt32 Integer alphaMaxRef) throws IllegalArgumentException
Sets the maximum alpha value of the RGBA descriptor, for example 239 or 959 (8 or 10 bits).
The default value for this optional property is 255.
To omit this optional property, call this method with null
.
alphaMaxRef
- Maximum alpha value of this RGBA descriptor.
IllegalArgumentException
- The given maximum alpha reference level is negative.ALPHAMAXREF_DEFAULT
,
setAlphaMinRef(Integer)
,
DigitalImageDescriptor.getAlphaTransparency()
,
RGBAComponentKind.Alpha
@UInt32 int getAlphaMaxRef()
Returns the maximum alpha value of this RGBA descriptor, for example 239 or 959 (8 or 10 bits).
If this optional property is not present, the default value of 255 is returned.
ALPHAMAXREF_DEFAULT
,
getAlphaMinRef()
,
DigitalImageDescriptor.getAlphaTransparency()
,
RGBAComponentKind.Alpha
void setAlphaMinRef(@UInt32 Integer alphaMinRef)
Sets the minimum alpha value of this RGBA descriptor, for example 16 or 64 (8 or 10 bits).
The default value for this property is 0. To omit
this optional property, call this method with null
.
alphaMinRef
- Minimum alpha value of this RGBA descriptor.ALPHAMINREF_DEFAULT
,
setAlphaMaxRef(Integer)
,
DigitalImageDescriptor.getAlphaTransparency()
,
RGBAComponentKind.Alpha
@UInt32 int getAlphaMinRef()
Returns the minimum alpha value of the RGBA descriptor, for example 16 or 64 (8 or 10 bits).
If this optional property is not present, the default value of 0 is returned.
ALPHAMINREF_DEFAULT
,
getAlphaMaxRef()
,
DigitalImageDescriptor.getAlphaTransparency()
,
RGBAComponentKind.Alpha
void setScanningDirection(ScanningDirectionType scanningDirection)
Sets the scanning direction of this RGBA descriptor, which specifies the scanning direction of the image. The value exactly matches the equivalent property in SMPTE 268M.
This property is optional and has a default value of
ScanningDirectionType.LeftToRightTopToBottom
. To omit
this optional property, call this method with null
.
scanningDirection
- Scanning direction of this RGBA descriptor.SCANNINGDIRECTION_DEFAULT
,
ScanningDirectionType
ScanningDirectionType getScanningDirection()
Returns the scanning direction of this RGBA descriptor, which specifies the scanning direction of the image. The value exactly matches the equivalent property in SMPTE 268M.
This property is optional and has a default value of
ScanningDirectionType.LeftToRightTopToBottom
. If the
optional property is not present, the default value is returned.
SCANNINGDIRECTION_DEFAULT
,
ScanningDirectionType
|
Media Authoring with Java API |
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |