MediaRecorder

MEDIA_ERROR_SERVER_DIED

public static final int MEDIA_ERROR_SERVER_DIED

Media server died. In this case, the application must release the MediaRecorder object and instantiate a new one.

Constant Value: 100 (0x00000064)

MEDIA_RECORDER_ERROR_UNKNOWN

public static final int MEDIA_RECORDER_ERROR_UNKNOWN

Unspecified media recorder error.

Constant Value: 1 (0x00000001)

MEDIA_RECORDER_INFO_MAX_DURATION_REACHED

public static final int MEDIA_RECORDER_INFO_MAX_DURATION_REACHED

A maximum duration had been setup and has now been reached.

Constant Value: 800 (0x00000320)

MEDIA_RECORDER_INFO_MAX_FILESIZE_APPROACHING

public static final int MEDIA_RECORDER_INFO_MAX_FILESIZE_APPROACHING

A maximum filesize had been setup and current recorded file size has reached 90% of the limit. This is sent once per file upon reaching/passing the 90% limit. To continue the recording, applicaiton should use setNextOutputFile(File) to set the next output file. Otherwise, recording will stop when reaching maximum file size.

Constant Value: 802 (0x00000322)

MEDIA_RECORDER_INFO_MAX_FILESIZE_REACHED

public static final int MEDIA_RECORDER_INFO_MAX_FILESIZE_REACHED

A maximum filesize had been setup and has now been reached. Note: This event will not be sent if application already set next output file through setNextOutputFile(File).

Constant Value: 801 (0x00000321)

MEDIA_RECORDER_INFO_NEXT_OUTPUT_FILE_STARTED

public static final int MEDIA_RECORDER_INFO_NEXT_OUTPUT_FILE_STARTED

A maximum filesize had been reached and MediaRecorder has switched output to a new file set by application setNextOutputFile(File). For best practice, application should use this event to keep track of whether the file previously set has been used or not.

Constant Value: 803 (0x00000323)

MEDIA_RECORDER_INFO_UNKNOWN

public static final int MEDIA_RECORDER_INFO_UNKNOWN

Unspecified media recorder info.

Constant Value: 1 (0x00000001)

MediaRecorder

public MediaRecorder ()

This constructor is deprecated.
Use MediaRecorder(android.content.Context) instead

Default constructor.

MediaRecorder

public MediaRecorder (Context context)

Default constructor.

addOnRoutingChangedListener

public void addOnRoutingChangedListener (AudioRouting.OnRoutingChangedListener listener, 
                Handler handler)

Adds an AudioRouting.OnRoutingChangedListener to receive notifications of routing changes on this MediaRecorder.

getActiveMicrophones

public List<MicrophoneInfo> getActiveMicrophones ()

Return A lists of MicrophoneInfo representing the active microphones. By querying channel mapping for each active microphone, developer can know how the microphone is used by each channels or a capture stream.

getActiveRecordingConfiguration

public AudioRecordingConfiguration getActiveRecordingConfiguration ()

Returns the current active audio recording for this audio recorder.

getAudioSourceMax

public static final int getAudioSourceMax ()

Gets the maximum value for audio sources.

getLogSessionId

public LogSessionId getLogSessionId ()

Returns the LogSessionId for MediaRecorder.

getMaxAmplitude

public int getMaxAmplitude ()

Returns the maximum absolute amplitude that was sampled since the last call to this method. Call this only after the setAudioSource().

getMetrics

public PersistableBundle getMetrics ()

Return Metrics data about the current Mediarecorder instance.

getPreferredDevice

public AudioDeviceInfo getPreferredDevice ()

Returns the selected input device specified by setPreferredDevice(AudioDeviceInfo). Note that this is not guaranteed to correspond to the actual device being used for recording.

getRoutedDevice

public AudioDeviceInfo getRoutedDevice ()

Returns an AudioDeviceInfo identifying the current routing of this MediaRecorder Note: The query is only valid if the MediaRecorder is currently recording. If the recorder is not recording, the returned device can be null or correspond to previously selected device when the recorder was last active.

getSurface

public Surface getSurface ()

Gets the surface to record from when using SURFACE video source.

May only be called after prepare(). Frames rendered to the Surface before start() will be discarded.

isPrivacySensitive

public boolean isPrivacySensitive ()

Returns whether this MediaRecorder is marked as privacy sensitive or not with regard to audio capture.

