Titanium 2.X

Titanium.Media

> Titanium.Media

The top level Media module.

The Media module is used accessing the device's media related functionality such as playing audio or recording video.

  • 0.1
  • 0.1
  • 0.1
  • 1.8
Defined By

Properties

Titanium.Media
AUDIO_FILEFORMAT_3GP2 : Numberreadonly

Audio file format 3GPP2.

Audio file format 3GPP2.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FILEFORMAT_3GPP : Numberreadonly

Audio file format 3GPP.

Audio file format 3GPP.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FILEFORMAT_AIFF : Numberreadonly

Audio file format Audio Interchange File Format (AIFF).

Audio file format Audio Interchange File Format (AIFF).

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FILEFORMAT_AMR : Numberreadonly

Audio file format Adaptive Multi-Rate (AMR).

Audio file format Adaptive Multi-Rate (AMR).

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FILEFORMAT_CAF : Numberreadonly

Audio file format Apple Compressed Audio Format (CAF).

Audio file format Apple Compressed Audio Format (CAF).

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FILEFORMAT_MP3 : Numberreadonly

Audio file format MP3.

Audio file format MP3.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FILEFORMAT_MP4 : Numberreadonly

Audio file format MP4.

Audio file format MP4.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FILEFORMAT_MP4A : Numberreadonly

Audio file format MP4A.

Audio file format MP4A.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FILEFORMAT_WAVE : Numberreadonly

Audio file format WAVE.

Audio file format WAVE.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FORMAT_AAC : Numberreadonly

Audio format MPEG4 AAC encoding.

Audio format MPEG4 AAC encoding.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FORMAT_ALAW : Numberreadonly

Audio format 8-bit aLaw encoding.

Audio format 8-bit aLaw encoding.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FORMAT_APPLE_LOSSLESS : Numberreadonly

Audio format Apple lossless encoding.

Audio format Apple lossless encoding.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FORMAT_ILBC : Numberreadonly

Audio format iLBC encoding.

Audio format iLBC encoding.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FORMAT_IMA4 : Numberreadonly

Audio format Apple IMA4 encoding.

Audio format Apple IMA4 encoding.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FORMAT_LINEAR_PCM : Numberreadonly

Audio format 16-bit, linear PCM encoding.

Audio format 16-bit, linear PCM encoding.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_FORMAT_ULAW : Numberreadonly

Audio format 8-bit muLaw encoding.

Audio format 8-bit muLaw encoding.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_HEADPHONES : Numberreadonly

Line-type constant for headphones.

Line-type constant for headphones.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_HEADPHONES_AND_MIC : Numberreadonly

Line-type constant for headphones and microphone.

Line-type constant for headphones and microphone.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_HEADSET_INOUT : Numberreadonly

Line-type constant for headset in/out.

Line-type constant for headset in/out.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_LINEOUT : Numberreadonly

Line-type constant for line-out.

Line-type constant for line-out.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_MICROPHONE : Numberreadonly

Line-type constant for microphone.

Line-type constant for microphone.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_MUTED : Numberreadonly

Line-type constant indicated mute switch is on.

Line-type constant indicated mute switch is on.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_RECEIVER_AND_MIC : Numberreadonly

Line-type constant indicating receiver and microphone.

Line-type constant indicating receiver and microphone.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_SESSION_MODE_AMBIENT : Numberreadonly

For long-duration sounds such as rain, car engine noise, and so on.

For long-duration sounds such as rain, car engine noise, and so on.

Also used for for 'play along' style applications, such a virtual piano that a user plays over iPod audio.

See also: AUDIO_SESSION_MODE_SOLO_AMBIENT.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_SESSION_MODE_PLAYBACK : Numberreadonly

Session mode for playing recorded music or other sounds that are central to the successful use of your application.

Session mode for playing recorded music or other sounds that are central to the successful use of your application.

When using this mode, your application audio continues with the Ring/Silent switch set to silent or when the screen locks. This property normally disallows mixing iPod audio with application audio.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_SESSION_MODE_PLAY_AND_RECORD : Numberreadonly

