Inheritance diagram for BGC.Audio.BGCStream:

[legend]

Collaboration diagram for BGC.Audio.BGCStream:

Public Member Functions
abstract IEnumerable< double >	GetChannelRMS ()
	The RMS amplitude of each channel More...

void	Initialize ()
	Perform any calculations necessary to prepare the Stream More...

abstract int	Read (float[] data, int offset, int count)
	Copy count samples into the Data buffer, starting at offset. More...

abstract void	Reset ()
	Sets this internal state of this stream to the initial state More...

abstract void	Seek (int position)
	Seek to the indicated position in the stream More...

Protected Member Functions
virtual void	_Initialize ()

Protected Attributes
bool	initialized = false

Properties
abstract int	Channels `[get]`

abstract int	TotalSamples `[get]`

abstract int	ChannelSamples `[get]`

abstract float	SamplingRate `[get]`

Properties inherited from BGC.Audio.IBGCStream
int	Channels `[get]`
	The number of underlying Channels of this BGCStream More...

int	TotalSamples `[get]`
	The total number of Samples of this BGCStream More...

int	ChannelSamples `[get]`
	The number of Samples of each channel for this BGCStream More...

float	SamplingRate `[get]`
	The sampling rate of the Stream More...

Detailed Description

Definition at line 6 of file BGCStream.cs.

Member Function Documentation

◆ _Initialize()

virtual void BGC.Audio.BGCStream._Initialize ( )

inlineprotectedvirtual

Reimplemented in BGC.Audio.Synthesis.STMAudioClip, BGC.Audio.Synthesis.NoiseAudioClip, BGC.Audio.Synthesis.SweepAudioClip, BGC.Audio.NormalizedMonoClip, and BGC.Audio.Synthesis.WhiteNoiseStream.

Definition at line 28 of file BGCStream.cs.

28 { }

◆ GetChannelRMS()

abstract IEnumerable<double> BGC.Audio.BGCStream.GetChannelRMS ( )

pure virtual

The RMS amplitude of each channel

Implements BGC.Audio.IBGCStream.

◆ Initialize()

void BGC.Audio.BGCStream.Initialize ( )

inline

Perform any calculations necessary to prepare the Stream

Implements BGC.Audio.IBGCStream.

Definition at line 18 of file BGCStream.cs.

         {
             if (!initialized)
             {
                 initialized = true;
                 _Initialize();
             }
         }

◆ Read()

abstract int BGC.Audio.BGCStream.Read	(	float []	data,
		int	offset,
		int	count
	)

pure virtual

Copy count samples into the Data buffer, starting at offset.

Returns: The number of samples copied

Implements BGC.Audio.IBGCStream.

◆ Reset()

abstract void BGC.Audio.BGCStream.Reset ( )

pure virtual

Sets this internal state of this stream to the initial state

Implements BGC.Audio.IBGCStream.

◆ Seek()

abstract void BGC.Audio.BGCStream.Seek ( int position )

pure virtual

Seek to the indicated position in the stream

Implements BGC.Audio.IBGCStream.

Field Documentation

◆ initialized

bool BGC.Audio.BGCStream.initialized = false

protected

Definition at line 27 of file BGCStream.cs.

Property Documentation

◆ Channels

abstract int BGC.Audio.BGCStream.Channels

get

Definition at line 8 of file BGCStream.cs.

◆ ChannelSamples

abstract int BGC.Audio.BGCStream.ChannelSamples

get

Definition at line 12 of file BGCStream.cs.

◆ SamplingRate

abstract float BGC.Audio.BGCStream.SamplingRate

get

Definition at line 14 of file BGCStream.cs.

◆ TotalSamples

abstract int BGC.Audio.BGCStream.TotalSamples

get

Definition at line 10 of file BGCStream.cs.

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

Audio/BGCStream.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Member Function Documentation

◆ _Initialize()

◆ GetChannelRMS()

◆ Initialize()

◆ Read()

◆ Reset()

◆ Seek()

Field Documentation

◆ initialized

Property Documentation

◆ Channels

◆ ChannelSamples

◆ SamplingRate

◆ TotalSamples