steelseries sonar py

API steelseries sonar py

โหมดสตรีมเมอร์อยู่ระหว่างการพัฒนา!

ภาพรวม

แพ็คเกจ Python นี้มอบอินเทอร์เฟซที่สะดวกสำหรับการโต้ตอบกับ API แอปพลิเคชัน SteelSeries Sonar
แอปพลิเคชั่น Sonar ช่วยให้ผู้ใช้ควบคุมและแสดงระดับเสียงของช่องเสียงต่างๆ

การติดตั้ง

หากต้องการใช้แพ็คเกจนี้ ให้ทำตามขั้นตอนเหล่านี้:

1. ติดตั้งแพ็คเกจโดยใช้ pip:

   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 ได้ด้วยค่า "สตรีมมิ่ง" (ค่าเริ่มต้น) หรือ "การตรวจสอบ":

 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 ได้ด้วยค่า "สตรีมมิ่ง" (ค่าเริ่มต้น) หรือ "การตรวจสอบ":

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

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

แชทมิกซ์

ดึงข้อมูลแชทมิกซ์:

 chatmix_data = sonar . get_chat_mix_data ()
print ( chatmix_data )

ตั้งค่า chat-mix ระหว่าง -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 thon API:

 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 API