net.sourceforge.jaad.mp4.boxes.impl.meta

Class ThreeGPPLocationBox

java.lang.Object

net.sourceforge.jaad.mp4.boxes.BoxImpl

net.sourceforge.jaad.mp4.boxes.FullBox

net.sourceforge.jaad.mp4.boxes.impl.meta.ThreeGPPMetadataBox

net.sourceforge.jaad.mp4.boxes.impl.meta.ThreeGPPLocationBox

All Implemented Interfaces:

Box

public class ThreeGPPLocationBox
extends ThreeGPPMetadataBox

This box contains meta information about a location. If the location information refers to a time-variant location, the name should express a high-level location, such as "Finland" for several places in Finland or "Finland-Sweden" for several places in Finland and Sweden. Further details on time-variant locations can be provided as additional notes. The values of longitude, latitude and altitude provide cursory Global Positioning System (GPS) information of the media content. A value of longitude (latitude) that is less than –180 (-90) or greater than 180 (90) indicates that the GPS coordinates (longitude, latitude, altitude) are unspecified, i.e. none of the given values for longitude, latitude or altitude are valid.

Field Summary

Fields inherited from class net.sourceforge.jaad.mp4.boxes.FullBox

flags, version

Fields inherited from class net.sourceforge.jaad.mp4.boxes.BoxImpl

children, offset, parent, size, type

Constructor Summary

Constructors

Constructor and Description
ThreeGPPLocationBox()

Method Summary

Methods

Modifier and Type	Method and Description
void	decode(MP4InputStream in) Decodes the given input stream by reading this box and all of its children (if any).
java.lang.String	getAdditionalNotes() A string containing any additional location-related information.
double	getAltitude() A floating point number indicating the altitude in meters.
java.lang.String	getAstronomicalBody() A string indicating the astronomical body on which the location exists, e.g.
double	getLatitude() A floating point number indicating the latitude in degrees.
double	getLongitude() A floating point number indicating the longitude in degrees.
java.lang.String	getPlaceName() A string indicating the name of the place.
int	getRole() The role of the place: "shooting location" "real location" "fictional location" Other values are reserved.

Methods inherited from class net.sourceforge.jaad.mp4.boxes.impl.meta.ThreeGPPMetadataBox

decodeCommon, getData, getLanguageCode

Methods inherited from class net.sourceforge.jaad.mp4.boxes.BoxImpl

getChild, getChildren, getChildren, getLeft, getName, getOffset, getParent, getSize, getType, hasChild, hasChildren, readChildren, readChildren, setParams, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreeGPPLocationBox

public ThreeGPPLocationBox()

Method Detail

decode

public void decode(MP4InputStream in)
            throws java.io.IOException

Description copied from class: BoxImpl

Decodes the given input stream by reading this box and all of its children (if any).

Overrides:

decode in class ThreeGPPMetadataBox

Parameters:

in - an input stream

Throws:

java.io.IOException - if an error occurs while reading

getPlaceName

public java.lang.String getPlaceName()

A string indicating the name of the place.

Returns:

the place's name

getRole

public int getRole()

The role of the place:

0. "shooting location"
1. "real location"
2. "fictional location"

Other values are reserved.

Returns:

the role of the place

getLongitude

public double getLongitude()

A floating point number indicating the longitude in degrees. Negative values represent western longitude.

Returns:

the longitude

getLatitude

public double getLatitude()

A floating point number indicating the latitude in degrees. Negative values represent southern latitude.

Returns:

the latitude

getAltitude

public double getAltitude()

A floating point number indicating the altitude in meters. The reference altitude, indicated by zero, is set to the sea level.

Returns:

the altitude

getAstronomicalBody

public java.lang.String getAstronomicalBody()

A string indicating the astronomical body on which the location exists, e.g. "earth".

Returns:

the astronomical body

getAdditionalNotes

public java.lang.String getAdditionalNotes()

A string containing any additional location-related information.

Returns:

the additional notes