lumis.portal.file.metadata

Class FileMetadata

java.lang.Object

lumis.portal.file.metadata.FileMetadata

All Implemented Interfaces:

IFileMetadata

@StableMinor(version="12.3",
             sinceVersion="6.1")
public class FileMetadata
extends Object
implements IFileMetadata

Value object that contains the metadata of a file.

Since:

6.1.0

Version:

$Revision: 23746 $ $Date: 2020-04-07 23:14:34 +0000 (Tue, 07 Apr 2020) $

Field Summary

Fields inherited from interface lumis.portal.fileparser.IFileMetadata

METADATA_DURATION, METADATA_FORMAT, METADATA_HEIGHT, METADATA_WIDTH

Constructor Summary

Constructors

Constructor and Description
FileMetadata() Creates a new FileMetadata.
FileMetadata(FileMacrotype macroType) Creates a new FileMetadata.

Method Summary

Modifier and Type	Method and Description
Double	getAudioBitRate() Returns the audio bit rate metadata.
Integer	getAudioChannels() Returns the number of audio channels metadata.
Integer	getAudioSamplingRate() Returns the audio sampling rate metadata.
Integer	getColorDepth() Returns the color depth metadata.
Long	getDuration() Returns the duration metadata, in milliseconds.
String	getFormat() Returns the format metadata.
Integer	getHeight() Returns the height metadata.
FileMacrotype	getMacroType() Returns the file macro type.
Double	getVideoFrameRate() Returns the video frame rate metadata.
Integer	getWidth() Returns the width metadata.
void	setAudioBitRate(Double audioBitRate) Sets the audio bit rate metadata.
void	setAudioChannels(Integer audioChannels) Sets the number of audio channels metadata.
void	setAudioSamplingRate(Integer audioSamplingRate) Sets the audio sampling rate metadata.
void	setColorDepth(Integer colorDepth) Sets the color depth metadata.
void	setDuration(Long duration) Sets the duration metadata, in milliseconds.
void	setFormat(String format) Sets the format metadata.
void	setHeight(Integer height) Sets the height metadata.
void	setVideoFrameRate(Double videoFrameRate) Sets the video frame rate metadata.
void	setWidth(Integer width) Sets the width metadata.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FileMetadata

public FileMetadata()

Creates a new FileMetadata.

Since:

6.1.0

FileMetadata

public FileMetadata(FileMacrotype macroType)

Creates a new FileMetadata.

Since:

7.0.0

Method Detail

getHeight

public Integer getHeight()

Returns the height metadata.

Specified by:

getHeight in interface IFileMetadata

Returns:

the height metadata, or null if it is unknown or not applicable.

Since:

6.1.0

setHeight

public void setHeight(Integer height)

Sets the height metadata.

Parameters:

height - the height, or null if it is unknown or not applicable.

Since:

6.1.0

getWidth

public Integer getWidth()

Returns the width metadata.

Specified by:

getWidth in interface IFileMetadata

Returns:

the width metadata, or null if it is unknown or not applicable.

Since:

6.1.0

setWidth

public void setWidth(Integer width)

Sets the width metadata.

Parameters:

width - the width, or null if it is unknown or not applicable.

Since:

6.1.0

getDuration

public Long getDuration()

Description copied from interface: IFileMetadata

Returns the duration metadata, in milliseconds.

Specified by:

getDuration in interface IFileMetadata

Returns:

the duration in milliseconds, or null if it is unknown or not applicable.

setDuration

public void setDuration(Long duration)

Sets the duration metadata, in milliseconds.

Parameters:

duration - the duration in milliseconds, or null if it is unknown or not applicable.

Since:

6.1.0

getFormat

public String getFormat()

Description copied from interface: IFileMetadata

Returns the format metadata.

Specified by:

getFormat in interface IFileMetadata

Returns:

the format, or null if it is unknown or not applicable.

setFormat

public void setFormat(String format)

Sets the format metadata.

Parameters:

format - the format, or null if it is unknown or not applicable.

Since:

6.1.0

getColorDepth

public Integer getColorDepth()

Description copied from interface: IFileMetadata

Returns the color depth metadata.

Returns:

the color depth, in bits per pixel, or null if it is unknown or not applicable.

setColorDepth

public void setColorDepth(Integer colorDepth)

Sets the color depth metadata.

Parameters:

colorDepth - the color depth, in bits per pixel, or null if it is unknown or not applicable.

Since:

7.0.0

getVideoFrameRate

public Double getVideoFrameRate()

Description copied from interface: IFileMetadata

Returns the video frame rate metadata.

Returns:

the video frame rate in frames per second, or null if it is unknown or not applicable.

setVideoFrameRate

public void setVideoFrameRate(Double videoFrameRate)

Sets the video frame rate metadata.

Parameters:

the - video frame rate in frames per second, in bits per pixel, or null if it is unknown or not applicable.

Since:

7.0.0

getAudioBitRate

public Double getAudioBitRate()

Description copied from interface: IFileMetadata

Returns the audio bit rate metadata.

Returns:

the audio bit rate in kilobits per second, or null if it is unknown or not applicable.

setAudioBitRate

public void setAudioBitRate(Double audioBitRate)

Sets the audio bit rate metadata.

Parameters:

the - audio bit rate in kilobits per second, or null if it is unknown or not applicable.

Since:

7.0.0

getAudioSamplingRate

public Integer getAudioSamplingRate()

Description copied from interface: IFileMetadata

Returns the audio sampling rate metadata.

Returns:

the audio sampling rate in Hz, or null if it is unknown or not applicable.

setAudioSamplingRate

public void setAudioSamplingRate(Integer audioSamplingRate)

Sets the audio sampling rate metadata.

Parameters:

the - audio sampling rate in Hz, or null if it is unknown or not applicable.

Since:

7.0.0

getAudioChannels

public Integer getAudioChannels()

Description copied from interface: IFileMetadata

Returns the number of audio channels metadata.

Returns:

the number of audio channels, or null if it is unknown or not applicable.

setAudioChannels

public void setAudioChannels(Integer audioChannels)

Sets the number of audio channels metadata.

Parameters:

the - number of audio channels, or null if it is unknown or not applicable.

Since:

7.0.0

getMacroType

public FileMacrotype getMacroType()

Returns the file macro type.

Returns:

the file macro type

Since:

7.0.0

See Also:

FileMacrotype