See setPrivacySensitive(boolean)

pause

public void pause ()

Pauses recording. Call this after start(). You may resume recording with resume() without reconfiguration, as opposed to stop(). It does nothing if the recording is already paused. When the recording is paused and resumed, the resulting output would be as if nothing happend during paused period, immediately switching to the resumed scene.

prepare

public void prepare ()

Prepares the recorder to begin capturing and encoding data. This method must be called after setting up the desired audio and video sources, encoders, file format, etc., but before start().

registerAudioRecordingCallback

public void registerAudioRecordingCallback (Executor executor, 
                AudioManager.AudioRecordingCallback cb)

Register a callback to be notified of audio capture changes via a AudioManager.AudioRecordingCallback. A callback is received when the capture path configuration changes (pre-processing, format, sampling rate...) or capture is silenced/unsilenced by the system.

release

public void release ()

Releases resources associated with this MediaRecorder object. It is good practice to call this method when you're done using the MediaRecorder. In particular, whenever an Activity of an application is paused (its onPause() method is called), or stopped (its onStop() method is called), this method should be invoked to release the MediaRecorder object, unless the application has a special need to keep the object around. In addition to unnecessary resources (such as memory and instances of codecs) being held, failure to call this method immediately if a MediaRecorder object is no longer needed may also lead to continuous battery consumption for mobile devices, and recording failure for other applications if no multiple instances of the same codec are supported on a device. Even if multiple instances of the same codec are supported, some performance degradation may be expected when unnecessary multiple instances are used at the same time.

removeOnRoutingChangedListener

public void removeOnRoutingChangedListener (AudioRouting.OnRoutingChangedListener listener)

Removes an AudioRouting.OnRoutingChangedListener which has been previously added to receive rerouting notifications.

reset

public void reset ()

Restarts the MediaRecorder to its idle state. After calling this method, you will have to configure it again as if it had just been constructed.

resume

public void resume ()

Resumes recording. Call this after start(). It does nothing if the recording is not paused.

setAudioChannels

public void setAudioChannels (int numChannels)

Sets the number of audio channels for recording. Call this method before prepare(). Prepare() may perform additional checks on the parameter to make sure whether the specified number of audio channels are applicable.

setAudioEncoder

public void setAudioEncoder (int audio_encoder)

Sets the audio encoder to be used for recording. If this method is not called, the output file will not contain an audio track. Call this after setOutputFormat() but before prepare().

setAudioEncodingBitRate

public void setAudioEncodingBitRate (int bitRate)

Sets the audio encoding bit rate for recording. Call this method before prepare(). Prepare() may perform additional checks on the parameter to make sure whether the specified bit rate is applicable, and sometimes the passed bitRate will be clipped internally to ensure the audio recording can proceed smoothly based on the capabilities of the platform.

setAudioProfile

public void setAudioProfile (EncoderProfiles.AudioProfile profile)

Uses the settings from an AudioProfile for recording.

This method should be called after the video AND audio sources are set, and before setOutputFile().

This method can be used instead of setProfile(CamcorderProfile) when using EncoderProfiles.

setAudioSamplingRate

public void setAudioSamplingRate (int samplingRate)

Sets the audio sampling rate for recording. Call this method before prepare(). Prepare() may perform additional checks on the parameter to make sure whether the specified audio sampling rate is applicable. The sampling rate really depends on the format for the audio recording, as well as the capabilities of the platform. For instance, the sampling rate supported by AAC audio coding standard ranges from 8 to 96 kHz, the sampling rate supported by AMRNB is 8kHz, and the sampling rate supported by AMRWB is 16kHz. Please consult with the related audio coding standard for the supported audio sampling rate.

setAudioSource

public void setAudioSource (int audioSource)

Sets the audio source to be used for recording. If this method is not called, the output file will not contain an audio track. The source needs to be specified before setting recording-parameters or encoders. Call this only before setOutputFormat().

setCamera

public void setCamera (Camera c)

This method was deprecated in API level 21.
Use getSurface() and the android.hardware.camera2 API instead.

Sets a Camera to use for recording.

Use this function to switch quickly between preview and capture mode without a teardown of the camera object. Camera.unlock() should be called before this. Must call before prepare().

setCaptureRate

public void setCaptureRate (double fps)

