Media Authoring
with Java API

tv.amwa.maj.iface
Interface TapeDescriptor

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

public interface TapeDescriptor
extends EssenceDescriptor

Specifies the description of audio tape or video tape media. A source mob described by a tape descriptor is known as a tape source mob.

Author:
Richard Cartwright
See Also:
AAFFactory.makeTapeDescriptor(), SourceMob.setEssenceDescriptor(EssenceDescriptor)

Method Summary
 VideoSignalType getSignalType()
          Returns the video signal standard recorded on the described tape.
 String getTapeBatchNumber()
          Returns the tape batch number for this tape descriptor.
 TapeFormatType getTapeFormat()
          Returns the recording method used for the described tape, known as its format.
 TapeCaseType getTapeFormFactor()
          Returns the tape form factor (case size) of the described tape.
 int getTapeLength()
          Returns the length of the described tape, measured in minutes.
 String getTapeManufacturer()
          Returns the tape manufacturer property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer of the tape.
 String getTapeModel()
          Returns the tape model property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer's brand designation of the tape.
 String getTapeStock()
          Returns the string identifying the tape stock for this tape descriptor.
 void setSignalType(VideoSignalType videoSignal)
          Sets the video signal standard recorded on the described tape.
 void setTapeBatchNumber(String tapeBatchNumber)
          Sets the tape batch number for this tape descriptor.
 void setTapeFormat(TapeFormatType tapeFormat)
          Sets the recording method used for the described tape.
 void setTapeFormFactor(TapeCaseType formFactor)
          Sets the tape form factor (case size) of the described tape.
 void setTapeLength(Integer tapeLength)
          Sets the length of the described tape, measured in minutes.
 void setTapeManufacturer(String tapeManufacturer)
          Sets the tape manufacturer property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer of the tape.
 void setTapeModel(String tapeModel)
          Sets the tape model property of this tape descriptor, which provides a text string to display to end users that identifies the manufacturer's brand designation of the tape.
 void setTapeStock(String tapeStock)
          Sets the string identifying the tape stock for this tape 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

setTapeManufacturer

void setTapeManufacturer(@AAFString
                         String tapeManufacturer)

Sets the tape manufacturer property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer of the tape. Set this optional property to null to omit it.

Parameters:
tapeManufacturer - Tape manufacturer property of the tape descriptor.

getTapeManufacturer

@AAFString
String getTapeManufacturer()
                           throws PropertyNotPresentException

Returns the tape manufacturer property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer of the tape. This is an optional property.

Returns:
Tape manufacturer property of the tape descriptor.
Throws:
PropertyNotPresentException - The optional tape manufacturer property is not present in this tape descriptor.

setTapeModel

void setTapeModel(@AAFString
                  String tapeModel)

Sets the tape model property of this tape descriptor, which provides a text string to display to end users that identifies the manufacturer's brand designation of the tape. Set this optional property to null to omit it.

Parameters:
tapeModel - Tape model of this tape descriptor.

getTapeModel

@AAFString
String getTapeModel()
                    throws PropertyNotPresentException

Returns the tape model property of the tape descriptor, which provides a text string to display to end users that identifies the manufacturer's brand designation of the tape. This is an optional property.

Returns:
Tape model of this tape descriptor.
Throws:
PropertyNotPresentException - The optional tape model property is not present in this tape descriptor.

setTapeFormFactor

void setTapeFormFactor(TapeCaseType formFactor)

Sets the tape form factor (case size) of the described tape. Set this optional property to null to omit it.

Typical values include:

Parameters:
formFactor - Tape form factor (case size) of the described tape.

getTapeFormFactor

TapeCaseType getTapeFormFactor()
                               throws PropertyNotPresentException

Returns the tape form factor (case size) of the described tape. This is an optional property.

Typical values include:

Returns:
Tape form factor of the described tape.
Throws:
PropertyNotPresentException - The optional tape form factor property is not present in this tape descriptor.

setSignalType

void setSignalType(VideoSignalType videoSignal)

Sets the video signal standard recorded on the described tape. Set this optional property to null to omit it.

Typical values includes:

Parameters:
videoSignal - Signal standard recorded on the described tape.

getSignalType

VideoSignalType getSignalType()
                              throws PropertyNotPresentException

Returns the video signal standard recorded on the described tape. This is an optional property.

Typical values includes:

Returns:
Signal standard recorded on the described tape.
Throws:
PropertyNotPresentException - The optional video signal type property is not present in this tape descriptor.

setTapeFormat

void setTapeFormat(TapeFormatType tapeFormat)

Sets the recording method used for the described tape. Set this optional property to null to omit it.

Typical values include:

Parameters:
tapeFormat - Recording method used for the described tape.

getTapeFormat

TapeFormatType getTapeFormat()
                             throws PropertyNotPresentException

Returns the recording method used for the described tape, known as its format. This is an optional property.

Typical values include:

Returns:
Recording method used for the described tape.
Throws:
PropertyNotPresentException - The optional tape format property is not present in this tape descriptor.

setTapeLength

void setTapeLength(@UInt32
                   Integer tapeLength)
                   throws IllegalArgumentException

Sets the length of the described tape, measured in minutes. Set this optional property to null to omit it.

Parameters:
tapeLength - Length of the described tape measured in minutes.
Throws:
IllegalArgumentException - The given tape length is negative.

getTapeLength

@UInt32
int getTapeLength()
                  throws PropertyNotPresentException

Returns the length of the described tape, measured in minutes. This is an optional property.

Returns:
Length of the described tape in minutes.
Throws:
PropertyNotPresentException - The optional tape length property is not present in this tape descriptor.

getTapeBatchNumber

String getTapeBatchNumber()
                          throws PropertyNotPresentException

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

Returns:
Tape batch number for this tape descriptor.
Throws:
PropertyNotPresentException - The optional tape batch number is not present in this tape descriptor.

setTapeBatchNumber

void setTapeBatchNumber(@AAFString
                        String tapeBatchNumber)

Sets the tape batch number for this tape descriptor.

Parameters:
tapeBatchNumber - Tape batch number for this tape descriptor.

getTapeStock

String getTapeStock()
                    throws PropertyNotPresentException

Returns the string identifying the tape stock for this tape descriptor. This is an optional property.

Returns:
String identifying the tape stock for this tape descriptor.
Throws:
PropertyNotPresentException - The optional tape stock property is not present for this tape descriptor.

setTapeStock

void setTapeStock(@AAFString
                  String tapeStock)

Sets the string identifying the tape stock for this tape descriptor. Set this optional property to null to omit it.

Parameters:
tapeStock - String identifying the tape stock for this tape 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.