kiteffmpeg/io.github.yuroyami.kiteffmpeg/Disposition

Disposition

data class Disposition(val default: Boolean = false, val forced: Boolean = false, val hearingImpaired: Boolean = false, val visualImpaired: Boolean = false, val attachedPicture: Boolean = false, val descriptions: Boolean = false, val comment: Boolean = false)

What a container says a stream is for.

A track menu needs this. Without forced a player cannot mark or auto-select forced subtitles, which is the difference between showing a translation of one foreign line and showing every subtitle in the film. Without attachedPicture album art is treated as a one frame video stream and the player tries to synchronise to it. Without descriptions and comment an audio description for blind viewers or a director's commentary looks like an ordinary audio track, and can be picked for someone who did not ask for it.

Constructors

Disposition

constructor(default: Boolean = false, forced: Boolean = false, hearingImpaired: Boolean = false, visualImpaired: Boolean = false, attachedPicture: Boolean = false, descriptions: Boolean = false, comment: Boolean = false)

Types

Companion

object Companion

Properties

attachedPicture

val attachedPicture: Boolean

Cover art, not video. Exactly one frame, and never the synchronisation master.

comment

val comment: Boolean

A commentary track, such as a director's commentary, not the programme's own sound.

default

val default: Boolean

descriptions

val descriptions: Boolean

The stream describes what is on screen, for viewers who cannot see it: audio description, or subtitles that describe sounds. MPEG-TS and some Matroska files mark the same audio as visualImpaired instead, so a caller looking for descriptive audio checks both.

forced

val forced: Boolean

hearingImpaired

val hearingImpaired: Boolean

visualImpaired

val visualImpaired: Boolean