Set video frame capture rate. This can be used to set a different video frame capture rate than the recorded video's playback rate. This method also sets the recording mode to time lapse. In time lapse video recording, only video is recorded. Audio related parameters are ignored when a time lapse recording session starts, if an application sets them.

setInputSurface

public void setInputSurface (Surface surface)

Configures the recorder to use a persistent surface when using SURFACE video source.

May only be called before prepare(). If called, getSurface() should not be used and will throw IllegalStateException. Frames rendered to the Surface before start() will be discarded.

setLocation

public void setLocation (float latitude, 
                float longitude)

Set and store the geodata (latitude and longitude) in the output file. This method should be called before prepare(). The geodata is stored in udta box if the output format is OutputFormat.THREE_GPP or OutputFormat.MPEG_4, and is ignored for other output formats. The geodata is stored according to ISO-6709 standard.

setLogSessionId

public void setLogSessionId (LogSessionId id)

Sets the LogSessionId for MediaRecorder.

The log session ID is a random 32-byte hexadecimal string that is used for monitoring the MediaRecorder performance.

setMaxDuration

public void setMaxDuration (int max_duration_ms)

Sets the maximum duration (in ms) of the recording session. Call this after setOutputFormat() but before prepare(). After recording reaches the specified duration, a notification will be sent to the MediaRecorder.OnInfoListener with a "what" code of MEDIA_RECORDER_INFO_MAX_DURATION_REACHED and recording will be stopped. Stopping happens asynchronously, there is no guarantee that the recorder will have stopped by the time the listener is notified.

When using MPEG-4 container (setOutputFormat(int) with OutputFormat#MPEG_4), it is recommended to set maximum duration that fits the use case. Setting a larger than required duration may result in a larger than needed output file because of space reserved for MOOV box expecting large movie data in this recording session. Unused space of MOOV box is turned into FREE box in the output file.

setMaxFileSize

public void setMaxFileSize (long max_filesize_bytes)

Sets the maximum filesize (in bytes) of the recording session. Call this after setOutputFormat() but before prepare(). After recording reaches the specified filesize, a notification will be sent to the MediaRecorder.OnInfoListener with a "what" code of MEDIA_RECORDER_INFO_MAX_FILESIZE_REACHED and recording will be stopped. Stopping happens asynchronously, there is no guarantee that the recorder will have stopped by the time the listener is notified.

When using MPEG-4 container (setOutputFormat(int) with OutputFormat#MPEG_4), it is recommended to set maximum filesize that fits the use case. Setting a larger than required filesize may result in a larger than needed output file because of space reserved for MOOV box expecting large movie data in this recording session. Unused space of MOOV box is turned into FREE box in the output file.

setNextOutputFile

public void setNextOutputFile (File file)

Sets the next output file to be used when the maximum filesize is reached on the prior output setOutputFile(File) or setNextOutputFile(File)). File should be seekable. After setting the next output file, application should not use the file until stop(). Application must call this after receiving on the MediaRecorder.OnInfoListener a "what" code of MEDIA_RECORDER_INFO_MAX_FILESIZE_APPROACHING and before receiving a "what" code of MEDIA_RECORDER_INFO_MAX_FILESIZE_REACHED. The file is not used until switching to that output. Application will receive MEDIA_RECORDER_INFO_NEXT_OUTPUT_FILE_STARTED when the next output file is used. Application will not be able to set a new output file if the previous one has not been used. Application is responsible for cleaning up unused files after stop() is called.

setNextOutputFile

public void setNextOutputFile (FileDescriptor fd)

Sets the next output file descriptor to be used when the maximum filesize is reached on the prior output setOutputFile(File) or setNextOutputFile(File)). File descriptor must be seekable and writable. After setting the next output file, application should not use the file referenced by this file descriptor until stop(). It is the application's responsibility to close the file descriptor. It is safe to do so as soon as this call returns. Application must call this after receiving on the MediaRecorder.OnInfoListener a "what" code of MEDIA_RECORDER_INFO_MAX_FILESIZE_APPROACHING and before receiving a "what" code of MEDIA_RECORDER_INFO_MAX_FILESIZE_REACHED. The file is not used until switching to that output. Application will receiveMEDIA_RECORDER_INFO_NEXT_OUTPUT_FILE_STARTED when the next output file is used. Application will not be able to set a new output file if the previous one has not been used. Application is responsible for cleaning up unused files after stop() is called.

