kiteplayer-audioviz/io.github.yuroyami.kiteplayer.audioviz/SongMap

SongMap

What a background scan of one audio track found. Every field may be absent, and a partial map describes only its covered range. See docs/audioviz-song-scan-api.md.

Types

Companion

object Companion

Properties

complete

val complete: Boolean

Whether the scan reached the end of the stream.

coveredThroughMicros

val coveredThroughMicros: Long

Media time analysed, from the start of the stream.

keyCount

val keyCount: Int

Key segments, in time order. Gaps are stretches with no supported key.

referencePower

val referencePower: Double?

The 95th percentile of valid ungated 400 ms K-weighted programme powers, in the causal reference's linear convention. Null for a partial or all-silent map.

structureCount

val structureCount: Int

Section boundaries, drops and breakdowns, in time order.

track

val track: TrackId

The audio track that was scanned.

version

val version: Int

The analysis version that produced this map; another version is never reused.

Functions

key

fun key(index: Int): KeySegment

structure

fun structure(index: Int): AudioDetection