s3d::OggVorbisEncoder Class Reference

Ogg Vorbis 形式音声データのエンコーダ More...

#include <OggVorbisEncoder.hpp>

Inherits s3d::IAudioEncoder.

Public Member Functions
StringView	name () const override
	エンコーダの名前 U"OggVorbis" を返します。 More...
const Array< String > &	possibleExtensions () const override
	Ogg Vorbis 形式のファイルに想定される拡張子一覧 { U"ogg" } を返します。 More...
bool	save (const Wave &wave, FilePathView path) const override
	Wave を Ogg Vorbis 形式でエンコードしてファイルに保存します。 More...
bool	save (const Wave &wave, FilePathView path, int32 quality, const AudioLoopTiming &loopTiming={}) const
	Wave を Ogg Vorbis 形式でエンコードしてファイルに保存します。 More...
bool	encode (const Wave &wave, IWriter &writer) const override
	Wave を Ogg Vorbis 形式でエンコードして書き出します。 More...
bool	encode (const Wave &wave, IWriter &writer, int32 quality, const AudioLoopTiming &loopTiming={}) const
	Wave を Ogg Vorbis 形式でエンコードして書き出します。 More...
Blob	encode (const Wave &wave) const override
	Wave を Ogg Vorbis 形式でエンコードした結果を Blob で返します。 More...
Blob	encode (const Wave &wave, int32 quality, const AudioLoopTiming &loopTiming={}) const
	Wave を Ogg Vorbis 形式でエンコードした結果を Blob で返します。 More...
Public Member Functions inherited from s3d::IAudioEncoder
virtual	~IAudioEncoder ()=default

Static Public Attributes
static constexpr int32	DefaultQuality = 60
	デフォルトのエンコード品質 (60) More...

Detailed Description

Ogg Vorbis 形式音声データのエンコーダ

Member Function Documentation

encode() [1/4]

Blob s3d::OggVorbisEncoder::encode ( const Wave &  wave ) const

overridevirtual

Wave を Ogg Vorbis 形式でエンコードした結果を Blob で返します。

Parameters

wave	エンコードする Wave

Returns

エンコード結果

Implements s3d::IAudioEncoder.

encode() [2/4]

Blob s3d::OggVorbisEncoder::encode	(	const Wave &	wave,
		int32	quality,
		const AudioLoopTiming &	loopTiming = {}
	)		const

Wave を Ogg Vorbis 形式でエンコードした結果を Blob で返します。

Parameters

wave	エンコードする Wave
quality	エンコード品質 [0, 100], 低いと低音質高圧縮
loopTiming	タグに埋め込むループ情報。{} の場合は埋め込み無し

Returns

エンコード結果

encode() [3/4]

bool s3d::OggVorbisEncoder::encode ( const Wave &  wave, IWriter &  writer  ) const

overridevirtual

Wave を Ogg Vorbis 形式でエンコードして書き出します。

Parameters

wave	エンコードする Wave
writer	書き出し先の IWriter インタフェース

Returns

書き出しに成功した場合 true, それ以外の場合は false

Implements s3d::IAudioEncoder.

encode() [4/4]

bool s3d::OggVorbisEncoder::encode	(	const Wave &	wave,
		IWriter &	writer,
		int32	quality,
		const AudioLoopTiming &	loopTiming = {}
	)		const

Wave を Ogg Vorbis 形式でエンコードして書き出します。

Parameters

wave	エンコードする Wave
writer	書き出し先の IWriter インタフェース
quality	エンコード品質 [0, 100], 低いと低音質高圧縮
loopTiming	タグに埋め込むループ情報。{} の場合は埋め込み無し

Returns

書き出しに成功した場合 true, それ以外の場合は false

name()

StringView s3d::OggVorbisEncoder::name ( ) const

overridevirtual

エンコーダの名前 U"OggVorbis" を返します。

Returns

文字列 U"OggVorbis"

Implements s3d::IAudioEncoder.

possibleExtensions()

const Array<String>& s3d::OggVorbisEncoder::possibleExtensions ( ) const

overridevirtual

Ogg Vorbis 形式のファイルに想定される拡張子一覧 { U"ogg" } を返します。

Returns

配列 { U"ogg" }

Implements s3d::IAudioEncoder.

save() [1/2]

bool s3d::OggVorbisEncoder::save ( const Wave &  wave, FilePathView  path  ) const

overridevirtual

Wave を Ogg Vorbis 形式でエンコードしてファイルに保存します。

Parameters

wave	エンコードする Wave
path	保存するファイルのパス

Returns

保存に成功した場合 true, それ以外の場合は false

Implements s3d::IAudioEncoder.

save() [2/2]

bool s3d::OggVorbisEncoder::save	(	const Wave &	wave,
		FilePathView	path,
		int32	quality,
		const AudioLoopTiming &	loopTiming = {}
	)		const

Wave を Ogg Vorbis 形式でエンコードしてファイルに保存します。

Parameters

wave	エンコードする Wave
path	保存するファイルのパス
quality	エンコード品質 [0, 100], 低いと低音質高圧縮
loopTiming	タグに埋め込むループ情報。{} の場合は埋め込み無し

Returns

保存に成功した場合 true, それ以外の場合は false

Member Data Documentation

DefaultQuality

constexpr int32 s3d::OggVorbisEncoder::DefaultQuality = 60

staticconstexpr

デフォルトのエンコード品質 (60)

---

The documentation for this class was generated from the following file:

• OpenSiv3D/Siv3D/include/Siv3D/AudioFormat/OggVorbisEncoder.hpp