pulse-cli-syntax(5)           File Formats Manual          pulse-cli-syntax(5)

نام (NAME)
       pulse-cli-syntax - نحو رابط خط فرمان پالس‌آدیو

خلاصه دستور (SYNOPSIS)
       ~/.config/pulse/default.pa

       /etc/pulse/default.pa

       /etc/pulse/system.pa

توضیحات (DESCRIPTION)
       پالس‌آدیو (PulseAudio) یک زبان خط فرمان ساده ارائه می‌دهد که توسط
       اسکریپت‌های پیکربندی، پوسته تعاملی pacmd و ماژول‌های module-cli و module-
       cli-protocol-{unix,tcp} استفاده می‌شود. خطوط خالی و خطوطی که با علامت هش
       (#) آغاز می‌شوند، بدون اعلان نادیده گرفته می‌شوند. دستورات متعددی
       پشتیبانی می‌شوند.

       توجه داشته باشید که هر آرگومان بولی (boolean) را می‌توان به صورت مثبت با
       '1'، 't'، 'y'، 'true'، 'yes' یا 'on' مشخص کرد. به همین ترتیب، مقادیر
       منفی را می‌توان با '0'، 'f'، 'n'، 'false'، 'no' یا 'off' تعیین نمود.
       بزرگی و کوچکی حروف نادیده گرفته می‌شود.

دستورات عمومی (GENERAL COMMANDS)
       help   نمایش راهنمای سریع درباره دستورات موجود.

دستورات وضعیت (STATUS COMMANDS)
       list-modules
              نمایش تمام ماژول‌های بارگذاری‌شده فعلی به همراه آرگومان‌های آن‌ها.

       list-cards
              نمایش تمام کارت‌های ثبت‌شده فعلی.

       list-sinks or list-sources
              نمایش تمام سینک‌ها (یا به ترتیب، سورس‌های) ثبت‌شده فعلی.

       list-clients
              نمایش تمام کلاینت‌های فعال فعلی.

       list-sink-inputs or list-source-outputs
              نمایش تمام ورودی‌های فعال به سینک‌ها (معروف به استریم‌های پخش) یا
              به ترتیب خروجی‌های سورس‌ها (معروف به استریم‌های ضبط).

       stat   نمایش آمارهای ساده‌ای درباره بلوک‌های حافظه تخصیص‌یافته و فضای
              مصرف‌شده توسط آن‌ها.

       info or ls or list
              ترکیبی از تمام دستورات وضعیت شرح‌داده‌شده در بالا (هر سه دستور
              مترادف یکدیگرند).

مدیریت ماژول‌ها (MODULE MANAGEMENT)
       load-module name [arguments...]
              بارگذاری یک ماژول مشخص‌شده با نام و آرگومان‌های آن. برای اکثر
              ماژول‌ها، بیش از یک بار بارگذاری شدن بلامانع است.

       unload-module index|name
              تخلیه یک ماژول که با نمایه (index) آن در فهرست ماژول‌ها یا نام آن
              مشخص می‌شود.

       describe-module name
              ارائه اطلاعات درباره ماژولی که با نام آن مشخص شده است.

دستورات حجم صدا (VOLUME COMMANDS)
       set-sink-volume|set-source-volume index|name volume
              تنظیم حجم صدای سینک (یا به ترتیب سورس) مشخص‌شده. می‌توانید سینک
              (یا سورس) را با نمایه آن در فهرست سینک‌ها/سورس‌ها یا با نام آن
              مشخص کنید. حجم صدا باید یک مقدار عددی صحیح بزرگ‌تر یا مساوی با 0
              (بی‌صدا) باشد. مقدار حجم صدای 65536 (0x10000) به عنوان حجم صدای
              «عادی» یا همان ۱۰۰٪ در نظر گرفته می‌شود. مقادیر بزرگ‌تر از این،
              سیگنال صوتی را تقویت می‌کنند (همراه با اعوجاج یا بریدگی صدا /
              clipping).

       set-sink-mute|set-source-mute index|name boolean
              بی‌صدا کردن یا لغو بی‌صدایی سینک (یا به ترتیب سورس) مشخص‌شده.
              می‌توانید سینک (یا سورس) را با نمایه یا نام آن مشخص کنید. مقدار
              بی‌صدایی 0 (با صدا) یا 1 (بی‌صدا) است.

       set-sink-input-volume|set-source-output-volume index volume
              تنظیم حجم صدای ورودی سینک (یا به ترتیب خروجی سورس) مشخص‌شده با
              نمایه آن. همان قوانین حجم صدا در set-sink-volume در اینجا نیز
              اعمال می‌شود.

       set-sink-input-mute|set-source-output-mute index boolean
              بی‌صدا کردن یا لغو بی‌صدایی ورودی سینک (یا به ترتیب خروجی سورس)
              مشخص‌شده با نمایه آن. همان قوانین بی‌صدایی در set-sink-mute در
              اینجا نیز اعمال می‌شود.

دستورات پیکربندی (CONFIGURATION COMMANDS)
       set-default-sink|set-default-source index|name
              تنظیم یک سینک (یا به ترتیب سورس) به عنوان پیش‌فرض. می‌توانید سینک
              (یا سورس) را با نمایه آن در فهرست یا با نام آن مشخص کنید. از نام
              ویژه @NONE@ برای لغو سینک یا سورس پیش‌فرض تعیین‌شده توسط کاربر
              استفاده کنید. در این حالت، پالس‌آدیو به انتخاب پیش‌فرض بر اساس
              اولویت بازخواهد گشت.

       توجه داشته باشید که پیش‌فرض‌ها ممکن است توسط ماژول‌های سیاست‌گذاری گوناگون
       یا پیکربندی‌های استریم خاص بازنویسی شوند.

       set-card-profile index|name profile-name
              تغییر نمایه کاربری (profile) یک کارت صدا.

       set-sink-port|set-source-port index|name port-name
              تغییر درگاه (port) یک سینک (یا به ترتیب سورس).

       set-port-latency-offset card-index|card-name port-name offset
              تغییر افست تأخیر یک درگاه متعلق به کارت مشخص‌شده.

       suspend-sink|suspend-source name|index true|false
              تعلیق یا از سرگیری سینک یا سورس مشخص‌شده (که می‌تواند با نام یا
              نمایه تعیین شود)، بسته به اینکه مقدار true (تعلیق) یا false (از
              سرگیری) به عنوان آخرین آرگومان ارسال شده باشد. تعلیق یک سینک
              تمام پخش‌ها را متوقف می‌کند و تعلیق یک سورس تمام ضبط‌ها را متوقف
              می‌سازد. بسته به ماژولی که سینک یا سورس را پیاده‌سازی می‌کند، این
              کار ممکن است منجر به بسته شدن دستگاه زیربنایی شود و آن را برای
              استفاده سایر برنامه‌ها آزاد کند. رفتار دقیق بستگی به ماژول دارد.

       suspend boolean
              تعلیق تمام سینک‌ها و سورس‌ها.

انتقال استریم‌ها (MOVING STREAMS)
       move-sink-input|move-source-output index sink-index|sink-name
              انتقال ورودی سینک (یا به ترتیب خروجی سورس) به سینک (یا به ترتیب
              سورس) دیگر.

فهرست‌های ویژگی (PROPERTY LISTS)
       update-sink-proplist|update-source-proplist index|name properties
              به‌روزرسانی ویژگی‌های سینک (یا به ترتیب سورس) مشخص‌شده با نام یا
              نمایه. ویژگی‌ها به عنوان مثال به صورت device.description="My
              Preferred Name" مشخص می‌شوند.

       update-sink-input-proplist|update-source-output-proplist index
       properties
              به‌روزرسانی ویژگی‌های ورودی سینک (یا به ترتیب خروجی سورس) مشخص‌شده
              با نمایه. ویژگی‌ها مانند بالا مشخص می‌شوند.

حافظه پنهان نمونه‌ها (SAMPLE CACHE)
       list-samples
              فهرست کردن محتویات حافظه پنهان نمونه‌ها.

       play-sample name sink-index|sink-name
              پخش یک ورودی حافظه پنهان نمونه در یک سینک.

       remove-sample name
              حذف یک ورودی از حافظه پنهان نمونه‌ها.

       load-sample name filename
              بارگذاری یک فایل صوتی در حافظه پنهان نمونه‌ها.

       load-sample-lazy name filename
              ایجاد یک ورودی جدید در حافظه پنهان نمونه‌ها، بدون بارگذاری فوری
              آن. نمونه تنها زمانی بارگذاری می‌شود که برای نخستین بار استفاده
              شود. پس از مدتی بیکاری (idle time)، مجدداً حافظه آن آزاد می‌شود.

       load-sample-dir-lazy path
              بارگذاری تمام ورودی‌های موجود در دایرکتوری مشخص‌شده به صورت تنبل
              (lazy) در حافظه پنهان نمونه‌ها. یک عبارت تطبیق الگو (مانند *.wav)
              می‌تواند به انتهای مسیر دایرکتوری افزوده شود.

متوقف‌سازی کلاینت‌ها/استریم‌ها (KILLING CLIENTS/STREAMS)
       kill-client index
              قطع اجباری ارتباط یک کلاینت از سرور. هیچ محافظتی در برابر اتصال
              مجدد فوری کلاینت وجود ندارد.

       kill-sink-input|kill-source-output index
              قطع اجباری یک ورودی سینک (یا به ترتیب خروجی سورس) از سرور. این
              عمل باعث حذف کلاینت مالک یا سایر استریم‌های بازشده توسط همان
              کلاینت از سرور نمی‌شود.

دستورات ثبت گزارش (LOG COMMANDS)
       set-log-level numeric-level
              تغییر سطح ثبت گزارش (log level).

       set-log-meta boolean
              نمایش مکان کد منبع در پیام‌های گزارش.

       set-log-target target
              تغییر مقصد ثبت گزارش (null, auto, journal, syslog, stderr,
              file:PATH, newfile:PATH).

       set-log-time boolean
              نمایش برچسب زمان (timestamp) در پیام‌های گزارش.

       set-log-backtrace num-frames
              نمایش ردگیری پشته (backtrace) در پیام‌های گزارش.

دستورات گوناگون (MISCELLANEOUS COMMANDS)
       play-file filename sink-index|sink-name
              پخش یک فایل صوتی در یک سینک.

       dump   برون‌ریزی پیکربندی فعلی دیمن در قالب دستورات خط فرمان.

       dump-volumes
              اشکال‌زدایی: نمایش وضعیت فعلی تمام حجم‌های صدا.

       shared اشکال‌زدایی: نمایش ویژگی‌های مشترک.

       send-message recipient message message_parameters
              ارسال یک پیام به شیء گیرنده مشخص‌شده. در صورت نیاز می‌توان یک رشته
              اضافی حاوی پارامترهای پیام مشخص کرد. یک رشته به عنوان پاسخ به
              پیام برگردانده می‌شود. برای مشاهده پیام‌های موجود به نشانی
              https://cgit.freedesktop.org/pulseaudio/pulseaudio/tree/doc/messaging_api.txt
              مراجعه کنید.

       exit   پایان دادن به فعالیت دیمن. اگر می‌خواهید اتصال خط فرمان را قطع
              کنید («خروج از حساب / log out»)، می‌توانید از کلید ترکیبی ctrl+d
              استفاده نمایید.

دستورات متا (META COMMANDS)
       علاوه بر دستورات شرح‌داده‌شده در بالا، چند دایرکتیو متا توسط مفسر خط
       فرمان پشتیبانی می‌شوند.

       .include filename|folder
              اجرای دستورات از فایل اسکریپت مشخص‌شده یا از تمام فایل‌های *.pa
              موجود در پوشه.

       .fail and .nofail
              فعال‌سازی (یا به ترتیب غیرفعال‌سازی) توقف اجرای اسکریپت جاری در
              صورت شکست دستورات بعدی. این قابلیت در صورت استفاده در خط فرمان
              تعاملی نادیده گرفته می‌شود.

       .ifexists filename
              اجرای بلوک بعدی دستورات تنها در صورتی که فایل مشخص‌شده وجود داشته
              باشد. معمولاً filename به یک ماژول اشاره دارد. مسیرهای نسبی با در
              نظر گرفتن دایرکتوری ماژول‌ها به عنوان مبنا تحلیل می‌شوند. با
              استفاده از مسیر مطلق، می‌توان وجود سایر فایل‌ها را نیز بررسی کرد.

       .else and .endif
              یک بلوک از دستورات توسط دستور متای .else یا .endif محدود می‌شود.
              تودرتوسازی دستورات شرطی پشتیبانی نمی‌شود.

نویسندگان (AUTHORS)
       توسعه‌دهندگان پالس‌آدیو <pulseaudio-discuss (at) lists (dot) freedesktop
       (dot) org>؛ پالس‌آدیو در http://pulseaudio.org در دسترس است

همچنین ببینید (SEE ALSO)
       default.pa(5), pacmd(1), pulseaudio(1)

Manuals                              User                  pulse-cli-syntax(5)