Session mode for recording (input) and playback (output) of audio, such as for a VOIP (voice over IP) application.

Session mode for recording (input) and playback (output) of audio, such as for a VOIP (voice over IP) application.

This category is appropriate for simultaneous recording and playback, and also for applications that record and play back but not simultaneously. If you want to ensure that sounds such as Messages alerts do not play while your application is recording, use AUDIO_SESSION_MODE_RECORD instead. This category normally disallows mixing iPod audio with application audio.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_SESSION_MODE_RECORD : Numberreadonly

Session mode for recording audio; it silences playback audio.

Session mode for recording audio; it silences playback audio.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_SESSION_MODE_SOLO_AMBIENT : Numberreadonly

Session mode for long-duration sounds such as rain, car engine noise, and so on.

Session mode for long-duration sounds such as rain, car engine noise, and so on.

When you use this category, audio from built-in applications, such as the iPod, is silenced. Your audio is silenced when the Ring/Silent switch is set to silent or when the screen locks.

To use long-duration sounds without silencing built-in applications, see AUDIO_SESSION_MODE_AMBIENT.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_SPEAKER : Numberreadonly

Line-type constant for speaker output.

Line-type constant for speaker output.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_UNAVAILABLE : Numberreadonly

Line-type constant indicating that audio is unavailable.

Line-type constant indicating that audio is unavailable.

  • 0.1
  • 0.1
Titanium.Media
AUDIO_UNKNOWN : Numberreadonly

Line-type constant indicating that line-type is unknown or not determined.

Line-type constant indicating that line-type is unknown or not determined.

  • 0.1
  • 0.1
Titanium.Media
DEVICE_BUSY : Numberreadonly

Constant for media device busy error.

Constant for media device busy error.

Titanium.Media
MEDIA_TYPE_PHOTO : Stringreadonly

Media type constant for photo media.

Media type constant for photo media.

Titanium.Media
MEDIA_TYPE_VIDEO : Stringreadonly

Media type constant for video media.

Media type constant for video media.

Titanium.Media
MUSIC_MEDIA_GROUP_ALBUM : Numberreadonly

Constant for grouping query results by album.

Constant for grouping query results by album.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_GROUP_ALBUM_ARTIST : Numberreadonly

Constant for grouping query results by album and artist.

Constant for grouping query results by album and artist.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_GROUP_ARTIST : Numberreadonly

Constant for grouping query results by artist.

Constant for grouping query results by artist.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_GROUP_COMPOSER : Numberreadonly

Constant for grouping query results by composer.

Constant for grouping query results by composer.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_GROUP_GENRE : Numberreadonly

Constant for grouping query results by genre.

Constant for grouping query results by genre.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_GROUP_PLAYLIST : Numberreadonly

Constant for grouping query results by playlist.

Constant for grouping query results by playlist.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_GROUP_PODCAST_TITLE : Numberreadonly

Constant for grouping query results by podcast title.

Constant for grouping query results by podcast title.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_GROUP_TITLE : Numberreadonly

Constant for grouping query results by title.

Constant for grouping query results by title.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_TYPE_ALL : Numberreadonly

Music library media containing any type of content.

Music library media containing any type of content.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_TYPE_ANY_AUDIO : Numberreadonly

Music library media containing any type of audio content.

Music library media containing any type of audio content.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_TYPE_AUDIOBOOK : Numberreadonly

Music library media containing audiobook content.

Music library media containing audiobook content.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_TYPE_MUSIC : Numberreadonly

Music library media containing music content.

Music library media containing music content.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_MEDIA_TYPE_PODCAST : Numberreadonly

Music library media containing podcast content.

Music library media containing podcast content.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_REPEAT_ALL : Numberreadonly

Constant for "Repeat All" setting.

Constant for "Repeat All" setting.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_REPEAT_DEFAULT : Numberreadonly

Constant for user's default repeat setting.

Constant for user's default repeat setting.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_REPEAT_NONE : Numberreadonly

Constant for "No Repeat" setting.

Constant for "No Repeat" setting.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_REPEAT_ONE : Numberreadonly

