kaios-types
    Preparing search index...

    Interface TVChannel

    Represents a TV channel.

    Preference: "dom.tv.enabled"

    tv

    CertifiedApps

    interface TVChannel {
        isEmergency: boolean;
        isFree: boolean;
        name: string;
        networkId: string;
        number: string;
        serviceId: string;
        source: TVSource;
        transportStreamId: string;
        type: TVChannelType;
        addEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | AddEventListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        getCurrentProgram(): Promise<TVProgram>;
        getPrograms(options?: TVGetProgramsOptions): Promise<TVProgram[]>;
        removeEventListener(
            type: string,
            callback: EventListenerOrEventListenerObject | null,
            options?: boolean | EventListenerOptions,
        ): void;
    }

    Hierarchy

    • EventTarget
      • TVChannel
    Index

    Properties

    isEmergency isFree name networkId number serviceId source transportStreamId type

    Methods

    addEventListener dispatchEvent getCurrentProgram getPrograms removeEventListener

    Properties

    isEmergency: boolean

    Indicates if this is an emergency channel.

    isFree: boolean

    Indicates if this channel is free-to-air.

    name: string

    The name of the channel.

    networkId: string

    The network identifier.

    number: string

    The channel number.

    serviceId: string

    The service identifier.

    source: TVSource

    The TV source providing this channel.

    transportStreamId: string

    The transport stream identifier.

    type: TVChannelType

    The type of the channel (e.g., 'tv', 'radio', 'data').

    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

    • Retrieves the program currently playing on this channel.

      Returns Promise<TVProgram>

      A promise resolving to the current TVProgram.

      NS_ERROR_NOT_AVAILABLE.

    • 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

    Settings

    Member Visibility

    On This Page

    Properties
    Methods