groundsdk 7.7.2 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

VideoFormat

constructor(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

AspectRatio

data class AspectRatio(val width: ULong, val height: ULong)

Represents an aspect ratio.

ColorPrimaries

interface ColorPrimaries

Color primaries.

ContentLightLevel

data class ContentLightLevel(val maxContentLightLevel: Long, val maxFrameAverageLightLevel: Long)

Content light level.

Descriptor

interface Descriptor

Describes a video format.

DynamicRange

enum DynamicRange : Enum<VideoFormat.DynamicRange>

Dynamic range.

Framerate

data class Framerate(val frames: Long, val period: Long)

Represents a framerate.

MasteringDisplayColorVolume

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

Mastering display color volume.

MatrixCoefficients

enum MatrixCoefficients : Enum<VideoFormat.MatrixCoefficients>

Matrix coefficients.

Raw

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.

Resolution

data class Resolution(val width: ULong, val height: ULong)

Represents a video resolution.

ToneMapping

enum ToneMapping : Enum<VideoFormat.ToneMapping>

Tone mapping.

TransferFunction

enum TransferFunction : Enum<VideoFormat.TransferFunction>

Transfer function.

Properties

bitDepth

val bitDepth: Int

bit depth

colorPrimaries

val colorPrimaries: VideoFormat.ColorPrimaries?

color primaries, or null if not available

contentLightLevel

val contentLightLevel: VideoFormat.ContentLightLevel?

Content light level, or null if not available

dynamicRange

val dynamicRange: VideoFormat.DynamicRange?

dynamic range, or null if not available

format

val format: VideoFormat.Descriptor

video format description

framerate

val framerate: VideoFormat.Framerate

video framerate

fullColorRange

val fullColorRange: Boolean

true for full color range, otherwise false

masteringDisplayColorVolume

val masteringDisplayColorVolume: VideoFormat.MasteringDisplayColorVolume?

mastering display color volume, or null if not available

matrixCoefficients

val matrixCoefficients: VideoFormat.MatrixCoefficients?

matrix coefficients, or null if not available

resolution

val resolution: VideoFormat.Resolution

video frame resolution (in pixels)

sampleAspectRatio

val sampleAspectRatio: VideoFormat.AspectRatio

sample aspect ratio

toneMapping

val toneMapping: VideoFormat.ToneMapping?

tone mapping, or null if not available

transferFunction

val transferFunction: VideoFormat.TransferFunction?

transfer function, or null if not available