Audio file format 3GPP.

• 0.8
• 0.8

Audio file format Audio Interchange File Format (AIFF).

• 0.8
• 0.8

Audio file format Adaptive Multi-Rate (AMR).

• 0.8
• 0.8

Audio file format Apple Compressed Audio Format (CAF).

• 0.8
• 0.8

Audio file format MP3.

• 0.8
• 0.8

Audio file format MP4.

• 0.8
• 0.8

Audio file format MP4A.

• 0.8
• 0.8

Audio file format WAVE.

• 0.8
• 0.8

Audio format MPEG4 AAC encoding.

• 0.8
• 0.8

Audio format 8-bit aLaw encoding.

• 0.8
• 0.8

Audio format Apple lossless encoding.

• 0.8
• 0.8

Audio format iLBC encoding.

• 0.8
• 0.8

Audio format Apple IMA4 encoding.

• 0.8
• 0.8

Audio format 16-bit, linear PCM encoding.

• 0.8
• 0.8

Audio format 8-bit muLaw encoding.

• 0.8
• 0.8

Line-type constant for headphones.

• 0.8
• 0.8

Line-type constant for headphones and microphone.

• 0.8
• 0.8

Line-type constant for headset in/out.

• 0.8
• 0.8

Line-type constant for line-out.

• 0.8
• 0.8

Line-type constant for microphone.

• 0.8
• 0.8

Line-type constant indicated mute switch is on.

• 0.8
• 0.8

Line-type constant indicating receiver and microphone.

• 0.8
• 0.8

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_CATEGORY_SOLO_AMBIENT.

• 3.4.2
• 3.4.2

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.

• 3.4.2
• 3.4.2

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_CATEGORY_RECORD instead. This category normally disallows mixing iPod audio with application audio.

In this mode, by default audio playback is routed to the speaker in the iPhone receiver. To have audio playback through the iPhone speaker, use setOverrideAudioRoute.

• 3.4.2
• 3.4.2

Session mode for recording audio; it silences playback audio.

• 3.4.2
• 3.4.2

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_CATEGORY_AMBIENT.

• 3.4.2
• 3.4.2

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.8
• 0.8

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.8
• 0.8

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_CATEGORY_RECORD instead. This category normally disallows mixing iPod audio with application audio.

In this mode, by default audio playback is routed to the speaker in the iPhone receiver. To have audio playback through the iPhone speaker, use setOverrideAudioRoute.

• 0.8
• 0.8

Session mode for recording audio; it silences playback audio.

• 0.8
• 0.8

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.8
• 0.8

Constant that specifies audio should output to the default audio route. See setOverrideAudioRoute for more information.

• 0.8
• 0.8

Constant that specifies audio should output to the speaker. See setOverrideAudioRoute for more information.

• 0.8
• 0.8

Constant for output on a remote Air Play device. This is an output port.

• 3.4.2
• 3.4.2

Constant for output on a Bluetooth A2DP device. This is an output port.

• 3.4.2
• 3.4.2

Constant for input or output on a Bluetooth Hands-Free Profile device. This can be both an input and output port.

• 3.4.2
• 3.4.2

Constant for output on a Bluetooth Low Energy device. This is an output port. This is available on iOS7 and later.

Requires: iOS 7.0 and later

• 3.4.2
• 3.4.2

Constant for built-in microphone on an iOS device. This is an input port.

• 3.4.2
• 3.4.2

Constant for the speaker you hold to your ear when on a phone call. This is an output port.

• 3.4.2
• 3.4.2

Constant for built-in speaker on an iOS device. This is an output port.

• 3.4.2
• 3.4.2

Constant for Input or output via Car Audio. This can be both an input and output port. This is available on iOS7 and later.

Requires: iOS 7.0 and later

• 3.4.2
• 3.4.2

Constant for output via High-Definition Multimedia Interface. This is an output port

• 3.4.2
• 3.4.2

Constant for headphone or headset output. This is an output port.

• 3.4.2
• 3.4.2

Constant for microphone on a wired headset. This is an input port.

• 3.4.2
• 3.4.2

Constant for line level input on a dock connector. This is an input port.

• 3.4.2
• 3.4.2

Constant for line level output on a dock connector. This is an output port.

• 3.4.2
• 3.4.2

Constant for input or output on a Universal Serial Bus device. This can be both an input and output port.

• 3.4.2
• 3.4.2

Line-type constant for speaker output.

