MediaFile (audiobox-jlib 1.0.4 API)

java.lang.Object
- java.util.Observable
- - fm.audiobox.core.models.Model
  - - fm.audiobox.core.models.MediaFile

```
public class MediaFile
extends Model
```
Media Files are the most important entity in the platform, has many properties, are editable, deletable and streamable.
Not every media container is supported by AudioBox, you can find this information in the user.json API call by looking user.accepted_extensions and user.accepted_formats.

Uploads

Media Files uploaded into AudioBox Cloud will use storage space that will count toward the monthly bill of the User. Please always check the permissions.cloud value prior to attempt an upload since a subscription might no be in good standing.

Streaming

Developers can request to stream a file in any moment.

Attributes

type:

string, readonly. Can be either 'AudioFile' or 'VideoFile'

token:

string, readonly. Identify uniquely this Media File in the system

artist:

string, readwrite. Artist name, automatically set depending on the Cloud Drive in use, if not set.

album:

string, readwrite. Album name, automatically set depending on the Cloud Drive in use if not set.

genre:

string, readwrite. Genre name, automatically set depending on the Cloud Drive in use if not set.

releaseYear:

integer, readwrite. Four integers, represents the year when the Media File has been released.

title:

string, readwrite. The title of this Media File.

albumArtist:

string, readwrite. Album Artist name. Useful to differentiate between compilations.

composer:

string, readwrite. Composer name.

comment:

string, readwrite. Custom comment.

lenlenStrtr:

string, readonly. Formatted as "3:04" to ease display in views. Represents the duration of the media file.

lenInt:

integer, readonly. Represents the duration in seconds of the media file.

position:

