MGL(Win32)
読み取り中…
検索中…
一致する文字列を見つけられません
公開型 | 公開メンバ関数 | 限定公開メンバ関数 | 全メンバ一覧
MGL::Audio::Voice クラスabstract

MGL オーディオボイス [詳解]

#include <mgl_audio_voice.h>

MGL::Audio::Voice の継承関係図
MGL::Audio::WaveStreamVoice MGL::Audio::WaveVoice

公開型

enum class  Status : uint8_t {
  None , Loading , Error , Ready ,
  Remove
}
 ボイスの状態 [詳解]
 
enum class  Type : uint8_t { Static , Dynamic }
 ボイスのタイプ [詳解]
 

公開メンバ関数

constexpr Voice (VoiceKey key, Type type) noexcept
 コンストラクタ
 
virtual bool Load () noexcept=0
 ボイスの読み込み処理
 
virtual bool GetSample (float &outDataL, float &outDataR, uint32_t trackIndex, size_t sampleFrame) const noexcept
 スタティックボイスのサンプルの取得
 
virtual bool GetSample (float &outDataL, float &outDataR) noexcept
 ダイナミックボイスのサンプルの取得
 
virtual bool Start (uint32_t trackIndex, LoopType loopType) noexcept
 ボイスの開始処理
 
virtual void Stop () noexcept
 ボイスの停止処理
 
virtual uint32_t GetTotalFrame (uint32_t trackIndex) const noexcept=0
 ボイスの最大フレーム数を取得
 
virtual bool IsLoop (uint32_t trackIndex) const noexcept=0
 指定したトラックのループ設定を取得
 
virtual uint32_t GetLoopFrame (uint32_t trackIndex) const noexcept=0
 指定したトラックのループフレームを取得
 
constexpr VoiceKey GetKey () const noexcept
 ボイスキーを取得
 
void RemoveRequests () noexcept
 削除を要求
 
Status GetStatus () const noexcept
 ボイスのステータスを取得
 
constexpr Type GetType () const noexcept
 ボイスの種類を取得
 
virtual uint32_t GetTrackCount () const noexcept=0
 ボイスが持つトラックの数を取得
 
void SetVolume (float volume) noexcept
 ボイスのボリュームを設定
 
float GetVolume () const noexcept
 ボイスのボリュームを取得
 

限定公開メンバ関数

void SetStatus (Status status) noexcept
 ボイスのステータスを設定
 

詳解

MGL オーディオボイス

列挙型メンバ詳解

◆ Status

enum class MGL::Audio::Voice::Status : uint8_t
strong

ボイスの状態

列挙値
None 

状態なし（初期状態）

Loading 

読み込み中

Error 

エラー発生

Ready 

準備完了

Remove 

削除要求済み

◆ Type

enum class MGL::Audio::Voice::Type : uint8_t
strong

ボイスのタイプ

列挙値
Static 

スタティック: 読み込み後は内部状態が変化しない．同時再生可能

Dynamic 

ダイナミック: 再生中に内部状態が変化する．同時再生不可能．ストリーム再生など

構築子と解体子

◆ Voice()

MGL::Audio::Voice::Voice ( VoiceKey key,
Type type )
inlineconstexprnoexcept

コンストラクタ

引数
[in]keyボイスキー
[in]typeボイスのタイプ

関数詳解

◆ GetKey()

VoiceKey MGL::Audio::Voice::GetKey ( ) const
inlinenodiscardconstexprnoexcept

ボイスキーを取得

戻り値
ボイスキー

◆ GetLoopFrame()

virtual uint32_t MGL::Audio::Voice::GetLoopFrame ( uint32_t trackIndex) const
nodiscardpure virtualnoexcept

指定したトラックのループフレームを取得

引数
[in]trackIndexトラック番号
戻り値
ループフレーム

MGL::Audio::WaveStreamVoice, MGL::Audio::WaveVoiceで実装されています。