• 0.8
• 0.8

Line-type constant indicating that audio is unavailable.

• 0.8
• 0.8

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

• 0.8
• 0.8

Constant specifying that app is authorized to use camera. This is available on iOS7 and later.

Requires: iOS 7.0 and later

• 4.0.0
• 4.0.0

Constant specifying that app is denied usage of camera. This is available on iOS7 and later.

Requires: iOS 7.0 and later

• 4.0.0
• 4.0.0

Constant specifying that app is not yet authorized to use camera. This is available on iOS7 and later.

• 4.0.0
• 4.0.0

Constant specifying that app is restricted from using camera. This is available on iOS7 and later.

Requires: iOS 7.0 and later

• 4.0.0
• 4.0.0

Constant specifying that app is not yet authorized to use camera. This is available on iOS7 and later.

Requires: iOS 7.0 and later

• 5.2.0
• 5.2.0

Constant specifying to have the device determine to use the flash or not.

• 3.3.0
• 1.4.0
• 1.4.0

Constant specifying to never fire the flash.

• 3.3.0
• 1.4.0
• 1.4.0

Constant specifying to always fire the flash.

• 3.3.0
• 1.4.0
• 1.4.0

Constant specifying the front camera.

• 3.2.0
• 0.8
• 0.8

Constant indicating the rear camera.

• 3.2.0
• 0.8
• 0.8

Constant for media device busy error.

Media type constant for live photo media.

Requires: iOS 9.1 and later

• 5.2.0
• 5.2.0

Media type constant for photo media.

Media type constant for video media.

Constant for grouping query results by album.

Constant value:1

• 0.8
• 0.8

Constant for grouping query results by album and artist.

Constant value:3

• 0.8
• 0.8

Constant for grouping query results by artist.

Constant value:2

• 0.8
• 0.8

Constant for grouping query results by composer.

Constant value:4

• 0.8
• 0.8

Constant for grouping query results by genre.

Constant value:5

• 0.8
• 0.8

Constant for grouping query results by playlist.

Constant value:6

• 0.8
• 0.8

Constant for grouping query results by podcast title.

Constant value:7

• 0.8
• 0.8

Constant for grouping query results by title.

• 0.8
• 0.8

Music library media containing any type of content.

• 0.8
• 0.8

Music library media containing any type of audio content.

• 0.8
• 0.8

Music library media containing audiobook content.

• 0.8
• 0.8

Music library media containing music content.

• 0.8
• 0.8

Music library media containing podcast content.

• 0.8
• 0.8

Constant for "Repeat All" setting.

• 0.8
• 0.8

Constant for user's default repeat setting.

• 0.8
• 0.8

Constant for "No Repeat" setting.

• 0.8
• 0.8

Constant for "Repeat one item" setting.

• 0.8
• 0.8

Constant for shuffling complete albums setting.

• 0.8
• 0.8

Constant for user's default shuffle setting.

• 0.8
• 0.8

Constant for "no shuffle" setting.

• 0.8
• 0.8

Constant for shuffling songs setting.

• 0.8
• 0.8

Constant for interrupted state.

• 0.8
• 0.8

Constant for paused state.

• 0.8
• 0.8

Constant for playing state.

• 0.8
• 0.8

Constant for backward seek state.

• 0.8
• 0.8

Constant for forward seek state.

• 0.8
• 0.8

Constant for stopped state.

• 0.8
• 0.8

Constant for media no camera error.

Constant for media no video error.

Media type constant for medium-quality video recording.

If recording, specifies that you want to use VGA-quality video recording (pixel dimensions of 640x480).

• 0.8
• 0.8

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.8
• 0.8

Media type constant for medium-quality video recording.

If recording, specifies that you want to use 1280x720 iFrame format.

• 6.0.0
• 6.0.0

Media type constant for medium-quality video recording.

If recording, specifies that you want to use 960x540 iFrame format.

• 6.0.0
• 6.0.0

Media type constant for low-quality video recording.

Recorded files can usually be transferred over the cellular network.

• 0.8
• 0.8

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.8
• 0.8

Constant for unknown media error.

Constant for default video controls.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

Constant for video controls for an embedded view.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

On Android, this constant has the same effect as VIDEO_CONTROL_DEFAULT. Video controls may only be shown or hidden.

Constant for fullscreen video controls.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

