ISteamMusic Interface (Steamworks ドキュメント)

Steamworks ドキュメンテーション

ISteamMusic Interface

Steamworks ドキュメント > Steamworks API リファレンス > ISteamMusic Interface

Steamクライアント内で音楽再生を管理するための関数。

これにより、重要なカットシーンが表示されたときに、ゲームが音楽を一時停止や音量を下げるようにして、その後でプレイを開始させる等ができるようになります。

詳細はfeatures/music_playerを参照してください。

メンバー関数

ISteamMusicのメンバー関数は、グローバルのアクセサ関数SteamMusic()経由で呼び出されます。

BIsEnabled

bool BIsEnabled();

Steam Musicが有効化されているかをチェックします。

戻り値： bool
true となるのは、有効化されている場合で、それ以外はfalseです。

BIsPlaying

bool BIsPlaying();

Steam Musicがアクティブかをチェックします。これは、必ずしも曲を再生中ということではなく、一時停止中かもしれません。

さらに細かいコントロールには GetPlaybackStatusを使用してください。

戻り値： bool
true となるのは曲が、再生中、一時停止中、プレイキュー内の場合で、それ以外はfalseです。

GetPlaybackStatus

AudioPlayback_Status GetPlaybackStatus();

Steam Musicプレイヤーの現在の状況を取得します。

戻り値： AudioPlayback_Status

GetVolume

float GetVolume();

Steam Musicプレイヤーの現在の音量を取得します。

戻り値： float
音量は0.0から1.0の間の割合として返されます。

Pause

void Pause();

Steam Musicプレイヤーを一時停止します。

Play

void Play();

Steam Musicプレイヤーの再生を再開します。

PlayNext

void PlayNext();

Steam Musicプレイヤーに次の曲までスキップさせます。

PlayPrevious

void PlayPrevious();

Steam Musicプレイヤーに前の曲を再生させます。

SetVolume

void SetVolume( float flVolume );

名前	型	説明
flVolume	float	音量の割合を0.0から1.0の間に設定します。

Steam Musicプレイヤーの音量を設定します。

コールバック

これらは SteamAPI_RunCallbacks を呼び出すことによって実行されるコールバックです。これらの多くはISteamMusicのメンバー関数への応答として直接実行されます。

PlaybackStatusHasChanged_t

このコールバックにはフィールドはありません。

VolumeHasChanged_t

名前	型	説明
m_flNewVolume	float

列挙型

これらはISteamMusicで使用するために定義された列挙型です。

AudioPlayback_Status

現在の再生ステータスを指定します。

名前	値	説明
AudioPlayback_Undefined	0	Steam Musicインターフェイスが恐らく有効化されていません。
AudioPlayback_Playing	1	Steam Musicは現在再生中です。
AudioPlayback_Paused	2	Steam Musicは現在一時停止中です。
AudioPlayback_Idle	3	Steam Musicは現在停止中です。

定数

これらはISteamMusicで使用するために定義された定数です。

名前	型	値	説明
STEAMMUSIC_INTERFACE_VERSION	const char *	"STEAMMUSIC_INTERFACE_VERSION001"