groundsdk 7.6.0 API/com.parrot.drone.groundsdk.stream/VideoFormat

VideoFormat

data class VideoFormat(val format: VideoFormat.Descriptor, val resolution: VideoFormat.Resolution, val framerate: VideoFormat.Framerate, val bitDepth: Int, val fullColorRange: Boolean, val colorPrimaries: VideoFormat.ColorPrimaries?, val transferFunction: VideoFormat.TransferFunction?, val matrixCoefficients: VideoFormat.MatrixCoefficients?, val dynamicRange: VideoFormat.DynamicRange?, val toneMapping: VideoFormat.ToneMapping?, val sampleAspectRatio: VideoFormat.AspectRatio, val masteringDisplayColorVolume: VideoFormat.MasteringDisplayColorVolume?, val contentLightLevel: VideoFormat.ContentLightLevel?)

Video format information.

Constructors

Link copied to clipboard
fun VideoFormat(format: VideoFormat.Descriptor, resolution: VideoFormat.Resolution, framerate: VideoFormat.Framerate, bitDepth: Int, fullColorRange: Boolean, colorPrimaries: VideoFormat.ColorPrimaries?, transferFunction: VideoFormat.TransferFunction?, matrixCoefficients: VideoFormat.MatrixCoefficients?, dynamicRange: VideoFormat.DynamicRange?, toneMapping: VideoFormat.ToneMapping?, sampleAspectRatio: VideoFormat.AspectRatio, masteringDisplayColorVolume: VideoFormat.MasteringDisplayColorVolume?, contentLightLevel: VideoFormat.ContentLightLevel?)

Types

Link copied to clipboard
data class AspectRatio(val width: ULong, val height: ULong)

Represents an aspect ratio.

Link copied to clipboard
interface ColorPrimaries

Color primaries.

Link copied to clipboard
data class ContentLightLevel(val maxContentLightLevel: Long, val maxFrameAverageLightLevel: Long)

Content light level.

Link copied to clipboard
interface Descriptor

Describes a video format.

Link copied to clipboard
enum DynamicRange : Enum<VideoFormat.DynamicRange>

Dynamic range.

Link copied to clipboard
data class Framerate(val frames: Long, val period: Long)

Represents a framerate.

Link copied to clipboard
data class MasteringDisplayColorVolume(val colorPrimaries: VideoFormat.ColorPrimaries, val luminanceRange: ClosedFloatingPointRange<Double>)

Mastering display color volume.

Link copied to clipboard
Link copied to clipboard
data class Raw(val pixelFormat: VideoFormat.Raw.PixelFormat?, val pixelOrder: VideoFormat.Raw.PixelOrder?, val pixelLayout: VideoFormat.Raw.PixelLayout?, val pixelSize: UInt, val dataLayout: VideoFormat.Raw.DataLayout?, val dataPadding: VideoFormat.Raw.DataPadding, val dataEndianness: VideoFormat.Raw.DataEndianness, val dataSize: UInt) : VideoFormat.Descriptor

Describes a raw video format.

Link copied to clipboard
data class Resolution(val width: ULong, val height: ULong)

Represents a video resolution.

Link copied to clipboard
enum ToneMapping : Enum<VideoFormat.ToneMapping>

Tone mapping.

Link copied to clipboard

Properties

Link copied to clipboard
val bitDepth: Int

bit depth

Link copied to clipboard
val colorPrimaries: VideoFormat.ColorPrimaries?

color primaries, or null if not available

Link copied to clipboard
val contentLightLevel: VideoFormat.ContentLightLevel?

Content light level, or null if not available

Link copied to clipboard
val dynamicRange: VideoFormat.DynamicRange?

dynamic range, or null if not available

Link copied to clipboard
val format: VideoFormat.Descriptor

video format description

Link copied to clipboard
val framerate: VideoFormat.Framerate

video framerate

Link copied to clipboard
val fullColorRange: Boolean

true for full color range, otherwise false

Link copied to clipboard
val masteringDisplayColorVolume: VideoFormat.MasteringDisplayColorVolume?

mastering display color volume, or null if not available

Link copied to clipboard
val matrixCoefficients: VideoFormat.MatrixCoefficients?

matrix coefficients, or null if not available

Link copied to clipboard
val resolution: VideoFormat.Resolution

video frame resolution (in pixels)

Link copied to clipboard
val sampleAspectRatio: VideoFormat.AspectRatio

sample aspect ratio

Link copied to clipboard
val toneMapping: VideoFormat.ToneMapping?

tone mapping, or null if not available

Link copied to clipboard
val transferFunction: VideoFormat.TransferFunction?

transfer function, or null if not available