steelseries sonar py

API steelseries sonar py

Mode streamer sedang dalam pengembangan!

Ringkasan

Paket Python ini menyediakan antarmuka yang nyaman untuk berinteraksi dengan API aplikasi SteelSeries Sonar.
Aplikasi Sonar memungkinkan pengguna untuk mengontrol dan menampilkan volume berbagai saluran audio.

Instalasi

Untuk menggunakan paket ini, ikuti langkah-langkah berikut:

1. Instal paket menggunakan pip:

   pip install steelseries-sonar-py

2. Impor kelas Sonar dalam skrip atau aplikasi Python Anda:

    from steelseries_sonar_py import Sonar 

Penggunaan

Menginisialisasi Objek Sonar

Kelas Sonar menerima dua parameter opsional selama inisialisasi:
streamer_mode : Setel ke True untuk menggunakan mode streamer (defaultnya adalah False).
app_data_path : Tentukan jalur khusus untuk file coreProps.json SteelSeries Engine 3
(default adalah jalur instalasi default: C:\ProgramData\SteelSeries\SteelSeries Engine 3\coreProps.json ).

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

atau

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

Mode Pita

API steelseries sonar py thon mendukung mode streamer, yang memungkinkan pengguna mengelola dua penggeser terpisah: streaming dan monitoring . Slider ini memungkinkan kontrol yang lebih baik pada saluran audio yang berbeda.

Untuk memeriksa apakah mode streamer diaktifkan, gunakan:

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

Untuk mengaktifkan atau menonaktifkan mode streamer, gunakan:

 # Enable streamer mode
sonar . set_streamer_mode ( True )

# Disable streamer mode
sonar . set_streamer_mode ( False )

Mengambil Informasi Volume

Ambil informasi tentang pengaturan volume saat ini untuk semua saluran:

 volume_data = sonar . get_volume_data ()
print ( volume_data )

Mengatur Volume untuk Saluran

Atur volume untuk saluran tertentu. Parameter channel harus berupa salah satu dari berikut ini:
master , game , chatRender , media , aux , chatCapture . Parameter volume harus berupa float antara 0 dan 1.
Selain itu, parameter streamer_slider opsional dapat disediakan, dengan nilai "streaming" (default) atau "monitoring":

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

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

Mematikan/Membunyikan Saluran

Alihkan status bisu untuk saluran tertentu. Parameter channel harus berupa salah satu dari berikut ini:
master , game , chatRender , media , aux , chatCapture . Parameter muted harus berupa boolean yang menunjukkan apakah akan menonaktifkan ( True ) atau mengaktifkan ( False ) saluran.
Selain itu, parameter streamer_slider opsional dapat disediakan, dengan nilai "streaming" (default) atau "monitoring":

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

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

campuran obrolan

Ambil data campuran obrolan:

 chatmix_data = sonar . get_chat_mix_data ()
print ( chatmix_data )

Tetapkan nilai campuran obrolan antara -1 and 1 untuk memfokuskan suara dari game atau saluran chatRender :

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

Pengecualian

Paket ini memperkenalkan serangkaian pengecualian yang mungkin muncul selama penggunaan.
Dianjurkan untuk menangani pengecualian ini sesuai dengan kode Anda.
Anda dapat mengimpornya dari steelseries_sonar_py.exceptions . Berikut adalah daftar kemungkinan pengecualian:

• EnginePathNotFoundError : Dimunculkan ketika SteelSeries Engine 3 tidak diinstal atau tidak berada di lokasi default.
• ServerNotAccessibleError : Dimunculkan ketika server SteelSeries tidak dapat diakses. Memberikan kode status HTTP.
• SonarNotEnabledError : Dimunculkan saat SteelSeries Sonar tidak diaktifkan.
• ServerNotReadyError : Dimunculkan ketika SteelSeries Sonar belum siap.
• ServerNotRunningError : Dimunculkan saat SteelSeries Sonar tidak berjalan.
• WebServerAddressNotFoundError : Dimunculkan ketika alamat server web tidak ditemukan.
• ChannelNotFoundError : Dimunculkan ketika saluran yang ditentukan tidak ditemukan.
• InvalidVolumeError : Dimunculkan ketika nilai volume yang diberikan tidak valid.
• InvalidMixVolumeError : Dimunculkan ketika nilai volume campuran yang diberikan tidak valid.
• SliderNotFoundError : Dimunculkan ketika nama penggeser yang tidak dikenal diberikan sebagai nilai streamer_slider .

Contoh

Berikut adalah contoh lengkap yang menunjukkan penggunaan API steelseries sonar py thon:

 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 )

Terima kasih khusus

Terima kasih kepada semua kontributor yang memungkinkan paket ini - wex untuk mengetahui API, TotalPanther317 untuk memahami mode streamer dan cookie untuk fitur seperti campuran obrolan dan deteksi mode streamer. Bersyukur atas upaya mereka!

Dokumentasi ini sekarang mencerminkan perubahan dan penambahan terbaru pada API steelseries sonar py thon.