Component:AudioStreamMetadata: Difference between revisions

From Resonite Wiki
Newer edit →
VisualWikitext
Automated: create new component page
 
Add almost all the minimal info
Line 3: Line 3:
|Name=Audio Stream Metadata`1
|Name=Audio Stream Metadata`1
}}
}}
{{stub}}
Audio Stream Metadata is a component that reads the running tallies of the different samples being sent and received by an [[Type:IAudioSource|IAudioSource]].


== Usage ==
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|Stream|'''[[Type:AudioStream`1|AudioStream`1]]<S>'''|TypeAdv0=true|
|Stream|'''[[Type:AudioStream`1|AudioStream`1]]<S>'''|TypeAdv0=true| The audio source to get data from
|UnreadSamples|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv1=true|
|UnreadSamples|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv1=true| The amount of samples yet to be played
|TotalMissedSamples|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv2=true|
|TotalMissedSamples|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv2=true| Samples missed due to lag or other reasons.
|LastMissedSamples|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv3=true|
|LastMissedSamples|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv3=true| The last time samples were missed instead of being read from the audio source.
|BufferLength|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv4=true|
|BufferLength|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv4=true| How big the sample buffer is.
|AverageReadSamplesPerSecond|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv5=true|
|AverageReadSamplesPerSecond|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv5=true| How many samples per second on a running average are being processed.
|AverageWriteSamplesPerSecond|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv6=true|
|AverageWriteSamplesPerSecond|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv6=true| The many samples per second on a running average are being written to the buffer per second.
|GlobalIndex|{{RootFieldType|RawOutput`1|[[Type:Long|Long]]}}|TypeAdv7=true|
|GlobalIndex|{{RootFieldType|RawOutput`1|[[Type:Long|Long]]}}|TypeAdv7=true| The audio source's index in the pool of audio players playing sounds.
|SamplesAvailableForEncode|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv8=true|
|SamplesAvailableForEncode|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv8=true| Samples currently ready to be encoded to a format supported by FrooxEngine's audio system.
|FrameSize|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv9=true|
|FrameSize|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv9=true|
|MaxFrameSize|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv10=true|
|MaxFrameSize|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv10=true|
|EncodedSampleRate|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv11=true|
|EncodedSampleRate|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv11=true| how fast encoded samples are being processed.
|TotalPacketCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv12=true|
|TotalPacketCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv12=true| How many audio packets have been networked by the audio source so far.
|TotalLostPackets|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv13=true|
|TotalLostPackets|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv13=true| How many packets of the network that were not received from the audio source.
|LastLostPackets|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv14=true|
|LastLostPackets|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv14=true| The last time packets were lost by the audio source.
|PacketLossRatio|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv15=true|
|PacketLossRatio|{{RootFieldType|RawOutput`1|[[Type:Float|Float]]}}|TypeAdv15=true| On average, the percentage of audio packets from the network that are being lost.
|AverageCodecSamplesPerSecond|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv16=true|
|AverageCodecSamplesPerSecond|{{RootFieldType|RawOutput`1|[[Type:Double|Double]]}}|TypeAdv16=true|
}}
}}

Revision as of 22:26, 7 November 2024

Component 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 IAudioSource.

Usage

Fields
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.
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
MaxFrameSize raw output of Int
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

Behavior

Examples

See Also

Retrieved from "https://wiki.resonite.com/index.php?title=Component:AudioStreamMetadata&oldid=92162"