setOnErrorListener

public void setOnErrorListener (MediaRecorder.OnErrorListener l)

Register a callback to be invoked when an error occurs while recording.

setOnInfoListener

public void setOnInfoListener (MediaRecorder.OnInfoListener listener)

Register a callback to be invoked when an informational event occurs while recording.

setOrientationHint

public void setOrientationHint (int degrees)

Sets the orientation hint for output video playback. This method should be called before prepare(). This method will not trigger the source video frame to rotate during video recording, but to add a composition matrix containing the rotation angle in the output video if the output format is OutputFormat.THREE_GPP or OutputFormat.MPEG_4 so that a video player can choose the proper orientation for playback. Note that some video players may choose to ignore the compostion matrix in a video during playback.

setOutputFile

public void setOutputFile (FileDescriptor fd)

Pass in the file descriptor of the file to be written. Call this after setOutputFormat() but before prepare().

setOutputFile

public void setOutputFile (String path)

Sets the path of the output file to be produced. Call this after setOutputFormat() but before prepare().

setOutputFile

public void setOutputFile (File file)

Pass in the file object to be written. Call this after setOutputFormat() but before prepare(). File should be seekable. After setting the next output file, application should not use the file until stop(). Application is responsible for cleaning up unused files after stop() is called.

setOutputFormat

public void setOutputFormat (int output_format)

Sets the format of the output file produced during recording. Call this after setAudioSource()/setVideoSource() but before prepare().

It is recommended to always use 3GP format when using the H.263 video encoder and AMR audio encoder. Using an MPEG-4 container format may confuse some desktop players.

setPreferredDevice

public boolean setPreferredDevice (AudioDeviceInfo deviceInfo)

Specifies an audio device (via an AudioDeviceInfo object) to route the input from this MediaRecorder.

setPreferredMicrophoneDirection

public boolean setPreferredMicrophoneDirection (int direction)

Specifies the logical microphone (for processing).

setPreferredMicrophoneFieldDimension

public boolean setPreferredMicrophoneFieldDimension (float zoom)

Specifies the zoom factor (i.e. the field dimension) for the selected microphone (for processing). The selected microphone is determined by the use-case for the stream.

setPreviewDisplay

public void setPreviewDisplay (Surface sv)

Sets a Surface to show a preview of recorded media (video). Calls this before prepare() to make sure that the desirable preview display is set. If setCamera(android.hardware.Camera) is used and the surface has been already set to the camera, application do not need to call this. If this is called with non-null surface, the preview surface of the camera will be replaced by the new surface. If this method is called with null surface or not called at all, media recorder will not change the preview surface of the camera.

setPrivacySensitive

public void setPrivacySensitive (boolean privacySensitive)

Indicates that this capture request is privacy sensitive and that any concurrent capture is not permitted.

The default is not privacy sensitive except when the audio source set with setAudioSource(int) is AudioSource#VOICE_COMMUNICATION or AudioSource#CAMCORDER.

Always takes precedence over default from audio source when set explicitly.

Using this API is only permitted when the audio source is one of:

• AudioSource#MIC
• AudioSource#CAMCORDER
• AudioSource#VOICE_RECOGNITION
• AudioSource#VOICE_COMMUNICATION
• AudioSource#UNPROCESSED
• AudioSource#VOICE_PERFORMANCE

Must be called after setAudioSource(int) and before setOutputFormat(int).

setProfile

public void setProfile (CamcorderProfile profile)

Uses the settings from a CamcorderProfile object for recording. This method should be called after the video AND audio sources are set, and before setOutputFile(). If a time lapse CamcorderProfile is used, audio related source or recording parameters are ignored.

setVideoEncoder

public void setVideoEncoder (int video_encoder)

Sets the video encoder to be used for recording. If this method is not called, the output file will not contain an video track. Call this after setOutputFormat() and before prepare().

setVideoEncodingBitRate

public void setVideoEncodingBitRate (int bitRate)

Sets the video encoding bit rate for recording. Call this method before prepare(). Prepare() may perform additional checks on the parameter to make sure whether the specified bit rate is applicable, and sometimes the passed bitRate will be clipped internally to ensure the video recording can proceed smoothly based on the capabilities of the platform.