Constant for "Repeat one item" setting.

Constant for "Repeat one item" setting.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_SHUFFLE_ALBUMS : Numberreadonly

Constant for shuffling complete albums setting.

Constant for shuffling complete albums setting.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_SHUFFLE_DEFAULT : Numberreadonly

Constant for user's default shuffle setting.

Constant for user's default shuffle setting.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_SHUFFLE_NONE : Numberreadonly

Constant for "no shuffle" setting.

Constant for "no shuffle" setting.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_SHUFFLE_SONGS : Numberreadonly

Constant for shuffling songs setting.

Constant for shuffling songs setting.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_STATE_INTERRUPTED : Numberreadonly

Constant for interrupted state.

Constant for interrupted state.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_STATE_PAUSED : Numberreadonly

Constant for paused state.

Constant for paused state.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_STATE_PLAYING : Numberreadonly

Constant for playing state.

Constant for playing state.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_STATE_SEEK_BACKWARD : Numberreadonly

Constant for backward seek state.

Constant for backward seek state.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_STATE_SEEK_FORWARD : Numberreadonly

Constant for forward seek state.

Constant for forward seek state.

  • 0.1
  • 0.1
Titanium.Media
MUSIC_PLAYER_STATE_STOPPED : Numberreadonly

Constant for stopped state.

Constant for stopped state.

  • 0.1
  • 0.1
Titanium.Media
NO_CAMERA : Numberreadonly

Constant for media no camera error.

Constant for media no camera error.

Titanium.Media
NO_VIDEO : Numberreadonly

Constant for media no video error.

Constant for media no video error.

Titanium.Media
QUALITY_HIGH : Numberreadonly

Media type constant for high-quality video recording.

Media type constant for high-quality video recording.

Recorded files are suitable for on-device playback and for wired transfer to the Desktop using Image Capture; they are likely to be too large for transfer using Wi-Fi.

  • 0.1
  • 0.1
Titanium.Media
QUALITY_LOW : Numberreadonly

Media type constant for low-quality video recording.

Media type constant for low-quality video recording.

Recorded files can usually be transferred over the cellular network.

  • 0.1
  • 0.1
Titanium.Media
QUALITY_MEDIUM : Numberreadonly

Media type constant for medium-quality video recording.

Media type constant for medium-quality video recording.

Recorded files can usually be transferred using Wi-Fi. This is the default video quality setting.

  • 0.1
  • 0.1
Titanium.Media
UNKNOWN_ERROR : Numberreadonly

Constant for unknown media error.

Constant for unknown media error.

Titanium.Media
VIDEO_CONTROL_DEFAULT : Numberreadonly

Constant for default video controls.

Constant for default video controls.

Titanium.Media
VIDEO_CONTROL_EMBEDDED : Numberreadonly

Constant for video controls for an embedded view.

Constant for video controls for an embedded view.

Used in conjunction with the movieControlStyle property of Titanium.Media.VideoPlayer in iPhone 3.2+.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_CONTROL_FULLSCREEN : Numberreadonly

Constant for fullscreen video controls.

Constant for fullscreen video controls.

Used in conjunction with the movieControlStyle property of Titanium.Media.VideoPlayer in iPhone 3.2+.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_CONTROL_HIDDEN : Numberreadonly

Constant for video controls hidden.

Constant for video controls hidden.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_CONTROL_NONE : Numberreadonly

Constant for no video controls.

Constant for no video controls.

Used in conjunction with the movieControlStyle property of Titanium.Media.VideoPlayer in iPhone 3.2+.

Titanium.Media
: Numberdeprecatedreadonly
Constant for video controls volume only. ...

Constant for video controls volume only.

deprecated since 1.8.0

  • 0.1
  • 0.1
Titanium.Media
VIDEO_FINISH_REASON_PLAYBACK_ENDED : Numberreadonly

Video playback ended normally.

Video playback ended normally.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_FINISH_REASON_PLAYBACK_ERROR : Numberreadonly

Video playback ended abnormally.

