bad cat |
add needed info, I hope |
||
Line 5: | Line 5: | ||
Audio Stream Metadata is a component that reads the running tallies of the different samples being sent and received by an [[Type:AudioStream`1|AudioStream`1]]. | Audio Stream Metadata is a component that reads the running tallies of the different samples being sent and received by an [[Type:AudioStream`1|AudioStream`1]]. | ||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Stream|'''[[Type:AudioStream`1|AudioStream`1]]<S>'''|TypeAdv0=true| The audio source to get data from | |Stream|'''[[Type:AudioStream`1|AudioStream`1]]<S>'''|TypeAdv0=true| The audio source to get data from | ||
Line 16: | Line 16: | ||
|GlobalIndex|{{RootFieldType|RawOutput`1|[[Type:Long|Long]]}}|TypeAdv7=true| The audio source's index in the pool of audio players playing sounds. | |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| Samples currently ready to be encoded to a format supported by FrooxEngine's audio system. | |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| The size of audio data coming in, which is in bytes and is influenced by data and channel count. | ||
|MaxFrameSize|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv10=true| | |MaxFrameSize|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv10=true| The max size of audio data coming in, which is in bytes and is influenced by data and channel count. | ||
|EncodedSampleRate|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv11=true| how fast encoded samples are being processed. | |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| How many audio packets have been networked by the audio source so far. | |TotalPacketCount|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv12=true| How many audio packets have been networked by the audio source so far. | ||
Line 23: | Line 23: | ||
|LastLostPackets|{{RootFieldType|RawOutput`1|[[Type:Int|Int]]}}|TypeAdv14=true| The last time packets were lost by the audio source. | |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| On average, the percentage of audio packets from the network that are being lost. | |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| The average amount of samples incoming in encoded form. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
Line 35: | Line 35: | ||
[[Category:Components{{#translation:}}|Audio Stream Metadata`1]] | [[Category:Components{{#translation:}}|Audio Stream Metadata`1]] | ||
[[Category:Generic Components{{#translation:}}|Audio Stream Metadata`1]] | [[Category:Generic Components{{#translation:}}|Audio Stream Metadata`1]] | ||
Latest revision as of 17:09, 29 December 2024
Component image
Audio Stream Metadata is a component that reads the running tallies of the different samples being sent and received by an AudioStream`1.
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 | 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. |