On iOS, use VIDEO_CONTROL_FULLSCREEN when creating a video player that occupies the entire screen, that is, the parent window should be a fullscreen window (fullscreen set to true) and the video player should occupy the entirety of the parent window.

If the user clicks the Done button in the fullscreen control bar, the video player pauses playback and generates a complete event.

Note that if you create a video player that does not occupy the entire screen, and later switch to fullscreen mode, the video controls are switched automatically. That is, if mediaControlStyle is set to VIDEO_CONTROL_DEFAULT or VIDEO_CONTROL_EMBEDDED, it is automatically switched to the fullscreen controls when the player enters fullscreen mode. This is true whether the user initiates the mode switch by clicking the fullscreen button in the embedded controls, or if you programmatically switch to full screen mode (by setting the fullscreen property to true).

On Android, this constant has the same effect as VIDEO_CONTROL_DEFAULT. Video controls may only be shown or hidden.

Constant for video controls hidden.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

Constant for no video controls.

Used in conjunction with the mediaControlStyle property of Titanium.Media.VideoPlayer.

Constant for video controls volume only.

• 0.8
• 0.8

Video playback ended normally.

Video playback ended abnormally.

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

Indicates that the player can no longer play media items because of an error.

• 0.8
• 0.8

Current media is playable.

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

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

Current load state is not known.

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

• 0.8
• 0.8

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

• 0.8
• 0.8

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

• 0.8
• 0.8

Video playback has been interrupted.

Video playback is paused.

Video is being played.

Video playback is rewinding.

Video playback is seeking forward.

Video playback is stopped.

Constant for disabling repeat on video playback.

• 6.2.0
• 0.9.0
• 0.9.0

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

• 6.2.0
• 0.9.0
• 0.9.0

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.

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.

Video scaling is disabled.

Specifies that the video should be stretched to fill the bounds of layer.

• 7.0.0
• 7.0.0

Specifies that the player should preserve the aspect ratio of video and fit the video within the bounds of layer.

• 7.0.0
• 7.0.0

Specifies that the player should preserve the aspect ratio of video and fill the bounds of layer.

• 7.0.0
• 7.0.0

Video source type is a file.

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

• 0.8
• 0.8

Video source type is a remote stream.

Related to the sourceType property of Titanium.Media.VideoPlayer

• 0.8
• 0.8

Video source type is unknown.

Related to the sourceType property of Titanium.Media.VideoPlayer

• 0.8
• 0.8

Use the closest sync (or key) frame at given the time.

• 3.6.0

Use the exact time.

• 0.8
• 0.8

Use the closest keyframe in the time.

• 3.6.0
• 0.8
• 0.8

Use the sync (or key) frame located right after or at given the time.

• 3.6.0

Use the sync (or key) frame located right before or at given the time.

• 3.6.0

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

• 0.8
• 0.8

Returns the line type constant for the current line type.

• 0.8
• 0.8

Returns true if the device is playing audio.

• 0.8
• 0.8

A constant for the audio session category to be used.

Set to one of the AUDIO_SESSION_CATEGORY 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).

This API can be assigned the following constants:

• AUDIO_SESSION_CATEGORY_AMBIENT
• AUDIO_SESSION_CATEGORY_PLAYBACK
• AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD
• AUDIO_SESSION_CATEGORY_RECORD
• AUDIO_SESSION_CATEGORY_SOLO_AMBIENT

• 3.4.2
• 3.4.2

A constant for the audio session mode to be used.

Set to one of the AUDIO_SESSION_MODE 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).

This API can be assigned the following constants:

• AUDIO_SESSION_MODE_AMBIENT
• AUDIO_SESSION_MODE_PLAYBACK
• AUDIO_SESSION_MODE_PLAY_AND_RECORD
• AUDIO_SESSION_MODE_RECORD
• AUDIO_SESSION_MODE_SOLO_AMBIENT

• 0.8
• 0.8

Array of media type constants supported for the camera.

This API can be assigned the following constants:

• MEDIA_TYPE_PHOTO
• MEDIA_TYPE_LIVEPHOTO
• MEDIA_TYPE_VIDEO

• 0.8
• 0.8

Array indicating which cameras are available, CAMERA_FRONT, CAMERA_REAR or both.

This API can be assigned the following constants:

• CAMERA_FRONT
• CAMERA_REAR

• 3.2.0
• 0.8
• 0.8

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

This API can be assigned the following constants:

