AudioStreamOggVorbis — C# API

Класс, представляющий аудиопоток Огг Ворбис.

class AudioStreamOggVorbisReckfellSharpНаследует AudioStream

Класс, представляющий аудиопоток Огг Ворбис.

Класс AudioStreamOggVorbis — это специализированный класс AudioStream для обработки файлов формата Огг Ворбис. Он предоставляет функциональность для загрузки и воспроизведения файлов Огг Ворбис, а также для управления зацикливанием и другими свойствами воспроизведения. Дополнительную информацию можно найти в ResourceImporterOggVorbis. Этот класс является частью системы аудиопотоков, которая также поддерживает файлы WAV через класс AudioStreamWav и файлы MP3 через класс AudioStreamMP3.

Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.

Конструкторы1

AudioStreamOggVorbisКонструктор

# AudioStreamOggVorbis

C#
public AudioStreamOggVorbis();

Свойства7

BarBeatsСвойство

# BarBeats

C#
public int BarBeats { get; set; }

Число музыкальных долей в такте, например 4 для четырёхдольного такта. Это метаданные композиции, а не число тактов в одной доле и не результат автоматического анализа звука.

BeatCountСвойство

# BeatCount

C#
public int BeatCount { get; set; }

Длительность аудиодорожки в тактах. Фактическая длительность аудиофайла может быть больше, чем указано в этом свойстве. Определяет конец аудио для зацикливания, AudioStreamPlaylist и AudioStreamInteractive.

BpmСвойство

# Bpm

C#
public double Bpm { get; set; }

Темп аудиодорожки, измеряемый в ударах в минуту.

LoopСвойство

# Loop

C#
public bool Loop { get; set; }

Если true, воспроизведение потока возобновится с указанного значения AudioStreamOggVorbis.LoopOffset после достижения конца аудиодорожки или после достижения конца последнего такта в соответствии с величиной, указанной в AudioStreamOggVorbis.BeatCount. Полезно для фоновых звуков и музыки.

LoopOffsetСвойство

# LoopOffset

C#
public double LoopOffset { get; set; }

Позиция возврата петли в секундах, когда включён Loop. Не является точкой WAV в кадрах и не задаёт отдельный конец петли. Проверьте значение на настоящей записи.

PacketSequenceСвойство

# PacketSequence

C#
public OggPacketSequence PacketSequence { get; set; }

Содержит необработанные данные Ogg для этого потока.

TagsСвойство

# Tags

C#
public Reckfell.Collections.Dictionary Tags { get; set; }

Содержит пользовательские теги, если они найдены в данных Огг Ворбис. Обычно используемые теги включают title, artist, album, tracknumber и date, (date не имеет стандартного формата даты). Примечание: Не все теги гарантированно присутствует в каждом файле, поэтому обязательно учитывайте ключи, которые не всегда существуют.

Методы17

GetBarBeatsint

# GetBarBeats

C#
public int GetBarBeats();

Возвращает int

GetBeatCountint

# GetBeatCount

C#
public int GetBeatCount();

Возвращает int

GetBpmdouble

# GetBpm

C#
public double GetBpm();

Возвращает double

GetLoopOffsetdouble

# GetLoopOffset

C#
public double GetLoopOffset();

Возвращает double

GetPacketSequenceOggPacketSequence

# GetPacketSequence

C#
public OggPacketSequence GetPacketSequence();

Возвращает OggPacketSequence

GetTagsReckfell.Collections.Dictionary

# GetTags

C#
public Reckfell.Collections.Dictionary GetTags();

Возвращает Reckfell.Collections.Dictionary

HasLoopbool

# HasLoop

C#
public bool HasLoop();

Возвращает bool

LoadFromBuffer2 перегрузки

# LoadFromBuffer · 1/2

C#
public static AudioStreamOggVorbis LoadFromBuffer(byte[] streamData);

Создает новый экземпляр AudioStreamOggVorbis из указанного буфера. Буфер должен содержать данные Огг Ворбис.

Параметры
Имя	Тип	По умолчанию
`streamData`	`byte[]`	—

Возвращает AudioStreamOggVorbis

# LoadFromBuffer · 2/2

C#
public static AudioStreamOggVorbis LoadFromBuffer(ReadOnlySpan<byte> streamData);

Создает новый экземпляр AudioStreamOggVorbis из указанного буфера. Буфер должен содержать данные Огг Ворбис.

Параметры
Имя	Тип	По умолчанию
`streamData`	`ReadOnlySpan<byte>`	—

Возвращает AudioStreamOggVorbis

LoadFromFileAudioStreamOggVorbis

# LoadFromFile

C#
public static AudioStreamOggVorbis LoadFromFile(string path);

Читает сырой аудиофайл напрямую, не применяя параметры .import редактора. Для ресурса проекта с применённым импортом используйте ResourceLoader.Load. Петлю и музыкальные параметры задайте у результата самостоятельно.

Параметры
Имя	Тип	По умолчанию
`path`	`string`	—

path

Путь к настоящему исходному файлу. Убедитесь, что он доступен в выбранной сборке; путь к импортированному ресурсу не гарантирует наличие исходных байтов.

Возвращает AudioStreamOggVorbis

Загруженный аудиоресурс либо null при ошибке чтения или формата. Проверяйте результат до воспроизведения.

SetBarBeatsvoid

# SetBarBeats

C#
public void SetBarBeats(int count);

Параметры
Имя	Тип	По умолчанию
`count`	`int`	—

SetBeatCountvoid

# SetBeatCount

C#
public void SetBeatCount(int count);

Параметры
Имя	Тип	По умолчанию
`count`	`int`	—

SetBpmvoid

# SetBpm

C#
public void SetBpm(double bpm);

Параметры
Имя	Тип	По умолчанию
`bpm`	`double`	—

SetLoopvoid

# SetLoop

C#
public void SetLoop(bool enable);

Параметры
Имя	Тип	По умолчанию
`enable`	`bool`	—

SetLoopOffsetvoid

# SetLoopOffset

C#
public void SetLoopOffset(double seconds);

Параметры
Имя	Тип	По умолчанию
`seconds`	`double`	—

SetPacketSequencevoid

# SetPacketSequence

C#
public void SetPacketSequence(OggPacketSequence packetSequence);

Параметры
Имя	Тип	По умолчанию
`packetSequence`	`OggPacketSequence`	—

SetTagsvoid

# SetTags

C#
public void SetTags(Reckfell.Collections.Dictionary tags);

Параметры
Имя	Тип	По умолчанию
`tags`	`Reckfell.Collections.Dictionary`	—