android.media
Class MediaScannerConnection

java.lang.Object
  android.media.MediaScannerConnection

All Implemented Interfaces:

ServiceConnection

public class MediaScannerConnection
extends Object
implements ServiceConnection

MediaScannerConnection provides a way for applications to pass a newly created or downloaded media file to the media scanner service. The media scanner service will read metadata from the file and add the file to the media content provider. The MediaScannerConnectionClient provides an interface for the media scanner service to return the Uri for a newly scanned file to the client of the MediaScannerConnection class.

Nested Class Summary

static interface

MediaScannerConnection.MediaScannerConnectionClient An interface for notifying clients of MediaScannerConnection when a connection to the MediaScanner service has been established and when the scanning of a file has completed.

Constructor Summary

MediaScannerConnection(Context context, MediaScannerConnection.MediaScannerConnectionClient client)
Constructs a new MediaScannerConnection object.

Method Summary

void	connect() Initiates a connection to the media scanner service.
void	disconnect() Releases the connection to the media scanner service.
boolean	isConnected() Returns whether we are connected to the media scanner service
void	onServiceConnected(ComponentName className, IBinder service) Part of the ServiceConnection interface.
void	onServiceDisconnected(ComponentName className) Part of the ServiceConnection interface.
void	scanFile(String path, String mimeType) Requests the media scanner to scan a file.

Methods inherited from class java.lang.Object

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

Constructor Detail

MediaScannerConnection

public MediaScannerConnection(Context context,
                              MediaScannerConnection.MediaScannerConnectionClient client)

Constructs a new MediaScannerConnection object.

Parameters:

context - the Context object, required for establishing a connection to the media scanner service.

client - an optional object implementing the MediaScannerConnectionClient interface, for receiving notifications from the media scanner.

Method Detail

connect

public void connect()

Initiates a connection to the media scanner service. MediaScannerConnection.MediaScannerConnectionClient.onMediaScannerConnected() will be called when the connection is established.

disconnect

public void disconnect()

Releases the connection to the media scanner service.

isConnected

public boolean isConnected()

Returns whether we are connected to the media scanner service

Returns:

true if we are connected, false otherwise

scanFile

public void scanFile(String path,
                     String mimeType)

Requests the media scanner to scan a file.

Parameters:

path - the path to the file to be scanned.

mimeType - an optional mimeType for the file. If mimeType is null, then the mimeType will be inferred from the file extension. Success or failure of the scanning operation cannot be determined until MediaScannerConnection.MediaScannerConnectionClient.onScanCompleted(String, Uri) is called.

onServiceConnected

public void onServiceConnected(ComponentName className,
                               IBinder service)

Part of the ServiceConnection interface. Do not call.

Specified by:

onServiceConnected in interface ServiceConnection

Parameters:

className - The concrete component name of the service that has been connected.

service - The IBinder of the Service's communication channel, which you can now make calls on.

onServiceDisconnected

public void onServiceDisconnected(ComponentName className)

Part of the ServiceConnection interface. Do not call.

Specified by:

onServiceDisconnected in interface ServiceConnection

Parameters:

className - The concrete component name of the service whose connection has been lost.