Titanium SDK

# Titanium.Media.SystemAlert

An object for playing system sounds.

Availability
6.1.0
9.2.0
Extends
Titanium.Proxy

DEPRECATED SINCE 8.0.0

This iOS-only API has been deprecated and moved to the Ti.SystemAlert module in 8.0.0.

# Overview

You can use this module to provide audible system alerts.

You can use it to play short (30 seconds or shorter) sounds. The interface does not provide level, positioning, looping, or timing control, and does not support simultaneous playback: You can play only one sound at a time.

This module differs from the Sound module because it honors the ringtone volume, not the Music volume.

Use the Titanium.Media.createSystemAlert method to create a SystemAlert object.

Know more about System Sound Services (opens new window).

# Examples

# Simple Example

Simple example of playing a WAVE file from the Resources directory.

var player = Ti.Media.createSystemAlert({url:"alert.wav"});
player.play();

# Properties

# apiName READONLY

Availability
6.1.0
9.2.0
apiName :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, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability
6.1.0
9.2.0
bubbleParent :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.

Default: true

# url

Availability
6.1.0
9.2.0
url :String

URL identifying the audio resource.

# Methods

# addEventListener

Availability
6.1.0
9.2.0
addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to invoke when the event is fired.

Returns

Type
void

# applyProperties

Availability
6.1.0
9.2.0
applyProperties(props) → void

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.

Parameters

Name Type Description
props Dictionary

A dictionary of properties to apply.

Returns

Type
void

# fireEvent

Availability
6.1.0
9.2.0
fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name Type Description
name String

Name of the event.

event Dictionary

A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

Type
void

# play

Availability
6.1.0
9.2.0
play() → void

Start playing the system alert.

Returns

Type
void

# removeEventListener

Availability
6.1.0
9.2.0
removeEventListener(name, callback) → void

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);

Parameters

Name Type Description
name String

Name of the event.

callback Callback<Titanium.Event>

Callback function to remove. Must be the same function passed to addEventListener.

Returns

Type
void

Contents