RAGS - v1.11.0
    Preparing search index...

    Class Stream

    Audio Stream

    Represents a single audio stream (sink, source, application, or recorder).

    Hierarchy (View Summary)

    Implements

    Index

    Accessors

    application_id description icon_name id is_muted isDisposed name state stream volume

    Constructors

    constructor

    Methods

    bind changed close connect diffBind disconnectAll dispose emit retryWithBackoff setStream trackConnection updateProperty import pspec register

    Accessors

    • get application_id(): string | null

      The PulseAudio/PipeWire application ID.

      Returns string | null

    • get description(): string | null

      Human-readable description of the stream.

      Returns string | null

    • get icon_name(): string | null

      Icon name representing this stream.

      Returns string | null

    • get isDisposed(): boolean

      Check if service has been disposed

      Returns boolean

    • get state(): string

      Current stream state: "closed", "ready", "connecting", or "failed".

      Returns string

    • get stream(): MixerStream | null

      The underlying Gvc.MixerStream instance.

      Returns MixerStream | null

    • get volume(): number

      Volume level as a float from 0.0 to maxStreamVolume (default 1.5).

      Returns number

    • set volume(value: number): void

      Sets the volume level, clamped between 0 and maxStreamVolume.

      Parameters

      • value: number

      Returns void

    Constructors

    Methods

    • Creates a Binding for a property on this service.

      Type Parameters

      • Prop extends
            | "name"
            | "description"
            | "icon_name"
            | "isDisposed"
            | "$signals"
            | "application_id"
            | "stream"
            | "id"
            | "state"
            | "is_muted"
            | "volume"

      Parameters

      • prop: Prop

        The property to bind

      Returns Binding<Stream, Prop, Stream[Prop]>

      A Binding that can be used in widget constructors

      const label = Widget.Label({
          label: audio.bind('volume').as(v => `${Math.round(v * 100)}%`),
      });

    • Notifies listeners that a property changed and emits the 'changed' signal.

      Parameters

      • property: string

        The property name that changed

      Returns void

    • Unbinds the underlying stream and emits the "closed" signal.

      Returns void

    • Connects a callback to a signal on this service.

      Parameters

      • signal: string = 'changed'

        The signal name (defaults to 'changed')

      • callback: (_: this, ...args: any[]) => void

        The callback to invoke when the signal is emitted

      Returns number

      The signal connection ID

    • Creates an incremental list binding that reuses existing widgets.

      Instead of recreating all widgets on every update, this method caches widgets by a key function and only creates new widgets for new items, destroying widgets for removed items.

      Type Parameters

      • Item
      • Prop extends
            | "name"
            | "description"
            | "icon_name"
            | "isDisposed"
            | "$signals"
            | "application_id"
            | "stream"
            | "id"
            | "state"
            | "is_muted"
            | "volume"

      Parameters

      • prop: Prop

        The property containing the item array

      • opts: {
            create: (item: Item) => Widget;
            key: (item: Item) => string | number;
            update?: (widget: Widget, item: Item) => void;
        }

        Key extractor, widget factory, and optional update callback

      Returns Binding<Stream, Prop, Widget[]>

      A Binding that produces an array of widgets

      const children = audio.diffBind('speakers', {
          key: (s) => s.name,
          create: (s) => Widget.Label({ label: s.description }),
          update: (w, s) => { w.label = s.description; },
      });

    • Clean up all tracked signal connections Call this in service-specific dispose implementations

      Returns void

    • Emits a signal, warning if the signal was not registered via Service.register.

      The warning is cheap (a Set lookup per emit) and helps catch typos and missing signal declarations that silently break .bind().

      Parameters

      • signal: string
      • ...args: any[]

      Returns void

    • Retry a DBus operation with exponential backoff

      Type Parameters

      • T

      Parameters

      • operation: () => Promise<T>
      • maxRetries: number = 3
      • baseDelay: number = 100

      Returns Promise<T>

    • Binds this wrapper to a Gvc.MixerStream, forwarding property change signals.

      Parameters

      • stream: MixerStream | null

        The mixer stream to bind, or null to unbind

      Returns void

    • Track a signal connection for automatic cleanup

      Parameters

      • emitter: Object

        The object the signal is connected to (defaults to this)

      • id: number

        The signal connection ID

      Returns void

    • Track a signal connection for automatic cleanup

      Parameters

      • id: number

        The signal connection ID

      Returns void

    • Updates a property value and emits a notify signal if the value changed.

      Performs a deep equality check via JSON serialization to avoid unnecessary notifications.

      Parameters

      • prop: string

        The property name in kebab-case

      • value: unknown

        The new value

      Returns void

    • Dynamically imports a built-in service by name.

      Type Parameters

      • S extends keyof Services

      Parameters

      • service: S

        The service name to import

      Returns Promise<Services[S]>

      The default export of the service module

      const Audio = await Service.import('audio');
      const Battery = await Service.import('battery');

    • Creates a GObject property specification.

      Parameters

      • name: string

        The property name in kebab-case

      • type: PspecType = 'jsobject'

        The property type (defaults to 'jsobject')

      • handle: PspecFlag = 'r'

        The access flag: 'r', 'w', or 'rw' (defaults to 'r')

      Returns ParamSpec<unknown>

      A GObject.ParamSpec

    • Registers a GObject subclass with signals and properties.

      Parameters

      • service: new (...args: any[]) => Object

        The class constructor to register

      • Optionalsignals: { [signal: string]: PspecType[] }

        Map of signal names to their parameter types

      • Optionalproperties: { [prop: string]: [type?: PspecType, handle?: PspecFlag] }

        Map of property names to [type, accessFlag] tuples

      Returns void

    Settings

    Member Visibility

    On This Page

    Accessors
    Constructors
    Methods