Video playback ended abnormally.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_FINISH_REASON_USER_EXITED : Numberreadonly

Video playback ended by user action (such as clicking the Done button).

Video playback ended by user action (such as clicking the Done button).

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_LOAD_STATE_PLAYABLE : Numberreadonly

Current media is playable.

Current media is playable.

  • 0.1
  • 0.1
  • 0.1
  • 1.8
Titanium.Media
VIDEO_LOAD_STATE_PLAYTHROUGH_OK : Numberreadonly

Playback will be automatically started in this state when autoplay is true.

Playback will be automatically started in this state when autoplay is true.

  • 0.1
  • 0.1
  • 0.1
  • 1.8
Titanium.Media
VIDEO_LOAD_STATE_STALLED : Numberreadonly

Playback will be automatically paused in this state, if started.

Playback will be automatically paused in this state, if started.

  • 0.1
  • 0.1
  • 0.1
  • 1.8
Titanium.Media
VIDEO_LOAD_STATE_UNKNOWN : Numberreadonly

Current load state is not known.

Current load state is not known.

  • 0.1
  • 0.1
  • 0.1
  • 1.8
Titanium.Media
VIDEO_MEDIA_TYPE_AUDIO : Numberreadonly

A audio type of media in the movie returned by Titanium.Media.VideoPlayer mediaTypes property.

A audio type of media in the movie returned by Titanium.Media.VideoPlayer mediaTypes property.

  • 0.1
  • 0.1
Titanium.Media
VIDEO_MEDIA_TYPE_NONE : Numberreadonly

An unknown type of media in the movie returned by Titanium.Media.VideoPlayer mediaTypes property.

An unknown type of media in the movie returned by Titanium.Media.VideoPlayer mediaTypes property.

  • 0.1
  • 0.1
Titanium.Media
VIDEO_MEDIA_TYPE_VIDEO : Numberreadonly

A video type of media in the movie returned by Titanium.Media.VideoPlayer mediaTypes property.

A video type of media in the movie returned by Titanium.Media.VideoPlayer mediaTypes property.

  • 0.1
  • 0.1
Titanium.Media
VIDEO_PLAYBACK_STATE_INTERRUPTED : Numberreadonly

Video playback has been interrupted.

Video playback has been interrupted.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_PLAYBACK_STATE_PAUSED : Numberreadonly

Video playback is paused.

Video playback is paused.

  • 0.1
  • 0.1
  • 0.1
  • 1.8
Titanium.Media
VIDEO_PLAYBACK_STATE_PLAYING : Numberreadonly

Video is being played.

Video is being played.

  • 0.1
  • 0.1
  • 0.1
  • 1.8
Titanium.Media
VIDEO_PLAYBACK_STATE_SEEKING_BACKWARD : Numberreadonly

Video playback is rewinding.

Video playback is rewinding.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_PLAYBACK_STATE_SEEKING_FORWARD : Numberreadonly

Video playback is seeking forward.

Video playback is seeking forward.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_PLAYBACK_STATE_STOPPED : Numberreadonly

Video playback is stopped.

Video playback is stopped.

  • 0.1
  • 0.1
  • 0.1
  • 1.8
Titanium.Media
VIDEO_REPEAT_MODE_NONE : Numberreadonly

Constant for disabling repeat on video playback.

Constant for disabling repeat on video playback.

  • 0.1
  • 0.1
  • 1.8
Titanium.Media
VIDEO_REPEAT_MODE_ONE : Numberreadonly

Constant for repeating one video (i.e., the one video will repeat constantly) during playback.

Constant for repeating one video (i.e., the one video will repeat constantly) during playback.

  • 0.1
  • 0.1
  • 1.8
Titanium.Media
VIDEO_SCALING_ASPECT_FILL : Numberreadonly

Scale video to fill the screen, clipping edges if necessary.

Scale video to fill the screen, clipping edges if necessary.

Video is scaled until the video fills the entire screen. Content at the edges of the larger of the two dimensions is clipped so that the other dimension fits the screen exactly. The aspect ratio of the movie is preserved.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_SCALING_ASPECT_FIT : Numberreadonly

