lumis.portal.file.metadata

Interface IFileMetadata

All Superinterfaces:

IFileMetadata

@StableMinor(version="12.3",
             sinceVersion="6.1")
public interface IFileMetadata
extends IFileMetadata

Provides 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

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 macro type metadata.
Double	getVideoFrameRate() Returns the video frame rate metadata.
Integer	getWidth() Returns the width metadata.

Method Detail

getDuration

Long getDuration()

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.

Since:

6.1.0

getHeight

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

getWidth

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

getFormat

String getFormat()

Returns the format metadata.

Specified by:

getFormat in interface IFileMetadata

Returns:

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

Since:

6.1.0

getColorDepth

Integer getColorDepth()

Returns the color depth metadata.

Returns:

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

Since:

7.0.0

getVideoFrameRate

Double getVideoFrameRate()

Returns the video frame rate metadata.

Returns:

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

Since:

7.0.0

getAudioBitRate

Double getAudioBitRate()

Returns the audio bit rate metadata.

Returns:

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

Since:

7.0.0

getAudioSamplingRate

Integer getAudioSamplingRate()

Returns the audio sampling rate metadata.

Returns:

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

Since:

7.0.0

getAudioChannels

Integer getAudioChannels()

Returns the number of audio channels metadata.

Returns:

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

Since:

7.0.0

getMacroType

FileMacrotype getMacroType()

Returns the macro type metadata.

Returns:

the macro type metadata.

Since:

7.0.0

See Also:

FileMacrotype