Titanium.Media

Audio file format 3GPP.

• 0.1
• 0.1

Audio file format Audio Interchange File Format (AIFF).

• 0.1
• 0.1

Audio file format Adaptive Multi-Rate (AMR).

• 0.1
• 0.1

Audio file format Apple Compressed Audio Format (CAF).

• 0.1
• 0.1

Audio file format MP3.

• 0.1
• 0.1

Audio file format MP4.

• 0.1
• 0.1

Audio file format MP4A.

• 0.1
• 0.1

Audio file format WAVE.

• 0.1
• 0.1

Audio format MPEG4 AAC encoding.

• 0.1
• 0.1

Audio format 8-bit aLaw encoding.

• 0.1
• 0.1

Audio format Apple lossless encoding.

• 0.1
• 0.1

Audio format iLBC encoding.

• 0.1
• 0.1

Audio format Apple IMA4 encoding.

• 0.1
• 0.1

Audio format 16-bit, linear PCM encoding.

• 0.1
• 0.1

Audio format 8-bit muLaw encoding.

• 0.1
• 0.1

Line-type constant for headphones.

• 0.1
• 0.1

Line-type constant for headphones and microphone.

• 0.1
• 0.1

Line-type constant for headset in/out.

• 0.1
• 0.1

Line-type constant for line-out.

• 0.1
• 0.1

Line-type constant for microphone.

• 0.1
• 0.1

Line-type constant indicated mute switch is on.

• 0.1
• 0.1

Line-type constant indicating receiver and microphone.

• 0.1
• 0.1

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

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

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

Session mode for recording audio; it silences playback audio.

• 0.1
• 0.1

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

Line-type constant for speaker output.

• 0.1
• 0.1

Line-type constant indicating that audio is unavailable.

• 0.1
• 0.1

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

• 0.1
• 0.1

Constant for media device busy error.

Media type constant for photo media.

Media type constant for video media.

Constant for grouping query results by album.

• 0.1
• 0.1

Constant for grouping query results by album and artist.

• 0.1
• 0.1

Constant for grouping query results by artist.

• 0.1
• 0.1

Constant for grouping query results by composer.

• 0.1
• 0.1

Constant for grouping query results by genre.

• 0.1
• 0.1

Constant for grouping query results by playlist.

• 0.1
• 0.1

Constant for grouping query results by podcast title.

• 0.1
• 0.1

Constant for grouping query results by title.

• 0.1
• 0.1

Music library media containing any type of content.

• 0.1
• 0.1

Music library media containing any type of audio content.

• 0.1
• 0.1

Music library media containing audiobook content.

• 0.1
• 0.1

Music library media containing music content.

• 0.1
• 0.1

Music library media containing podcast content.

• 0.1
• 0.1

Constant for "Repeat All" setting.

• 0.1
• 0.1

Constant for user's default repeat setting.

• 0.1
• 0.1

Constant for "No Repeat" setting.

• 0.1
• 0.1

Constant for "Repeat one item" setting.

• 0.1
• 0.1

Constant for shuffling complete albums setting.

• 0.1
• 0.1

Constant for user's default shuffle setting.

• 0.1
• 0.1

Constant for "no shuffle" setting.

• 0.1
• 0.1

Constant for shuffling songs setting.

• 0.1
• 0.1

Constant for interrupted state.

• 0.1
• 0.1

Constant for paused state.

• 0.1
• 0.1

Constant for playing state.

• 0.1
• 0.1

Constant for backward seek state.

• 0.1
• 0.1

Constant for forward seek state.

• 0.1
• 0.1

Constant for stopped state.

• 0.1
• 0.1

Constant for media no camera error.

Constant for media no video error.

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

Media type constant for low-quality video recording.

Recorded files can usually be transferred over the cellular network.

• 0.1
• 0.1

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

Constant for unknown media error.

Constant for default video controls.

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

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

Constant for video controls hidden.

• 0.1
• 0.1
• 0.1

Constant for no video controls.

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

Constant for video controls volume only.

• 0.1
• 0.1

Video playback ended normally.

• 0.1
• 0.1
• 0.1

Video playback ended abnormally.

• 0.1
• 0.1
• 0.1

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

• 0.1
• 0.1
• 0.1

Current media is playable.

• 0.1
• 0.1
• 0.1
• 1.8

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

• 0.1
• 0.1
• 0.1
• 1.8

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

• 0.1
• 0.1
• 0.1
• 1.8

Current load state is not known.

• 0.1
• 0.1
• 0.1
• 1.8

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

• 0.1
• 0.1

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

• 0.1
• 0.1

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

• 0.1
• 0.1

Video playback has been interrupted.

• 0.1
• 0.1
• 0.1

Video playback is paused.

• 0.1
• 0.1
• 0.1
• 1.8

Video is being played.

• 0.1
• 0.1
• 0.1
• 1.8

Video playback is rewinding.

• 0.1
• 0.1
• 0.1

Video playback is seeking forward.

• 0.1
• 0.1
• 0.1

Video playback is stopped.

• 0.1
• 0.1
• 0.1
• 1.8

Constant for disabling repeat on video playback.

• 0.1
• 0.1
• 1.8

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

• 0.1
• 0.1
• 1.8

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

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.

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

Video scaling is disabled.

Video source type is a file.

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

• 0.1
• 0.1

Video source type is a remote stream.

Related to the sourceType property of Titanium.Media.VideoPlayer

• 0.1
• 0.1

Video source type is unknown.

Related to the sourceType property of Titanium.Media.VideoPlayer

• 0.1
• 0.1

Use the exact time.

• 0.1
• 0.1

Use the closest keyframe in the time.

• 0.1
• 0.1

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

• 0.1
• 0.1

Returns the line type constant for the current line type.

• 0.1
• 0.1

