steelseries sonar pyダウンロード - steelseries sonar pyソースコードのダウンロード

steelseries sonar py

AI ソースコード

1.2.0

ダウンロード

steelseries sonar py Python API

ストリーマーモードは現在開発中です！

概要

この Python パッケージは、SteelSeries Sonar アプリケーション API と対話するための便利なインターフェイスを提供します。
Sonar アプリケーションを使用すると、ユーザーはさまざまなオーディオチャンネルの音量を制御および表示できます。

インストール

このパッケージを使用するには、次の手順に従います。

pip を使用してパッケージをインストールします。
```
pip install steelseries-sonar-py
```
Python スクリプトまたはアプリケーションにSonarクラスをインポートします。
```
 from steelseries_sonar_py import Sonar 
```

使用法

ソナーオブジェクトの初期化

Sonar クラスは、初期化中に 2 つのオプションのパラメーターを受け入れます。
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 Python API はストリーマーモードをサポートしており、ユーザーはstreamingとmonitoring 2 つの個別のスライダーを管理できます。これらのスライダーを使用すると、さまざまなオーディオチャンネルを微調整して制御できます。

ストリーマモードが有効かどうかを確認するには、次を使用します。

 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_data = sonar . get_chat_mix_data ()
print ( chatmix_data )

gameまたはchatRenderチャンネルからのサウンドに焦点を当てるには、チャットミックス値を-1 and 1までに設定します。

 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 : Web サーバーのアドレスが見つからない場合に発生します。
ChannelNotFoundError : 指定されたチャネルが見つからない場合に発生します。
InvalidVolumeError : 無効なボリューム値が指定された場合に発生します。
InvalidMixVolumeError : 無効なミックスボリューム値が指定された場合に発生します。
SliderNotFoundError : 不明なスライダー名がstreamer_slider値として指定された場合に発生します。

例

以下は、 steelseries sonar py Python 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 )