CamcorderProfile
open class CamcorderProfile
kotlin.Any | |
↳ | android.media.CamcorderProfile |
Retrieves the predefined camcorder profile settings for camcorder applications. These settings are read-only.
The compressed output from a recording session with a given CamcorderProfile contains two tracks: one for audio and one for video.
Each profile specifies the following set of parameters:
- The file output format
- Video codec format
- Video bit rate in bits per second
- Video frame rate in frames per second
- Video frame width and height,
- Audio codec format
- Audio bit rate in bits per second,
- Audio sample rate
- Number of audio channels for recording.
Summary
Constants | |
---|---|
static Int |
Quality level corresponding to the 1080p (1920 x 1080) resolution. |
static Int |
Quality level corresponding to the 2160p (3840x2160) resolution. |
static Int |
Quality level corresponding to 2K (2048 x 1080) resolution |
static Int |
Quality level corresponding to the 480p (720 x 480) resolution. |
static Int |
Quality level corresponding to 4k-DCI (4096 x 2160) resolution. |
static Int |
Quality level corresponding to the 720p (1280 x 720) resolution. |
static Int |
Quality level corresponding to 8K UHD (7680 x 4320) resolution |
static Int |
Quality level corresponding to the cif (352 x 288) resolution. |
static Int |
Quality level corresponding to the highest available resolution. |
static Int |
High speed ( >= 100fps) quality level corresponding to the 1080p (1920 x 1080 or 1920x1088) resolution. |
static Int |
High speed ( >= 100fps) quality level corresponding to the 2160p (3840 x 2160) resolution. |
static Int |
High speed ( >= 100fps) quality level corresponding to the 480p (720 x 480) resolution. |
static Int |
High speed ( >= 100fps) quality level corresponding to the 4K-DCI (4096 x 2160) |
static Int |
High speed ( >= 100fps) quality level corresponding to the 720p (1280 x 720) resolution. |
static Int |
High speed ( >= 100fps) quality level corresponding to the CIF (352 x 288) |
static Int |
High speed ( >= 100fps) quality level corresponding to the highest available resolution. |
static Int |
High speed ( >= 100fps) quality level corresponding to the lowest available resolution. |
static Int |
High speed ( >= 100fps) quality level corresponding to the VGA (640 x 480) |
static Int |
Quality level corresponding to the lowest available resolution. |
static Int |
Quality level corresponding to the qcif (176 x 144) resolution. |
static Int |
Quality level corresponding to QHD (2560 x 1440) resolution |
static Int |
Quality level corresponding to the QVGA (320x240) resolution. |
static Int |
Time lapse quality level corresponding to the 1080p (1920 x 1088) resolution. |
static Int |
Time lapse quality level corresponding to the 2160p (3840 x 2160) resolution. |
static Int |
Time lapse quality level corresponding to the 2K (2048 x 1080) resolution. |
static Int |
Time lapse quality level corresponding to the 480p (720 x 480) resolution. |
static Int |
Time lapse quality level corresponding to the 4k-DCI (4096 x 2160) resolution. |
static Int |
Time lapse quality level corresponding to the 720p (1280 x 720) resolution. |
static Int |
Time lapse quality level corresponding to the 8K UHD (7680 x 4320) resolution. |
static Int |
Time lapse quality level corresponding to the cif (352 x 288) resolution. |
static Int |
Time lapse quality level corresponding to the highest available resolution. |
static Int |
Time lapse quality level corresponding to the lowest available resolution. |
static Int |
Time lapse quality level corresponding to the qcif (176 x 144) resolution. |
static Int |
Time lapse quality level corresponding to the QHD (2560 x 1440) resolution. |
static Int |
Time lapse quality level corresponding to the QVGA (320 x 240) resolution. |
static Int |
Time lapse quality level corresponding to the VGA (640 x 480) resolution. |
static Int |
Quality level corresponding to the VGA (640 x 480) resolution. |
Public methods | |
---|---|
open static CamcorderProfile! |
Returns the default camcorder profile at the given quality level for the first back-facing camera on the device. |
open static CamcorderProfile! |
Returns the default camcorder profile for the given camera at the given quality level. |
open static EncoderProfiles? |
Returns all encoder profiles of a camcorder profile for the given camera at the given quality level. |
open static Boolean |
hasProfile(quality: Int) Returns true if a camcorder profile exists for the first back-facing camera at the given quality level. |
open static Boolean |
hasProfile(cameraId: Int, quality: Int) Returns true if a camcorder profile exists for the given camera at the given quality level. |
Properties | |
---|---|
Int |
The target audio output bit rate in bits per second |
Int |
The number of audio channels used for the audio track |
Int |
The audio encoder being used for the audio track. |
Int |
The audio sampling rate used for the audio track |
Int |
Default recording duration in seconds before the session is terminated. |
Int |
The file output format of the camcorder profile |
Int |
The quality level of the camcorder profile |
Int |
The target video output bit rate in bits per second |
Int |
The video encoder being used for the video track |
Int |
The target video frame height in pixels |
Int |
The target video frame rate in frames per second. |
Int |
The target video frame width in pixels |
Constants
QUALITY_1080P
static val QUALITY_1080P: Int
Quality level corresponding to the 1080p (1920 x 1080) resolution. Note that the vertical resolution for 1080p can also be 1088, instead of 1080 (used by some vendors to avoid cropping during video playback).
Value: 6
QUALITY_2160P
static val QUALITY_2160P: Int
Quality level corresponding to the 2160p (3840x2160) resolution.
Value: 8
QUALITY_2K
static val QUALITY_2K: Int
Quality level corresponding to 2K (2048 x 1080) resolution
Value: 12
QUALITY_480P
static val QUALITY_480P: Int
Quality level corresponding to the 480p (720 x 480) resolution. Note that the horizontal resolution for 480p can also be other values, such as 640 or 704, instead of 720.
Value: 4
QUALITY_4KDCI
static val QUALITY_4KDCI: Int
Quality level corresponding to 4k-DCI (4096 x 2160) resolution.
Value: 10
QUALITY_720P
static val QUALITY_720P: Int
Quality level corresponding to the 720p (1280 x 720) resolution.
Value: 5
QUALITY_8KUHD
static val QUALITY_8KUHD: Int
Quality level corresponding to 8K UHD (7680 x 4320) resolution
Value: 13
QUALITY_CIF
static val QUALITY_CIF: Int
Quality level corresponding to the cif (352 x 288) resolution.
Value: 3
QUALITY_HIGH
static val QUALITY_HIGH: Int
Quality level corresponding to the highest available resolution.
Value: 1
QUALITY_HIGH_SPEED_1080P
static val QUALITY_HIGH_SPEED_1080P: Int
High speed ( >= 100fps) quality level corresponding to the 1080p (1920 x 1080 or 1920x1088) resolution.
Value: 2004
QUALITY_HIGH_SPEED_2160P
static val QUALITY_HIGH_SPEED_2160P: Int
High speed ( >= 100fps) quality level corresponding to the 2160p (3840 x 2160) resolution.
Value: 2005
QUALITY_HIGH_SPEED_480P
static val QUALITY_HIGH_SPEED_480P: Int
High speed ( >= 100fps) quality level corresponding to the 480p (720 x 480) resolution. Note that the horizontal resolution for 480p can also be other values, such as 640 or 704, instead of 720.
Value: 2002
QUALITY_HIGH_SPEED_4KDCI
static val QUALITY_HIGH_SPEED_4KDCI: Int
High speed ( >= 100fps) quality level corresponding to the 4K-DCI (4096 x 2160)
Value: 2008
QUALITY_HIGH_SPEED_720P
static val QUALITY_HIGH_SPEED_720P: Int
High speed ( >= 100fps) quality level corresponding to the 720p (1280 x 720) resolution.
Value: 2003
QUALITY_HIGH_SPEED_CIF
static val QUALITY_HIGH_SPEED_CIF: Int
High speed ( >= 100fps) quality level corresponding to the CIF (352 x 288)
Value: 2006
QUALITY_HIGH_SPEED_HIGH
static val QUALITY_HIGH_SPEED_HIGH: Int
High speed ( >= 100fps) quality level corresponding to the highest available resolution.
Value: 2001
QUALITY_HIGH_SPEED_LOW
static val QUALITY_HIGH_SPEED_LOW: Int
High speed ( >= 100fps) quality level corresponding to the lowest available resolution.
For all the high speed profiles defined below ((from QUALITY_HIGH_SPEED_LOW
to QUALITY_HIGH_SPEED_2160P
), they are similar as normal recording profiles, with just higher output frame rate and bit rate. Therefore, setting these profiles with MediaRecorder#setProfile
without specifying any other encoding parameters will produce high speed videos rather than slow motion videos that have different capture and output (playback) frame rates. To record slow motion videos, the application must set video output (playback) frame rate and bit rate appropriately via MediaRecorder#setVideoFrameRate
and MediaRecorder#setVideoEncodingBitRate
based on the slow motion factor. If the application intends to do the video recording with MediaCodec
encoder, it must set each individual field of MediaFormat
similarly according to this CamcorderProfile.
Value: 2000
QUALITY_HIGH_SPEED_VGA
static val QUALITY_HIGH_SPEED_VGA: Int
High speed ( >= 100fps) quality level corresponding to the VGA (640 x 480)
Value: 2007
QUALITY_LOW
static val QUALITY_LOW: Int
Quality level corresponding to the lowest available resolution.
Value: 0
QUALITY_QCIF
static val QUALITY_QCIF: Int
Quality level corresponding to the qcif (176 x 144) resolution.
Value: 2
QUALITY_QHD
static val QUALITY_QHD: Int
Quality level corresponding to QHD (2560 x 1440) resolution
Value: 11
QUALITY_QVGA
static val QUALITY_QVGA: Int
Quality level corresponding to the QVGA (320x240) resolution.
Value: 7
QUALITY_TIME_LAPSE_1080P
static val QUALITY_TIME_LAPSE_1080P: Int
Time lapse quality level corresponding to the 1080p (1920 x 1088) resolution.
Value: 1006
QUALITY_TIME_LAPSE_2160P
static val QUALITY_TIME_LAPSE_2160P: Int
Time lapse quality level corresponding to the 2160p (3840 x 2160) resolution.
Value: 1008
QUALITY_TIME_LAPSE_2K
static val QUALITY_TIME_LAPSE_2K: Int
Time lapse quality level corresponding to the 2K (2048 x 1080) resolution.
Value: 1012
QUALITY_TIME_LAPSE_480P
static val QUALITY_TIME_LAPSE_480P: Int
Time lapse quality level corresponding to the 480p (720 x 480) resolution.
Value: 1004
QUALITY_TIME_LAPSE_4KDCI
static val QUALITY_TIME_LAPSE_4KDCI: Int
Time lapse quality level corresponding to the 4k-DCI (4096 x 2160) resolution.
Value: 1010
QUALITY_TIME_LAPSE_720P
static val QUALITY_TIME_LAPSE_720P: Int
Time lapse quality level corresponding to the 720p (1280 x 720) resolution.
Value: 1005
QUALITY_TIME_LAPSE_8KUHD
static val QUALITY_TIME_LAPSE_8KUHD: Int
Time lapse quality level corresponding to the 8K UHD (7680 x 4320) resolution.
Value: 1013
QUALITY_TIME_LAPSE_CIF
static val QUALITY_TIME_LAPSE_CIF: Int
Time lapse quality level corresponding to the cif (352 x 288) resolution.
Value: 1003
QUALITY_TIME_LAPSE_HIGH
static val QUALITY_TIME_LAPSE_HIGH: Int
Time lapse quality level corresponding to the highest available resolution.
Value: 1001
QUALITY_TIME_LAPSE_LOW
static val QUALITY_TIME_LAPSE_LOW: Int
Time lapse quality level corresponding to the lowest available resolution.
Value: 1000
QUALITY_TIME_LAPSE_QCIF
static val QUALITY_TIME_LAPSE_QCIF: Int
Time lapse quality level corresponding to the qcif (176 x 144) resolution.
Value: 1002
QUALITY_TIME_LAPSE_QHD
static val QUALITY_TIME_LAPSE_QHD: Int
Time lapse quality level corresponding to the QHD (2560 x 1440) resolution.
Value: 1011
QUALITY_TIME_LAPSE_QVGA
static val QUALITY_TIME_LAPSE_QVGA: Int
Time lapse quality level corresponding to the QVGA (320 x 240) resolution.
Value: 1007
QUALITY_TIME_LAPSE_VGA
static val QUALITY_TIME_LAPSE_VGA: Int
Time lapse quality level corresponding to the VGA (640 x 480) resolution.
Value: 1009
QUALITY_VGA
static val QUALITY_VGA: Int
Quality level corresponding to the VGA (640 x 480) resolution.
Value: 9
Public methods
get
open static funget(quality: Int): CamcorderProfile!
Deprecated: Use getAll
instead
Returns the default camcorder profile at the given quality level for the first back-facing camera on the device. If the device has no back-facing camera, this returns null.
Parameters | |
---|---|
quality |
Int: the target quality level for the camcorder profile |
See Also
get
open static funget(
cameraId: Int,
quality: Int
): CamcorderProfile!
Deprecated: Use getAll
instead
Returns the default camcorder profile for the given camera at the given quality level. Quality levels QUALITY_LOW, QUALITY_HIGH are guaranteed to be supported, while other levels may or may not be supported. The supported levels can be checked using hasProfile(int,int)
. QUALITY_LOW refers to the lowest quality available, while QUALITY_HIGH refers to the highest quality available. QUALITY_LOW/QUALITY_HIGH have to match one of qcif, cif, 480p, 720p, 1080p or 2160p. E.g. if the device supports 480p, 720p, 1080p and 2160p, then low is 480p and high is 2160p. The same is true for time lapse quality levels, i.e. QUALITY_TIME_LAPSE_LOW, QUALITY_TIME_LAPSE_HIGH are guaranteed to be supported and have to match one of qcif, cif, 480p, 720p, 1080p, or 2160p. For high speed quality levels, they may or may not be supported. If a subset of the levels are supported, QUALITY_HIGH_SPEED_LOW and QUALITY_HIGH_SPEED_HIGH are guaranteed to be supported and have to match one of 480p, 720p, or 1080p. A camcorder recording session with higher quality level usually has higher output bit rate, better video and/or audio recording quality, larger video frame resolution and higher audio sampling rate, etc, than those with lower quality level.
Parameters | |
---|---|
cameraId |
Int: the id for the camera. Integer camera ids parsed from the list received by invoking CameraManager#getCameraIdList can be used as long as they are CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE and not EXTERNAL . |
quality |
Int: the target quality level for the camcorder profile. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if quality is not one of the defined QUALITY_ values. |
See Also
#QUALITY_LOW
#QUALITY_HIGH
#QUALITY_QCIF
#QUALITY_CIF
#QUALITY_480P
#QUALITY_720P
#QUALITY_1080P
#QUALITY_2160P
#QUALITY_TIME_LAPSE_LOW
#QUALITY_TIME_LAPSE_HIGH
#QUALITY_TIME_LAPSE_QCIF
#QUALITY_TIME_LAPSE_CIF
#QUALITY_TIME_LAPSE_480P
#QUALITY_TIME_LAPSE_720P
#QUALITY_TIME_LAPSE_1080P
#QUALITY_TIME_LAPSE_2160P
#QUALITY_HIGH_SPEED_LOW
#QUALITY_HIGH_SPEED_HIGH
#QUALITY_HIGH_SPEED_480P
#QUALITY_HIGH_SPEED_720P
#QUALITY_HIGH_SPEED_1080P
#QUALITY_HIGH_SPEED_2160P
getAll
open static fun getAll(
cameraId: String,
quality: Int
): EncoderProfiles?
Returns all encoder profiles of a camcorder profile for the given camera at the given quality level.
Quality levels QUALITY_LOW, QUALITY_HIGH are guaranteed to be supported, while other levels may or may not be supported. The supported levels can be checked using hasProfile(int,int)
. QUALITY_LOW refers to the lowest quality available, while QUALITY_HIGH refers to the highest quality available. QUALITY_LOW/QUALITY_HIGH have to match one of qcif, cif, 480p, 720p, 1080p or 2160p. E.g. if the device supports 480p, 720p, 1080p and 2160p, then low is 480p and high is 2160p.
The same is true for time lapse quality levels, i.e. QUALITY_TIME_LAPSE_LOW, QUALITY_TIME_LAPSE_HIGH are guaranteed to be supported and have to match one of qcif, cif, 480p, 720p, 1080p, or 2160p.
For high speed quality levels, they may or may not be supported. If a subset of the levels are supported, QUALITY_HIGH_SPEED_LOW and QUALITY_HIGH_SPEED_HIGH are guaranteed to be supported and have to match one of 480p, 720p, or 1080p.
A camcorder recording session with higher quality level usually has higher output bit rate, better video and/or audio recording quality, larger video frame resolution and higher audio sampling rate, etc, than those with lower quality level.
Note: as of Android TIRAMISU
, this method can return advanced encoder profiles.
Apps targeting Build.VERSION_CODES#S_V2
or before will only receive basic video encoder profiles that use output YUV 4:2:0 8-bit content. Apps targeting Build.VERSION_CODES#TIRAMISU
or above will also receive advanced video encoder profiles that may output 10-bit, YUV 4:2:2/4:4:4 or HDR content.
Return | |
---|---|
EncoderProfiles? |
null if there are no encoder profiles defined for the quality level for the given camera. |
Exceptions | |
---|---|
java.lang.IllegalArgumentException |
if quality is not one of the defined QUALITY_ values. |
See Also
#QUALITY_LOW
#QUALITY_HIGH
#QUALITY_QCIF
#QUALITY_CIF
#QUALITY_480P
#QUALITY_720P
#QUALITY_1080P
#QUALITY_2160P
#QUALITY_TIME_LAPSE_LOW
#QUALITY_TIME_LAPSE_HIGH
#QUALITY_TIME_LAPSE_QCIF
#QUALITY_TIME_LAPSE_CIF
#QUALITY_TIME_LAPSE_480P
#QUALITY_TIME_LAPSE_720P
#QUALITY_TIME_LAPSE_1080P
#QUALITY_TIME_LAPSE_2160P
#QUALITY_HIGH_SPEED_LOW
#QUALITY_HIGH_SPEED_HIGH
#QUALITY_HIGH_SPEED_480P
#QUALITY_HIGH_SPEED_720P
#QUALITY_HIGH_SPEED_1080P
#QUALITY_HIGH_SPEED_2160P
hasProfile
open static fun hasProfile(quality: Int): Boolean
Returns true if a camcorder profile exists for the first back-facing camera at the given quality level.
When using the Camera 2 API in LEGACY
mode (i.e. when android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
is set to android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY
), #hasProfile may return true
for unsupported resolutions. To ensure a a given resolution is supported in LEGACY mode, the configuration given in android.hardware.camera2.CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
must contain the the resolution in the supported output sizes. The recommended way to check this is with android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes(Class)
with the class of the desired recording endpoint, and check that the desired resolution is contained in the list returned.
Parameters | |
---|---|
quality |
Int: the target quality level for the camcorder profile |
hasProfile
open static fun hasProfile(
cameraId: Int,
quality: Int
): Boolean
Returns true if a camcorder profile exists for the given camera at the given quality level.
When using the Camera 2 API in LEGACY mode (i.e. when android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL
is set to android.hardware.camera2.CameraCharacteristics#INFO_SUPPORTED_HARDWARE_LEVEL_LEGACY
), #hasProfile may return true
for unsupported resolutions. To ensure a a given resolution is supported in LEGACY mode, the configuration given in android.hardware.camera2.CameraCharacteristics#SCALER_STREAM_CONFIGURATION_MAP
must contain the the resolution in the supported output sizes. The recommended way to check this is with android.hardware.camera2.params.StreamConfigurationMap#getOutputSizes(Class)
with the class of the desired recording endpoint, and check that the desired resolution is contained in the list returned.
Parameters | |
---|---|
cameraId |
Int: the id for the camera. Integer camera ids parsed from the list received by invoking CameraManager#getCameraIdList can be used as long as they are CameraMetadata#REQUEST_AVAILABLE_CAPABILITIES_BACKWARD_COMPATIBLE and not EXTERNAL . |
quality |
Int: the target quality level for the camcorder profile |
Properties
audioBitRate
var audioBitRate: Int
The target audio output bit rate in bits per second
audioChannels
var audioChannels: Int
The number of audio channels used for the audio track
audioCodec
var audioCodec: Int
The audio encoder being used for the audio track.
audioSampleRate
var audioSampleRate: Int
The audio sampling rate used for the audio track
duration
var duration: Int
Default recording duration in seconds before the session is terminated. This is useful for applications like MMS has limited file size requirement.
videoBitRate
var videoBitRate: Int
The target video output bit rate in bits per second
This is the target recorded video output bit rate if the application configures the video recording via MediaRecorder#setProfile
without specifying any other MediaRecorder
encoding parameters. For example, for high speed quality profiles (from QUALITY_HIGH_SPEED_LOW
to QUALITY_HIGH_SPEED_2160P
), this is the bit rate where the video is recorded with. If the application intends to record slow motion videos with the high speed quality profiles, it must set a different video bit rate that is corresponding to the desired recording output bit rate (i.e., the encoded video bit rate during normal playback) via MediaRecorder#setVideoEncodingBitRate
. For example, if QUALITY_HIGH_SPEED_720P
advertises 240fps videoFrameRate
and 64Mbps videoBitRate
in the high speed CamcorderProfile, and the application intends to record 1/8 factor slow motion recording videos, the application must set 30fps via MediaRecorder#setVideoFrameRate
and 8Mbps ( videoBitRate
* slow motion factor) via MediaRecorder#setVideoEncodingBitRate
. Failing to do so will result in videos with unexpected frame rate and bit rate, or MediaRecorder
error if the output bit rate exceeds the encoder limit. If the application intends to do the video recording with MediaCodec
encoder, it must set each individual field of MediaFormat
similarly according to this CamcorderProfile.
videoCodec
var videoCodec: Int
The video encoder being used for the video track
videoFrameHeight
var videoFrameHeight: Int
The target video frame height in pixels
videoFrameRate
var videoFrameRate: Int
The target video frame rate in frames per second.
This is the target recorded video output frame rate per second if the application configures the video recording via MediaRecorder#setProfile
without specifying any other MediaRecorder
encoding parameters. For example, for high speed quality profiles (from QUALITY_HIGH_SPEED_LOW
to QUALITY_HIGH_SPEED_2160P
), this is the frame rate where the video is recorded and played back with. If the application intends to create slow motion use case with the high speed quality profiles, it must set a different video frame rate that is corresponding to the desired output (playback) frame rate via MediaRecorder#setVideoFrameRate
. For example, if QUALITY_HIGH_SPEED_720P
advertises 240fps videoFrameRate
in the CamcorderProfile, and the application intends to create 1/8 factor slow motion recording videos, the application must set 30fps via MediaRecorder#setVideoFrameRate
. Failing to do so will result in high speed videos with normal speed playback frame rate (240fps for above example). If the application intends to do the video recording with MediaCodec
encoder, it must set each individual field of MediaFormat
similarly according to this CamcorderProfile.
videoFrameWidth
var videoFrameWidth: Int
The target video frame width in pixels