pw-cli(1) General Commands Manual pw-cli(1)

pw-cli - رابط خط فرمان PipeWire

pw-cli [command]

تعامل با یک نمونهٔ PipeWire.

هنگامی که یک دستور داده شود، pw-cli دستور را اجرا کرده و خارج می‌شود.

اگر دستوری مشخص نشود، pw-cli یک نشست تعاملی با نمونهٔ پیش‌فرض PipeWire یعنی pipewire-0 آغاز می‌کند.

امکان برقراری اتصال با سایر نمونه‌های دوردست (remote) نیز وجود دارد. نام نمونهٔ فعلی در اعلان خط فرمان نمایش داده می‌شود.

توجه داشته باشید که pw-cli همچنین یک نمونهٔ محلی از PipeWire ایجاد می‌کند. برخی دستورها بر روی نمونهٔ فعلی (دوردست) و برخی دیگر روی نمونهٔ محلی عمل می‌کنند، مانند بارگذاری ماژول‌ها.

از دستور 'help' برای مشاهدهٔ فهرست دستورهای موجود استفاده کنید.

help | h

نمایش راهنمای سریع دربارهٔ دستورهای موجود. این دستور همچنین نام‌های مستعار (alias) بسیاری از دستورها را فهرست می‌کند.

quit | q

خروج از pw-cli.

list-vars

فهرست کردن تمام متغیرهای شناخته‌شدهٔ فعلی و نوع آن‌ها. برخی دستورها اشیایی ایجاد می‌کنند که با یک متغیر مشخص می‌شوند.

ماژول‌ها در نمونهٔ محلی (یعنی خود باینری pw-cli) بارگذاری و تخلیه می‌شوند و می‌توانند قابلیت‌ها یا اشیایی را به نمونهٔ محلی بیفزایند. در PipeWire امکان بارگذاری ماژول‌ها در نمونه‌ای دیگر وجود ندارد.

load-module name [arguments...]

بارگذاری یک ماژول با نام و آرگومان‌های مشخص‌شده در نمونهٔ محلی. بارگذاری بیش از یک‌بار برای اکثر ماژول‌ها بدون اشکال است.

این دستور متغیر ماژولی برمی‌گرداند که می‌تواند برای تخلیهٔ ماژول استفاده شود.

ماژول محلی در نمونهٔ دوردست قابل مشاهده نیست. در PipeWire امکان بارگذاری ماژول در یک نمونهٔ دوردست وجود ندارد.

unload-module module-var

تخلیهٔ یک ماژول با مشخص کردن متغیر آن.

list-objects

فهرست کردن اشیاء نمونهٔ فعلی.

اشیاء به همراه id، type و version خود فهرست می‌شوند.

info id | all

دریافت اطلاعات دربارهٔ یک شیء مشخص یا همهٔ اشیاء (all).

درخواست اطلاعات دربارهٔ یک شیء همچنین شما را از تغییرات آن مطلع خواهد کرد.

connect [remote-name]

اتصال به یک نمونهٔ دوردست و تبدیل آن به نمونهٔ فعلی.

اگر نام دوردستی مشخص نشود، اتصال به نمونهٔ دوردست پیش‌فرض (معمولاً pipewire-0) برقرار می‌شود.

نام دوردستِ ویژهٔ internal می‌تواند برای اتصال به نمونهٔ محلی PipeWire در pw-cli به کار رود.

این دستور یک متغیر دوردست (remote var) برمی‌گرداند که می‌تواند برای قطع اتصال یا تغییر نمونهٔ دوردست استفاده شود.

disconnect [remote-var]

قطع اتصال از یک نمونهٔ دوردست.

اگر نام دوردستی مشخص نشود، اتصال نمونهٔ فعلی قطع می‌شود.

list-remotes

فهرست کردن تمام نمونه‌های دوردست.

switch-remote [remote-var]

تبدیل نمونهٔ دوردست مشخص‌شده به نمونهٔ فعلی.

اگر نام دوردستی مشخص نشود، نخستین نمونه به عنوان نمونهٔ فعلی در نظر گرفته می‌شود.

create-node factory-name [properties...]

ایجاد یک گره (node) از یک factory در نمونهٔ فعلی.

ویژگی‌ها (properties) جفت‌های key=value هستند که با نویسهٔ فاصله جدا می‌شوند.

این دستور یک متغیر گره برمی‌گرداند.

export-node node-id [remote-var]

برون‌ریزی یک گره از نمونهٔ محلی به نمونهٔ مشخص‌شده. در صورتی که نمونه‌ای تعیین نشود، گره به نمونهٔ فعلی صادر خواهد شد.

create-device factory-name [properties...]

ایجاد یک دستگاه (device) از یک factory در نمونهٔ فعلی.

ویژگی‌ها جفت‌های key=value هستند که با نویسهٔ فاصله جدا می‌شوند.

این دستور یک متغیر دستگاه برمی‌گرداند.

create-link node-id port-id node-id port-id [properties...]

ایجاد یک پیوند (link) میان ۲ گره و درگاه (port).

شناسه‌های درگاه (port-id) و شناسه‌های گره (node-id) را می‌توان روی - تنظیم کرد تا یک گره یا درگاه به طور خودکار انتخاب شود.

شناسه‌های درگاه می‌توانند * باشند تا درگاه‌های منطبق در گره‌ها به طور خودکار به هم پیوند داده شوند.

ویژگی‌ها جفت‌های key=value هستند که با نویسهٔ فاصله جدا می‌شوند.

این دستور یک یا چند متغیر پیوند برمی‌گرداند.

destroy object-id

از بین بردن یک شیء سراسری (global).

enum-params object-id param-id

شمارش و پیمایش پارامترهای یک شیء.

param-id را می‌توان به عنوان نام کوتاه پارامتر نیز مشخص کرد.

set-param object-id param-id param-json

تنظیم پارامتر یک شیء.

param-id را می‌توان به عنوان نام کوتاه پارامتر نیز مشخص کرد.

permissions client-id object-id permission

تنظیم مجوزها برای یک کلاینت (client).

object-id می‌تواند برای تنظیم مجوزهای پیش‌فرض برابر -1 باشد.

get-permissions client-id

دریافت مجوزهای یک کلاینت.

send-command object-id

ارسال یک دستور به یک شیء.

توسعه‌دهندگان PipeWire https://gitlab.freedesktop.org/pipewire/pipewire/issues؛ PipeWire در https://pipewire.org در دسترس است

pipewire(1), pw-mon(1),

1.6.8 PipeWire