• MEDIA_TYPE_PHOTO
• MEDIA_TYPE_LIVEPHOTO
• MEDIA_TYPE_VIDEO

• 0.8
• 0.8

Array of media type constants supported for the photo library.

This API can be assigned the following constants:

• MEDIA_TYPE_PHOTO
• MEDIA_TYPE_LIVEPHOTO
• MEDIA_TYPE_VIDEO

• 0.8
• 0.8

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

See startMicrophoneMonitor, stopMicrophoneMonitor.

• 0.8
• 0.8

Returns the authorization status for the camera.

Requires: iOS 7.0 and later

This API can be assigned the following constants:

• CAMERA_AUTHORIZATION_AUTHORIZED
• CAMERA_AUTHORIZATION_DENIED
• CAMERA_AUTHORIZATION_RESTRICTED
• CAMERA_AUTHORIZATION_NOT_DETERMINED
• CAMERA_AUTHORIZATION_UNKNOWN

• 5.2.0
• 5.2.0

Returns the authorization status for the camera.

• 4.0.0
• 4.0.0

Determines how the flash is fired when using the device's camera.

This API can be assigned the following constants:

• CAMERA_FLASH_AUTO
• CAMERA_FLASH_OFF
• CAMERA_FLASH_ON

Default: Titanium.Media.CAMERA_FLASH_AUTO

• 3.3.0
• 1.4.0
• 1.4.0

true if the device has a recording input device available.

• 6.2.0
• 0.8
• 0.8

Returns a description of the current route, consisting of zero or more input ports and zero or more output ports.

• 3.4.2
• 3.4.2

true if the device has camera support.

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

See startMicrophoneMonitor, stopMicrophoneMonitor.

• 0.8
• 0.8

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

• 0.8
• 0.8

Current volume of the playback device.

• 0.8
• 0.8

Plays a device beep notification.

• 0.8
• 0.8

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.

• 6.2.0
• 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.Sound.

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.SystemAlert.

• 6.1.0
• 6.1.0

Parameters

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

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

Returns

• Titanium.Media.SystemAlert

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

• 0.9
• 0.9
• 0.9

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.8
• 0.8

Returns

• Titanium.Media.MusicPlayer

Gets the value of the audioLineType property.

• 0.8
• 0.8

Returns

• Number

Gets the value of the audioPlaying property.

• 0.8
• 0.8

Returns

• Boolean

Gets the value of the audioSessionCategory property.

• 3.4.2
• 3.4.2

Returns

• Number

Gets the value of the audioSessionMode property.

• 0.8
• 0.8

Returns

• Number

Gets the value of the availableCameraMediaTypes property.

• 0.8
• 0.8

Returns

• Object[]

Gets the value of the availableCameras property.

• 3.2.0
• 0.8
• 0.8

Returns

• Number[]

Gets the value of the availablePhotoGalleryMediaTypes property.

• 0.8
• 0.8

Returns

• Object[]

Gets the value of the availablePhotoMediaTypes property.

• 0.8
• 0.8

Returns

• Object[]

Gets the value of the averageMicrophonePower property.

• 0.8
• 0.8

Returns

• Number

Gets the value of the cameraAuthorization property.

• 5.2.0
• 5.2.0

Returns

• Number

Gets the value of the cameraAuthorizationStatus property.

• 4.0.0
• 4.0.0

Returns

• Number

Gets the value of the cameraFlashMode property.

• 3.3.0
• 1.4.0
• 1.4.0

Returns

• Number

Gets the value of the canRecord property.

• 6.2.0
• 0.8
• 0.8

Returns

• Boolean

Gets the value of the currentRoute property.

• 3.4.2
• 3.4.2

Returns

• RouteDescription

Gets the value of the isCameraSupported property.

Returns

• Boolean

Gets the value of the peakMicrophonePower property.

• 0.8
• 0.8

Returns

• Number

Gets the value of the QUALITY_640x480 property.

• 0.8
• 0.8

Returns

• Number

Gets the value of the QUALITY_IFRAME_1280x720 property.

• 6.0.0
• 6.0.0

Returns

• Number

Gets the value of the QUALITY_IFRAME_960x540 property.

• 6.0.0
• 6.0.0

Returns

• Number

Gets the value of the systemMusicPlayer property.

• 0.8
• 0.8

Returns

• Titanium.Media.MusicPlayer

Gets the value of the volume property.

• 0.8
• 0.8

Returns

• Number

