reckfellENGINE

AudioStreamPlayback

Метакласс для воспроизведения звука.

На этой странице
class AudioStreamPlaybackReckfellSharpНаследует RefCounted

Метакласс для воспроизведения звука.

Может воспроизводить, зацикливать, приостанавливать прокрутку аудио. См. AudioStream и AudioStreamOggVorbis для использования.

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

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

AudioStreamPlaybackКонструктор
# AudioStreamPlayback
C#
public AudioStreamPlayback();

Методы18

GetLoopCountint
# GetLoopCount
C#
public int GetLoopCount();

Переопределяемый метод. Должен возвращать, сколько раз этот аудиопоток был зациклен. Большинство встроенных воспроизведений всегда возвращают 0.

Возвращает int
GetPlaybackPositiondouble
# GetPlaybackPosition
C#
public double GetPlaybackPosition();

Переопределяемый метод. Должен возвращать текущий прогресс по аудиопотоку в секундах.

Возвращает double
GetSamplePlaybackAudioSamplePlayback
# GetSamplePlayback
C#
public AudioSamplePlayback GetSamplePlayback();

Возвращает AudioSamplePlayback, связанный с этим AudioStreamPlayback, для воспроизведения аудиосэмпла этого потока.

Возвращает AudioSamplePlayback
IsPlayingbool
# IsPlaying
C#
public bool IsPlaying();

Переопределяемый метод. Должен возвращать true, если это воспроизведение активно и воспроизводит свой аудиопоток.

Возвращает bool
MixAudioVector2[]
# MixAudio
C#
public Vector2[] MixAudio(float rateScale, int frames);

Смешивает до frames аудио из потока из текущей позиции со скоростью rate_scale, продвигая поток. Возвращает Vector2[], где каждый элемент содержит уровни громкости левого и правого каналов каждого кадра. Примечание: Может возвращать меньше кадров, чем запрошено, обязательно используйте размер возвращаемого значения.

Параметры
ИмяТипПо умолчанию
rateScalefloat—
framesint—
Возвращает Vector2[]
Seekvoid
# Seek
C#
public void Seek(double time = 0d);

Переопределите этот метод, чтобы настроить действия при поиске аудиопотока в указанной position, например, вызвав AudioStreamPlayer.Seek.

Параметры
ИмяТипПо умолчанию
timedouble0d
SetSamplePlaybackvoid
# SetSamplePlayback
C#
public void SetSamplePlayback(AudioSamplePlayback playbackSample);

Связывает AudioSamplePlayback с этим AudioStreamPlayback для воспроизведения аудиосэмпла этого потока.

Параметры
ИмяТипПо умолчанию
playbackSampleAudioSamplePlayback—
Startvoid
# Start
C#
public void Start(double fromPos = 0d);

Переопределите этот метод, чтобы настроить то, что происходит при запуске воспроизведения в заданной позиции, например, вызвав AudioStreamPlayer.Play.

Параметры
ИмяТипПо умолчанию
fromPosdouble0d
Stopvoid
# Stop
C#
public void Stop();

Переопределите этот метод, чтобы настроить действия, которые будут происходить при остановке воспроизведения, например, вызвав AudioStreamPlayer.Stop.

_GetLoopCountint
# _GetLoopCount
C#
public virtual int _GetLoopCount();

Переопределяемый метод. Должен возвращать, сколько раз этот аудиопоток был зациклен. Большинство встроенных воспроизведений всегда возвращают 0.

Возвращает int
_GetParameterVariant
# _GetParameter
C#
public virtual Variant _GetParameter(StringName name);

Возврат текущего значения параметра воспроизведения по имени (см. AudioStream._GetParameterList).

Параметры
ИмяТипПо умолчанию
nameStringName—
Возвращает Variant
_GetPlaybackPositiondouble
# _GetPlaybackPosition
C#
public virtual double _GetPlaybackPosition();

Переопределяемый метод. Должен возвращать текущий прогресс по аудиопотоку в секундах.

Возвращает double
_IsPlayingbool
# _IsPlaying
C#
public virtual bool _IsPlaying();

Переопределяемый метод. Должен возвращать true, если это воспроизведение активно и воспроизводит свой аудиопоток.

Возвращает bool
_Seekvoid
# _Seek
C#
public virtual void _Seek(double position);

Переопределите этот метод, чтобы настроить действия при поиске аудиопотока в указанной position, например, вызвав AudioStreamPlayer.Seek.

Параметры
ИмяТипПо умолчанию
positiondouble—
_SetParametervoid
# _SetParameter
C#
public virtual void _SetParameter(StringName name, Variant value);

Установить текущее значение параметра воспроизведения по имени (см. AudioStream._GetParameterList).

Параметры
ИмяТипПо умолчанию
nameStringName—
valueVariant—
_Startvoid
# _Start
C#
public virtual void _Start(double fromPos);

Переопределите этот метод, чтобы настроить то, что происходит при запуске воспроизведения в заданной позиции, например, вызвав AudioStreamPlayer.Play.

Параметры
ИмяТипПо умолчанию
fromPosdouble—
_Stopvoid
# _Stop
C#
public virtual void _Stop();

Переопределите этот метод, чтобы настроить действия, которые будут происходить при остановке воспроизведения, например, вызвав AudioStreamPlayer.Stop.

_TagUsedStreamsvoid
# _TagUsedStreams
C#
public virtual void _TagUsedStreams();

Переопределяемый метод. Вызывается всякий раз, когда аудиопоток микшируется, если воспроизведение активно и AudioServer.SetEnableTaggingUsedAudioStreams установлен в true. Плагины редактора могут использовать этот метод для «тегирования» текущей позиции вдоль аудиопотока и отображения ее в предварительном просмотре.

Документация Reckfell EngineНаверх ↑
БЫСТРЫЙ ПЕРЕХОДНачало работыEntity и иерархияC# & .NET 10Сцены и префабы
Руководства и полный API Reckfell K
reckfellENGINE
RECKFELL ACCOUNT

Вход в аккаунт

Войдите в аккаунт Reckfell.

Один аккаунт для всей платформы Reckfell.