Media (libvlc 3.1.12 API)

java.lang.Object
- org.videolan.libvlc.Media

public class Media
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Media.AudioTrack` see libvlc_audio_track_t
`static class`	`Media.Event`
`static interface`	`Media.EventListener`
`static class`	`Media.Meta` see libvlc_meta_t
`static class`	`Media.Parse` see libvlc_media_parse_flag_t
`static class`	`Media.ParsedStatus`
`static class`	`Media.Slave` see libvlc_media_slave_t
`static class`	`Media.State` see libvlc_state_t
`static class`	`Media.Stats` see libvlc_media_stats_t
`static class`	`Media.SubtitleTrack` see libvlc_subtitle_track_t
`static class`	`Media.Track` see libvlc_media_track_t
`static class`	`Media.Type` libvlc_media_type_t
`static class`	`Media.UnknownTrack` see libvlc_subtitle_track_t
`static class`	`Media.VideoTrack` see libvlc_video_track_t

Constructor Summary

Constructors
Modifier	Constructor and Description
	`Media(LibVLC libVLC, android.content.res.AssetFileDescriptor afd)` Create a Media from libVLC and an AssetFileDescriptor
	`Media(LibVLC libVLC, java.io.FileDescriptor fd)` Create a Media from libVLC and a FileDescriptor
	`Media(LibVLC libVLC, java.lang.String path)` Create a Media from libVLC and a local path starting with '/'.
	`Media(LibVLC libVLC, android.net.Uri uri)` Create a Media from libVLC and a Uri
`protected`	`Media(MediaList ml, int index)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addOption(java.lang.String option)` Add an option to this Media.
`void`	`addSlave(Media.Slave slave)` Add a slave to the current media.
`void`	`clearSlaves()` Clear all slaves previously added by `addSlave(Slave)` or internally.
`protected void`	`finalize()`
`long`	`getDuration()` Get the duration of the media.
`java.lang.String`	`getMeta(int id)` Get a Meta.
`Media.Slave[]`	`getSlaves()` Get a media's slave list The list will contain slaves parsed by VLC or previously added by `addSlave(Slave)`.
`int`	`getState()` Get the state of the media.
`Media.Stats`	`getStats()` Get the stats related to the playing media
`Media.Track`	`getTrack(int idx)` Get a Track The Track can be casted to `Media.AudioTrack`, `Media.VideoTrack` or `Media.SubtitleTrack` in function of the `Media.Track.Type`.
`int`	`getTrackCount()` Get the Track count.
`int`	`getType()` Get the type of the media
`android.net.Uri`	`getUri()` Get the MRL associated with the Media.
`boolean`	`isParsed()` Returns true if the media is parsed This Media should be alive (not released).
`boolean`	`isReleased()` Returns true if native object is released
`protected Media.Event`	`onEventNative(int eventType, long arg1, long arg2, float argf1)` Called when libvlc send events.
`protected void`	`onReleaseNative()` Called when native object is released (refcount is 0).
`boolean`	`parse()` Parse the media and local art synchronously.
`boolean`	`parse(int flags)` Parse the media synchronously with a flag.
`boolean`	`parseAsync()` Parse the media and local art asynchronously.
`boolean`	`parseAsync(int flags)`
`boolean`	`parseAsync(int flags, int timeout)` Parse the media asynchronously with a flag.
`void`	`release()` Release the native object if ref count is 1.
`boolean`	`retain()` Increment internal ref count of the native object.
`protected void`	`setDefaultMediaPlayerOptions()` Enable HWDecoder options if not already set
`void`	`setEventListener(Media.EventListener listener)`
`protected void`	`setEventListener(VLCEvent.Listener<T> listener)` Set an event listener.
`protected void`	`setEventListener(VLCEvent.Listener<T> listener, android.os.Handler handler)` Set an event listener and an executor Handler
`void`	`setHWDecoderEnabled(boolean enabled, boolean force)` Add or remove hw acceleration media options
`MediaList`	`subItems()` Get the subItems MediaList associated with the Media.

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

- Constructor Detail
  - Media
```
public Media(LibVLC libVLC,
             java.lang.String path)
```
    Create a Media from libVLC and a local path starting with '/'.
    
    Parameters:
    
    libVLC - a valid libVLC
    
    path - an absolute local path
  - Media
```
public Media(LibVLC libVLC,
             android.net.Uri uri)
```
    Create a Media from libVLC and a Uri
    
    Parameters:
    
    libVLC - a valid libVLC
    
    uri - a valid RFC 2396 Uri
  - Media
```
public Media(LibVLC libVLC,
             java.io.FileDescriptor fd)
```
    Create a Media from libVLC and a FileDescriptor
    
    Parameters:
    
    libVLC - a valid LibVLC
    
    fd - file descriptor object
  - Media
```
public Media(LibVLC libVLC,
             android.content.res.AssetFileDescriptor afd)
```
    Create a Media from libVLC and an AssetFileDescriptor
    
    Parameters:
    
    libVLC - a valid LibVLC
    
    afd - asset file descriptor object
  - Media
```
protected Media(MediaList ml,
                int index)
```
    Parameters:
    
    ml - Should not be released and locked
    
    index - index of the Media from the MediaList
- Method Detail
  - setEventListener
```
public void setEventListener(Media.EventListener listener)
```
  - onEventNative
```
protected Media.Event onEventNative(int eventType,
                                    long arg1,
                                    long arg2,
                                    float argf1)
