UPMPDCLI.CONF(5) Upmpdcli UPMPDCLI.CONF(5)

upmpdcli.conf - فایل پیکربندی کلاینت صوتی upmpdcli

upmpdcli.conf فایل پیکربندی برای upmpdcli(1) است. مکان آن باید از طریق متغیر محیطی UPMPD_CONFIG یا از طریق گزینه خط فرمان -c به برنامه شناسانده شود.

هر خط در فایل پیکربندی شامل یک نام تنظیم و مقدار آن است، مانند:

logfilename = /tmp/upmpdcli.log

تقریباً تمام متغیرهای پیکربندی دارای مقادیر پیش‌فرض مناسبی هستند و توزیع برنامه شامل یک فایل نمونه است که معمولاً در /etc نصب می‌شود و متغیرها در آن فهرست شده و توضیح داده شده‌اند.

برای اطلاعات کامل‌تر باید نگاهی به راهنمای برخط بیندازید: http://www.lesbonscomptes.com/upmpdcli/upmpdcli-manual.html

نام فایل گزارش (لاگ). پیش‌فرض stderr است. این مقدار را می‌توان با -d logfilename نیز تعیین کرد. برخی از افزونه‌ها از فایل‌های متفاوتی یا از stderr برای ثبت پیام‌های خود استفاده می‌کنند.
سطح گزارش‌گیری. همچنین می‌تواند با -l loglevel تعیین شود. برخی از افزونه‌ها دارای تنظیمات اختصاصی خود برای کنترل میزان جزئیات گزارش هستند.
فعال‌سازی گزارش‌گیری سطح پایین libnpupnp و تعیین نام خروجی. برای ارسال به stderr مقدار را خالی بگذارید. در صورت عدم تنظیم این متغیر، این گزارش فعال نخواهد بود. برای ارسال پیام‌ها به stderr از یک مقدار خالی استفاده کنید.
سطح گزارش‌گیری برای کتابخانه سطح پایین UPnP. به دلایل تاریخی، مقادیر متناظر ۱ واحد کمتر از مقادیر معادل برای گزارش upmpdcli هستند. مقدار ۴ بسیار پرجزئیات (verbose) است.
دایرکتوری ذخیره‌سازی داده‌های XML و سایر داده‌های ثابت. پیش‌فرض: '$prefix/share/upmpdcli' (مانند: '/usr/share/upmpdcli').
نام فایل قفل مورد استفاده برای ذخیره PID فرایند جاری. تنها زمانی استفاده می‌شود که فرایند توسط کاربر root اجرا شده باشد. توسط سیستم init و برای جلوگیری از اجرای چندین نمونه کاربرد دارد. تنها دلیل تغییر این مقدار آن است که واقعاً بخواهید چندین نمونه را همزمان اجرا کنید (که در این صورت باید cachedir را نیز تغییر دهید).
رابط یا رابط‌های شبکه‌ای برای استفاده در UPnP. می‌توان این متغیر را خالی گذاشت تا نخستین رابط مناسبِ یافت‌شده استفاده شود، یا آن را روی یک نویسه "*" تنظیم کرد تا از تمام رابط‌ها استفاده شود. در غیر این صورت، آن را روی فهرستی از نام‌های رابط‌ها که با فاصله جدا شده‌اند تنظیم کنید (اگر نام‌ها حاوی نویسه فاصله هستند از گیومه دوگانه استفاده کنید).
نشانی IPv4 برای استفاده در UPnP، به عنوان جایگزینی برای استفاده از نام رابط شبکه.
شماره درگاه (پورت) مورد استفاده برای UPnP. مقدار پیش‌فرض libupnp/pupnp اولین درگاه آزاد پس از ۴۹۱۵۲ است. توجه داشته باشید که نیازی نیست کلاینت‌ها از این مقدار آگاه باشند، چرا که به طور خودکار کشف می‌شود.
فعال‌سازی استفاده از IPv6. به طور پیش‌فرض تنها از IPv4 استفاده می‌شود.
«نام ملموس» (Friendly Name) برای پخش‌کننده رسانه (Media Renderer). این نام توسط بیشتر نقاط کنترل (Control Points) برای شناسایی رندرر نمایش داده می‌شود. برخی از نقاط کنترل OpenHome ممکن است به جای آن مقدار 'ohproductroom' را نمایش دهند.
نام ملموس اختصاصی برای پخش‌کننده رسانه UPnP/AV. حالت پیش‌فرض، افزودن "-av" به انتهای مقدار friendlyname است.
فعال‌سازی سرویس‌های UPnP AV (مقدار 0/1). این گزینه به طور پیش‌فرض فعال است، اما اگر فقط از OpenHome استفاده می‌کنید، غیرفعال کردن آن برای جلوگیری از شلوغی گزینه‌های انتخاب رندرر می‌تواند مفید باشد.
فعال‌سازی سرویس‌های OpenHome (مقدار 0/1). پیش‌فرض آن ۱ است، زیرا صف‌بندی OpenHome برای اکثر کاربردها برتر است. معمولاً دلیلی برای خاموش کردن آن وجود ندارد.
غیرفعال‌سازی سرویس اعتبارنامه‌های OpenHome (Credentials). در گذشته، این گزینه برای اینکه Lumin بتواند نمونه‌های upmpdcli را ببیند ضروری بود؛ زیرا به دلایلی نامشخص، برنامه Lumin 1.10 با فعال بودن Credentials قادر به کشف upmpdcli نبود.
ذخیره متاداده در متغیر "metatext" مربوط به OpenHome. سرویس اطلاعات OpenHome داده‌های متفاوتی را عمدتاً برای رادیوها نگهداری می‌کند؛ به طوری که داده‌های دائمی رادیو (آیکون، نشانی اینترنتی، نام رادیو) در متغیر "Metadata" و اطلاعات عنوان جاری در متغیر "Metatext" ثبت می‌شوند. فعال‌سازی این گزینه باعث می‌شود upmpdcli هر داده غیرخالی Metatext را در متغیر Metadata ذخیره کند. این کار به برخی از پخش‌کننده‌ها (مانند Kazoo) در نمایش تصویر جلد آلبوم قطعه جاری کمک می‌کند.
بررسی پشتیبانی از قالب محتوای ورودی. اطلاعات protocolinfo را از متاداده ورودی استخراج کرده و آن را با قالب‌های پشتیبانی‌شده می‌سنجد. اگر یک نقطه کنترل یا مدیا سرور داده‌های صوتی سالم را با متاداده نامعتبر ارسال می‌کند، این گزینه را روی 0 تنظیم کنید.
مسیر آیکون رندرر. این تصویر توسط نقاط کنترلی که از آن پشتیبانی کنند نمایش داده خواهد شد. پروتکل UPnP تدابیری دارد تا رندرر نشانی اینترنتی یک آیکون توصیفی را به عنوان بخشی از توصیف دستگاه ارسال کند. به دلیل محدودیت‌های فعلی (و احتمالاً دائمی) *upmpdcli*، فایل تصویر *باید* یک فایل PNG با ابعاد ۶۴×۶۴ و عمق رنگ ۳۲ بیت بر پیکسل باشد. پیش‌فرض: '$pkgdatadir/icon.png'. آیکون فقط یک بار در هنگام راه‌اندازی upmpdcli خوانده خواهد شد.
ذخیره پارامترهای ورود سرویس‌های پخش جریانی (استریم) روی دیسک. این کار اجازه می‌دهد گذرواژه با پروکسی سرویس استریم مدیا سرور upmpdcli (در صورت استفاده همزمان) به اشتراک گذاشته شود و از لزوم وارد کردن گذرواژه در فایل پیکربندی معمولی جلوگیری می‌کند. بسته به موقعیت شما، ممکن است این مورد یک ریسک امنیتی تلقی شود. مقدار پیش‌فرض true است، زیرا در حالت کلی مسئله مهمی نیست.
مسیر دستور openssl. سرویس OHCredentials به نگارش 1.1.x یا جدیدتر openssl نیاز دارد. مسیر دستور openssl در صورتی که نسخه سیستمی (در /usr/bin) بیش از حد قدیمی باشد در اینجا مشخص می‌شود. به طور پیش‌فرض تنظیم نشده است.
دایرکتوری مورد استفاده برای ذخیره داده‌های کش (حافظه موقت). در حال حاضر فقط برای متاداده صف OpenHome استفاده می‌شود. مقدار پیش‌فرض برای کاربران عادی ‎~/.cache/upmpdcli‎ و در صورت اجرای upmpdcli با دسترسی root برابر با /var/cache/upmpdcli است.
مسیر سند HTML معرفی (presentation). می‌توانید آن را تغییر دهید تا جایگزین صفحه معرفی پیش‌فرض شود. این صفحه فقط یک بار در زمان راه‌اندازی upmpdcli خوانده می‌شود. در حال حاضر نمی‌توان از آن برای به‌روزرسانی‌های وضعیت استفاده کرد (اما می‌توانید در آن یک تغییر مسیر به صفحه‌ای پویاتر که توسط یک سرور HTTP واقعی میزبانی می‌شود قرار دهید). پیش‌فرض: '$pkgdatadir/presentation.html'.
اعلام پشتیبانی از قالب L16. قالب L16 یک جریان صوتی خام خطی ۱۶ بیتی و منشأ مشکلات متعددی است، زیرا اطلاعات شناسایی را شامل نمی‌شود. پیش‌تر به دلیل باگی در mpd که منجر به نویز شدید می‌شد، به طور پیش‌فرض غیرفعال بود. اکنون به طور پیش‌فرض فعال است، اما در صورت نیاز همچنان می‌توان آن را غیرفعال کرد. به نظر می‌رسد این گزینه گاهی تداخل شدیدی با قابلیت "cast to device" ویندوز ۱۰ دارد، بنابراین اگر با این قابلیت مشکل دارید، می‌توانید آن را خاموش کنید.
میزبانی که MPD روی آن اجرا می‌شود. پیش‌فرض localhost است. همچنین می‌تواند با -h host مشخص شود.
درگاه IP مورد استفاده توسط MPD. همچنین می‌تواند با -p port مشخص شود. مقدار پیش‌فرض درگاه معمول MPD یعنی ۶۶۰۰ است.
گذرواژه MPD. گذرواژه برای اتصال به MPD (تنها در صورتی لازم است که دسترسی با گذرواژه در فایل پیکربندی MPD فعال شده باشد).
مهلت زمانی (timeout) اتصال به MPD بر حسب میلی‌ثانیه. اگر این مقدار صفر نباشد، تبادلات با mpd پس از این مدت منقضی می‌شوند. این کار به upmpdcli اجازه می‌دهد در صورت قفل شدن MPD، همچنان پاسخگو بماند (خطا بازگرداند).
تعیین مالکیت صف MPD. اگر این گزینه تنظیم شود (پیش‌فرض فعال است)، ما مالک صف MPD خواهیم بود و با اطمینان آن را پاک خواهیم کرد. همچنین می‌تواند با -q 0|1 تعیین شود.
دستوری که هنگام شروع قریب‌الوقوع پخش اجرا می‌شود. مسیر کامل برنامه را مشخص کنید، مانند /usr/bin/logger.
دستوری که هنگام تغییر وضعیت MPD به "PLAY" اجرا می‌شود. مسیر کامل برنامه را مشخص کنید، مانند /usr/bin/logger.
دستوری که هنگام تغییر وضعیت MPD به "PAUSE" اجرا می‌شود. مسیر کامل برنامه را مشخص کنید، مانند /usr/bin/logger.
دستوری که هنگام تغییر وضعیت MPD به "STOP" اجرا می‌شود. مسیر کامل برنامه را مشخص کنید، مانند /usr/bin/logger.
دستوری که هنگام فراخوانی عملیات setstandby اجرا می‌شود. مسیر کامل برنامه را مشخص کنید. این دستور با یک آرگومان 0/1 برای تغییر وضعیت آماده‌به‌کار (۱ برای فعال‌سازی standby) و بدون آرگومان برای پرس‌وجوی وضعیت فراخوانی می‌شود. در تمامی حالات، باید پیش از خروج، وضعیت آماده‌به‌کار (0/1) را در stdout چاپ کند.
استفاده از دستور خارجی برای مدیریت حجم صدا (0/1). این گزینه در مواردی کاربرد دارد که MPD قادر به کنترل حجم صدا نیست اما دستور دیگری می‌تواند این کار را انجام دهد؛ مثلاً اگر یک آمپلی‌فایر خارجی دارید که می‌توان حجم صدای آن را از طریق اسکریپت‌ها تنظیم کرد و خواند. در صورت فعال بودن، فراخوانی‌های MPD برای تنظیم و خواندن صدا با اجرای 'onvolumechange' و 'getexternalvolume' جایگزین خواهد شد.
دستوری که برای خواندن حجم صدا اجرا می‌شود. این دستور باید یک مقدار عددی بین ۰ تا ۱۰۰ را در stdout بنویسد.
دستوری که برای تنظیم حجم صدا اجرا می‌شود. زمانی استفاده می‌شود که 'externalvolumecontrol' فعال باشد. مسیر کامل برنامه را مشخص کنید؛ این برنامه با حجم صدا به عنوان آرگومان اول فراخوانی می‌شود، مانند /some/script 85.
شبیه‌سازی خودکار دستور Play هنگام تعیین قطعه. در پروتکل UPnP/AV متد SetAVTransportURI که برای تعیین قطعه جهت پخش به کار می‌رود، معمولاً وضعیت جاری انتقال را تغییر نمی‌دهد: اگر ترنسپورت متوقف بوده باشد، یک دستور صریح Play برای شروع پخش لازم است. تنظیم این پارامتر پس از دریافت SetAVTransportURI یک دستور Play ساختگی تولید می‌کند. این ویژگی برای برخی از نقاط کنترل که دستور Play را ارسال نمی‌کنند مورد نیاز است.
نام اتاقی که محصول در آن قرار دارد. به طور پیش‌فرض روی "Main Room" تنظیم شده است و توسط برخی از نقاط کنترل به جای "friendly name" نمایش داده می‌شود. از ProductRoom برای گروه‌بندی محصول با سایر محصولات مرتبط در یک اتاق فیزیکی یکسان استفاده می‌شود (مانند یک منبع همراه با پیش‌آمپلی‌فایر). محصولاتی که به صورت فیزیکی به هم متصل هستند باید همواره نام ProductRoom یکسانی داشته باشند.
مسیر فایل خارجی حاوی تعاریف ایستگاه‌های رادیویی. ایستگاه‌های رادیویی را می‌توان در این فایل (فایل پیکربندی اصلی) یا در یک فایل خارجی (یا هر دو) تعریف کرد. استفاده از فایل خارجی می‌تواند توزیع را در چندین سیستم آسان‌تر کند، ساختار را شفاف‌تر سازد و اکنون حالت پیش‌فرض است. برای اطلاعات در مورد نحوه تعریف ایستگاه رادیویی، به فایل ارائه‌شده (نام در زیر) مراجعه کنید. در صورتی که مایلید رادیوها را در فایل پیکربندی اصلی تعریف کنید، آن‌ها الزماً باید در انتهای فایل قرار گیرند (زیرا به صورت زیربخش‌هایی تعریف می‌شوند که آخرین آن‌ها تا انتهای فایل ادامه می‌یابد).
دایرکتوری اسکریپت‌های متاداده رادیو. مسیر دایرکتوری محل قرارگیری اسکریپت‌هایی که برای دریافت متاداده کانال‌ها استفاده می‌شوند. مقدار پیش‌فرض /usr/share/upmpdcli/radio_scripts است. توجه داشته باشید که اسکریپت‌ها همواره ابتدا در مکان‌های تعریف‌شده در متغیر محیطی PATH جستجو می‌شوند.
نام سازنده.
اطلاعات سازنده.
نشانی اینترنتی وب‌سایت سازنده.
نشانی اینترنتی (URI) نشان‌واره (لوگوی) سازنده.
نام مدل.
اطلاعات مدل.
نشانی اینترنتی وب‌سایت مدل.
نشانی اینترنتی (URI) آیکون مدل.
نام محصول قابل مشاهده برای کاربر. به طور پیش‌فرض روی ModelName تنظیم شده است.
اطلاعات محصول.
نشانی اینترنتی وب‌سایت محصول. این نشانی ممکن است صفحه معرفی UPnP باشد.
نشانی اینترنتی (URI) تصویر محصول.
ذخیره متاداده صف روی دیسک (0/1). این گزینه اجازه می‌دهد اطلاعات متاداده در طول راه‌اندازی‌های مجدد باقی بمانند؛ پیش‌فرض ۱ است و دلیلی برای خاموش کردن آن وجود ندارد.
حداقل بازه زمانی (به ثانیه) میان دو ذخیره‌سازی کش. افزایش این مقدار می‌تواند سرعت بارگذاری فهرست پخش را در دستگاه‌های کند بهبود بخشد. حالت پیش‌فرض این است که به محض اتمام ذخیره قبلی، ذخیره‌سازی جدید آغاز شود (چنانچه در این فاصله فهرست مجدداً تغییر کرده باشد).
نام ملموس (Friendly name) برای سرور رسانه (در صورت فعال بودن). مقدار پیش‌فرض، افزودن "-mediaserver" به انتهای مقدار friendlyname است.
شناسه شیء (Object ID) نام‌مستعار ریشه سرور رسانه. از کانتینر مشخص‌شده سرور رسانه به عنوان ریشه استفاده می‌کند. نقطه کنترل در هنگام اتصال، مستقیماً این کانتینر را نمایش می‌دهد که مانع از نیاز به پیمایش سطوح بالایی (در صورت عدم استفاده از آن‌ها) می‌شود (مثلاً نمایش مستقیم فهرست افزونه‌های فعال در صورتی که تنها یک افزونه وجود داشته باشد). این مقدار یک شناسه شیء UPnP است که متأسفانه عموماً از نقاط کنترل قابل دریافت نیست. با این حال مقادیر پرکاربرد ساده هستند:
- `0$uprcl$` دسترسی مستقیم به ریشه رسانه محلی (Local Media)
- `0$uprcl$folders` دسترسی مستقیم به درخت [پوشه‌های] رسانه محلی