NB: the actual bitrate and other encoding characteristics may be affected by the minimum quality floor behavior introduced in Build.VERSION_CODES.S. More detail on how and where this impacts video encoding can be found in the MediaCodec page and looking for "quality floor" (near the top of the page).

setVideoEncodingProfileLevel

public void setVideoEncodingProfileLevel (int profile, 
                int level)

Sets the desired video encoding profile and level for recording. The profile and level must be valid for the video encoder set by setVideoEncoder(int). This method can called before or after setVideoEncoder(int) but it must be called before prepare(). prepare() may perform additional checks on the parameter to make sure that the specified profile and level are applicable, and sometimes the passed profile or level will be discarded due to codec capablity or to ensure the video recording can proceed smoothly based on the capabilities of the platform.
Application can also use the MediaCodecInfo.CodecCapabilities#profileLevels to query applicable combination of profile and level for the corresponding format. Note that the requested profile/level may not be supported by the codec that is actually being used by this MediaRecorder instance.

setVideoFrameRate

public void setVideoFrameRate (int rate)

Sets the frame rate of the video to be captured. Must be called after setVideoSource(). Call this after setOutputFormat() but before prepare().

NOTE: On some devices that have auto-frame rate, this sets the maximum frame rate, not a constant frame rate. Actual frame rate will vary according to lighting conditions.

setVideoProfile

public void setVideoProfile (EncoderProfiles.VideoProfile profile)

Uses the settings from a VideoProfile object for recording.

This method should be called after the video AND audio sources are set, and before setOutputFile().

This method can be used instead of setProfile(CamcorderProfile) when using EncoderProfiles.

setVideoSize

public void setVideoSize (int width, 
                int height)

Sets the width and height of the video to be captured. Must be called after setVideoSource(). Call this after setOutputFormat() but before prepare().

setVideoSource

public void setVideoSource (int video_source)

Sets the video source to be used for recording. If this method is not called, the output file will not contain an video track. The source needs to be specified before setting recording-parameters or encoders. Call this only before setOutputFormat().

start

public void start ()

Begins capturing and encoding data to the file specified with setOutputFile(). Call this after prepare().

Since API level 13, if applications set a camera via setCamera(android.hardware.Camera), the apps can use the camera after this method call. The apps do not need to lock the camera again. However, if this method fails, the apps should still lock the camera back. The apps should not start another recording session during recording.

stop

public void stop ()

Stops recording. Call this after start(). Once recording is stopped, you will have to configure it again as if it has just been constructed. Note that a RuntimeException is intentionally thrown to the application, if no valid audio/video data has been received when stop() is called. This happens if stop() is called immediately after start(). The failure lets the application take action accordingly to clean up the output file (delete the output file, for instance), since the output file is not properly constructed when this happens.

unregisterAudioRecordingCallback

public void unregisterAudioRecordingCallback (AudioManager.AudioRecordingCallback cb)

Unregister an audio recording callback previously registered with registerAudioRecordingCallback(java.util.concurrent.Executor, android.media.AudioManager.AudioRecordingCallback).

finalize

protected void finalize ()

Called by the garbage collector on an object when garbage collection determines that there are no more references to the object. A subclass overrides the finalize method to dispose of system resources or to perform other cleanup.

The general contract of finalize is that it is invoked if and when the Java virtual machine has determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, except as a result of an action taken by the finalization of some other object or class which is ready to be finalized. The finalize method may take any action, including making this object available again to other threads; the usual purpose of finalize, however, is to perform cleanup actions before the object is irrevocably discarded. For example, the finalize method for an object that represents an input/output connection might perform explicit I/O transactions to break the connection before the object is permanently discarded.

The finalize method of class Object performs no special action; it simply returns normally. Subclasses of Object may override this definition.

The Java programming language does not guarantee which thread will invoke the finalize method for any given object. It is guaranteed, however, that the thread that invokes finalize will not be holding any user-visible synchronization locks when finalize is invoked. If an uncaught exception is thrown by the finalize method, the exception is ignored and finalization of that object terminates.

After the finalize method has been invoked for an object, no further action is taken until the Java virtual machine has again determined that there is no longer any means by which this object can be accessed by any thread that has not yet died, including possible actions by other objects or classes which are ready to be finalized, at which point the object may be discarded.

The finalize method is never invoked more than once by a Java virtual machine for any given object.

Any exception thrown by the finalize method causes the finalization of this object to be halted, but is otherwise ignored.