Returns true if the app has audio permissions.

On iOS 7.0, recording audio requires explicit permission from the user. After the user grants or denies permission, the system remembers the choice for future use in the same app. If permission is not granted, or if the user has not yet responded to the permission prompt, any audio recording sessions record only silence.

In addition, Apple introduced the Info.plist key NSMicrophoneUsageDescription that is used to display an own description while authorizing microphone permissions. In iOS 10, this key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

• 6.0.0
• 6.0.0

Returns

• Boolean

Returns true if the app has audio permissions.

On iOS 7.0, recording audio requires explicit permission from the user. After the user grants or denies permission, the system remembers the choice for future use in the same app. If permission is not granted, or if the user has not yet responded to the permission prompt, any audio recording sessions record only silence.

In addition, Apple introduced the Info.plist key NSMicrophoneUsageDescription that is used to display an own description while authorizing microphone permissions. In iOS 10, this key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

• 6.2.0
• 6.1.0
• 6.1.0

Returns

• Boolean

Returns true if the app has camera access.

• 5.1.0
• 5.1.0
• 5.1.0

Returns

• Boolean

Returns true if the app has camera access.

Music-library permissions are only needed in iOS 9.3 and later and will be ignored on older iOS versions. Because of that, the method will return true for devices that run iOS < 9.3.

• 6.0.0
• 6.0.0

Returns

• Boolean

Returns true if the app has photo gallery permissions.

• 6.0.0
• 6.0.0

Returns

• Boolean

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.

• 3.2.0
• 0.8
• 0.8

Returns

• void

Hides the music library.

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

• 0.8
• 0.8

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.8
• 0.8

Parameters

• source : String

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

• type : String

  Media type to check.

  This API can be assigned the following constants:

  • MEDIA_TYPE_PHOTO
  • MEDIA_TYPE_LIVEPHOTO
  • 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.8
• 0.8

Parameters

• options : MusicLibraryOptionsType

  A dictionary of options as described in MusicLibraryOptionsType.

Returns

• void

Opens the photo gallery image picker.

In iOS 6, Apple introduced the Info.plist key NSPhotoLibraryUsageDescription that is used to display an own description while authorizing gallery permissions. In iOS 10, this key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

Parameters

• options : PhotoGalleryOptionsType

  Photo gallery options as described in PhotoGalleryOptionsType.

Returns

• void

Displays the given image.

• 0.8

Parameters

• options : Dictionary<PreviewImageOptions>

  Dictionary containing the image and callback functions.

Returns

• void

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

Use hasMusicLibraryPermissions to check the granted permissions and requestMusicLibraryPermissions to request the permissions. This is especially important when running on an iOS 10 device, because the music-library access will crash without having the privacy-key NSAppleMusicUsageDescription that is specified in requestMusicLibraryPermissions.

• 0.8
• 0.8

Parameters

• query : MediaQueryType

  The query object to extract information from.

Returns

• Titanium.Media.Item[]

Request the user's permission for audio recording.

On iOS 7.0, recording audio requires explicit permission from the user. After the user grants or denies permission, the system remembers the choice for future use in the same app. If permission is not granted, or if the user has not yet responded to the permission prompt, any audio recording sessions record only silence.

In addition, Apple introduced the Info.plist key NSMicrophoneUsageDescription that is used to display an own description while authorizing microphone permissions. In iOS 10, this key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

• 5.1.0
• 5.1.0

Parameters

• callback : Callback<MediaAuthorizationResponse>

  Callback function to execute when the users responds to the authorization alert.

Returns

• void

Request the user's permission for audio recording.

On iOS 7.0, recording audio requires explicit permission from the user. After the user grants or denies permission, the system remembers the choice for future use in the same app. If permission is not granted, or if the user has not yet responded to the permission prompt, any audio recording sessions record only silence.

In addition, Apple introduced the Info.plist key NSMicrophoneUsageDescription that is used to display an own description while authorizing microphone permissions. In iOS 10, this key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

• 6.2.0
• 6.1.0
• 6.1.0

Parameters

• callback : Callback<MediaAuthorizationResponse>

  Callback function to execute when the users responds to the authorization alert.

Returns

• void

Request the user's permission for audio recording.

On iOS 7.0, recording audio requires explicit permission from the user. After the user grants or denies permission, the system remembers the choice for future use in the same app. If permission is not granted, or if the user has not yet responded to the permission prompt, any audio recording sessions record only silence.

