streampack-core/io.github.thibaultbee.streampack.core.elements.encoders/AudioCodecConfig

AudioCodecConfig

open class AudioCodecConfig(val mimeType: String = MediaFormat.MIMETYPE_AUDIO_AAC, val startBitrate: Int, val sampleRate: Int = getDefaultSampleRate(mimeType), val channelConfig: Int = AudioFormat.CHANNEL_IN_STEREO, val byteFormat: Int = AudioFormat.ENCODING_PCM_16BIT, val profile: Int = getDefaultProfile(mimeType)) : CodecConfig

Audio configuration class. If you don't know how to set class members, Video encoding recommendations should give you hints.

Constructors

AudioCodecConfig

constructor(mimeType: String = MediaFormat.MIMETYPE_AUDIO_AAC, startBitrate: Int, sampleRate: Int = getDefaultSampleRate(mimeType), channelConfig: Int = AudioFormat.CHANNEL_IN_STEREO, byteFormat: Int = AudioFormat.ENCODING_PCM_16BIT, profile: Int = getDefaultProfile(mimeType))

Types

Companion

object Companion

Properties

byteFormat

val byteFormat: Int

Audio byte format.

channelConfig

val channelConfig: Int

Audio channel configuration. From AudioRecord API: " AudioFormat#CHANNEL_IN_MONO is guaranteed to work on all devices."

defaultEncoderName

val defaultEncoderName: String?

Get default encoder name. If name is null, it won't be possible to start a stream.

isFormatSupported

val isFormatSupported: Boolean

Check if this configuration is supported by the default encoder. If format is not supported, it won't be possible to start a stream.

mimeType

val mimeType: String

The encoder mime type.

profile

val profile: Int = 0

The encoder profile. Only applicable to AAC, AVC, HEVC, VP9, AV1.

sampleRate

val sampleRate: Int

Audio capture sample rate in Hz. From AudioRecord API: "44100Hz is currently the only rate that is guaranteed to work on all devices, but other rates such as 22050, 16000, and 11025 may work on some devices."

sourceConfig

val AudioCodecConfig.sourceConfig: AudioSourceConfig

Converts AudioCodecConfig to AudioSourceConfig.

startBitrate

val startBitrate: Int

The encoder bitrate in bits/s.

Functions

copy

fun copy(mimeType: String = this.mimeType, startBitrate: Int = this.startBitrate, sampleRate: Int = this.sampleRate, channelConfig: Int = this.channelConfig, byteFormat: Int = this.byteFormat, profile: Int = this.profile): AudioCodecConfig

Copies the audio configuration with new values.

createHandlerBox

fun CodecConfig.createHandlerBox(): HandlerBox

createTypeMediaHeaderBox

fun CodecConfig.createTypeMediaHeaderBox(): TypeMediaHeaderBox

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

isCompatibleWith

fun AudioCodecConfig.isCompatibleWith(sourceConfig: AudioSourceConfig): Boolean

Whether AudioCodecConfig is compatible with AudioSourceConfig.

isFormatSupportedForEncoder

fun isFormatSupportedForEncoder(name: String): Boolean

Check if this configuration is supported by the specified encoder. If format is not supported, it won't be possible to start a stream.

toString

open override fun toString(): String