MediaRecorder

MEDIA_ERROR_SERVER_DIED

static val MEDIA_ERROR_SERVER_DIED: Int

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

Value: 100

MEDIA_RECORDER_ERROR_UNKNOWN

static val MEDIA_RECORDER_ERROR_UNKNOWN: Int

Unspecified media recorder error.

Value: 1

MEDIA_RECORDER_INFO_MAX_DURATION_REACHED

static val MEDIA_RECORDER_INFO_MAX_DURATION_REACHED: Int

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

Value: 800

MEDIA_RECORDER_INFO_MAX_FILESIZE_APPROACHING

static val MEDIA_RECORDER_INFO_MAX_FILESIZE_APPROACHING: Int

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 to set the next output file. Otherwise, recording will stop when reaching maximum file size.

Value: 802

MEDIA_RECORDER_INFO_MAX_FILESIZE_REACHED

static val MEDIA_RECORDER_INFO_MAX_FILESIZE_REACHED: Int

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.

Value: 801

MEDIA_RECORDER_INFO_NEXT_OUTPUT_FILE_STARTED

static val MEDIA_RECORDER_INFO_NEXT_OUTPUT_FILE_STARTED: Int

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

Value: 803

MEDIA_RECORDER_INFO_UNKNOWN

static val MEDIA_RECORDER_INFO_UNKNOWN: Int

Unspecified media recorder info.

Value: 1

MediaRecorder

MediaRecorder()

Deprecated: Use MediaRecorder(android.content.Context) instead

Default constructor.

MediaRecorder

MediaRecorder(context: Context)

Default constructor.

addOnRoutingChangedListener

open fun addOnRoutingChangedListener(
    listener: AudioRouting.OnRoutingChangedListener!, 
    handler: Handler!
): Unit

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

getActiveMicrophones

open fun getActiveMicrophones(): MutableList<MicrophoneInfo!>!

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

open fun getActiveRecordingConfiguration(): AudioRecordingConfiguration?

Returns the current active audio recording for this audio recorder.

getAudioSourceMax

static fun getAudioSourceMax(): Int

Gets the maximum value for audio sources.

getLogSessionId

open fun getLogSessionId(): LogSessionId

Returns the LogSessionId for MediaRecorder.

getMaxAmplitude

open fun getMaxAmplitude(): Int

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

getMetrics

open fun getMetrics(): PersistableBundle!

Return Metrics data about the current Mediarecorder instance.

getPreferredDevice

open fun getPreferredDevice(): AudioDeviceInfo!

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

getRoutedDevice

open fun getRoutedDevice(): AudioDeviceInfo!

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

open fun getSurface(): Surface!

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

open fun isPrivacySensitive(): Boolean

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

See setPrivacySensitive(boolean)

pause

open fun pause(): Unit

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

open fun prepare(): Unit

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

open fun registerAudioRecordingCallback(
    executor: Executor, 
    cb: AudioManager.AudioRecordingCallback
): Unit

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

open fun release(): Unit

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

open fun removeOnRoutingChangedListener(listener: AudioRouting.OnRoutingChangedListener!): Unit

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

reset

open fun reset(): Unit

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

open fun resume(): Unit

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

setAudioChannels

open fun setAudioChannels(numChannels: Int): Unit

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

open fun setAudioEncoder(audio_encoder: Int): Unit

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

open fun setAudioEncodingBitRate(bitRate: Int): Unit

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

open fun setAudioProfile(profile: EncoderProfiles.AudioProfile): Unit

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 when using EncoderProfiles.

setAudioSamplingRate

open fun setAudioSamplingRate(samplingRate: Int): Unit

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

open fun setAudioSource(audioSource: Int): Unit

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

open fun setCamera(c: Camera!): Unit

Deprecated: Use getSurface and the android.hardware.camera2 API instead.

Sets a android.hardware.Camera to use for recording.

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

setCaptureRate

open fun setCaptureRate(fps: Double): Unit

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

open fun setInputSurface(surface: Surface): Unit

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

open fun setLocation(
    latitude: Float, 
    longitude: Float
): Unit

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

open fun setLogSessionId(id: LogSessionId): Unit

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

open fun setMaxDuration(max_duration_ms: Int): Unit

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 android.media.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

open fun setMaxFileSize(max_filesize_bytes: Long): Unit

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 android.media.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

open fun setNextOutputFile(file: File!): Unit

Sets the next output file to be used when the maximum filesize is reached on the prior output #setOutputFile or #setNextOutputFile). 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 android.media.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

open fun setNextOutputFile(fd: FileDescriptor!): Unit

Sets the next output file descriptor to be used when the maximum filesize is reached on the prior output #setOutputFile or #setNextOutputFile). 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 android.media.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

open fun setOnErrorListener(l: MediaRecorder.OnErrorListener!): Unit

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

setOnInfoListener

open fun setOnInfoListener(listener: MediaRecorder.OnInfoListener!): Unit

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

setOrientationHint

open fun setOrientationHint(degrees: Int): Unit

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

open fun setOutputFile(file: File!): Unit

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.

setOutputFile

open fun setOutputFile(fd: FileDescriptor!): Unit

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

setOutputFile

open fun setOutputFile(path: String!): Unit

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

setOutputFormat

open fun setOutputFormat(output_format: Int): Unit

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

open fun setPreferredDevice(deviceInfo: AudioDeviceInfo!): Boolean

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

setPreferredMicrophoneDirection

open fun setPreferredMicrophoneDirection(direction: Int): Boolean

Specifies the logical microphone (for processing).

setPreferredMicrophoneFieldDimension

open fun setPreferredMicrophoneFieldDimension(zoom: Float): Boolean

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

open fun setPreviewDisplay(sv: Surface!): Unit

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

open fun setPrivacySensitive(privacySensitive: Boolean): Unit

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

open fun setProfile(profile: CamcorderProfile!): Unit

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

open fun setVideoEncoder(video_encoder: Int): Unit

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

open fun setVideoEncodingBitRate(bitRate: Int): Unit

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 android.os.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

open fun setVideoEncodingProfileLevel(
    profile: Int, 
    level: Int
): Unit

Sets the desired video encoding profile and level for recording. The profile and level must be valid for the video encoder set by setVideoEncoder. This method can called before or after setVideoEncoder 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

open fun setVideoFrameRate(rate: Int): Unit

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

open fun setVideoProfile(profile: EncoderProfiles.VideoProfile): Unit

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 when using EncoderProfiles.

setVideoSize

open fun setVideoSize(
    width: Int, 
    height: Int
): Unit

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

setVideoSource

open fun setVideoSource(video_source: Int): Unit

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

open fun start(): Unit

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

open fun stop(): Unit

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

open fun unregisterAudioRecordingCallback(cb: AudioManager.AudioRecordingCallback): Unit

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

finalize

protected open fun finalize(): Unit