Scale video to fit the screen, letterboxing if necessary.

Scale video to fit the screen, letterboxing if necessary.

Video is scaled until the larger dimension fits on the screen exactly. In the other dimension, the region between the edge of the movie and the edge of the screen is filled with a black bar. The aspect ratio of the movie is preserved.

Titanium.Media
VIDEO_SCALING_MODE_FILL : Numberreadonly

Video is scaled until both dimensions fit the screen exactly, stretching if necessary.

Video is scaled until both dimensions fit the screen exactly, stretching if necessary.

The aspect ratio of the video is not preserved.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
VIDEO_SCALING_NONE : Numberreadonly

Video scaling is disabled.

Video scaling is disabled.

Titanium.Media
VIDEO_SOURCE_TYPE_FILE : Numberreadonly

Video source type is a file.

Video source type is a file.

Related to the sourceType property of Titanium.Media.VideoPlayer.

  • 0.1
  • 0.1
Titanium.Media
VIDEO_SOURCE_TYPE_STREAMING : Numberreadonly

Video source type is a remote stream.

Video source type is a remote stream.

Related to the sourceType property of Titanium.Media.VideoPlayer

  • 0.1
  • 0.1
Titanium.Media
VIDEO_SOURCE_TYPE_UNKNOWN : Numberreadonly

Video source type is unknown.

Video source type is unknown.

Related to the sourceType property of Titanium.Media.VideoPlayer

  • 0.1
  • 0.1
Titanium.Media
VIDEO_TIME_OPTION_EXACT : Numberreadonly

Use the exact time.

Use the exact time.

  • 0.1
  • 0.1
Titanium.Media
VIDEO_TIME_OPTION_NEAREST_KEYFRAME : Numberreadonly

Use the closest keyframe in the time.

Use the closest keyframe in the time.

  • 0.1
  • 0.1

An instance of Titanium.Media.MusicPlayer representing the app-specific music player.

An instance of Titanium.Media.MusicPlayer representing the app-specific music player.

  • 0.1
  • 0.1
Titanium.Media
audioLineType : Numberreadonly

Returns the line type constant for the current line type.

Returns the line type constant for the current line type.

  • 0.1
  • 0.1
Titanium.Media
audioPlaying : Booleanreadonly

Returns true if the device is playing audio.

Returns true if the device is playing audio.

  • 0.1
  • 0.1
Titanium.Media
audioSessionMode : Number

A constant for the audio session mode to be used.

A constant for the audio session mode to be used.

Set to one of the AUDIO_SESSION constants defined in Titanium.Media.

Must be set while the audio session is inactive (no sounds are playing, no listeners for audio properties on the Media module, but the iPod may be active).

  • 0.1
  • 0.1
Titanium.Media
availableCameraMediaTypes : Object[]

Array of media type constants supported for the camera.

Array of media type constants supported for the camera.

  • 0.1
  • 0.1
Titanium.Media
availablePhotoGalleryMediaTypes : Object[]

Array of media type constants supported for saving to the device's camera roll or saved images album.

Array of media type constants supported for saving to the device's camera roll or saved images album.

  • 0.1
  • 0.1
Titanium.Media
availablePhotoMediaTypes : Object[]

Array of media type constants supported for the photo library.

Array of media type constants supported for the photo library.

  • 0.1
  • 0.1
Titanium.Media
averageMicrophonePower : Number

Current average microphone level in dB or -1 if microphone monitoring is disabled.

Current average microphone level in dB or -1 if microphone monitoring is disabled.

See startMicrophoneMonitor, stopMicrophoneMonitor.

  • 0.1
  • 0.1
Titanium.Media
canRecord : Booleanreadonly

true if the device has a recording input device available.

true if the device has a recording input device available.

  • 0.1
  • 0.1
Titanium.Media
isCameraSupported : Booleanreadonly

true if the device has camera support.

true if the device has camera support.

  • 0.1
  • 0.1
  • 0.1
Titanium.Media
peakMicrophonePower : Numberreadonly

