Hiyve Components - v1.0.0
    Preparing search index...

    Interface PlayDrillCardProps

    Props for PlayDrillCard.

    interface PlayDrillCardProps {
        audioDeviceId?: string;
        children?: ReactNode;
        colors?: Partial<DrillColors>;
        index: number;
        instrument?: InstrumentFamily;
        labels?: Partial<DrillCardLabels>;
        loadEngine: NotationEngineLoader;
        midiInputId?: string;
        names?: TheoryNamesOverrides;
        onAnswer: (choice: string, correct?: boolean) => void;
        onError?: (error: Error) => void;
        onFinish?: () => void;
        onNext: () => void;
        playLabels?: Partial<PlayDrillCardLabels>;
        profile?: AudioProfile;
        reportColors?: Partial<TakeReportColors>;
        round: DrillRound;
        samples?: SampleSource;
        sound?: boolean;
        source?: LiveSource;
        summary?: DrillSummary;
        sx?: SxProps<Theme>;
        total: number;
    }

    Hierarchy

    • Omit<DrillCardProps, "answerArea" | "noteStyles" | "onSoundingChange">
      • PlayDrillCardProps
    Index

    Properties

    audioDeviceId? children? colors? index instrument? labels? loadEngine midiInputId? names? onAnswer onError? onFinish? onNext playLabels? profile? reportColors? round samples? sound? source? summary? sx? total

    Properties

    audioDeviceId?: string

    The microphone to use

    children?: ReactNode

    Anything to show under the question — a hint, a replay button

    colors?: Partial<DrillColors>
    index: number

    The round's place, from 0

    instrument?: InstrumentFamily

    What is played, so the microphone is listened to the right way (default: 'keyboard')

    labels?: Partial<DrillCardLabels>
    loadEngine: NotationEngineLoader

    Supplies the notation engine for the staff

    midiInputId?: string

    Listen to this MIDI input only

    names?: TheoryNamesOverrides

    The names answers are shown by: intervals, chords, scales and keys

    onAnswer: (choice: string, correct?: boolean) => void

    A choice was made — or, from answerArea, an answer played, with whether it was right

    onError?: (error: Error) => void

    Called when the staff fails to draw or the sound fails to start

    onFinish?: () => void

    End the drill early, keeping what was answered (useDrill's finish); the Finish button shows when given

    onNext: () => void

    Move on

    playLabels?: Partial<PlayDrillCardLabels>

    Labels of the listening panel

    profile?: AudioProfile

    How the microphone is opened (default: 'instrument')

    reportColors?: Partial<TakeReportColors>

    The colours the answer is marked in on the staff (default: the TakeReport colours)

    round: DrillRound

    The round being asked

    samples?: SampleSource

    Recorded samples to play the question with — a piano, say — instead of the built-in voice; the question's notes are downloaded as it appears. The SDK ships none: you choose the host, and that set's licence applies

    sound?: boolean

    Play the question once a choice is made, with a button to hear it again (default: true). A question asked by ear (question.byEar) is played as it appears — after its reference note, when it has one — with its staff hidden until it is answered; with sound off, or where the browser has no Web Audio, it shows its staff like any other

    source?: LiveSource

    Follow the microphone ('audio') or a MIDI instrument ('midi') (default: 'audio')

    summary?: DrillSummary

    How the drill has gone so far (useDrill's summary): given, the card shows the running score and how far through the drill it is

    sx?: SxProps<Theme>
    total: number

    Questions in the drill

    Settings

    Member Visibility

    On This Page

    Properties