Arabic Maqām Network - TypeScript Library Documentation - v0.1.0
    Preparing search index...

    Interface Jins

    Represents a concrete, tuning-system-specific jins with actual pitch classes.

    This interface represents a jins that has been "realized" within a specific tuning system, containing actual pitch classes with frequencies and intervallic relationships. Unlike JinsData (which contains only abstract note names), a Jins interface instance is playable and can be used for audio synthesis.

    Tahlil vs Taswir:

    • Tahlil (transposition: false): The original form of the jins starting from its traditional root note (e.g., Jins Kurd starting on dūgāh)
    • Taswir (transposition: true): A transposition of the jins starting from a different pitch class while preserving intervallic relationships (e.g., Jins Kurd al-Muhayyar starting on muhayyar/octave of dūgāh)

    The transposition algorithm uses pattern matching to find all valid starting positions within the tuning system where the complete interval pattern can be realized, ensuring authentic intervallic structure is maintained.

    interface Jins {
        jinsId: string;
        name: string;
        transposition: boolean;
        jinsPitchClasses: default[];
        jinsPitchClassIntervals: PitchClassInterval[];
    }
    Index

    Properties

    jinsId: string

    ID of the original jins this instance is based on

    name: string

    Name of this jins instance. For tahlil: original name (e.g., "Jins Kurd") For taswir: includes transposition info (e.g., "Jins Kurd al-Muhayyar")

    transposition: boolean

    Whether this is a transposition (taswir) or original form (tahlil). false = tahlil (original), true = taswir (transposition)

    jinsPitchClasses: default[]

    Array of actual pitch classes with frequencies and note names. These are the concrete, playable pitches within the tuning system.

    jinsPitchClassIntervals: PitchClassInterval[]

    Intervallic relationships between consecutive pitch classes. These intervals remain consistent between tahlil and taswir forms.