mpc-js
    Preparing search index...

    Interface PartitionCommands

    interface PartitionCommands {
        deletePartition(name: string): Promise<void>;
        listPartitions(): Promise<string[]>;
        moveOutput(outputName: string): Promise<void>;
        newPartition(name: string): Promise<void>;
        partition(name: string): Promise<void>;
    }

    Hierarchy

    • ReturnType<typeof createPartitionCommands>
      • PartitionCommands
    Index

    Methods

    deletePartition listPartitions moveOutput newPartition partition

    Methods

    • Delete a partition. The partition must be empty (no connected clients and no outputs).

      Parameters

      • name: string

      Returns Promise<void>

    • Returns a list of partitions.

      Returns Promise<string[]>

    • Move an output to the current partition.

      Parameters

      • outputName: string

      Returns Promise<void>

    • Create a new partition.

      Parameters

      • name: string

      Returns Promise<void>

    • Switch the client to a different partition.

      Parameters

      • name: string

      Returns Promise<void>

    Settings

    Member Visibility

    On This Page

    Methods