یک نام مستعار باید با `0` (که شناسه اجباری شیء ریشه در UPnP است) شروع شود و پس از آن `$pluginname$` قرار گیرد که در آن _pluginname_ می‌تواند هر زیردایرکتوری از `/usr/share/upmpdcli/cdplugins` به جز `pycommon` باشد (مانند `uprcl`، `qobuz`، `upradios` و...)، و باقی مسیر بسته به نوع افزونه متفاوت خواهد بود.

نام میزبان/نشانی IP مورد استفاده در آدرس‌های پروکسی. حالت پیش‌فرض استفاده از همان میزبان/نشانی سرور UPnP است. استفاده از localhost/127.0.0.1 باعث از دست رفتن قابلیت استریم به یک رندرر راه دور می‌شود، اما امکان داشتن فهرست‌های پخش قابل حمل را فراهم می‌سازد.
درگاه IP برای سرویس HTTP محلی Subsonic، Tidal یا Qobuz. نشانی قطعاتی که از این سرویس‌ها استریم می‌شوند، به یک سرور HTTP محلی microhttpd اشاره دارد که روی این درگاه اجرا می‌شود. این سرور هنگام پخش جریانی از هدایت مجدد (redirection) به نشانی اصلی سرویس یا ارسال پروکسی از آن استفاده می‌کند. مقدار پیش‌فرض ۴۹۱۴۹ است.
تعیین اینکه جریان‌های سرویس‌های استریم پروکسی شوند (کپی از سرویس به رندرر) یا هدایت مجدد گردند (redirect). این تنظیم مربوط به نحوه مدیریت پاسخ دریافتی از یک سرویس پخش جریانی مانند Subsonic، Tidal یا Qobuz است. نشانی‌هایی که این سرویس‌ها ارائه می‌دهند معمولاً کوتاه‌مدت هستند، بنابراین نمی‌توانند بخشی از یک فهرست پخش باشند. upmpdcli این منابع را در پس یک نشانی پایدار پنهان می‌کند که به رندرر (پخش‌کننده) ارائه می‌شود.

