com.codename1.media

Class MediaManager

java.lang.Object

com.codename1.media.MediaManager

public class MediaManager
extends Object

Allow us to create objects using String URI's or with a stream to the media data.
Notice that the underlying platforms contains the actual codecs, therefore you need to play common media file types such as mp3, mp4 to successfully play them across devices on all target platforms. The simulator can't accurately reproduce the behavior of this class in all devices/cases.

The sample code below demonstrates simple video playback.

The code below demonstrates capturing audio using the Capture API and playing back audio files using the Media API:

The code below demonstrates capturing audio and playing back audio using the Media, MediaManager and MediaRecorderBuilder APIs, as alternative and more customizable approach than using the Capture API:

Constructor Summary

Constructors

Constructor and Description
MediaManager()

Method Summary

Modifier and Type	Method and Description
static void	addCompletionHandler(Media media, Runnable onCompletion) Adds a callback to a Media element that will be called when the media finishes playing.
static Media	createBackgroundMedia(String uri) Creates an audio media that can be played in the background.
static AsyncResource<Media>	createBackgroundMediaAsync(String uri) Creates an audio media asynchronously that can be played in the background.
static Media	createMedia(InputStream stream, String mimeType) Creates the Media in the given stream.
static Media	createMedia(InputStream stream, String mimeType, Runnable onCompletion) Creates the Media in the given stream Notice that you should invoke cleanup on a media once you are done with it.
static Media	createMedia(String uri, boolean isVideo) Creates a Media from a given URI
static Media	createMedia(String uri, boolean isVideo, Runnable onCompletion) Creates a Media from a given URI
static AsyncResource<Media>	createMediaAsync(InputStream stream, String mimeType, Runnable onCompletion) Creates the Media in the given stream asynchronously.
static AsyncResource<Media>	createMediaAsync(String uri, boolean isVideo, Runnable onCompletion) Creates a Media from a given URI asynchronously.
static Media	createMediaRecorder(MediaRecorderBuilder builder) Creates a Media recorder Object which will record from the device mic to a file in the given path.
static Media	createMediaRecorder(String path) Deprecated. see createMediaRecorder(String path, String mimeType) instead
static Media	createMediaRecorder(String path, String mimeType) Creates a Media recorder Object which will record from the device mic to a file in the given path.
static void	deleteAudioBuffer(String path) Deprecated. Prefer to use releaseAudioBuffer(java.lang.String)
static AsyncMedia	getAsyncMedia(Media media) Converts the media object into an AsyncMedia object.
static AudioBuffer	getAudioBuffer(String path) Gets an audio buffer at the given path.
static AudioBuffer	getAudioBuffer(String path, boolean create, int size) Gets or creates an audio buffer at the given path.
static String[]	getAvailableRecordingMimeTypes() Gets the available recording MimeTypes
static String	getMediaRecorderingMimeType() Deprecated. see getAvailableRecordingMimeTypes() instead
static RemoteControlListener	getRemoteControlListener() Gets the currently registered remote control listener.
static void	releaseAudioBuffer(String path) Releases an audio buffer at a given path.
static void	removeCompletionHandler(Media media, Runnable onCompletion) Removes onComplete callback from Media element.
static void	setRemoteControlListener(RemoteControlListener l) Registers a listener to be notified of remote control events - e.g.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaManager

public MediaManager()

Method Detail

getAudioBuffer

public static AudioBuffer getAudioBuffer(String path)

Gets an audio buffer at the given path.

Parameters:

path - The path to the Audio buffer. This path doesn't correspond to a real file. It is just used as a key to map to the audio buffer so that it can be addressed.

Returns:

The AudioBuffer or null if no buffer exists at that path.

Since:

7.0

getAudioBuffer

public static AudioBuffer getAudioBuffer(String path,
                                         boolean create,
                                         int size)

Gets or creates an audio buffer at the given path.

Parameters:

path - The path to the Audio buffer. This path doesn't correspond to a real file. It is just used as a key to map to the audio buffer so that it can be addressed.

create - If this flag is true and no buffer exists at the given path, then the buffer will be created.

size - The maximum size of the buffer.

Returns:

The audio buffer or null if no buffer exists at that path and the create flag is false.

Since:

7.0

releaseAudioBuffer

public static void releaseAudioBuffer(String path)

Releases an audio buffer at a given path. Audio buffers use a simple reference counter mechanism. Every call to getAudioBuffer(java.lang.String, boolean, int) will increment the counter, and calls to releaseAudioBuffer(java.lang.String) will decrement the counter.

Parameters:

path - The path to the buffer.

Since:

7.0

deleteAudioBuffer

public static void deleteAudioBuffer(String path)

Deprecated. Prefer to use releaseAudioBuffer(java.lang.String)

Deletes the audio buffer at the given path.

Parameters:

path - The path to the audio buffer to delete.

Since:

7.0

setRemoteControlListener

public static void setRemoteControlListener(RemoteControlListener l)

Registers a listener to be notified of remote control events - e.g. the play/pause/seek buttons on the user's lock screen when background media is being played.

Parameters:

l - The remote control listener to set. null to set no listener.

Since:

7.0

getRemoteControlListener

public static RemoteControlListener getRemoteControlListener()

Gets the currently registered remote control listener.

Returns:

The currently registered remote control listener, or null if none is registered.

Since:

7.0

createBackgroundMedia

public static Media createBackgroundMedia(String uri)
                                   throws IOException

Creates an audio media that can be played in the background.

Parameters:

uri - the uri of the media can start with jar://, file://, http:// (can also use rtsp:// if supported on the platform)

Returns:

Media a Media Object that can be used to control the playback of the media

Throws:

IOException - if creation of media from the given URI has failed

createBackgroundMediaAsync

public static AsyncResource<Media> createBackgroundMediaAsync(String uri)

Creates an audio media asynchronously that can be played in the background.

Parameters:

uri - the uri of the media can start with jar://, file://, http:// (can also use rtsp:// if supported on the platform)

Returns:

Media a Media Object that can be used to control the playback of the media

Since:

7.0

createMedia

public static Media createMedia(String uri,
                                boolean isVideo)
                         throws IOException

Creates a Media from a given URI

Parameters:

uri - the uri of the media can start with file://, http:// (can also use rtsp:// although may not be supported on all target platforms)

isVideo - a boolean flag to indicate if this is a video media

Returns:

Media a Media Object that can be used to control the playback of the media

Throws:

IOException - if creation of media from the given URI has failed

createMedia

public static Media createMedia(InputStream stream,
                                String mimeType)
                         throws IOException

Creates the Media in the given stream. Notice that you should invoke cleanup on a media once you are done with it.

Parameters:

stream - the stream containing the media data

mimeType - the type of the data in the stream

Returns:

Media a Media Object that can be used to control the playback of the media

Throws:

IOException - if the creation of the Media has failed

createMediaAsync

public static AsyncResource<Media> createMediaAsync(InputStream stream,
                                                    String mimeType,
                                                    Runnable onCompletion)

Creates the Media in the given stream asynchronously. Notice that you should invoke cleanup on a media once you are done with it.

Parameters:

stream - the stream containing the media data

mimeType - the type of the data in the stream

Returns:

Media a Media Object that can be used to control the playback of the media

Since:

7.0

createMedia

public static Media createMedia(String uri,
                                boolean isVideo,
                                Runnable onCompletion)
                         throws IOException

Creates a Media from a given URI

Parameters:

uri - the uri of the media can start with file://, http:// (can also use rtsp:// although may not be supported on all target platforms)

isVideo - a boolean flag to indicate if this is a video media

onCompletion - a Runnable to be called when the media has finished

Returns:

Media a Media Object that can be used to control the playback of the media

Throws:

IOException - if creation of media from given URI failed

createMediaAsync

public static AsyncResource<Media> createMediaAsync(String uri,
                                                    boolean isVideo,
                                                    Runnable onCompletion)

Creates a Media from a given URI asynchronously.

Parameters:

uri - the uri of the media can start with file://, http:// (can also use rtsp:// although may not be supported on all target platforms)

isVideo - a boolean flag to indicate if this is a video media

onCompletion - a Runnable to be called when the media has finished

Returns:

Media a Media Object that can be used to control the playback of the media

Since:

7.0

addCompletionHandler

public static void addCompletionHandler(Media media,
                                        Runnable onCompletion)

Adds a callback to a Media element that will be called when the media finishes playing.

Parameters:

media - The media to add the callback to.

onCompletion - The callback that will run on the EDT when the playback completes.

See Also:

removeCompletionHandler(com.codename1.media.Media, java.lang.Runnable)

removeCompletionHandler

public static void removeCompletionHandler(Media media,
                                           Runnable onCompletion)

Removes onComplete callback from Media element.

Parameters:

media - The media element.

onCompletion - The callback.

See Also:

addCompletionHandler(com.codename1.media.Media, java.lang.Runnable)

createMedia

public static Media createMedia(InputStream stream,
                                String mimeType,
                                Runnable onCompletion)
                         throws IOException

Creates the Media in the given stream Notice that you should invoke cleanup on a media once you are done with it.

Parameters:

stream - the stream containing the media data

mimeType - the type of the data in the stream

onCompletion - a Runnable to be called when the media has finished

Returns:

Media a Media Object that can be used to control the playback of the media

Throws:

IOException - if the URI access fails

createMediaRecorder

public static Media createMediaRecorder(String path)
                                 throws IOException

Deprecated. see createMediaRecorder(String path, String mimeType) instead

Creates a Media recorder Object which will record from the device mic to a file in the given path. The output format will be amr-nb if supported by the platform.

Parameters:

path - a file path to where to store the recording, if the file does not exists it will be created.

Throws:

IOException

getMediaRecorderingMimeType

public static String getMediaRecorderingMimeType()

Deprecated. see getAvailableRecordingMimeTypes() instead

Gets the recording mime type for the returned Media from the createMediaRecorder method

Returns:

the recording mime type

getAvailableRecordingMimeTypes

public static String[] getAvailableRecordingMimeTypes()

Gets the available recording MimeTypes

createMediaRecorder

public static Media createMediaRecorder(String path,
                                        String mimeType)
                                 throws IOException

Creates a Media recorder Object which will record from the device mic to a file in the given path.

Parameters:

path - a file path to where to store the recording, if the file does not exists it will be created.

mimeType - the output mime type that is supported see getAvailableRecordingMimeTypes()

Throws:

IllegalArgumentException - if given mime-type is not supported

IOException - id failed to create a Media object

createMediaRecorder

public static Media createMediaRecorder(MediaRecorderBuilder builder)
                                 throws IOException

Creates a Media recorder Object which will record from the device mic to a file in the given path.

Parameters:

builder - media settings

Throws:

IllegalArgumentException - if given mime-type is not supported

IOException - id failed to create a Media object

Since:

7.0

getAsyncMedia

public static AsyncMedia getAsyncMedia(Media media)

Converts the media object into an AsyncMedia object. Many media objects area already instances of AsyncMedia, so this method would perform a simple cast. For media objects that are not already async, this will return an Async wrapper.

Parameters:

media - The media object to convert.

Returns:

The media object as an AsyncMedia instance.

Since:

7.0