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

VideoCodecConfig

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

Constructors

VideoCodecConfig

constructor(mimeType: String = MediaFormat.MIMETYPE_VIDEO_AVC, startBitrate: Int, resolution: Size = DEFAULT_RESOLUTION, fps: Int = DEFAULT_FPS, gopDurationInS: Float = 1.0f, profile: Int, level: Int = getBestLevel(mimeType, profile), customize: MediaFormatCustomHandler = {})

Instantiates a VideoCodecConfig instance from profile and level.

constructor(mimeType: String = MediaFormat.MIMETYPE_VIDEO_AVC, startBitrate: Int, resolution: Size = DEFAULT_RESOLUTION, fps: Int = DEFAULT_FPS, gopDurationInS: Float = 1.0f, profileLevelColorBuilder: VideoProfileLevelColor.Builder.() -> Unit = {}, customize: MediaFormatCustomHandler = {})

Instantiates a VideoCodecConfig instance from VideoProfileLevelColor.Builder.

Types

Companion

object Companion

Properties

defaultEncoderName

val defaultEncoderName: String?

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

dynamicRangeProfile

val dynamicRangeProfile: DynamicRangeProfile

The dynamic range profile. It is deduced from the profile. See Also: DynamicRangeProfiles

fps

val fps: Int

Video framerate. This is a best effort as few camera can not generate a fixed framerate.

gopDurationInS

val gopDurationInS: Float = 1.0f

Video encoder I-frame interval in seconds. This is a best effort as few camera can not generate a fixed frame rate. For live streaming, I-frame interval should be really low. For recording, I-frame interval should be higher. A value of 0 means that each frame is an I-frame. On device with API < 25, this value will be rounded to an integer. So don't expect a precise value and any value < 0.5 will be considered as 0.

isHdr

val isHdr: <Error class: unknown class>

Whether the configuration is HDR or not.

level

val level: Int

Video encoder level. Encoders may not support requested level. In this case, StreamPack fallbacks to default level. ** See ** MediaCodecInfo.CodecProfileLevel

mimeType

val mimeType: String

The encoder mime type.

profile

val profile: Int = 0

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

resolution

val resolution: Size

Video output resolution in pixel.

sourceConfig

val VideoCodecConfig.sourceConfig: VideoSourceConfig

Converts VideoCodecConfig to VideoSourceConfig.

startBitrate

val startBitrate: Int

The encoder bitrate in bits/s.

Functions

copy

fun copy(mimeType: String = this.mimeType, startBitrate: Int = this.startBitrate, resolution: Size = this.resolution, fps: Int = this.fps, gopDurationInS: Float = this.gopDurationInS, profileLevelColor: VideoProfileLevelColor = this.profileLevelColor, customize: MediaFormatCustomHandler = this.customize): VideoCodecConfig

Copies video configuration with new values

createHandlerBox

fun CodecConfig.createHandlerBox(): HandlerBox

createTypeMediaHeaderBox

fun CodecConfig.createTypeMediaHeaderBox(): TypeMediaHeaderBox

equals