```
    Called when libvlc send events.
    
    Parameters:
    
    eventType - event type
    
    arg1 - first argument
    
    arg2 - second argument
    
    argf1 - first float argument
    
    Returns:
    
    Event that will be dispatched to listeners
  - getUri
```
public android.net.Uri getUri()
```
    Get the MRL associated with the Media.
  - getDuration
```
public long getDuration()
```
    Get the duration of the media.
  - getState
```
public int getState()
```
    Get the state of the media.
    
    See Also:
    
    Media.State
  - subItems
```
public MediaList subItems()
```
    Get the subItems MediaList associated with the Media. This Media should be alive (not released).
    
    Returns:
    
    subItems as a MediaList. This MediaList should be released with release().
  - parse
```
public boolean parse(int flags)
```
    Parse the media synchronously with a flag. This Media should be alive (not released).
    
    Parameters:
    
    flags - see Media.Parse
    
    Returns:
    
    true in case of success, false otherwise.
  - parse
```
public boolean parse()
```
    Parse the media and local art synchronously. This Media should be alive (not released).
    
    Returns:
    
    true in case of success, false otherwise.
  - parseAsync
```
public boolean parseAsync(int flags,
                          int timeout)
```
    Parse the media asynchronously with a flag. This Media should be alive (not released). To track when this is over you can listen to Media.Event.ParsedChanged event (only if this methods returned true).
    
    Parameters:
    
    flags - see Media.Parse
    
    timeout - maximum time allowed to preparse the media. If -1, the default "preparse-timeout" option will be used as a timeout. If 0, it will wait indefinitely. If > 0, the timeout will be used (in milliseconds).
    
    Returns:
    
    true in case of success, false otherwise.
  - parseAsync
```
public boolean parseAsync(int flags)
```
  - parseAsync
```
public boolean parseAsync()
```
    Parse the media and local art asynchronously. This Media should be alive (not released).
    
    See Also:
    
    parseAsync(int)
  - isParsed
```
public boolean isParsed()
```
    Returns true if the media is parsed This Media should be alive (not released).
  - getType
```
public int getType()
```
    Get the type of the media
    
    See Also:
    
    Type}
  - getTrackCount
```
public int getTrackCount()
```
    Get the Track count.
  - getTrack
```
public Media.Track getTrack(int idx)
```
    Get a Track The Track can be casted to Media.AudioTrack, Media.VideoTrack or Media.SubtitleTrack in function of the Media.Track.Type.
    
    Parameters:
    
    idx - index of the track
    
    Returns:
    
    Track or null if not idx is not valid
    
    See Also:
    
    getTrackCount()
  - getMeta
```
public java.lang.String getMeta(int id)
```
    Get a Meta.
    
    Parameters:
    
    id - see Media.Meta
    
    Returns:
    
    meta or null if not found
  - setHWDecoderEnabled
```
public void setHWDecoderEnabled(boolean enabled,
                                boolean force)
```
    Add or remove hw acceleration media options
    
    Parameters:
    
    enabled - if true, hw decoder will be used
    
    force - force hw acceleration even for unknown devices
  - setDefaultMediaPlayerOptions
```
protected void setDefaultMediaPlayerOptions()
```
    Enable HWDecoder options if not already set
  - addOption
```
public void addOption(java.lang.String option)
```
    Add an option to this Media. This Media should be alive (not released).
    
    Parameters:
    
    option - ":option" or ":option=value"
  - addSlave
```
public void addSlave(Media.Slave slave)
```
    Add a slave to the current media. A slave is an external input source that may contains an additional subtitle track (like a .srt) or an additional audio track (like a .ac3). This function must be called before the media is parsed (via parseAsync(int)} or before the media is played (via MediaPlayer.play())
  - clearSlaves
```
public void clearSlaves()
```
    Clear all slaves previously added by addSlave(Slave) or internally.
  - getSlaves
```
public Media.Slave[] getSlaves()
```
    Get a media's slave list The list will contain slaves parsed by VLC or previously added by addSlave(Slave). The typical use case of this function is to save a list of slave in a database for a later use.
  - getStats
```
public Media.Stats getStats()
```
    Get the stats related to the playing media
  - onReleaseNative
```
protected void onReleaseNative()
```
    Called when native object is released (refcount is 0). This is where you must release native resources.
  - isReleased
```
public boolean isReleased()
```
    Returns true if native object is released
  - retain
```
public final boolean retain()
```
    Increment internal ref count of the native object.
    
    Returns:
    
    true if media is retained
  - release
```
public final void release()
```
    Release the native object if ref count is 1. After this call, native calls are not possible anymore. You can still call others methods to retrieve cached values. For example: if you parse, then release a media, you'll still be able to retrieve all Metas or Tracks infos.
  - finalize
```
protected void finalize()
```
    Overrides:
    
    finalize in class java.lang.Object
  - setEventListener
```
protected void setEventListener(VLCEvent.Listener<T> listener)
```
    Set an event listener. Events are sent via the android main thread.
    
    Parameters:
    
    listener - see VLCEvent.Listener
  - setEventListener
```
protected void setEventListener(VLCEvent.Listener<T> listener,
                                android.os.Handler handler)
```
    Set an event listener and an executor Handler
    
    Parameters:
    
    listener - see VLCEvent.Listener
    
    handler - Handler in which events are sent. If null, a handler will be created running on the main thread

Class Media

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Media

Media

Media

Media

Media

Method Detail

setEventListener

onEventNative

getUri

getDuration

getState

subItems

parse

parse

parseAsync

parseAsync

parseAsync

isParsed

getType

getTrackCount

getTrack

getMeta

setHWDecoderEnabled

setDefaultMediaPlayerOptions

addOption

addSlave

clearSlaves

getSlaves

getStats

onReleaseNative

isReleased

retain

release

finalize

setEventListener

setEventListener