Module tagtraum.japlphoto

Package com.tagtraum.macos.photos

Interface MediaItem

All Superinterfaces:

Reference

@Code("IPmi")
@Name("media item")
public interface MediaItem
extends Reference

A media item, such as a photo or video.

Author:

JaplScript 3.4.11

Field Summary

Fields

Modifier and Type	Field	Description
static TypeClass	CLASS

Method Summary

Modifier and Type	Method	Description
double	getAltitude()	The GPS altitude in meters.
Date	getDate()	The date of the media item.
String	getDescription()	A description of the media item.
String	getFilename()	The name of the file on disk.
int	getHeight()	The height of the media item in pixels.
String	getId()	The unique ID of the media item.
String[]	getKeywords()	A list of keywords to associate with a media item.
double[]	getLocation()	The GPS latitude and longitude, in an ordered list of 2 numbers or missing values.
String	getName()	The name (title) of the media item.
Map<String,Object>	getProperties()	Returns all properties for an instance of this class.
int	getSize()	The selected media item file size.
int	getWidth()	The width of the media item in pixels.
boolean	isFavorite()	Whether the media item has been favorited.
void	setDate(Date date)	The date of the media item.
void	setDescription(String description)	A description of the media item.
void	setFavorite(boolean favorite)	Whether the media item has been favorited.
void	setKeywords(String[] keywords)	A list of keywords to associate with a media item.
void	setLocation(double[] location)	The GPS latitude and longitude, in an ordered list of 2 numbers or missing values.
void	setName(String name)	The name (title) of the media item.
void	setSize(int size)	The selected media item file size.

Methods inherited from interface com.tagtraum.japlscript.Reference

cast, getApplicationReference, getObjectReference, getTypeClass, isInstanceOf

Field Detail

CLASS

static final TypeClass CLASS

Method Detail

getKeywords

@Code("IPkw")
@Kind("property")
@Name("keywords")
@Type("text")
String[] getKeywords()

A list of keywords to associate with a media item.

Returns:

property value

setKeywords

@Code("IPkw")
@Kind("property")
@Name("keywords")
@Type("text")
void setKeywords(String[] keywords)

A list of keywords to associate with a media item.

Parameters:

keywords - new property value

getName

@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
String getName()

The name (title) of the media item.

Returns:

property value

setName

@Code("pnam")
@Kind("property")
@Name("name")
@Type("text")
void setName(String name)

The name (title) of the media item.

Parameters:

name - new property value

getDescription

@Code("IPde")
@Kind("property")
@Name("description")
@Type("text")
String getDescription()

A description of the media item.

Returns:

property value

setDescription

@Code("IPde")
@Kind("property")
@Name("description")
@Type("text")
void setDescription(String description)

A description of the media item.

Parameters:

description - new property value

isFavorite

@Code("IPfv")
@Kind("property")
@Name("favorite")
@Type("boolean")
boolean isFavorite()

Whether the media item has been favorited.

Returns:

property value

setFavorite

@Code("IPfv")
@Kind("property")
@Name("favorite")
@Type("boolean")
void setFavorite(boolean favorite)

Whether the media item has been favorited.

Parameters:

favorite - new property value

getDate

@Code("idat")
@Kind("property")
@Name("date")
@Type("date")
Date getDate()

The date of the media item.

Returns:

property value

setDate

@Code("idat")
@Kind("property")
@Name("date")
@Type("date")
void setDate(Date date)

The date of the media item.

Parameters:

date - new property value

getId

@Code("ID  ")
@Kind("property")
@Name("id")
@Type("text")
String getId()

The unique ID of the media item.

Returns:

property value

getHeight

@Code("phit")
@Kind("property")
@Name("height")
@Type("integer")
int getHeight()

The height of the media item in pixels.

Returns:

property value

getWidth

@Code("pwid")
@Kind("property")
@Name("width")
@Type("integer")
int getWidth()

The width of the media item in pixels.

Returns:

property value

getFilename

@Code("filn")
@Kind("property")
@Name("filename")
@Type("text")
String getFilename()

The name of the file on disk.

Returns:

property value

getAltitude

@Code("alti")
@Kind("property")
@Name("altitude")
@Type("real")
double getAltitude()

The GPS altitude in meters.

Returns:

property value

getSize

@Code("fsiz")
@Kind("property")
@Name("size")
@Type("integer")
int getSize()

The selected media item file size.

Returns:

property value

setSize

@Code("fsiz")
@Kind("property")
@Name("size")
@Type("integer")
void setSize(int size)

The selected media item file size.

Parameters:

size - new property value

getLocation

@Code("IPlo")
@Kind("property")
@Name("location")
@Type("real")
double[] getLocation()

The GPS latitude and longitude, in an ordered list of 2 numbers or missing values. Latitude in range -90.0 to 90.0, longitude in range -180.0 to 180.0.

Returns:

property value

setLocation

@Code("IPlo")
@Kind("property")
@Name("location")
@Type("real")
void setLocation(double[] location)

The GPS latitude and longitude, in an ordered list of 2 numbers or missing values. Latitude in range -90.0 to 90.0, longitude in range -180.0 to 180.0.

Parameters:

location - new property value

getProperties

Map<String,Object> getProperties()

Returns all properties for an instance of this class.

Returns:

Map containing all properties