Titanium.Media.Android
Android-specific media-related functionality.
Extends: Titanium.Module · Since: 1.7.0 · Platforms: android
Properties #
apiName#
Type: String
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.
bubbleParent#
Type: Boolean
Indicates if the proxy will bubble an event to its parent.
Some proxies (most commonly views) have a relationship to other proxies, often
established by the add() method. For example, for a button added to a window, a
click event on the button would bubble up to the window. Other common parents are
table sections to their rows, table views to their sections, and scrollable views
to their views. Set this property to false to disable the bubbling to the proxy's parent.
lifecycleContainer#
Type: Titanium.UI.Window, Titanium.UI.TabGroup
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks
will also be called on the proxy. Proxies that require the activity lifecycle will need this property set
to the appropriate containing Window or TabGroup.
Methods #
addEventListener #
Adds the specified callback as an event listener for the named event.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. | No |
applyProperties #
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that
myproxy[key] = value.
| Name | Type | Summary | Optional |
|---|---|---|---|
props | Dictionary | A dictionary of properties to apply. | No |
fireEvent #
Fires a synthesized event to any registered listeners.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. | Yes |
removeEventListener #
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function
in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to addEventListener. | No |
scanMediaFiles #
Scans newly created or downloaded media files to make them available to other
Android media providers, such as the Gallery.
Android scans media files for inclusion in the Gallery and other media providers.
Use this method to force an immediate scan of particular files, such as
newly-created or downloaded resources.
| Name | Type | Summary | Optional |
|---|---|---|---|
paths | Array<String> | Array of paths to the files you want to scan. | No |
mimeTypes | Array<String> | Array of MIME types for the files in the paths parameter. If null, MIME type willbe inferred from the file names. | No |
callback | Callback<MediaScannerResponse> | Function to call when each file is done being scanned. | No |
setSystemWallpaper #
Set the system homescreen wallpaper.
The image to use as the wallpaper must be passed as a Titanium.Blob. You can
create a Blob from an image file by calling File.read.
You can also use the Titanium.Media.openPhotoGallery
or Titanium.Media.showCamera methods to allow users to select an existing photo
or take a new one.
| Name | Type | Summary | Optional |
|---|---|---|---|
image | Titanium.Blob | Image to use as the wallpaper, as a Blob object. | No |
scale | Boolean | If true, the image is scaled to fit the width of the system wallpaper. Iffalse, the image is not scaled. | No |