AudioStreamPlayback
Метакласс для воспроизведения звука.
Метакласс для воспроизведения звука.
Может воспроизводить, зацикливать, приостанавливать прокрутку аудио. См. AudioStream и AudioStreamOggVorbis для использования.
Объявления сверены с C# SDK 1.0.0. Раскройте имя, чтобы увидеть сигнатуры и описание.
Конструкторы1
AudioStreamPlaybackКонструктор
public AudioStreamPlayback();Методы18
GetLoopCountint
public int GetLoopCount();Переопределяемый метод. Должен возвращать, сколько раз этот аудиопоток был зациклен. Большинство встроенных воспроизведений всегда возвращают 0.
intGetPlaybackPositiondouble
public double GetPlaybackPosition();Переопределяемый метод. Должен возвращать текущий прогресс по аудиопотоку в секундах.
doubleGetSamplePlaybackAudioSamplePlayback
public AudioSamplePlayback GetSamplePlayback();Возвращает AudioSamplePlayback, связанный с этим AudioStreamPlayback, для воспроизведения аудиосэмпла этого потока.
AudioSamplePlaybackIsPlayingbool
public bool IsPlaying();Переопределяемый метод. Должен возвращать true, если это воспроизведение активно и воспроизводит свой аудиопоток.
boolMixAudioVector2[]
public Vector2[] MixAudio(float rateScale, int frames);Смешивает до frames аудио из потока из текущей позиции со скоростью rate_scale, продвигая поток.
Возвращает Vector2[], где каждый элемент содержит уровни громкости левого и правого каналов каждого кадра.
Примечание: Может возвращать меньше кадров, чем запрошено, обязательно используйте размер возвращаемого значения.
| Имя | Тип | По умолчанию |
|---|---|---|
rateScale | float | — |
frames | int | — |
Vector2[]Seekvoid
public void Seek(double time = 0d);Переопределите этот метод, чтобы настроить действия при поиске аудиопотока в указанной position, например, вызвав AudioStreamPlayer.Seek.
| Имя | Тип | По умолчанию |
|---|---|---|
time | double | 0d |
SetSamplePlaybackvoid
public void SetSamplePlayback(AudioSamplePlayback playbackSample);Связывает AudioSamplePlayback с этим AudioStreamPlayback для воспроизведения аудиосэмпла этого потока.
| Имя | Тип | По умолчанию |
|---|---|---|
playbackSample | AudioSamplePlayback | — |
Startvoid
public void Start(double fromPos = 0d);Переопределите этот метод, чтобы настроить то, что происходит при запуске воспроизведения в заданной позиции, например, вызвав AudioStreamPlayer.Play.
| Имя | Тип | По умолчанию |
|---|---|---|
fromPos | double | 0d |
Stopvoid
public void Stop();Переопределите этот метод, чтобы настроить действия, которые будут происходить при остановке воспроизведения, например, вызвав AudioStreamPlayer.Stop.
_GetLoopCountint
public virtual int _GetLoopCount();Переопределяемый метод. Должен возвращать, сколько раз этот аудиопоток был зациклен. Большинство встроенных воспроизведений всегда возвращают 0.
int_GetParameterVariant
public virtual Variant _GetParameter(StringName name);Возврат текущего значения параметра воспроизведения по имени (см. AudioStream._GetParameterList).
| Имя | Тип | По умолчанию |
|---|---|---|
name | StringName | — |
Variant_GetPlaybackPositiondouble
public virtual double _GetPlaybackPosition();Переопределяемый метод. Должен возвращать текущий прогресс по аудиопотоку в секундах.
double_IsPlayingbool
public virtual bool _IsPlaying();Переопределяемый метод. Должен возвращать true, если это воспроизведение активно и воспроизводит свой аудиопоток.
bool_Seekvoid
public virtual void _Seek(double position);Переопределите этот метод, чтобы настроить действия при поиске аудиопотока в указанной position, например, вызвав AudioStreamPlayer.Seek.
| Имя | Тип | По умолчанию |
|---|---|---|
position | double | — |
_SetParametervoid
public virtual void _SetParameter(StringName name, Variant value);Установить текущее значение параметра воспроизведения по имени (см. AudioStream._GetParameterList).
| Имя | Тип | По умолчанию |
|---|---|---|
name | StringName | — |
value | Variant | — |
_Startvoid
public virtual void _Start(double fromPos);Переопределите этот метод, чтобы настроить то, что происходит при запуске воспроизведения в заданной позиции, например, вызвав AudioStreamPlayer.Play.
| Имя | Тип | По умолчанию |
|---|---|---|
fromPos | double | — |
_Stopvoid
public virtual void _Stop();Переопределите этот метод, чтобы настроить действия, которые будут происходить при остановке воспроизведения, например, вызвав AudioStreamPlayer.Stop.
_TagUsedStreamsvoid
public virtual void _TagUsedStreams();Переопределяемый метод. Вызывается всякий раз, когда аудиопоток микшируется, если воспроизведение активно и AudioServer.SetEnableTaggingUsedAudioStreams установлен в true. Плагины редактора могут использовать этот метод для «тегирования» текущей позиции вдоль аудиопотока и отображения ее в предварительном просмотре.