In addition, Apple introduced the Info.plist key NSMicrophoneUsageDescription that is used to display an own description while authorizing microphone permissions. In iOS 10, this key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

• 3.1.3
• 3.1.3

Parameters

• callback : Callback<MediaAuthorizationResponse>

  Callback function to execute when the users responds to the authorization alert.

Returns

• void

Requests for camera access.

This method allows the app to request for camera access, before or without the user granting it in showCamera. The request view will only show if user has not yet made a decision. If he has, the callback will return his earlier decision, and if any changes has to be made, the user has to change it in the device settings.

• 4.0.0
• 4.0.0

Parameters

• callback : Callback<RequestCameraAccessResult>

  Function to call upon user decision to grant camera access.

Returns

• void

Requests for camera access.

Requires: iOS 7.0 and later

On Android, the request view will show if the permission is not accepted by the user, and the user did not check the box "Never ask again" when denying the request. If the user checks the box "Never ask again," the user has to manually enable the permission in device settings.

This method requests Manifest.permission.CAMERA on Android. If you require other permissions, you can also use Titanium.Android.requestPermissions.

In iOS 6, Apple introduced the Info.plist key NSCameraUsageDescription that is used to display an own description while authorizing camera permissions. In iOS 10, this key is mandatory when taking a photo and the application will crash if your app does not include the key. Check the Apple docs for more information. When using the camera to take a video, you also need the NSMicrophoneUsageDescription key. In addition, the authorization dialog will only show if user has not made a decision, yet. If the user has, the callback will return the earlier decision. To change the permission the user needs to change it in the device settings.

• 5.1.0
• 5.1.0
• 5.1.0

Parameters

• callback : Callback<RequestCameraAccessResult>

  Function to call upon user decision to grant camera access.

Returns

• void

Request permissions for the native music-library.

Music-library permissions are only needed in iOS 9.3 and later and will be ignored on older iOS versions. Because of that, the callback will ignore the permission-check and always return {success: true} for devices that run iOS < 9.3.

Important: On iOS 10, Apple introduced the Info.plist key NSAppleMusicUsageDescription that is used to display an own description while authorizing the music library. This key is mandatory and the application will crash if your app does not include the key. Check the Apple docs for more information.

• 6.0.0
• 6.0.0

Parameters

• callback : Callback<RequestMusicLibraryAccessResult>

  Function to call upon user decision to grant camera access.

Returns

• void

Requests for photo gallery permissions.

Requires: iOS 8.0 and later

In iOS 6, Apple introduced the Info.plist key NSPhotoLibraryUsageDescription that is used to display an own description while authorizing photo gallery permissions. In iOS 10, this key is mandatory when accessing the photo gallery and the application will crash if your app does not include the key. Check the Apple docs for more information. If the user has, the callback will return the earlier decision. To change the permission the user needs to change it in the device settings.

This API is available in iOS 8 and later. Earlier versions of iOS, as well as apps that do not include this method, will present the system-dialog while the dialog is opened with openPhotoGallery.

• 6.0.0
• 6.0.0

Parameters

• callback : Callback<RequestPhotoGalleryAccessResult>

  Function to call upon user decision to grant camera access.

Returns

• void

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.

On Android this method only supports saving images to the device gallery prior to Titanium SDK 6.1.0.

• 3.3.0
• 0.8
• 0.8

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 audioSessionCategory property.

• 3.4.2
• 3.4.2

Parameters

• audioSessionCategory : Number

  New value for the property.

Returns

• void

Sets the value of the audioSessionMode property.

• 0.8
• 0.8

Parameters

• audioSessionMode : Number

  New value for the property.

Returns

• void

Sets the value of the availableCameraMediaTypes property.

• 0.8
• 0.8

Parameters

• availableCameraMediaTypes : Array<Object>

  New value for the property.

Returns

• void

Sets the value of the availablePhotoGalleryMediaTypes property.

• 0.8
• 0.8

Parameters

• availablePhotoGalleryMediaTypes : Array<Object>

  New value for the property.

Returns

• void

Sets the value of the availablePhotoMediaTypes property.

• 0.8
• 0.8

Parameters

• availablePhotoMediaTypes : Array<Object>

  New value for the property.

Returns

• void

Sets the value of the averageMicrophonePower property.

• 0.8
• 0.8

Parameters

• averageMicrophonePower : Number

  New value for the property.

Returns

• void