با تنظیم پیش‌فرض "redirect"، نشانی پایدار به یک تغییر مسیر HTTP 302 تبدیل می‌شود که به منبع اصلی استریم اشاره دارد. رندرر باید این تغییر مسیر را دنبال کرده و سپس از مکان اصلی پخش را انجام دهد. برخی از رندررها (مانند گیرنده‌های صوتی‌تصویری AV) قادر به دنبال کردن تغییر مسیر HTTP نیستند.

با تنظیم "proxy"، نشانی اصلی پنهان می‌ماند و هیچ هدایت مجددی وجود ندارد. upmpdcli موسیقی را از سرویس راه دور خوانده و همزمان به رندرر ارائه می‌دهد. این روش در مقایسه با هدایت مجدد، منابع بیشتری مصرف می‌کند و کارایی کمتری دارد، اما برخی رندررها از تغییر مسیر HTTP پشتیبانی نمی‌کنند.

مسیر آیکون سرور رسانه. تصویر توسط نقاط کنترلی که از آن پشتیبانی کنند نمایش داده خواهد شد. با توجه به محدودیت‌های فعلی (و احتمالاً دائمی) *upmpdcli*، فایل تصویر *باید* یک فایل PNG با ابعاد ۶۴×۶۴ و عمق رنگ ۳۲ بیت بر پیکسل باشد. پیش‌فرض: '$pkgdatadir/icon.png'. این آیکون فقط یک بار در هنگام راه‌اندازی upmpdcli خوانده می‌شود.
مسیری که سرور HTTP مربوط به UPnP فایل‌ها را از آن ارائه می‌دهد: 0:none (هیچ‌کدام)، 1:auto (خودکار)، مسیر مطلق: استفاده از آن مسیر. برخی از افزونه‌های سرور رسانه به آن نیاز دارند، مثلاً برای ارائه فایل‌های آیکون یا داده‌های کش‌شده. مقدار پیش‌فرض ۱ است که منجر به مسیر واقعی /var/cache/upmpdcli/www یا ‎~/.cache/upmpdcli/www‎ می‌شود.
نام کاربری Hra. نام ورود شما به حساب Hra.
گذرواژه Hra. گذرواژه برای حساب Hra شما.
تنظیم زبان Hra (مقادیر en/de). برخی پیام‌های Highresaudio به زبان مناسب تنظیم خواهند شد.
عنوان افزونه. این مقدار به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
نام کاربری Qobuz (مقدار می‌تواند ساختگی باشد). نام ورود شما به Qobuz. این متغیر باید برای فعال‌سازی افزونه سرور رسانه تنظیم شود، اما مقدار واقعی استفاده نمی‌شود.
کیفیت استریم Qobuz. مقدار ۵ برای mp3/320، مقدار ۶ برای FLAC، مقدار ۷ برای FLAC 24/96، مقدار ۲۷ برای کیفیت بسیار بالا (hi-res) (در صورتی که اشتراک شما اجازه پخش هر یک از قالب‌ها را بدهد).
شماره‌گذاری مجدد قطعات Qobuz. شماره‌گذاری مجدد قطعات با شمارش عناصر که از بروز مشکل در Kodi جلوگیری می‌کند. به طور پیش‌فرض فعال است.
شماره‌های صریح آیتم‌ها در کروشه. افزودن شماره آیتم‌ها در کروشه در فهرست‌ها، عمدتاً برای سازگاری و کاربرد در Kodi. به طور پیش‌فرض غیرفعال است.
نام هنرمند پیش از آلبوم در فهرست آلبوم‌ها. درج نام هنرمند قبل از آلبوم در فهرست‌های آلبوم، عمدتاً برای سازگاری و کاربرد در Kodi. به طور پیش‌فرض غیرفعال است.
عنوان افزونه. این مقدار به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
متغیر ساختگی نام کاربری. تعیین می‌کند که آیا سرویس باید راه‌اندازی شود یا خیر. آن را روی هر مقدار دلخواهی تنظیم کنید.
نوع توکن احراز هویت OAuth2. نوع توکن مورد استفاده برای احراز هویت OAUTH2، معمولاً Bearer.
حداکثر کیفیت استریم Tidal. مقدار LOW برای mp3/96، مقدار HIGH برای mp3/320، مقدار LOSSLESS برای FLAC 16/44، مقدار HI_RES برای FLAC تا سقف 24/48، و HI_RES_LOSSLESS برای فایل‌های بسیار باکیفیت FLAC (در صورتی که اشتراک شما اجازه پخش هر یک از قالب‌ها را بدهد).
عنوان افزونه. این عنوان به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
استفاده از شماره آیتم‌ها در فهرست آلبوم‌ها برای سازگاری با Kodi. نرم‌افزار Kodi همواره تلاش می‌کند موارد را مرتب‌سازی کند؛ با این پارامتر آن را وادار می‌کنیم ورودی‌ها را به ترتیب دلخواه نمایش دهد.
فعال‌سازی کش تصاویر، نیازمند webdocumentroot. به افزونه اجازه می‌دهد تصاویر هنرمندان و آلبوم‌ها را کش کند. نیازمند webdocumentroot و مقداری فضای دیسک است؛ استفاده از آن توصیه می‌شود.
محدودیت جستجوی Tidal. تعیین حداکثر تعداد موارد بازگردانده‌شده در جستجو، پیش‌فرض ۱۵ است.
بازنویسی کد کشور. به شما امکان می‌دهد کد دورقمی کشور مورد نظر را مشخص کنید. در صورت مشخص نشدن، پیش‌فرض روی کد کشور نمایه کاربری قرار می‌گیرد.
عبارت باقاعده (Regex) برای شناسه قطعه. عبارتی که برای اعتبارسنجی track_id در trackuri استفاده می‌شود. تنها در صورتی که کاملاً به کار خود آگاهی دارید آن را تنظیم کنید.
فعال‌سازی گزارش‌گیری پرجزئیات، پیش‌فرض 0 (خیر). گزارش‌گیری با جزئیات بیشتر را فعال می‌کند که ممکن است برای آزمایش مفید باشد.
متغیر ساختگی نام کاربری. برای حفظ هماهنگی با سایر افزونه‌های سرور رسانه جهت تصمیم‌گیری در مورد راه‌اندازی سرویس استفاده می‌شود (بنابراین اگر خواهان سرور رسانه هستید آن را تنظیم کنید). احتمالاً مایل خواهید بود uprclautostart=1 را نیز تنظیم کنید تا راه‌اندازی اولیه همزمان با شروع برنامه آغاز شود.
عنوان افزونه. این مقدار به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
دایرکتوری‌های رسانه. این یک فهرست جداشده با فاصله از دایرکتوری‌هایی است که باید برای یافتن فایل‌های صوتی جستجو شوند. این مقدار مستقیماً به عنوان مقدار "topdirs" در recoll استفاده می‌شود، بنابراین می‌توانید برای مسیرهای دارای فاصله از گیومه دوگانه استفاده کنید. در صورت تنظیم نشدن، تلاش می‌شود از contentDirs پیکربندی Minim استفاده شود. اگر هر دو خالی باشند خطایی رخ خواهد داد.
عدم ایجاد فهرست رادیوی محلی به عنوان فهرست پخش. به طور پیش‌فرض، uprcl فهرست رادیوهای محلی را پردازش کرده و آن را به عنوان یک فهرست پخش (در کانتینر بالایی Playlists) در دسترس قرار می‌دهد. این کار می‌تواند راه‌اندازی اولیه را کند کند و در صورت فعال بودن افزونه upradios بی‌فایده است، بنابراین می‌توانید با این متغیر آن را غیرفعال کنید.
میزبان و درگاه سرور HTTP مربوط به uprcl برای ارائه فایل‌های رسانه‌ای. Uprcl از یک سرور HTTP مجزا مبتنی بر چارچوب پایتون Bottle و وب‌سرور Waitress استفاده می‌کند. سرور HTTP به این نشانی و درگاه گوش فرا خواهد داد که در نشانی‌های تولیدی ما نیز درج خواهد شد. اگر این متغیر تنظیم نشود، از درگاه 9090 و همان نشانی سرور مورد استفاده برای سایر سرویس‌ها (یا plgmicrohttphost یا نخستین نشانی IPv4 مورد استفاده در لایه upnp) استفاده می‌شود. مثال: 192.168.1.1:9090. از آنجا که استفاده از نشانی یکسان با لایه upnp منطقی است، برای تعیین صرفاً شماره درگاه به uprclport نیز مراجعه کنید.
درگاه سرور HTTP مربوط به uprcl برای ارائه فایل‌های رسانه‌ای. درگاهی که برای گوش فرا دادن به درخواست‌های رسانه‌ای استفاده می‌شود. نشانی شنود یا plgmicrohttphost (در صورت تنظیم) یا نخستین نشانی IPv4 مورد استفاده توسط لایه upnp خواهد بود. در صورت تنظیم uprclhostport نادیده گرفته می‌شود.
دایرکتوری نمایه Recoll مربوط به uprcl. این گزینه معمولاً تعریف نمی‌شود و پیش‌فرض آن /var/cache/upmpdcli/uprcl است. نام آن کمی گمراه‌کننده است زیرا داده‌های پیکربندی واقعی اندکی در آن وجود دارد: بیشتر داده‌ها به صورت برنامه‌ریزی‌شده از پیکربندی واقعی در مکان‌های دیگر تولید می‌شوند (اما به uprclconfrecolluser نیز مراجعه کنید).
نام فایل الحاقات پیکربندی کاربر برای Recoll. این نام فایلی با پارامترهای اضافی برای فایل recoll.conf در uprcl است که محتویات آن پیش از نمایه‌سازی به انتهای فایل افزوده می‌شود. پیش‌فرض /var/cache/upmpdcli/uprcl/recoll.conf.user است. در صورت تنظیم، باید یک مسیر مطلق باشد.
نام فایل پیکربندی Minim Server. در صورت تنظیم، این نام فایل پیکربندی Minim Server است که پارامترهایی مانند aliasTags و غیره باید از آن واکشی شوند (راهنما را ببینید). به طور پیش‌فرض تنظیم نشده و اختیاری است.
حذف ورودی‌های "Tag View" در پوشه‌ها. ورودی "Tag View" امکان مرور یک زیردایرکتوری را بر اساس برچسب‌ها فراهم می‌کند. این ویژگی می‌تواند بسیار مفید باشد اما ممکن است با برخی از نقاط کنترل یا شیوه‌های استفاده ناسازگار باشد.
عدم اجرای نمایه‌ساز در هنگام راه‌اندازی. عمدتاً برای صرفه‌جویی در زمان به هنگام راه‌اندازی مجدد سرور جهت اشکال‌زدایی کاربرد دارد.
متغیر ساختگی نام کاربری. برای حفظ هماهنگی با سایر افزونه‌های سرور رسانه جهت تصمیم‌گیری در مورد راه‌اندازی سرویس استفاده می‌شود (بنابراین اگر می‌خواهید فهرست رادیوها را ببینید، آن را تنظیم کنید).
عنوان افزونه. این مقدار به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
حداکثر تعداد نخ‌ها (threads) برای استفاده در هنگام مقداردهی اولیه فهرست رادیوها. بیشتر رادیوها توسط فایل‌های فهرست پخش تعریف می‌شوند که ممکن است پیش از دستیابی به نشانی واقعی قابل استفاده توسط نقطه کنترل، نیازمند چندین تعامل شبکه‌ای باشند. ما برای تسریع این فرآیند از چندین نخ استفاده می‌کنیم؛ این متغیر حداکثر تعداد نخ‌ها را مشخص می‌کند.
متغیر ساختگی نام کاربری. تعیین می‌کند که آیا سرویس باید راه‌اندازی شود یا خیر. آن را روی هر مقدار دلخواهی تنظیم کنید.
عنوان افزونه. این مقدار به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
توکن IPInfo. توکن ipinfo خود را به منظور داشتن میان‌بر برای رادیوهای محلی تنظیم کنید.
کشور ترجیحی. این متغیر را روی کشور ترجیحی تنظیم کنید تا میان‌بر رادیوهای محلی را داشته باشید. این گزینه جایگزینی برای استفاده از توکن ipinfo است. مقادیر باید در قالب یک کد کشور مشخص شوند، مانند `FR`، `IT` و غیره.
متغیر ساختگی نام کاربری. تعیین می‌کند که آیا سرویس باید راه‌اندازی شود یا خیر. آن را روی هر مقدار دلخواهی تنظیم کنید.
عنوان افزونه. این عنوان به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
متغیر ساختگی نام کاربری. تعیین می‌کند که آیا سرویس باید راه‌اندازی شود یا خیر. آن را روی هر مقدار دلخواهی تنظیم کنید.
عنوان افزونه. این عنوان به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
نام کاربری SubSonic. تعیین می‌کند که آیا سرویس باید راه‌اندازی شود یا خیر. آن را روی نام کاربری مناسب تنظیم کنید.
گذرواژه SubSonic. برای احراز هویت در SubSonic لازم است. آن را روی گذرواژه مناسب تنظیم کنید.
حالت احراز هویت سنتی SubSonic. برای احراز هویت SubSonic در برخی از سرورها (مانند lms) لازم است. برای فعال‌سازی آن را روی 1 تنظیم کنید.
عامل کاربر (User Agent) ساب‌سونیک. به شما امکان می‌دهد عامل کاربر را در درخواست‌های HTTP مشخص کنید؛ پیش‌فرض upmpdcli است.
اجبار به خالی بودن عامل کاربر. در صورتی که عامل کاربر پیش‌فرض مشکلاتی ایجاد می‌کند، ممکن است بخواهید این گزینه را فعال کنید (نتایج بسته به شرایط متغیر است).
نشانی پایه سرور SubSonic. نشانی وب سرور بدون درگاه. http یا https را مشخص کنید.
درگاه سرور SubSonic. درگاه سرور SubSonic.
مسیر سرور SubSonic. اختیاری؛ تنها در صورتی استفاده شود که سرور در یک مسیر اختصاصی ارائه شده باشد.
تعداد آیتم‌ها در هر صفحه در SubSonic. تعداد موارد در هر صفحه برای SubSonic.
مهلت زمانی کش هنرمندان در SubSonic. مهلت زمانی کش برای هنرمندان؛ پیش‌فرض ۶۰۰ است.
افزودن سال به کانتینر آلبوم. در صورت فعال بودن، سال به آلبوم به عنوان یک کانتینر افزوده خواهد شد. به طور پیش‌فرض فعال است.
افزودن سال به نمای آلبوم. در صورت فعال بودن، سال به نمای آلبوم اضافه خواهد شد. به طور پیش‌فرض غیرفعال است.
افزودن سال به آلبوم در نتایج جستجو. در صورت فعال بودن، سال به آلبوم به عنوان نتیجه جستجو افزوده می‌شود. به طور پیش‌فرض غیرفعال است.
افزودن نقش‌ها به هنرمندان. در صورت فعال بودن، نقش‌های هنرمند به ورودی‌های هنرمندان اضافه می‌شود. به طور پیش‌فرض فعال است.
فعال‌سازی تبدیل قالب (ترنسکدینگ). اگر مقداری تنظیم شود، به عنوان کدک فرآیند تبدیل قالب استفاده خواهد شد. این مقدار باید پسوند فایل قالب مورد نظر (بدون نقطه ابتدایی) باشد، مانند "mp3" یا "flac"، زیرا این مقدار پایه ارتباط نوع MIME صحیح به رندرر را فراهم می‌سازد.

