skainet-data-media/sk.ainet.data.media/ChannelLayout

ChannelLayout

enum ChannelLayout : Enum<ChannelLayout> (source)

Memory layout for audio sample data.

Different audio processing libraries use different conventions for storing multi-channel audio data.

Entries

Single channel (mono) audio. Shape: samples

Interleaved multi-channel audio. Samples from different channels alternate: L R L R L R... Shape: samples, channels

Planar (non-interleaved) multi-channel audio. Each channel is stored contiguously: LLLL...RRRR... Shape: channels, samples

BATCH_INTERLEAVED

BATCH_INTERLEAVED

Batched interleaved audio. Shape: batch, samples, channels

Batched planar audio. Shape: batch, channels, samples

Properties

val channelsAxis: Int

Index of the channels dimension in the shape array. Returns -1 for MONO (no channel dimension).

val entries: EnumEntries<ChannelLayout>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

val expectedRank: Int

Expected tensor rank for this layout.

val isBatched: Boolean

Whether this layout includes a batch dimension.

val isMono: Boolean

Whether this layout is mono (single channel).

val isPlanar: Boolean

Whether channels are stored contiguously (planar).

val samplesAxis: Int

Index of the samples dimension in the shape array.

Functions

fun batched(): ChannelLayout

Convert to batched version of this layout.

fun unbatched(): ChannelLayout

Convert to unbatched version of this layout.

fun valueOf(value: String): ChannelLayout

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

fun values(): Array<ChannelLayout>

Returns an array containing the constants of this enum type, in the order they're declared.