Current microphone level peak power in dB or -1 if microphone monitoring is disabled.

Current microphone level peak power in dB or -1 if microphone monitoring is disabled.

See startMicrophoneMonitor, stopMicrophoneMonitor.

  • 0.1
  • 0.1

An instance of Titanium.Media.MusicPlayer representing the system-wide music player.

An instance of Titanium.Media.MusicPlayer representing the system-wide music player.

  • 0.1
  • 0.1
Titanium.Media
volume : Numberreadonly

Current volume of the playback device.

Current volume of the playback device.

  • 0.1
  • 0.1
Defined By

Methods

( String name, Callback<Object> callback )
Adds the specified callback as an event listener for the named event. ...

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Titanium.Media
( )
Plays a device beep notification. ...

Plays a device beep notification.

  • 0.1
  • 0.1

Returns

  • void
Creates and returns an instance of Titanium.Media.AudioPlayer. ...

Creates and returns an instance of Titanium.Media.AudioPlayer.

  • 0.9
  • 0.9
  • 0.9

Parameters

Returns

Creates and returns an instance of Titanium.Media.AudioRecorder. ...

Creates and returns an instance of Titanium.Media.AudioRecorder.

  • 0.9
  • 0.9

Parameters

Returns

Creates and returns an instance of Titanium.Media.Item. ...

Creates and returns an instance of Titanium.Media.Item.

  • 1.4
  • 1.4

Parameters

Returns

Creates and returns an instance of Titanium.Media.MusicPlayer. ...

Creates and returns an instance of Titanium.Media.MusicPlayer.

  • 1.4
  • 1.4

Parameters

Returns

Creates and returns an instance of Titanium.Media.Sound. ...

Creates and returns an instance of Titanium.Media.Sound.

  • 0.8
  • 0.8
  • 0.8

Parameters

Returns

Creates and returns an instance of Titanium.Media.VideoPlayer. ...

Creates and returns an instance of Titanium.Media.VideoPlayer.

  • 0.9
  • 0.9
  • 0.9
  • 1.8

Parameters

Returns

( String name, Dictionary event )
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the appMusicPlayer property. ...

Gets the value of the appMusicPlayer property.

  • 0.1
  • 0.1

Returns

Titanium.Media
( ) : Number
Gets the value of the audioLineType property. ...

Gets the value of the audioLineType property.

  • 0.1
  • 0.1

Returns

  • Number
Titanium.Media
( ) : Boolean
Gets the value of the audioPlaying property. ...

Gets the value of the audioPlaying property.

  • 0.1
  • 0.1

Returns

  • Boolean
Titanium.Media
( ) : Number
Gets the value of the audioSessionMode property. ...

Gets the value of the audioSessionMode property.

  • 0.1
  • 0.1

Returns

  • Number
Titanium.Media
( ) : Object[]
Gets the value of the availableCameraMediaTypes property. ...

Gets the value of the availableCameraMediaTypes property.

  • 0.1
  • 0.1

Returns

  • Object[]
Titanium.Media
( ) : Object[]
Gets the value of the availablePhotoGalleryMediaTypes property. ...

Gets the value of the availablePhotoGalleryMediaTypes property.

  • 0.1
  • 0.1

Returns

  • Object[]
Titanium.Media
( ) : Object[]
Gets the value of the availablePhotoMediaTypes property. ...

Gets the value of the availablePhotoMediaTypes property.

  • 0.1
  • 0.1

Returns

  • Object[]
Titanium.Media
( ) : Number
Gets the value of the averageMicrophonePower property. ...

Gets the value of the averageMicrophonePower property.

  • 0.1
  • 0.1

Returns

  • Number
Titanium.Media
( ) : Boolean
Gets the value of the canRecord property. ...

Gets the value of the canRecord property.

  • 0.1
  • 0.1

Returns

  • Boolean
Titanium.Media
( ) : Boolean
Gets the value of the isCameraSupported property. ...

Gets the value of the isCameraSupported property.

  • 0.1
  • 0.1
  • 0.1

Returns

  • Boolean