Returns true if the device is playing audio.

• 0.1
• 0.1

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

Array of media type constants supported for the camera.

• 0.1
• 0.1

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

• 0.1
• 0.1

Array of media type constants supported for the photo library.

• 0.1
• 0.1

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

See startMicrophoneMonitor, stopMicrophoneMonitor.

• 0.1
• 0.1

true if the device has a recording input device available.

• 0.1
• 0.1

true if the device has camera support.

• 0.1
• 0.1
• 0.1

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.

• 0.1
• 0.1

Current volume of the playback device.

• 0.1
• 0.1

Plays a device beep notification.

• 0.1
• 0.1

Returns

• void

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

• 0.9
• 0.9
• 0.9

Parameters

• parameters : Dictionary<Titanium.Media.AudioPlayer> (optional)

  Properties to set on a new object, including any defined by Titanium.Media.AudioPlayer except those marked not-creation or read-only.

Returns

• Titanium.Media.AudioPlayer

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

• 0.9
• 0.9

Parameters

• parameters : Dictionary<Titanium.Media.AudioRecorder> (optional)

  Properties to set on a new object, including any defined by Titanium.Media.AudioRecorder except those marked not-creation or read-only.

Returns

• Titanium.Media.AudioRecorder

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

• 1.4
• 1.4

Parameters

• parameters : Dictionary<Titanium.Media.Item> (optional)

  Properties to set on a new object, including any defined by Titanium.Media.Item except those marked not-creation or read-only.

Returns

• Titanium.Media.Item

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

• 1.4
• 1.4

Parameters

• parameters : Dictionary<Titanium.Media.MusicPlayer> (optional)

  Properties to set on a new object, including any defined by Titanium.Media.MusicPlayer except those marked not-creation or read-only.

Returns

• Titanium.Media.MusicPlayer

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

• 0.8
• 0.8
• 0.8

Parameters

• parameters : Dictionary<Titanium.Media.Sound> (optional)

  Properties to set on a new object, including any defined by Titanium.Media.Sound except those marked not-creation or read-only.

Returns

• Titanium.Media.Sound

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

• 0.9
• 0.9
• 0.9
• 1.8

Parameters

• parameters : Dictionary<Titanium.Media.VideoPlayer> (optional)

  Properties to set on a new object, including any defined by Titanium.Media.VideoPlayer except those marked not-creation or read-only.

Returns

• Titanium.Media.VideoPlayer

Gets the value of the appMusicPlayer property.

• 0.1
• 0.1

Returns

• Titanium.Media.MusicPlayer

Gets the value of the audioLineType property.

• 0.1
• 0.1

Returns

• Number

Gets the value of the audioPlaying property.

• 0.1
• 0.1

Returns

• Boolean

Gets the value of the audioSessionMode property.

• 0.1
• 0.1

Returns

• Number

Gets the value of the availableCameraMediaTypes property.

• 0.1
• 0.1

Returns

• Object[]

Gets the value of the availablePhotoGalleryMediaTypes property.

• 0.1
• 0.1

Returns

• Object[]

Gets the value of the availablePhotoMediaTypes property.

• 0.1
• 0.1

Returns

• Object[]

Gets the value of the averageMicrophonePower property.

• 0.1
• 0.1

Returns

• Number

Gets the value of the canRecord property.

• 0.1
• 0.1

Returns

• Boolean

Gets the value of the isCameraSupported property.

• 0.1
• 0.1
• 0.1

Returns

• Boolean

Gets the value of the peakMicrophonePower property.

• 0.1
• 0.1

Returns

• Number

Gets the value of the systemMusicPlayer property.

• 0.1
• 0.1

Returns

• Titanium.Media.MusicPlayer

Gets the value of the volume property.

• 0.1
• 0.1

Returns

• Number

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

Hides the music library.

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

• 0.1
• 0.1

Returns

• void

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

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

• options : MusicLibraryOptionsType

  A dictionary of options as described in MusicLibraryOptionsType.

Returns

• void

Opens the photo gallery image picker.

• 0.1
• 0.1
• 0.1

Parameters

• options : PhotoGalleryOptionsType

  Photo gallery options as described in PhotoGalleryOptionsType.

Returns

• void

Displays the given image.

• 0.1

Parameters

• options : Dictionary<PreviewImageOptions>

  Dictionary containing the image and callback functions.

Returns

• void

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

• 0.1
• 0.1

Parameters

• query : MediaQueryType

  The query object to extract information from.

Returns

• Titanium.Media.Item[]

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

Sets the value of the audioSessionMode property.

• 0.1
• 0.1

Parameters

• audioSessionMode : Number

  New value for the property.

Returns

• void

Sets the value of the availableCameraMediaTypes property.

• 0.1
• 0.1

Parameters

• availableCameraMediaTypes : Object[]

  New value for the property.

Returns

• void

Sets the value of the availablePhotoGalleryMediaTypes property.

• 0.1
• 0.1

Parameters

• availablePhotoGalleryMediaTypes : Object[]

  New value for the property.

Returns

• void

Sets the value of the availablePhotoMediaTypes property.

• 0.1
• 0.1

Parameters

• availablePhotoMediaTypes : Object[]

  New value for the property.

Returns

• void

Sets the value of the averageMicrophonePower property.

• 0.1
• 0.1

Parameters

• averageMicrophonePower : Number

  New value for the property.

Returns

• void

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

• options : CameraOptionsType

  A dictionary of camera options as described in CameraOptionsType.

Returns

• void

Starts monitoring the microphone sound level.

• 0.1
• 0.1

Returns

• void

Stops monitoring the microphone sound level.

• 0.1
• 0.1

Returns

• void

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

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

• callback : Callback<ScreenshotResult>

  Function to call upon capture.

Returns

• void

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

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.

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.