Titanium 3.X

Titanium.Media.AudioRecorder

> Titanium.Media.AudioRecorder

An audio recorder object used for recording audio from the device microphone.

Use the Titanium.Media.createAudioRecorder method to create an audio recorder.

  • 0.9
  • 0.9
Defined By

Properties

apiName : Stringreadonly

The name of the API that this proxy corresponds to.

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button returns Ti.UI.Button.

  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2
Indicates if the proxy will bubble an event to its parent. ...

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

  • 3.0
  • 3.0
  • 3.0
Titanium.Media.AudioRecorder
: Number
Audio compression to be used for the recording. ...

Audio compression to be used for the recording.

Specify one of the AUDIO_FORMAT_ constants from Titanium.Media.

Default: Titanium.Media.AUDIO_FORMAT_LINEAR_PCM

Titanium.Media.AudioRecorder
: Number
Audio format to be used for the recording. ...

Audio format to be used for the recording.

Specify one of the AUDIO_FILEFORMAT_ constants from Titanium.Media.

Default: Titanium.Media.AUDIO_FILEFORMAT_CAF

Titanium.Media.AudioRecorder
paused : Booleanreadonly

Indicates if the audio recorder is paused.

Indicates if the audio recorder is paused.

Titanium.Media.AudioRecorder
recording : Booleanreadonly

Indicates if the audio recorder is recording.

Indicates if the audio recorder is recording.

Titanium.Media.AudioRecorder
stopped : Booleanreadonly

Indicates if the audio recorder is stopped.

Indicates if the audio recorder is stopped.

Defined By

Methods

( name, callback ) : void
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
Applies the properties to the proxy. ...

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
( name, event ) : void
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 apiName property. ...

Gets the value of the apiName property.

  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0
  • 3.0
  • 3.0

Returns

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

Gets the value of the compression property.

Returns

  • Number
Titanium.Media.AudioRecorder
( ) : Number
Gets the value of the format property. ...

Gets the value of the format property.

Returns

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

Gets the value of the paused property.

Returns

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

Gets the value of the recording property.

Returns

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

Gets the value of the stopped property.

Returns

  • Boolean
Titanium.Media.AudioRecorder
( ) : void
Pauses the current audio recording. ...

Pauses the current audio recording.

Returns

  • void
( name, callback ) : void
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.AudioRecorder
( ) : void
Resumes a paused recording. ...

Resumes a paused recording.

Returns

  • void
( bubbleParent ) : void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Titanium.Media.AudioRecorder
( compression ) : void
Sets the value of the compression property. ...

Sets the value of the compression property.

Parameters

  • compression : Number

    New value for the property.

Returns

  • void
Titanium.Media.AudioRecorder
( format ) : void
Sets the value of the format property. ...

Sets the value of the format property.

Parameters

  • format : Number

    New value for the property.

Returns

  • void
Titanium.Media.AudioRecorder
( ) : void
Starts an audio recording. ...

Starts an audio recording.

Returns

  • void
Titanium.Media.AudioRecorder
( ) : Titanium.Filesystem.File
Stops the current audio recording and returns the recorded audio file. ...

Stops the current audio recording and returns the recorded audio file.

Returns