steelseries sonar py

steelseries sonar py ثون API

وضع غاسل قيد التطوير حاليا!

ملخص

توفر حزمة Python هذه واجهة ملائمة للتفاعل مع واجهة برمجة تطبيقات تطبيق SteelSeries Sonar.
يتيح تطبيق Sonar للمستخدمين التحكم وعرض مستويات الصوت لمختلف القنوات الصوتية.

تثبيت

لاستخدام هذه الحزمة، اتبع الخطوات التالية:

1. تثبيت الحزمة باستخدام النقطة:

   pip install steelseries-sonar-py

2. قم باستيراد فئة Sonar في برنامج Python النصي أو التطبيق الخاص بك:

    from steelseries_sonar_py import Sonar 

الاستخدام

تهيئة كائن السونار

تقبل فئة Sonar معلمتين اختياريتين أثناء التهيئة:
streamer_mode : اضبط على True لاستخدام وضع البث (الوضع الافتراضي هو False).
app_data_path : حدد مسارًا مخصصًا لملف SteelSeries Engine 3 coreProps.json
(الافتراضي هو مسار التثبيت الافتراضي: C:\ProgramData\SteelSeries\SteelSeries Engine 3\coreProps.json ).

 sonar = Sonar ( app_data_path = "C: \ path \ to \ coreProps.json" )

أو

 sonar = Sonar ( app_data_path = "C: \ path \ to \ coreProps.json" , streamer_mode = True )

وضع غاسل

تدعم واجهة برمجة تطبيقات steelseries sonar py وضع البث، والذي يسمح للمستخدمين بإدارة شريطي تمرير منفصلين: streaming monitoring . تتيح أشرطة التمرير هذه التحكم الدقيق في القنوات الصوتية المختلفة.

للتحقق من تمكين وضع البث، استخدم:

 is_streaming = sonar . is_streamer_mode ()
print ( "Is Streamer Mode:" , is_streaming )

لتمكين وضع البث أو تعطيله، استخدم:

 # Enable streamer mode
sonar . set_streamer_mode ( True )

# Disable streamer mode
sonar . set_streamer_mode ( False )

استرداد معلومات الحجم

استرجاع المعلومات حول إعدادات الصوت الحالية لجميع القنوات:

 volume_data = sonar . get_volume_data ()
print ( volume_data )

ضبط مستوى الصوت للقناة

ضبط مستوى الصوت لقناة معينة. يجب أن تكون معلمة channel واحدة مما يلي:
master , game , chatRender , media , aux , chatCapture . يجب أن تكون معلمة volume عائمة بين 0 و1.
بالإضافة إلى ذلك، يمكن توفير معلمة streamer_slider اختيارية، مع القيم "streaming" (افتراضي) أو "monitoring":

 channel = "master"
volume = 0.75
streamer_slider = "streaming"  # or "monitoring"

result = sonar . set_volume ( channel , volume , streamer_slider = streamer_slider )
print ( result )

كتم/إلغاء كتم صوت القناة

تبديل حالة كتم الصوت لقناة معينة. يجب أن تكون معلمة channel واحدة مما يلي:
master , game , chatRender , media , aux , chatCapture . يجب أن تكون المعلمة muted منطقية تشير إلى ما إذا كان سيتم كتم صوت القناة ( True ) أو إلغاء كتم صوتها ( False ).
بالإضافة إلى ذلك، يمكن توفير معلمة streamer_slider اختيارية، مع القيم "streaming" (افتراضي) أو "monitoring":

 channel = "game"
muted = True
streamer_slider = "monitoring"

result = sonar . mute_channel ( channel , muted , streamer_slider = streamer_slider )
print ( result )

Chatmix

استرداد بيانات مزيج الدردشة:

 chatmix_data = sonar . get_chat_mix_data ()
print ( chatmix_data )

قم بتعيين قيمة مزيج الدردشة بين -1 and 1 لتركيز الصوت من game أو قناة chatRender :

 result = sonar . set_chat_mix ( 0.5 )
print ( result )

الاستثناءات

تقدم الحزمة مجموعة من الاستثناءات التي قد تثار أثناء الاستخدام.
يُنصح بمعالجة هذه الاستثناءات وفقًا لذلك في التعليمات البرمجية الخاصة بك.
يمكنك استيرادها من steelseries_sonar_py.exceptions . فيما يلي قائمة الاستثناءات المحتملة:

• EnginePathNotFoundError : يظهر عندما لا يتم تثبيت SteelSeries Engine 3 أو عندما لا يكون في الموقع الافتراضي.
• ServerNotAccessibleError : يظهر عندما لا يمكن الوصول إلى خادم SteelSeries. يوفر رمز حالة HTTP.
• SonarNotEnabledError : يظهر عند عدم تمكين SteelSeries Sonar.
• ServerNotReadyError : يظهر عندما لا يكون جهاز SteelSeries Sonar جاهزًا.
• ServerNotRunningError : يظهر عندما لا يكون SteelSeries Sonar قيد التشغيل.
• WebServerAddressNotFoundError : يُثار عندما لا يتم العثور على عنوان خادم الويب.
• ChannelNotFoundError : يتم رفعه عند عدم العثور على القناة المحددة.
• InvalidVolumeError : يتم رفعه عند توفير قيمة حجم غير صالحة.
• InvalidMixVolumeError : يتم رفعه عند توفير قيمة حجم مزيج غير صالحة.
• SliderNotFoundError : يتم رفعه عند تقديم اسم شريط تمرير غير معروف كقيمة streamer_slider .

مثال

فيما يلي مثال كامل يوضح استخدام واجهة برمجة تطبيقات steelseries sonar py :

 from steelseries_sonar_py import Sonar
from steelseries_sonar_py . exceptions import EnginePathNotFoundError

# Initialize Sonar object
try :
    sonar = Sonar ( app_data_path = "C: \ path \ to \ coreProps.json" )
except EnginePathNotFoundError :
    print ( "Engine not found!" )
    quit ()

# Retrieve volume data
volume_data = sonar . get_volume_data ()
print ( "Volume Data:" , volume_data )

# Set volume for the 'master' channel
channel = "master"
volume = 0.8
streamer_slider = "streaming"
result = sonar . set_volume ( channel , volume , streamer_slider = streamer_slider )
print ( f"Set volume for { channel } :" , result )

# Mute the 'game' channel
channel = "game"
muted = True
streamer_slider = "monitoring"
result = sonar . mute_channel ( channel , muted , streamer_slider = streamer_slider )
print ( f"Mute { channel } :" , result )

# Retrieve chat-mix data
chatmix_data = sonar . get_chat_mix_data ()
print ( "Chatmix Data:" , chatmix_data )

# Set chat-mix value
result = sonar . set_chat_mix ( 0.5 )
print ( "Set Chatmix:" , result )

شكر خاص

شكرًا لجميع المساهمين الذين جعلوا هذه الحزمة ممكنة - wex لاكتشاف واجهة برمجة التطبيقات (API)، وTotalPanther317 لفهم وضع البث وملفات تعريف الارتباط لميزات مثل مزيج الدردشة واكتشاف وضع البث. شاكرين جهودهم!

تعكس هذه الوثائق الآن أحدث التغييرات والإضافات إلى واجهة برمجة تطبيقات steelseries sonar py Thon.