Recorder.Builder
public final class Recorder.Builder
Builder class for Recorder objects.
Summary
Public constructors |
|---|
Builder()Constructor for |
Public methods |
|
|---|---|
@NonNull Recorder |
build()Builds the |
@NonNull Recorder.Builder |
setAspectRatio(int aspectRatio)Sets the video aspect ratio of this Recorder. |
@NonNull Recorder.Builder |
setExecutor(@NonNull Executor executor)Sets the |
@NonNull Recorder.Builder |
setQualitySelector(@NonNull QualitySelector qualitySelector)Sets the |
@NonNull Recorder.Builder |
setTargetVideoEncodingBitRate(@IntRange(from = 1) int bitrate)Sets the intended video encoding bitrate for recording. |
@NonNull Recorder.Builder |
setVideoCapabilitiesSource(int videoCapabilitiesSource)Sets the video capabilities source. |
Public constructors
Public methods
build
public @NonNull Recorder build()
Builds the Recorder instance.
The {code build()} method can be called multiple times, generating a new Recorder instance each time. The returned instance is configured with the options set on this builder.
setAspectRatio
public @NonNull Recorder.Builder setAspectRatio(int aspectRatio)
Sets the video aspect ratio of this Recorder.
The final video resolution will be based on the input aspect ratio and the QualitySelector in setQualitySelector. Both settings will be respected. For example, if the aspect ratio is 4:3 and the preferred quality in QualitySelector is HD, then a HD quality resolution with 4:3 aspect ratio such as 1280x960 or 960x720 will be used. CameraX will choose an appropriate one depending on the resolutions supported by the camera and the codec capabilities. With this setting, no other aspect ratios (such as 16:9) will be used, nor any other qualities (such as UHD, FHD and SD). If no resolution with the settings can be found, it will fail to bind VideoCapture. Therefore, a recommended way is to provide a flexible QualitySelector if there is no specific video quality requirement, such as the setting in DEFAULT_QUALITY_SELECTOR.
The default value is RATIO_DEFAULT. If no aspect ratio is set, the selected resolution will be based only on the QualitySelector.
| Parameters | |
|---|---|
int aspectRatio |
the aspect ratio. Possible values are |
| See also | |
|---|---|
setQualitySelector |
setExecutor
public @NonNull Recorder.Builder setExecutor(@NonNull Executor executor)
Sets the Executor that runs the Recorder background task.
The executor is used to run the Recorder tasks, the audio encoding and the video encoding. For the best performance, it's recommended to be an Executor that is capable of running at least two tasks concurrently, such as a java.util.concurrent.ThreadPoolExecutor backed by 2 or more threads.
If not set, the Recorder will be run on the IO executor internally managed by CameraX.
setQualitySelector
public @NonNull Recorder.Builder setQualitySelector(@NonNull QualitySelector qualitySelector)
Sets the QualitySelector of this Recorder.
The provided quality selector is used to select the resolution of the recording depending on the resolutions supported by the camera and codec capabilities.
If no quality selector is provided, the default is DEFAULT_QUALITY_SELECTOR.
setAspectRatio can be used with to specify the intended video aspect ratio.
| See also | |
|---|---|
QualitySelector |
|
setAspectRatio |
setTargetVideoEncodingBitRate
public @NonNull Recorder.Builder setTargetVideoEncodingBitRate(@IntRange(from = 1) int bitrate)
Sets the intended video encoding bitrate for recording.
The target video encoding bitrate attempts to keep the actual video encoding bitrate close to the requested bitrate. Bitrate may vary during a recording depending on the scene being recorded.
Additional checks will be performed on the requested bitrate to make sure the specified bitrate is applicable, and sometimes the passed bitrate will be changed internally to ensure the video recording can proceed smoothly based on the capabilities of the platform.
This API only affects the video stream and should not be considered the target for the entire recording. The audio stream's bitrate is not affected by this API.
If this method isn't called, an appropriate bitrate for normal video recording is selected by default. Only call this method if a custom bitrate is desired.
| Parameters | |
|---|---|
@IntRange(from = 1) int bitrate |
the target video encoding bitrate in bits per second. |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if bitrate is 0 or less. |
setVideoCapabilitiesSource
public @NonNull Recorder.Builder setVideoCapabilitiesSource(int videoCapabilitiesSource)
Sets the video capabilities source.
Possible values include VIDEO_CAPABILITIES_SOURCE_CAMCORDER_PROFILE and VIDEO_CAPABILITIES_SOURCE_CODEC_CAPABILITIES. The final selected quality from the QualitySelector will be affected by the source. See the document of the constants for more detail.
VIDEO_CAPABILITIES_SOURCE_CAMCORDER_PROFILE will be the default if not set.
| Parameters | |
|---|---|
int videoCapabilitiesSource |
the video capabilities source. |
| Returns | |
|---|---|
@NonNull Recorder.Builder |
the builder instance. |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if videoCapabilitiesSource is not one of the possible values. |