Titanium.Media
( ) : Number
Gets the value of the peakMicrophonePower property. ...

Gets the value of the peakMicrophonePower property.

  • 0.1
  • 0.1

Returns

  • Number
Gets the value of the systemMusicPlayer property. ...

Gets the value of the systemMusicPlayer property.

  • 0.1
  • 0.1

Returns

Titanium.Media
( ) : Number
Gets the value of the volume property. ...

Gets the value of the volume property.

  • 0.1
  • 0.1

Returns

  • Number
Titanium.Media
( )
Hides the device camera UI. ...

Hides the device camera UI.

Must be called after calling showCamera and only when autohide is set to false. This method causes the media capture UI to be hidden.

  • 0.1
  • 0.1

Returns

  • void
Titanium.Media
( )
Hides the music library. ...

Hides the music library.

Must be called after calling openMusicLibrary and only when autohide is set to false.

  • 0.1
  • 0.1

Returns

  • void
Titanium.Media
( String source, String type ) : Boolean
Returns true if the source supports the specified media type. ...

Returns true if the source supports the specified media type.

You can query whether a given media type is supported by the device's camera (source == 'camera') or photo library (source == 'photo').

An additional value, photogallery can be used to query the media supported by the device's camera roll or saved image album, which is a subset of the iOS photo library. However, when calling openPhotoGallery on iOS, the entire library is displayed, and there is currently no way to restrict the gallery to show only the camera roll/saved images album.

  • 0.1
  • 0.1

Parameters

  • source : String

    Media source specified as a string: camera for Camera or photo for Photo Library.

  • type : String

    Media type to check, either MEDIA_TYPE_PHOTO or MEDIA_TYPE_VIDEO.

Returns

  • Boolean
Titanium.Media
( MusicLibraryOptionsType options )
Shows the music library and allows the user to select one or more tracks. ...

Shows the music library and allows the user to select one or more tracks.

If autohide is set to false, you must hide the library explicitly using hideMusicLibrary.

  • 0.1
  • 0.1

Parameters

Returns

  • void
Titanium.Media
( PhotoGalleryOptionsType options )
Opens the photo gallery image picker. ...

Opens the photo gallery image picker.

  • 0.1
  • 0.1
  • 0.1

Parameters

Returns

  • void
Titanium.Media
( Dictionary<PreviewImageOptions> options )
Displays the given image. ...

Displays the given image.

  • 0.1

Parameters

Returns

  • void
Searches the music library for items matching the specified search predicates. ...

Searches the music library for items matching the specified search predicates.

  • 0.1
  • 0.1

Parameters

Returns

( String name, Callback<Object> callback )
Removes the specified callback as an event listener for the named event. ...

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 : String

    Name of the event.

  • callback : Callback<Object>

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

Returns

  • void
Titanium.Media
( Titanium.Blob/Titanium.Filesystem.File media, Object callbacks )
Saves media to the device's photo gallery / camera roll. ...

Saves media to the device's photo gallery / camera roll.

This operation is asynchronous. The caller can supply callbacks to be triggered when the save operation completes.

Media can be passed as either a Blob object or a File object. If the media argument is not one of these types, an error is generated.

Note that when passing a file (or a blob created from a file), the file name must have the appropriate extension for the data--for example, image.jpg or video1.mov work, but video1.tmp does not. Currently, the .mp4 extension is not supported, but MP4 files may be imported by saving them with the .mov extension.

  • 0.1
  • 0.1

Parameters

  • media : Titanium.Blob/Titanium.Filesystem.File

    Media to save to the camera roll or media gallery.

  • callbacks : Object

    Pass a dictionary with the following supported keys: success a function that will be called when the save succeeds, and error a function that will be called upon receiving an error.

Returns

  • void
Titanium.Media
( Number audioSessionMode )
Sets the value of the audioSessionMode property. ...

Sets the value of the audioSessionMode property.

  • 0.1
  • 0.1

Parameters

  • audioSessionMode : Number

    New value for the property.

Returns

  • void
Titanium.Media
( Object[] availableCameraMediaTypes )
Sets the value of the availableCameraMediaTypes property. ...

