Component:AudioStreamMetadata

CollapseComponent image 

File:AudioStreamMetadata`1Component.png

Audio Stream Metadata`1 component as seen in the Scene Inspector

Audio Stream Metadata is a component that reads the running tallies of the different samples being sent and received by an AudioStream`1.

Fields

Fields Collapse

Name	Type	Description
persistent	Bool	Determines whether or not this item will be saved to the server.
UpdateOrder	Int	Controls the order in which this component is updated.
Enabled	Bool	Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
Stream	AudioStream`1<S>	The audio source to get data from
UnreadSamples	raw output of Int	The amount of samples yet to be played
TotalMissedSamples	raw output of Int	Samples missed due to lag or other reasons.
LastMissedSamples	raw output of Int	The last time samples were missed instead of being read from the audio source.
BufferLength	raw output of Int	How big the sample buffer is.
AverageReadSamplesPerSecond	raw output of Double	How many samples per second on a running average are being processed.
AverageWriteSamplesPerSecond	raw output of Double	The many samples per second on a running average are being written to the buffer per second.
GlobalIndex	raw output of Long	The audio source's index in the pool of audio players playing sounds.
SamplesAvailableForEncode	raw output of Int	Samples currently ready to be encoded to a format supported by FrooxEngine's audio system.
FrameSize	raw output of Int	The size of audio data coming in, which is in bytes and is influenced by data and channel count.
MaxFrameSize	raw output of Int	The max size of audio data coming in, which is in bytes and is influenced by data and channel count.
EncodedSampleRate	raw output of Int	how fast encoded samples are being processed.
TotalPacketCount	raw output of Int	How many audio packets have been networked by the audio source so far.
TotalLostPackets	raw output of Int	How many packets of the network that were not received from the audio source.
LastLostPackets	raw output of Int	The last time packets were lost by the audio source.
PacketLossRatio	raw output of Float	On average, the percentage of audio packets from the network that are being lost.
AverageCodecSamplesPerSecond	raw output of Double	The average amount of samples incoming in encoded form.