VideoCaptureLegacyConfig

@RequiresApi(21) class VideoCaptureLegacyConfig : UseCaseConfig<VideoCaptureLegacy!>, ImageOutputConfig, ThreadConfig
kotlin.Any
   ↳ androidx.camera.video.impl.VideoCaptureLegacyConfig

Config for a video capture use case.

In the earlier stage, the VideoCaptureLegacy is deprioritized.

Summary

Inherited constants
Public constructors

Public methods
Int
getAudioBitRate(valueIfMissing: Int)

Returns the audio encoding bit rate.

Int

Returns the audio encoding bit rate.

Int
getAudioChannelCount(valueIfMissing: Int)

Returns the audio channel count.

Int

Returns the audio channel count.

Int
getAudioMinBufferSize(valueIfMissing: Int)

Returns the audio minimum buffer size, in bytes.

Int

Returns the audio minimum buffer size, in bytes.

Int
getAudioRecordSource(valueIfMissing: Int)

Returns the audio recording source.

Int

Returns the audio recording source.

Int
getAudioSampleRate(valueIfMissing: Int)

Returns the audio sample rate.

Int

Returns the audio sample rate.

Int
getBitRate(valueIfMissing: Int)

Returns the encoding bit rate.

Int

Returns the encoding bit rate.

Config

Int
getIFrameInterval(valueIfMissing: Int)

Returns the number of seconds between each key frame.

Int

Returns the number of seconds between each key frame.

Int

Retrieves the format of the image that is fed as input.

Int
getVideoFrameRate(valueIfMissing: Int)

Returns the recording frames per second.

Int

Returns the recording frames per second.

Inherited functions
Properties
static Config.Option<Int!>!

static Config.Option<Int!>!

static Config.Option<Int!>!

static Config.Option<Int!>!

static Config.Option<Int!>!

static Config.Option<Int!>!

static Config.Option<Int!>!

static Config.Option<Int!>!

Inherited properties

Public constructors

VideoCaptureLegacyConfig

VideoCaptureLegacyConfig(@NonNull config: OptionsBundle)

Public methods

getAudioBitRate

fun getAudioBitRate(valueIfMissing: Int): Int

Returns the audio encoding bit rate.

Parameters
valueIfMissing Int: The value to return if this configuration option has not been set.
Return
Int The stored value or valueIfMissing if the value does not exist in this configuration.

getAudioBitRate

fun getAudioBitRate(): Int

Returns the audio encoding bit rate.

Return
Int The stored value, if it exists in this configuration.
Exceptions
IllegalArgumentException if the option does not exist in this configuration.

getAudioChannelCount

fun getAudioChannelCount(valueIfMissing: Int): Int

Returns the audio channel count.

Parameters
valueIfMissing Int: The value to return if this configuration option has not been set.
Return
Int The stored value or valueIfMissing if the value does not exist in this configuration.

getAudioChannelCount

fun getAudioChannelCount(): Int

Returns the audio channel count.

Return
Int The stored value, if it exists in this configuration.
Exceptions
IllegalArgumentException if the option does not exist in this configuration.

getAudioMinBufferSize

fun getAudioMinBufferSize(valueIfMissing: Int): Int

Returns the audio minimum buffer size, in bytes.

Parameters
valueIfMissing Int: The value to return if this configuration option has not been set.
Return
Int The stored value or valueIfMissing if the value does not exist in this configuration.

getAudioMinBufferSize

fun getAudioMinBufferSize(): Int

Returns the audio minimum buffer size, in bytes.

Return
Int The stored value, if it exists in this configuration.
Exceptions
IllegalArgumentException if the option does not exist in this configuration.

getAudioRecordSource

fun getAudioRecordSource(valueIfMissing: Int): Int

Returns the audio recording source.

Parameters
valueIfMissing Int: The value to return if this configuration option has not been set.
Return
Int The stored value or valueIfMissing if the value does not exist in this configuration.

getAudioRecordSource

fun getAudioRecordSource(): Int

Returns the audio recording source.

Return
Int The stored value, if it exists in this configuration.
Exceptions
IllegalArgumentException if the option does not exist in this configuration.

getAudioSampleRate

fun getAudioSampleRate(valueIfMissing: Int): Int

Returns the audio sample rate.

Parameters
valueIfMissing Int: The value to return if this configuration option has not been set.
Return
Int The stored value or valueIfMissing if the value does not exist in this configuration.

getAudioSampleRate

fun getAudioSampleRate(): Int

Returns the audio sample rate.

Return
Int The stored value, if it exists in this configuration.
Exceptions
IllegalArgumentException if the option does not exist in this configuration.

getBitRate

fun getBitRate(valueIfMissing: Int): Int

Returns the encoding bit rate.

Parameters
valueIfMissing Int: The value to return if this configuration option has not been set.
Return
Int The stored value or valueIfMissing if the value does not exist in this configuration.

getBitRate

fun getBitRate(): Int

Returns the encoding bit rate.

Return
Int The stored value, if it exists in this configuration.
Exceptions
IllegalArgumentException if the option does not exist in this configuration.

getConfig

@NonNull fun getConfig(): Config

getIFrameInterval

fun getIFrameInterval(valueIfMissing: Int): Int

Returns the number of seconds between each key frame.

Parameters
valueIfMissing Int: The value to return if this configuration option has not been set.
Return
Int The stored value or valueIfMissing if the value does not exist in this configuration.

getIFrameInterval

fun getIFrameInterval(): Int

Returns the number of seconds between each key frame.

Return
Int The stored value, if it exists in this configuration.
Exceptions
IllegalArgumentException if the option does not exist in this configuration.

getInputFormat

fun getInputFormat(): Int

Retrieves the format of the image that is fed as input.

This should always be PRIVATE for VideoCaptureLegacy.

getVideoFrameRate

fun getVideoFrameRate(valueIfMissing: Int): Int

Returns the recording frames per second.

Parameters
valueIfMissing Int: The value to return if this configuration option has not been set.
Return
Int The stored value or valueIfMissing if the value does not exist in this configuration.

getVideoFrameRate

fun getVideoFrameRate(): Int

Returns the recording frames per second.

Return
Int The stored value, if it exists in this configuration.
Exceptions
IllegalArgumentException if the option does not exist in this configuration.

Properties

OPTION_AUDIO_BIT_RATE

static val OPTION_AUDIO_BIT_RATE: Config.Option<Int!>!

OPTION_AUDIO_CHANNEL_COUNT

static val OPTION_AUDIO_CHANNEL_COUNT: Config.Option<Int!>!

OPTION_AUDIO_MIN_BUFFER_SIZE

static val OPTION_AUDIO_MIN_BUFFER_SIZE: Config.Option<Int!>!

OPTION_AUDIO_RECORD_SOURCE

static val OPTION_AUDIO_RECORD_SOURCE: Config.Option<Int!>!

OPTION_AUDIO_SAMPLE_RATE

static val OPTION_AUDIO_SAMPLE_RATE: Config.Option<Int!>!

OPTION_BIT_RATE

static val OPTION_BIT_RATE: Config.Option<Int!>!

OPTION_INTRA_FRAME_INTERVAL

static val OPTION_INTRA_FRAME_INTERVAL: Config.Option<Int!>!

OPTION_VIDEO_FRAME_RATE

static val OPTION_VIDEO_FRAME_RATE: Config.Option<Int!>!