◆ GetSample() [1/2]

virtual bool MGL::Audio::Voice::GetSample ( float & outDataL,
float & outDataR )
inlinevirtualnoexcept

ダイナミックボイスのサンプルの取得

引数
[out]outDataL左チャンネル出力の格納先
[out]outDataR右チャンネル出力の格納先
戻り値
true継続
false終了

MGL::Audio::WaveStreamVoiceで再実装されています。

◆ GetSample() [2/2]

virtual bool MGL::Audio::Voice::GetSample ( float & outDataL,
float & outDataR,
uint32_t trackIndex,
size_t sampleFrame ) const
inlinevirtualnoexcept

スタティックボイスのサンプルの取得

引数
[out]outDataL左チャンネル出力の格納先
[out]outDataR右チャンネル出力の格納先
[in]trackIndexトラック番号
[in]sampleFrameサンプルフレーム
戻り値
true継続
false終了

MGL::Audio::WaveVoiceで再実装されています。

◆ GetStatus()

Status MGL::Audio::Voice::GetStatus ( ) const
inlinenodiscardnoexcept

ボイスのステータスを取得

戻り値
ボイスのステータス

◆ GetTotalFrame()

virtual uint32_t MGL::Audio::Voice::GetTotalFrame ( uint32_t trackIndex) const
nodiscardpure virtualnoexcept

ボイスの最大フレーム数を取得

引数
[in]trackIndexトラック番号
戻り値
最大フレーム数

MGL::Audio::WaveStreamVoice, MGL::Audio::WaveVoiceで実装されています。

◆ GetTrackCount()

virtual uint32_t MGL::Audio::Voice::GetTrackCount ( ) const
nodiscardpure virtualnoexcept

ボイスが持つトラックの数を取得

戻り値
トラック数

MGL::Audio::WaveStreamVoice, MGL::Audio::WaveVoiceで実装されています。

◆ GetType()

Type MGL::Audio::Voice::GetType ( ) const
inlinenodiscardconstexprnoexcept

ボイスの種類を取得

戻り値
ボイスの種類

◆ GetVolume()

float MGL::Audio::Voice::GetVolume ( ) const
inlinenodiscardnoexcept

ボイスのボリュームを取得

戻り値
volume ボリューム

◆ IsLoop()

virtual bool MGL::Audio::Voice::IsLoop ( uint32_t trackIndex) const
nodiscardpure virtualnoexcept

指定したトラックのループ設定を取得

引数
[in]trackIndexトラック番号
戻り値
trueループあり
falseループなし

MGL::Audio::WaveStreamVoice, MGL::Audio::WaveVoiceで実装されています。

◆ Load()

virtual bool MGL::Audio::Voice::Load ( )
pure virtualnoexcept

ボイスの読み込み処理

戻り値
true成功
false失敗

MGL::Audio::WaveStreamVoice, MGL::Audio::WaveVoiceで実装されています。

◆ SetStatus()

void MGL::Audio::Voice::SetStatus ( Status status)
inlineprotectednoexcept

ボイスのステータスを設定

引数
[in]status設定するステータス

◆ SetVolume()

void MGL::Audio::Voice::SetVolume ( float volume)
inlinenoexcept

ボイスのボリュームを設定

引数
[in]volumeボリューム

◆ Start()

virtual bool MGL::Audio::Voice::Start ( uint32_t trackIndex,
LoopType loopType )
inlinevirtualnoexcept

ボイスの開始処理

引数
[in]trackIndexトラック番号
[in]loopTypeループタイプ
戻り値
true成功
false失敗

MGL::Audio::WaveStreamVoiceで再実装されています。

◆ Stop()

virtual void MGL::Audio::Voice::Stop ( )
inlinevirtualnoexcept

ボイスの停止処理

MGL::Audio::WaveStreamVoiceで再実装されています。

このクラス詳解は次のファイルから抽出されました:
構築: doxygen 1.12.0