Sets the value of the cameraFlashMode property.

• 3.3.0
• 1.4.0
• 1.4.0

Parameters

• cameraFlashMode : Number

  New value for the property.

Returns

• void

Overrides the default audio route when using the AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD session mode.

By default, when using the AUDIO_SESSION_CATEGORY_PLAY_AND_RECORD session mode, the audio output is routed to the speaker in the receiver. This method lets you specify that audio should be routed to the built-in speaker.

If you override the audio route while audio is playing the changes won't not take effect until the audio is restarted.

• 0.8
• 0.8

Parameters

• route : Number

  The specified audio route.

  This API can be assigned the following constants:

  • AUDIO_SESSION_OVERRIDE_ROUTE_NONE
  • AUDIO_SESSION_OVERRIDE_ROUTE_SPEAKER

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.

Android Platform Notes

To suppress the default controls, set autohide to false and then set the overlay property to a view that contains a control (such as a button) to take the photo. You must then control the camera explicitly, using the takePicture and hideCamera methods.

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.

Images taken with the camera will not have accurate geolocation data embedded in the images; the latitude and longitude will be set to '0'. This is not an error, but a limitation which Apple has put on the camera API.

Important: Use hasCameraPermissions and requestCameraPermissions to ask for camera permissions. This is especially important when running on iOS 10 and later, since the application may crash otherwise.

Parameters

• options : CameraOptionsType

  A dictionary of camera options as described in CameraOptionsType.

Returns

• void

Starts monitoring the microphone sound level.

• 0.8
• 0.8

Returns

• void

Starts video capture using the camera specified.

• 5.4.0
• 0.8
• 0.8

Returns

• void

Stops monitoring the microphone sound level.

• 0.8
• 0.8

Returns

• void

Stops video capture using the camera specified.

• 5.4.0
• 0.8
• 0.8

Returns

• void

Switches between front and rear-facing cameras. Make sure to set one of the below constants to determine the camera you want to switch to.

In Android, this can only be called when using a custom overlay (see showCamera).

• 3.2.0
• 1.8.1
• 1.8.1

Parameters

• camera : Number

  Constant indicating to which camera you want to switch.

  This API can be assigned the following constants:

  • CAMERA_FRONT
  • CAMERA_REAR

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.

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.

Parameters

• callback : Callback<ScreenshotResult>

  Function to call upon capture.

Returns

• void

Makes the device vibrate.

On Android, 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).

Parameters

• pattern : Array<Number> (optional)

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

Returns

• void

Fired when an audio line type change is detected.

• 0.8
• 0.8

Properties

• source : Object

  Source object that fired the event.

  •  
  •  
  •  
• type : String

  Name of the event fired.

  •  
  •  
  •  
• bubbles : Boolean

  True if the event will try to bubble up if possible.

  •  
  •  
  •  
• cancelBubble : Boolean

  Set to true to stop the event from bubbling.

  •  
  •  
  •  

Fired when the availablity of recording input changes.

• 0.8
• 0.8

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.

  •  
  •  
  •  
• bubbles : Boolean

  True if the event will try to bubble up if possible.

  •  
  •  
  •  
• cancelBubble : Boolean

  Set to true to stop the event from bubbling.

  •  
  •  
  •  

Fired when an audio line type change is detected.

• 3.4.2
• 3.4.2

Properties

• reason : String

  The reason for route change.

• oldRoute : RouteDescription

  Returns a description of the old route, consisting of zero or more input ports and zero or more output ports.

• currentRoute : RouteDescription

  Returns a description of the current route, consisting of zero or more input ports and zero or more output ports.

• source : Object

  Source object that fired the event.

  •  
  •  
  •  
• type : String

  Name of the event fired.

  •  
  •  
  •  
• bubbles : Boolean

  True if the event will try to bubble up if possible.

  •  
  •  
  •  
• cancelBubble : Boolean

  Set to true to stop the event from bubbling.

  •  
  •  
  •  

Fired when the volume output changes.

• 0.8
• 0.8

Properties

• volume : Number

  New volume level in dB.

• source : Object

  Source object that fired the event.

  •  
  •  
  •  
• type : String

  Name of the event fired.

  •  
  •  
  •  
• bubbles : Boolean

  True if the event will try to bubble up if possible.

  •  
  •  
  •  
• cancelBubble : Boolean

  Set to true to stop the event from bubbling.

  •  
  •  
  •