Sets the value of the availableCameraMediaTypes property.

  • 0.1
  • 0.1

Parameters

  • availableCameraMediaTypes : Object[]

    New value for the property.

Returns

  • void
Titanium.Media
( Object[] availablePhotoGalleryMediaTypes )
Sets the value of the availablePhotoGalleryMediaTypes property. ...

Sets the value of the availablePhotoGalleryMediaTypes property.

  • 0.1
  • 0.1

Parameters

  • availablePhotoGalleryMediaTypes : Object[]

    New value for the property.

Returns

  • void
Titanium.Media
( Object[] availablePhotoMediaTypes )
Sets the value of the availablePhotoMediaTypes property. ...

Sets the value of the availablePhotoMediaTypes property.

  • 0.1
  • 0.1

Parameters

  • availablePhotoMediaTypes : Object[]

    New value for the property.

Returns

  • void
Titanium.Media
( Number averageMicrophonePower )
Sets the value of the averageMicrophonePower property. ...

Sets the value of the averageMicrophonePower property.

  • 0.1
  • 0.1

Parameters

  • averageMicrophonePower : Number

    New value for the property.

Returns

  • void
Titanium.Media
( CameraOptionsType options )
Shows the camera. ...

Shows the camera.

By default, the native camera controls are displayed. To add your own camera controls, you can add an overlay view by setting the overlay property on the options argument.

iOS Platform Notes

To suppress the default controls, set showControls and autohide to false.

If the showControls option is false, you must control the camera explicitly, using the takePicture and hideCamera methods.

  • 0.1
  • 0.1
  • 0.1

Parameters

Returns

  • void
Titanium.Media
( )
Starts monitoring the microphone sound level. ...

Starts monitoring the microphone sound level.

  • 0.1
  • 0.1

Returns

  • void
Titanium.Media
( )
Stops monitoring the microphone sound level. ...

Stops monitoring the microphone sound level.

  • 0.1
  • 0.1

Returns

  • void
Titanium.Media
( )
Uses the device camera to capture a photo. ...

Uses the device camera to capture a photo.

Must be called after calling showCamera and only when autohide is set to false.

This method causes the media capture device to capture a photo and call the success callback.

  • 0.1
  • 0.1
  • 0.1

Returns

  • void
Titanium.Media
( Callback<ScreenshotResult> callback )
Takes a screen shot of the visible UI on the device. ...

Takes a screen shot of the visible UI on the device.

This method is asynchronous. The screenshot is returned in the callback argument. The callback argument's media property contains the screenshot image as a Blob object.

  • 0.1
  • 0.1
  • 0.1

Parameters

Returns

  • void
Titanium.Media
( [Number[] pattern] )
Makes the device vibrate. ...

Makes the device vibrate.

On Android and Mobile Web, a pattern argument can be provided to specify a vibration pattern.

The pattern is an array of Number values. Each number in the array is interpreted as a duration in milliseconds. The first number is the delay before the pattern starts, and the remaining numbers are interpreted as alternating periods of on and off times. For example, the following pattern:

[ 0, 500, 100, 500, 100, 500 ]

Would cause the vibration to start immediately (delay = 0), and perform three long vibrations (500 ms) separated by short pauses (100ms).

On Mobile Web, calling vibrate without a pattern will stop the vibration.

  • 0.1
  • 0.1
  • 0.1
  • 1.8

Parameters

  • pattern : Number[] (optional)

    Array of values identifying a vibrate pattern (only used on Android).

Returns

  • void
Defined By

Events

Titanium.Media
Fired when an audio line type change is detected. ...

Fired when an audio line type change is detected.

  • 0.1
  • 0.1

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media
Fired when the availablity of recording input changes. ...

Fired when the availablity of recording input changes.

  • 0.1
  • 0.1

Properties

  • available : Boolean

    Indicates whether the recording device is available.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Titanium.Media
Fired when the volume output changes. ...

Fired when the volume output changes.

  • 0.1
  • 0.1

Properties

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • volume : Number

    New volume level in dB.