این یک متن آزاد است که در تبادل داده میان سرور Subsonic (مانند Navidrome) و upmpdcli استفاده می‌شود. سرور باید مدخل متناظر با این مقدار قالب را داشته باشد تا دستور ترنسکدینگ اختصاص‌یافته را آغاز کند.

تبدیل قالب برای فایل‌هایی که در حال حاضر در قالب درخواستی هستند انجام نمی‌شود.

تعیین حداکثر نرخ بیت برای ترنسکدینگ. در صورت تنظیم مقدار، به عنوان بیشینه نرخ بیت برای فرآیند تبدیل قالب استفاده خواهد شد.
فعال‌سازی اسکروبل سمت سرور. در صورت فعال بودن، هنگام شروع استریم، قطعه اسکروبل خواهد شد. به طور پیش‌فرض غیرفعال است.
افزودن شماره ترتیبی به آلبوم در فهرست آلبوم‌ها. عمدتاً برای سازگاری و کاربرد در Kodi. به طور پیش‌فرض فعال است.
فعال‌سازی رادیوهای اینترنتی در Subsonic. رادیوهای اینترنتی را فعال می‌کند. به طور پیش‌فرض غیرفعال است؛ upmpdcli چندین راهکار را برای مدیریت رادیوهای اینترنتی ارائه می‌دهد.
نمایش ورودی‌های خالی علاقه‌مندی‌ها در Subsonic. نمایش اجباری ورودی‌ها برای بخش علاقه‌مندی‌ها (Favorites)، حتی اگر هیچ موردی وجود نداشته باشد؛ به طور پیش‌فرض غیرفعال است.
نمایش ورودی خالی فهرست‌های پخش در Subsonic. اجبار به نمایش ورودی برای فهرست‌های پخش (Playlists)، حتی اگر هیچ فهرست پخشی موجود نباشد؛ به طور پیش‌فرض غیرفعال است.
عنوان افزونه. این مقدار به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
نمایش سبک‌ها در نمای آلبوم در Subsonic. نمایش سبک‌ها (ژانرها) در نمای آلبوم؛ به طور پیش‌فرض غیرفعال است.
نمایش سبک‌ها در ورودی کانتینر آلبوم در Subsonic. نمایش سبک‌ها در کانتینر آلبوم که در فهرست‌های آلبوم استفاده می‌شود؛ به طور پیش‌فرض غیرفعال است.
فعال‌سازی کش تصاویر، نیازمند webdocumentroot. به افزونه اجازه می‌دهد تصاویر را از سرور کش کند. نیازمند webdocumentroot و مقداری فضای دیسک است؛ توصیه می‌شود.
فعال‌سازی پاک‌سازی (هرس) کش تصاویر، نیازمند webdocumentroot. به افزونه اجازه می‌دهد تصاویر قدیمی کش‌شده را از سرور پاک کند؛ توصیه می‌شود.
محدودیت سن فایل‌های تصویری در کش به روز. حداکثر سن فایل تصویری را به روز مشخص می‌کند و زمانی که هرس کش فعال باشد اهمیت دارد.
فعال‌سازی استفاده از تصویر جلد هنرمندان؛ پیش‌فرض فعال است. برای جلوگیری از استفاده از coverArt هنرمندان مقدار آن را روی `0` قرار دهید، زیرا در صورت فعال بودن Spotify ممکن است در تعامل با Navidrome سنگین و کند باشد.
فعال‌سازی ویژگی‌های نگهداری، مانند فهرست کردن آلبوم‌های بدون شناسه MusicBrainz. برای فعال‌سازی ویژگی‌های نگهداری کتابخانه مقدار را روی 1 بگذارید؛ به طور پیش‌فرض غیرفعال است.
نمایش آلبوم‌های هنرمند از جدیدترین به قدیمی‌ترین در صورت خالی گذاشتن یا تنظیم روی 1. امکان تغییر ترتیب مرتب‌سازی آلبوم‌های هنرمند را می‌دهد. اگر می‌خواهید ترتیب صعودی باشد به جای نزولی (پیش‌فرض)، آن را روی 0 تنظیم کنید.
تعداد آهنگ‌ها در فهرست آهنگ‌های تصادفی (Random Songs). حداکثر تعداد آهنگ‌ها در این فهرست را مشخص می‌کند؛ پیش‌فرض ۲۵۰ است و نمی‌تواند بیشتر از ۵۰۰ باشد.
متغیر ساختگی نام کاربری. برای فعال‌سازی افزونه این متغیر را مقداردهی کنید؛ خود مقدار نادیده گرفته می‌شود.
روزهای گذشته در فهرست کاتالوگ BBC Sounds. این متغیر کنترل می‌کند چند روز در نمایش ایستگاه فهرست شوند.
عنوان افزونه. این مقدار به عنوان مدخل افزونه در دایرکتوری ریشه سرور رسانه نمایش داده خواهد شد.
نام فایل گزارش برای sc2mpd (پیش‌فرض stderr). این مقدار *نباید* با مقدار مورد استفاده برای upmpdcli یکسان باشد (مگر اینکه خالی باشد).
میزان جزئیات گزارش‌گیری برای sc2mpd.
روش پخش در sc2mpd (مقادیر mpd/alsa). با تنظیم این مقدار روی 'alsa'، برنامه sc2mpd صدا را مستقیماً به درایور صوتی ارسال می‌کند که تنها راه واقعی برای جلوگیری از پرش و کنترل همگام‌سازی در پیکربندی‌های چنداتاقه است. *برای 'alsa'، اطمینان حاصل کنید که کاربر upmpdcli دسترسی لازم به دستگاه‌های صوتی را دارد!*
درگاه مورد استفاده توسط sc2mpd برای اتصال MPD. فقط برای scplaymethod=mpd استفاده می‌شود. sc2mpd تنها اتصالات از localhost را می‌پذیرد.
دستگاه Alsa مورد استفاده توسط sc2mpd برای پخش صدا. تنها برای scplaymethod=alsa کاربرد دارد. برای مشاهده مقادیر مجاز از 'aplay -L' استفاده کنید.
روش بازنمونه‌برداری (resampling) در sc2mpd. تنها برای scplaymethod=alsa کاربرد دارد. sc2mpd از libsamplerate استفاده می‌کند. روش پیش‌فرض SRC_SINC_FASTEST است و رزبری‌پای ۱ نیز سرعت کافی برای استفاده از آن را دارد. مقادیر مجاز: SRC_SINC_BEST_QUALITY، SRC_SINC_MEDIUM_QUALITY، SRC_SINC_FASTEST، SRC_ZERO_ORDER_HOLD، SRC_LINEAR. برای مشاهده توضیحات به مستندات libsamplerate مراجعه کنید. هر روشی بالاتر از SRC_SINC_FASTEST به پردازنده‌ای قدرتمند نیاز دارد. BEST_QUALITY تقریباً ۲۵٪ پردازنده را در Core i7 4770T اشغال می‌کند که مسلماً بیش از حد زیاد است و شاید در عمل پایدار نباشد (تقریباً معادل ۱۰۰٪ یک هسته است). MEDIUM_QUALITY در همان سیستم حدود ۱۰٪ و FASTEST بین ۴ تا ۵٪ مصرف دارد. با توجه به اینکه این مقدار برای کل فرایند اندازه‌گیری شده، سهم تبدیل در واقع چند درصد است. مقدار NONE بازنمونه‌برداری را خاموش می‌کند: کمترین مصرف پردازنده و بهترین کیفیت، اما بروز گاه‌به‌گاه ناهماهنگی بر اساس انحراف ساعت‌ها (clock skew) قطعی خواهد بود.
مقیاس‌بندی جریان songcast بر اساس مقدار حجم صدای mpd. امکان کنترل صدا از نقطه کنترل را با تغییر مقیاس جریان صوتی بر اساس مقدار حجم صدای mpd فراهم می‌سازد. تنها در صورتی عمل می‌کند که scplaymethod برابر با 'alsa' باشد.
مسیر sc2mpd. تنها در صورتی کاربرد دارد که در /usr/bin نباشد و مکان آن در متغیر PATH برای اسکریپت‌های init موجود نباشد.
مسیر فایل وضعیت screceiver. در صورت تنظیم، نشانی و متاداده فرستنده هنگام مقداردهی اولیه سرویس گیرنده Songcast از این فایل خوانده شده و هنگام تعیین یک فرستنده برای سرویس در فایل نوشته می‌شوند. برای حفظ اطلاعات فرستنده بین راه‌اندازی‌های مجدد مفید است.
!!گیرنده‌های استاندارد Songcast فقط از PCM پشتیبانی می‌کنند!! کدک مورد استفاده برای جریان شبکه. برای پشتیبانی از گیرنده‌های خارجی، آن را خالی بگذارید یا روی PCM تنظیم کنید؛ یا برای بار شبکه کمتر از FLAC یا OPUS استفاده کنید.
مسیر اسکریپت راه‌انداز. این اسکریپت معمولاً scmakempdsender است که mpd کمکی و فرایند فرستنده را اجرا می‌کند. به طور پیش‌فرض خالی است و در PATH جستجو می‌شود.
مقیاس‌بندی جریان Songcast. در صورت تنظیم، کنترل نرم‌افزاری حجم صدای MPD روی جریان اعمال خواهد شد. به طور پیش‌فرض True است: استفاده از یک نقطه کنترل برای تنظیم صدا روی نمونه upmpdcli که فرستنده را آغاز کرده، حجم صدای تمام گیرنده‌ها را تحت تأثیر قرار می‌دهد.
درگاه localhost برای استفاده توسط mpd کمکی.
دایرکتوری اسکریپت‌های منابع خارجی. مکان اسکریپت‌های مورد استفاده برای برپایی منابع خارجی اضافی. به صفحه مستندات پشتیبانی Songcast Sender مراجعه کنید.
مهلت مدارا (بر حسب ثانیه) برای انتظار جهت خروج فرایند اسکریپت پیش از خاتمه اجباری (kill) آن. پیش‌فرض ۲ ثانیه است.

upmpdcli(1)

March 4, 2024 1.8.8