kaios-types
    Preparing search index...

    Interface FMRadio

    Provides access to the FM radio.

    interface FMRadio {
        antennaAvailable: boolean;
        channelWidth: number;
        enabled: boolean;
        frequency: number | null;
        frequencyLowerBound: number;
        frequencyUpperBound: number;
        onantennaavailablechange: EventHandler;
        ondisabled: EventHandler;
        onenabled: EventHandler;
        onfrequencychange: EventHandler;
        onnewrdsgroup: EventHandler;
        onpichange: EventHandler;
        onpschange: EventHandler;
        onptychange: EventHandler;
        onrdsdisabled: EventHandler;
        onrdsenabled: EventHandler;
        onrtchange: EventHandler;
        pi: number | null;
        ps: string | null;
        pty: number | null;
        rdsEnabled: boolean;
        rdsgroup: Uint16Array<ArrayBuffer> | null;
        rdsGroupMask: number;
        rt: string | null;
        addEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | AddEventListenerOptions,
        ): void;
        cancelSeek(): DOMRequest;
        disable(): DOMRequest;
        disableRDS(): DOMRequest;
        dispatchEvent(event: Event): boolean;
        enable(frequency: number): DOMRequest;
        enableRDS(): DOMRequest;
        removeEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | EventListenerOptions,
        ): void;
        seekDown(): DOMRequest;
        seekUp(): DOMRequest;
        setFrequency(frequency: number): DOMRequest;
    }

    Hierarchy

    • EventTarget
      • FMRadio
    Index

    Properties

    antennaAvailable channelWidth enabled frequency frequencyLowerBound frequencyUpperBound onantennaavailablechange ondisabled onenabled onfrequencychange onnewrdsgroup onpichange onpschange onptychange onrdsdisabled onrdsenabled onrtchange pi ps pty rdsEnabled rdsgroup rdsGroupMask rt

    Methods

    addEventListener cancelSeek disable disableRDS dispatchEvent enable enableRDS removeEventListener seekDown seekUp setFrequency

    Properties

    antennaAvailable: boolean

    Indicates whether an antenna is plugged in.

    channelWidth: number

    The channel width in MHz.

    enabled: boolean

    Indicates whether the FM radio is enabled.

    frequency: number | null

    The current frequency in MHz, or null if not enabled.

    frequencyLowerBound: number

    The lower bound of the frequency range in MHz.

    frequencyUpperBound: number

    The upper bound of the frequency range in MHz.

    onantennaavailablechange: EventHandler

    Event handler for antenna availability changes.

    ondisabled: EventHandler

    Event handler for when the radio is disabled.

    onenabled: EventHandler

    Event handler for when the radio is enabled.

    onfrequencychange: EventHandler

    Event handler for frequency changes.

    onnewrdsgroup: EventHandler

    Event handler for new RDS group data.

    onpichange: EventHandler

    Event handler for PI code changes.

    onpschange: EventHandler

    Event handler for PS name changes.

    onptychange: EventHandler

    Event handler for PTY code changes.

    onrdsdisabled: EventHandler

    Event handler for when RDS is disabled.

    onrdsenabled: EventHandler

    Event handler for when RDS is enabled.

    onrtchange: EventHandler

    Event handler for RT changes.

    pi: number | null

    Program Identification (PI) code.

    ps: string | null

    Program Service (PS) name.

    pty: number | null

    Program Type (PTY) code.

    rdsEnabled: boolean

    Indicates whether RDS (Radio Data System) is enabled.

    rdsgroup: Uint16Array<ArrayBuffer> | null

    Raw RDS group data.

    rdsGroupMask: number

    RDS group mask.

    rt: string | null

    Radio Text (RT).

    Methods

    • The addEventListener() method of the EventTarget interface sets up a function that will be called whenever the specified event is delivered to the target.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | AddEventListenerOptions

      Returns void

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Enables the FM radio on the specified frequency.

      Parameters

      • frequency: number

        The frequency to tune to in MHz.

      Returns DOMRequest

      A DOMRequest indicating success or failure.

    • The removeEventListener() method of the EventTarget interface removes an event listener previously registered with EventTarget.addEventListener() from the target.

      MDN Reference

      Parameters

      • type: string
      • callback: EventListenerOrEventListenerObject | null
      • Optionaloptions: boolean | EventListenerOptions

      Returns void

    • Sets the frequency.

      Parameters

      • frequency: number

        The frequency to tune to in MHz.

      Returns DOMRequest

      A DOMRequest indicating success or failure.

    Settings

    Member Visibility

    On This Page

    Properties
    Methods