integer, readwrite. Represents the position this Media File occupy in a collection/album (track's number).

filename:

string, readonly. File name indicating where the file has been stored on our systems.

loved:

boolean, readwrite. Indicates if this Media File is 'loved' by its owner or not. Default is false.

discNumber:

integer, readwrite. Represents the number of the disc in a multi collection set.

mime:

string, readonly. Formatted such as "audio/mpeg", represents the recognized mime type for this file. This value can help some client to better recognize the type of file to be streamed.

remotePath:

string, readonly. Used along with some Cloud Drives to help the platform identifying where this file is stored for retrieval.

source:

string, readonly. Represents where this Media File comes from. Possible values are: 'cloud', 'local', 'dropbox', 'skydrive', 'box', 'gdrive', 'youtube', 'soundcloud', 'mega'.

shareToken:

string, readonly. Shared token across multiple Media Files with the same artist/album combo that builds up a Share URL, such as: http://audiobox.fm/share/cfa4b55e1736415b491147f041b95392.

artwork:

string, readwrite. Represents the path for the Artwork of a Media File on the HTTP(S) CDN m.audiobox.fm. 256x256. 1.5MB Max. PNG/JPEG/GIF.

size:

integer, readonly. Physical size of the Media File, in bytes.

hash:

string, readonly. MD5 Hash of the Media File.

videoBitrate:

string, readonly. Indicates the bitrate in case of VideoFile.

videoCodec:

string, readonly. Indicates the codec in case of VideoFile.

videoResolution:

string, readonly. Indicates the resolution in case of VideoFile.

videoFps:

string, readonly. Indicates the frame per second in case of VideoFile.

videoAspect:

string, readonly. Indicates the aspect ratio in case of VideoFile.

videoContainer:

string, readonly. Indicates the container in case of VideoFile.

audioBitrate:

string, readonly. Indicates the bitrate in case of AudioFile or the first audio track in a VideoFile.

audioCodec:

string, readonly. Indicates the codec in case of AudioFile or the first audio track in a VideoFile.

audioSampleRate:

string, readonly. Indicates the sample rate in case of AudioFile or the first audio track in a VideoFile.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`album` The Album.
`protected java.lang.String`	`albumArtist` The Album artist.
`protected java.lang.String`	`artist` The Artist.
`protected java.lang.String`	`artwork` The Artwork.
`protected java.lang.String`	`audioBitrate` The Audio bitrate.
`protected java.lang.String`	`audioCodec` The Audio codec.
`protected java.lang.String`	`audioSampleRate` The Audio sample rate.
`protected java.lang.String`	`comment` The Comment.
`protected java.lang.String`	`composer` The Composer.
`protected int`	`discNumber` The Disc number.
`protected java.lang.String`	`filename` The Filename.
`protected java.lang.String`	`genre` The Genre.
`protected java.lang.String`	`hash` The Hash.
`protected int`	`lenInt` The duration in seconds.
`protected java.lang.String`	`lenStr` The duration string formatted.
`protected boolean`	`loved` The Loved.
`protected java.lang.String`	`lyrics` The Lyrics.
`protected java.lang.String`	`mediaFileName` The Media file name.
`protected java.lang.String`	`mime` The Mime.
`protected int`	`position` The Position.
`protected int`	`releaseYear` The Release year.
`protected java.lang.String`	`remotePath` The Remote path.
`protected java.lang.String`	`shareToken` The Share token.
`protected long`	`size` The Size.
`protected java.lang.String`	`source` The Source.
`protected java.lang.String`	`title` The Title.
`protected java.lang.String`	`token` The Token.
`protected java.lang.String`	`type` The Type.
`protected java.lang.String`	`videoAspect` The Video aspect ratio.
`protected java.lang.String`	`videoBitrate` The Video bitrate.
`protected java.lang.String`	`videoCodec` The Video codec.
`protected java.lang.String`	`videoContainer` The Video container.
`protected java.lang.String`	`videoFps` The Video FPS.
`protected java.lang.String`	`videoResolution` The Video resolution.

Constructor Summary

Constructors
Constructor and Description

MediaFile()
Instantiates a new Playlist.

Constructors
Constructor and Description
`MediaFile()` Instantiates a new Playlist.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`destroy(AudioBoxClient audioBoxClient)` Handle a single media file destruction synchronously.
`java.io.OutputStream`	`download(AudioBoxClient audioBoxClient, java.io.OutputStream out)` Downloads the media to specified `OutputStream`
`java.io.OutputStream`	`download(AudioBoxClient audioBoxClient, java.io.OutputStream out, NetworkProgressListener listener)` Downloads the media to specified `OutputStream`
`java.lang.String`	`getAlbum()` Album name, automatically set depending on the Cloud Drive in use if not set.
`java.lang.String`	`getAlbumArtist()` Album Artist name.
`java.lang.String`	`getArtist()` Artist name, automatically set depending on the Cloud Drive in use, if not set.
`java.lang.String`	`getArtwork()` Represents the path for the Artwork of a Media File on the HTTP(S) CDN m.audiobox.fm. 256x256. 1.5MB Max.
`java.lang.String`	`getAudioBitrate()` Indicates the bitrate in case of AudioFile or the first audio track in a VideoFile.
`java.lang.String`	`getAudioCodec()` Indicates the codec in case of AudioFile or the first audio track in a VideoFile.
`java.lang.String`	`getAudioSampleRate()` Indicates the sample rate in case of AudioFile or the first audio track in a VideoFile.
`java.lang.String`	`getComment()` Gets custom comment.
`java.lang.String`	`getComposer()` Composer name.
`int`	`getDiscNumber()` Represents the number of the disc in a multi collection set.
`java.lang.String`	`getDownloadPath()` Gets download path for this media file.
`java.lang.String`	`getDownloadUrl(AudioBoxClient audioBoxClient)` Gets download url for this media file.
`java.lang.String`	`getFilename()` File name indicating where the file has been stored on our systems.
`java.lang.String`	`getGenre()` Genre name, automatically set depending on the Cloud Drive in use if not set.
`java.lang.String`	`getHash()` MD5 Hash of the Media File.
`int`	`getLenInt()` Represents the duration in seconds of the media file.
`java.lang.String`	`getLenStr()` Formatted as "3:04" to ease display in views.
`java.lang.String`	`getLyrics(AudioBoxClient audioBoxClient)` Loads the media file lyrics from AudioBox.
`java.lang.String`	`getMime()` Formatted such as "audio/mpeg", represents the recognized mime type for this file.
`static java.lang.String`	`getPath()` Gets the generic remote resource path (token interpolation is needed).
`int`	`getPosition()` Represents the position this Media File occupy in a collection/album (track's number).
`int`	`getReleaseYear()` Four integers, represents the year when the Media File has been released.
`java.lang.String`	`getRemotePath()` Used along with some Cloud Drives to help the platform identifying where this file is stored for retrieval.
`java.lang.String`	`getShareToken()` Shared token across multiple Media Files with the same artist/album combo that builds up a Share URL, such as: `http://audiobox.fm/share/cfa4b55e1736415b491147f041b95392`
`long`	`getSize()` Physical size of the Media File, in bytes.
`java.lang.String`	`getSource()` Represents where this Media File comes from.
`java.lang.String`	`getStreamPath()` Gets stream path for this media file.
`java.lang.String`	`getStreamUrl(AudioBoxClient audioBoxClient, boolean secure)` Gets stream url for this media file.
`java.lang.String`	`getTitle()` The title of this Media File.
`java.lang.String`	`getToken()` Gets token, identify uniquely this Media File in the system.
`java.lang.String`	`getType()` Gets the media file type, can be either 'AudioFile' or 'VideoFile'.
`java.lang.String`	`getVideoAspect()` Indicates the aspect ratio in case of VideoFile.
`java.lang.String`	`getVideoBitrate()` Indicates the codec in case of VideoFile.
`java.lang.String`	`getVideoCodec()` Indicates the codec in case of VideoFile.
`java.lang.String`	`getVideoContainer()` Indicates the container in case of VideoFile.
`java.lang.String`	`getVideoFps()` Indicates the frame per second in case of VideoFile.
`java.lang.String`	`getVideoResolution()` Indicates the resolution in case of VideoFile.
`boolean`	`isLoved()` Indicates if this Media File is 'loved' by its owner or not.
`static MediaFile`	`load(AudioBoxClient audioBoxClient, java.lang.String token)` Load a single media file.
`MediaFile`	`love(AudioBoxClient audioBoxClient)` Manually 'love' a Media File This will also trigger love/like on all supported and linked remote services, such as Last.fm/Facebook.
`MediaFile`	`reload(AudioBoxClient audioBoxClient)` (Re)load a new instance of the same media file.
`MediaFile`	`scrobble(AudioBoxClient audioBoxClient)` Notify the system that this media file finished playing.
`void`	`setAlbum(java.lang.String album)` Sets album.
`void`	`setAlbumArtist(java.lang.String albumArtist)` Sets album artist name.
`void`	`setArtist(java.lang.String artist)` Sets artist.
`void`	`setArtwork(java.lang.String artwork)` Sets artwork.
`void`	`setAudioBitrate(java.lang.String audioBitrate)` Sets audio bitrate.
`void`	`setAudioCodec(java.lang.String audioCodec)` Sets audio codec.
`void`	`setAudioSampleRate(java.lang.String audioSampleRate)` Sets audio sample rate.
`void`	`setComment(java.lang.String comment)` Sets comment.
`void`	`setComposer(java.lang.String composer)` Sets composer.
`void`	`setDiscNumber(int discNumber)` Sets disc number.
`void`	`setFilename(java.lang.String filename)` Sets filename.
`void`	`setGenre(java.lang.String genre)` Sets genre.
`void`	`setHash(java.lang.String hash)` Sets hash.
`void`	`setLenInt(int lenInt)` Sets len int.
`void`	`setLenStr(java.lang.String lenStr)` Sets length in string format
`void`	`setLoved(boolean loved)` Sets loved.
`void`	`setLyrics(java.lang.String lyrics)` Sets lyrics.
`void`	`setMediaFileName(java.lang.String mediaFileName)` Sets media file name.
`void`	`setMime(java.lang.String mime)` Sets mime.
`void`	`setPosition(int position)` Sets position.
`void`	`setReleaseYear(int releaseYear)` Sets release year.
`void`	`setRemotePath(java.lang.String remotePath)` Sets remote path.
`void`	`setShareToken(java.lang.String shareToken)` Sets share token.
`void`	`setSize(long size)` Sets size.
`void`	`setSource(java.lang.String source)` Sets source.
`void`	`setTitle(java.lang.String title)` Sets title.
`void`	`setToken(java.lang.String token)` Sets token.
`void`	`setType(java.lang.String type)` Sets type.
`void`	`setVideoAspect(java.lang.String videoAspect)` Sets video aspect.
`void`	`setVideoBitrate(java.lang.String videoBitrate)` Sets video bitrate.
`void`	`setVideoCodec(java.lang.String videoCodec)` Sets video codec.
`void`	`setVideoContainer(java.lang.String videoContainer)` Sets video container.
`void`	`setVideoFps(java.lang.String videoFps)` Sets video fps.
`void`	`setVideoResolution(java.lang.String videoResolution)` Sets video resolution.
`MediaFile`	`toggleLove(AudioBoxClient audioBoxClient)` Switch the loved attribute to true/false and fire off remote services notifications.
`MediaFile`	`unlove(AudioBoxClient audioBoxClient)` Manually 'unlove' a Media File This will also trigger 'unlove' on all supported and linked remote services, such as Last.fm/Facebook/Google Drive.
`MediaFile`	`update(AudioBoxClient audioBoxClient)` Handle a single media file update.

Methods inherited from class fm.audiobox.core.models.Model
getProp, notifyObservers, setProp

Methods inherited from class java.util.Observable
addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - type
```
protected java.lang.String type
```
    The Type.
  - token
```
protected java.lang.String token
```
    The Token.
  - artist
```
protected java.lang.String artist
```
    The Artist.
  - album
```
protected java.lang.String album
```
    The Album.
  - genre
```
protected java.lang.String genre
```
    The Genre.
  - releaseYear
```
protected int releaseYear
```
    The Release year.
  - title
```
protected java.lang.String title
```
    The Title.
  - lenStr
```
protected java.lang.String lenStr
```
    The duration string formatted.
  - lenInt
```
protected int lenInt
```
    The duration in seconds.
  - position
```
protected int position
```
    The Position.
  - filename
```
protected java.lang.String filename
```
    The Filename.
  - mediaFileName
```
protected java.lang.String mediaFileName
```
    The Media file name.
  - loved
```
protected boolean loved
```
    The Loved.
  - discNumber
```
protected int discNumber
```
    The Disc number.
  - mime
```
protected java.lang.String mime
```
    The Mime.
  - remotePath
```
protected java.lang.String remotePath
```
    The Remote path.
  - source
```
protected java.lang.String source
```
    The Source.
  - shareToken
```
protected java.lang.String shareToken
```
    The Share token.
  - artwork
```
protected java.lang.String artwork
```
    The Artwork.
  - size
```
protected long size
```
    The Size.
  - albumArtist
```
protected java.lang.String albumArtist
```
    The Album artist.
  - hash
```
protected java.lang.String hash
```
    The Hash.
  - composer
```
protected java.lang.String composer
```
    The Composer.
  - comment
```
protected java.lang.String comment
```
    The Comment.
  - videoBitrate
```
protected java.lang.String videoBitrate
```
    The Video bitrate.
  - videoCodec
```
protected java.lang.String videoCodec
```
    The Video codec.
  - videoResolution
```
protected java.lang.String videoResolution
```
    The Video resolution.
  - videoFps
```
protected java.lang.String videoFps
```
    The Video FPS.
  - videoAspect
```
protected java.lang.String videoAspect
```
    The Video aspect ratio.
  - videoContainer
```
protected java.lang.String videoContainer
```
    The Video container.
  - audioBitrate
```
protected java.lang.String audioBitrate
```
    The Audio bitrate.
  - audioCodec
```
protected java.lang.String audioCodec
```
    The Audio codec.
  - audioSampleRate
```
protected java.lang.String audioSampleRate
```
    The Audio sample rate.
  - lyrics
```
protected java.lang.String lyrics
```
    The Lyrics.
- Constructor Detail
  - MediaFile
```
public MediaFile()
```
    Instantiates a new Playlist.
    Default empty constructor.
- Method Detail
  - getPath
```
public static java.lang.String getPath()
```
    Gets the generic remote resource path (token interpolation is needed).
    
    Returns:
    the path String
  - getStreamPath
```
public java.lang.String getStreamPath()
```
    Gets stream path for this media file.
    
    Returns:
    the stream path
  - getStreamUrl
```
public java.lang.String getStreamUrl(AudioBoxClient audioBoxClient,
                            boolean secure)
```
    Gets stream url for this media file.
    Some device does not support SSL streaming (such as old Android), in this case you are forced to serve via canonical HTTP protocol (secure = false).
    
    Parameters:
    audioBoxClient - the Client instance to grab env configuration from
    secure - whether to serve the SSL protected stream url or not
    
    Returns:
    the stream path
  - getDownloadPath
```
public java.lang.String getDownloadPath()
```
    Gets download path for this media file.
    
    Returns:
    the download path
  - getDownloadUrl
```
public java.lang.String getDownloadUrl(AudioBoxClient audioBoxClient)
```
    Gets download url for this media file.
    
    Parameters:
    audioBoxClient - the Client instance to grab env configuration from
    
    Returns:
    the stream path
  - load
```
public static MediaFile load(AudioBoxClient audioBoxClient,
             java.lang.String token)
                      throws java.io.IOException
```
    Load a single media file.
    
    Parameters:
    audioBoxClient - client the to use for the request
    token - the token that uniquely identify the media file
    
    Returns:
    the requested media file
    
    Throws:
    
    ResourceNotFoundException - if the requested media was not found on AudioBox.
    
    java.io.IOException
    See Also:
  - reload
```
public MediaFile reload(AudioBoxClient audioBoxClient)
                 throws java.io.IOException
```
    (Re)load a new instance of the same media file.
    
    Parameters:
    audioBoxClient - client the to use for the request
    
    Returns:
    the requested media file
    
    Throws:
    
    ResourceNotFoundException - if the requested media was not found on AudioBox.
    
    java.io.IOException
    See Also:
  - download
```
public java.io.OutputStream download(AudioBoxClient audioBoxClient,
                            java.io.OutputStream out)
                              throws java.io.IOException
```
    Downloads the media to specified OutputStream
    
    Parameters:
    audioBoxClient - client the to use for the request
    out - the desired OutputStream where to store the downloaded data
    
    Returns:
    the same given instance with downloaded data
    
    Throws:
    
    java.io.IOException - if any network communication or IO occurs
  - download
```
public java.io.OutputStream download(AudioBoxClient audioBoxClient,
                            java.io.OutputStream out,
                            NetworkProgressListener listener)
                              throws java.io.IOException
```
    Downloads the media to specified OutputStream
    
    Parameters:
    audioBoxClient - client the to use for the request
    out - the desired OutputStream where to store the downloaded data
    listener - a NetworkProgressListener for monitoring download progress
    
    Returns:
    the same given instance with downloaded data
    
    Throws:
    
    java.io.IOException - if any network communication or IO occurs
  - update
```
public MediaFile update(AudioBoxClient audioBoxClient)
                 throws java.io.IOException
```
    Handle a single media file update.
    
    Parameters:
    audioBoxClient - the client to use for the request
    
    Returns:
    the media file in order to chain other calls.
    
    Throws:
    
    AudioBoxException - if any of the remote error exception is detected.
    
    java.io.IOException
    See Also:
  - destroy
```
public boolean destroy(AudioBoxClient audioBoxClient)
                throws java.io.IOException
```
    Handle a single media file destruction synchronously.
    If you need to permanently destroy more than one single media file in one sweep use MediaFiles.destroyAll(fm.audiobox.core.AudioBoxClient, java.util.List)
    Do not attempt to call this endpoint for single tracks the user selected to destroy.
    This will remove the media file from our database. If the media file is stored on AudioBox Cloud it will be physically removed as well. If the media file is stored on a remote storage solution like AudioBox Desktop, Dropbox, SkyDrive, etc. it will not be harmed unless management mode is enabled.
    
    Parameters:
    audioBoxClient - the client to use for the request
    
    Returns:
    true if the operation succeeds.
    
    Throws:
    
    AudioBoxException - if any of the remote error exception is detected.
    
    java.io.IOException
    See Also:
  - scrobble
```
public MediaFile scrobble(AudioBoxClient audioBoxClient)
                   throws java.io.IOException
```
    Notify the system that this media file finished playing.
    This endpoint is highly recommended to be used and should be called when the Media File is approaching the end of the stream.
    Triggers different actions in the system, such as Scrobbling to Last.fm and much more.
    
    Parameters:
    audioBoxClient - client the to use for the request
    
    Returns:
    the media file in order to chain other calls.
    
    Throws:
    
    AudioBoxException - if any of the remote error exception is detected.
    
    java.io.IOException
    See Also:
  - getLyrics
```
public java.lang.String getLyrics(AudioBoxClient audioBoxClient)
                           throws java.io.IOException
```
    Loads the media file lyrics from AudioBox.
    
    Parameters:
    audioBoxClient - client the to use for the request
    
    Returns:
    the lyrics or null
    
    Throws:
    
    AudioBoxException - if any of the remote error exception is detected.
    
    java.io.IOException
    See Also:
  - love
```
public MediaFile love(AudioBoxClient audioBoxClient)
               throws java.io.IOException
```
    Manually 'love' a Media File
    This will also trigger love/like on all supported and linked remote services, such as Last.fm/Facebook.
    You can also 'love' the media file by issuing a PUT update request and setting the attribute 'loved' to true, but this will not notifying any remote services.
    Last.fm will see a track as loved, Facebook as liked, Google Drive as starred, and so on.
    
    Parameters:
    audioBoxClient - client the to use for the request
    
    Returns:
    the media file in order to chain other calls.
    
    Throws:
    
    AudioBoxException - if any of the remote error exception is detected.
    
    java.io.IOException
    See Also:
  - unlove
```
public MediaFile unlove(AudioBoxClient audioBoxClient)
                 throws java.io.IOException
```
    Manually 'unlove' a Media File
    This will also trigger 'unlove' on all supported and linked remote services, such as Last.fm/Facebook/Google Drive.
    You can also 'unlove' the media file by issuing a PUT update request and setting the attribute 'loved' to false, but this will not notifying any remote services.
    Last.fm will see a track as unloved, Facebook as unliked, Google Drive as not starred, and so on.
    
    Parameters:
    audioBoxClient - client the to use for the request
    
    Returns:
    the media file in order to chain other calls.
    
    Throws:
    
    AudioBoxException - if any of the remote error exception is detected.
    
    java.io.IOException
    See Also:
  - toggleLove
```
public MediaFile toggleLove(AudioBoxClient audioBoxClient)
                     throws java.io.IOException
```
    Switch the loved attribute to true/false and fire off remote services notifications.
    This is useful for application that care about the loved attribute after it's being set.
    Preserve all the features of the love and unlove endpoints.
    
    Parameters:
    audioBoxClient - client the to use for the request
    
    Returns:
    the media file in order to chain other calls.
    
    Throws:
    
    AudioBoxException - if any of the remote error exception is detected.
    
    java.io.IOException
    See Also:
  - getType
```
public java.lang.String getType()
```
    Gets the media file type, can be either 'AudioFile' or 'VideoFile'.
    
    Returns:
    the type
  - getToken
```
public java.lang.String getToken()
```
    Gets token, identify uniquely this Media File in the system.
    
    Returns:
    the token
  - getArtist
```
public java.lang.String getArtist()
```
    Artist name, automatically set depending on the Cloud Drive in use, if not set.
    
    Returns:
    the artist
  - setArtist
```
public void setArtist(java.lang.String artist)
```
    Sets artist.
    
    Parameters:
    artist - the artist
  - getAlbum
```
public java.lang.String getAlbum()
```
    Album name, automatically set depending on the Cloud Drive in use if not set.
    
    Returns:
    the album
  - setAlbum
```
public void setAlbum(java.lang.String album)
```
    Sets album.
    
    Parameters:
    album - the album
  - getGenre
```
public java.lang.String getGenre()
```
    Genre name, automatically set depending on the Cloud Drive in use if not set.
    
    Returns:
    the genre
  - setGenre
```
public void setGenre(java.lang.String genre)
```
    Sets genre.
    
    Parameters:
    genre - the genre
  - getReleaseYear
```
public int getReleaseYear()
```
    Four integers, represents the year when the Media File has been released.
    
    Returns:
    the release year
  - setReleaseYear
```
public void setReleaseYear(int releaseYear)
```
    Sets release year.
    
    Parameters:
    releaseYear - the release year
  - getTitle
```
public java.lang.String getTitle()
```
    The title of this Media File.
    
    Returns:
    the title
  - setTitle
```
public void setTitle(java.lang.String title)
```
    Sets title.
    
    Parameters:
    title - the title
  - getLenStr
```
public java.lang.String getLenStr()
```
    Formatted as "3:04" to ease display in views. Represents the duration of the media file.
    
    Returns:
    the len str
  - getLenInt
```
public int getLenInt()
```
    Represents the duration in seconds of the media file.
    
    Returns:
    the len int
  - getPosition
```
public int getPosition()
```
    Represents the position this Media File occupy in a collection/album (track's number).
    
    Returns:
    the position
  - setPosition
```
public void setPosition(int position)
```
    Sets position.
    
    Parameters:
    position - the position
  - getFilename
```
public java.lang.String getFilename()
```
    File name indicating where the file has been stored on our systems.
    
    Returns:
    the filename
  - isLoved
```
public boolean isLoved()
```
    Indicates if this Media File is 'loved' by its owner or not. Default is false.
    
    Returns:
    the boolean
  - setLoved
```
public void setLoved(boolean loved)
```
    Sets loved.
    
    Parameters:
    loved - the loved
  - getDiscNumber
```
public int getDiscNumber()
```
    Represents the number of the disc in a multi collection set.
    
    Returns:
    the disc number
  - setDiscNumber
```
public void setDiscNumber(int discNumber)
```
    Sets disc number.
    
    Parameters:
    discNumber - the disc number
  - getMime
```
public java.lang.String getMime()
```
    Formatted such as "audio/mpeg", represents the recognized mime type for this file. This value can help some client to better recognize the type of file to be streamed.
    
    Returns:
    the mime
  - getRemotePath
```
public java.lang.String getRemotePath()
```
    Used along with some Cloud Drives to help the platform identifying where this file is stored for retrieval.
    
    Returns:
    the remote path
  - getSource
```
public java.lang.String getSource()
```
    Represents where this Media File comes from. Possible values are: 'cloud', 'local', 'dropbox', 'skydrive', 'box', 'gdrive', 'youtube', 'soundcloud', 'mega'.
    
    Returns:
    the source
  - getShareToken
```
public java.lang.String getShareToken()
```
    Shared token across multiple Media Files with the same artist/album combo that builds up a Share URL, such as: http://audiobox.fm/share/cfa4b55e1736415b491147f041b95392
    
    Returns:
    the share token
  - getArtwork
```
public java.lang.String getArtwork()
```
    Represents the path for the Artwork of a Media File on the HTTP(S) CDN m.audiobox.fm. 256x256. 1.5MB Max. PNG/JPEG/GIF.
    
    Returns:
    the artwork
  - setArtwork
```
public void setArtwork(java.lang.String artwork)
```
    Sets artwork.
    
    Parameters:
    artwork - the artwork
  - getSize
```
public long getSize()
```
    Physical size of the Media File, in bytes.
    
    Returns:
    the size
  - getAlbumArtist
```
public java.lang.String getAlbumArtist()
```
    Album Artist name. Useful to differentiate between compilations.
    
    Returns:
    the album artist
  - setAlbumArtist
```
public void setAlbumArtist(java.lang.String albumArtist)
```
    Sets album artist name.
    
    Parameters:
    albumArtist - the album artist
  - getHash
```
public java.lang.String getHash()
```
    MD5 Hash of the Media File.
    
    Returns:
    the hash
  - getComposer
```
public java.lang.String getComposer()
```
    Composer name.
    
    Returns:
    the composer
  - setComposer
```
public void setComposer(java.lang.String composer)
```
    Sets composer.
    
    Parameters:
    composer - the composer
  - getComment
```
public java.lang.String getComment()
```
    Gets custom comment.
    
    Returns:
    the comment
  - setComment
```
public void setComment(java.lang.String comment)
```
    Sets comment.
    
    Parameters:
    comment - the comment
  - getVideoBitrate
```
public java.lang.String getVideoBitrate()
```
    Indicates the codec in case of VideoFile.
    
    Returns:
    the video bitrate
  - getVideoCodec
```
public java.lang.String getVideoCodec()
```
    Indicates the codec in case of VideoFile.
    
    Returns:
    the video codec
  - getVideoResolution
```
public java.lang.String getVideoResolution()
```
    Indicates the resolution in case of VideoFile.
    
    Returns:
    the video resolution
  - getVideoFps
```
public java.lang.String getVideoFps()
```
    Indicates the frame per second in case of VideoFile.
    
    Returns:
    the video fps
  - getVideoAspect
```
public java.lang.String getVideoAspect()
```
    Indicates the aspect ratio in case of VideoFile.
    
    Returns:
    the video aspect
  - getVideoContainer
```
public java.lang.String getVideoContainer()
```
    Indicates the container in case of VideoFile.
    
    Returns:
    the video container
  - getAudioBitrate
```
public java.lang.String getAudioBitrate()
```
    Indicates the bitrate in case of AudioFile or the first audio track in a VideoFile.
    
    Returns:
    the audio bitrate
  - getAudioCodec
```
public java.lang.String getAudioCodec()
```
    Indicates the codec in case of AudioFile or the first audio track in a VideoFile.
    
    Returns:
    the audio codec
  - getAudioSampleRate
```
public java.lang.String getAudioSampleRate()
```
    Indicates the sample rate in case of AudioFile or the first audio track in a VideoFile.
    
    Returns:
    the audio sample rate
  - setType
```
public void setType(java.lang.String type)
```
    Sets type.
    
    Parameters:
    type - the type
  - setToken
```
public void setToken(java.lang.String token)
```
    Sets token.
    
    Parameters:
    token - the token
  - setLenStr
```
public void setLenStr(java.lang.String lenStr)
```
    Sets length in string format
    
    Parameters:
    lenStr - the media duration in string format
  - setLenInt
```
public void setLenInt(int lenInt)
```
    Sets len int.
    
    Parameters:
    lenInt - the len int
  - setFilename
```
public void setFilename(java.lang.String filename)
```
    Sets filename.
    
    Parameters:
    filename - the filename
  - setMediaFileName
```
public void setMediaFileName(java.lang.String mediaFileName)
```
    Sets media file name.
    
    Parameters:
    mediaFileName - the media file name
  - setMime
```
public void setMime(java.lang.String mime)
```
    Sets mime.
    
    Parameters:
    mime - the mime
  - setRemotePath
```
public void setRemotePath(java.lang.String remotePath)
```
    Sets remote path.
    
    Parameters:
    remotePath - the remote path
  - setSource
```
public void setSource(java.lang.String source)
```
    Sets source.
    
    Parameters:
    source - the source
  - setShareToken
```
public void setShareToken(java.lang.String shareToken)
```
    Sets share token.
    
    Parameters:
    shareToken - the share token
  - setSize
```
public void setSize(long size)
```
    Sets size.
    
    Parameters:
    size - the size
  - setHash
```
public void setHash(java.lang.String hash)
```
    Sets hash.
    
    Parameters:
    hash - the hash
  - setVideoBitrate
```
public void setVideoBitrate(java.lang.String videoBitrate)
```
    Sets video bitrate.
    
    Parameters:
    videoBitrate - the video bitrate
  - setVideoCodec
```
public void setVideoCodec(java.lang.String videoCodec)
```
    Sets video codec.
    
    Parameters:
    videoCodec - the video codec
  - setVideoResolution
```
public void setVideoResolution(java.lang.String videoResolution)
```
    Sets video resolution.
    
    Parameters:
    videoResolution - the video resolution
  - setVideoFps
```
public void setVideoFps(java.lang.String videoFps)
```
    Sets video fps.
    
    Parameters:
    videoFps - the video fps
  - setVideoAspect
```
public void setVideoAspect(java.lang.String videoAspect)
```
    Sets video aspect.
    
    Parameters:
    videoAspect - the video aspect
  - setVideoContainer
```
public void setVideoContainer(java.lang.String videoContainer)
```
    Sets video container.
    
    Parameters:
    videoContainer - the video container
  - setAudioBitrate
```
public void setAudioBitrate(java.lang.String audioBitrate)
```
    Sets audio bitrate.
    
    Parameters:
    audioBitrate - the audio bitrate
  - setAudioCodec
```
public void setAudioCodec(java.lang.String audioCodec)
```
    Sets audio codec.
    
    Parameters:
    audioCodec - the audio codec
  - setAudioSampleRate
```
public void setAudioSampleRate(java.lang.String audioSampleRate)
```
    Sets audio sample rate.
    
    Parameters:
    audioSampleRate - the audio sample rate
  - setLyrics
```
public void setLyrics(java.lang.String lyrics)
```
    Sets lyrics.
    
    Parameters:
    lyrics - the lyrics

Class MediaFile

Uploads

Streaming

Attributes

Field Summary

Constructor Summary

Method Summary

Methods inherited from class fm.audiobox.core.models.Model

Methods inherited from class java.util.Observable

Methods inherited from class java.lang.Object

Field Detail

type

token

artist

album

genre

releaseYear

title

lenStr

lenInt

position

filename

mediaFileName

loved

discNumber

mime

remotePath

source

shareToken

artwork

size

albumArtist

hash

composer

comment

videoBitrate

videoCodec

videoResolution

videoFps

videoAspect

videoContainer

audioBitrate

audioCodec

audioSampleRate

lyrics

Constructor Detail

MediaFile

Method Detail

getPath

getStreamPath

getStreamUrl

getDownloadPath

getDownloadUrl

load

reload

download

download

update

destroy

scrobble

getLyrics

love

unlove

toggleLove

getType

getToken

getArtist

setArtist

getAlbum

setAlbum

getGenre

setGenre

getReleaseYear

setReleaseYear

getTitle

setTitle

getLenStr

getLenInt

getPosition

setPosition