Version

menu_open
Wwise SDK 2023.1.5
ak.wwise.core.profiler.getStreamedMedia Result Schema

Schema

{
"type": "object",
"properties": {
"return": {
"type": "array",
"description": "Array of Streams.",
"items": {
"type": "object",
"description": "Information about how each of the streams is managed by the Wwise sound engine.",
"properties": {
"deviceName": {
"type": "string",
"description": "The name of the device from which the stream eminates."
},
"streamName": {
"type": "string",
"description": "The name given to the stream."
},
"fileSize": {
"type": "integer",
"description": "The size of the file being streamed."
},
"filePosition": {
"type": "number",
"description": "The position of the stream within the file, given as a percentage."
},
"priority": {
"type": "integer",
"description": "The priority of the stream."
},
"bandwidthTotal": {
"type": "integer",
"description": "The rate at which the file was streamed in the last profiling frame. This value takes all transfers into account, including transfers that occurred from the Stream Manager's cache"
},
"bandwidthLowLevel": {
"type": "integer",
"description": "The rate at which the file was streamed in the last profiling frame. Unlike the Total Bandwidth field, this field value considers transfers that occurred from within the low-level device."
},
"referencedMemory": {
"type": "integer",
"description": "The amount of memory that is referenced by the stream. This excludes memory used for I/O transfers. It can be seen as a measure of how much data the stream may grant to the sound engine at any given time."
},
"estimatedThroughput": {
"type": "integer",
"description": "The estimated throughput of the stream. The sound engine estimates the rate at which it consumes data from a stream according to its encoding format and number of channels."
},
"active": {
"type": "boolean",
"description": "Indicates True if the stream was active at least once during the last profiling frame."
},
"targetBufferSize": {
"type": "integer",
"description": "The streaming device's target buffer length."
},
"bufferStatusBuffered": {
"type": "number",
"description": "The portion of requested data that is buffered, given as a percentage of the target buffer size."
}
},
"additionalProperties": false
}
}
},
"required": [
"return"
],
"additionalProperties": false
}

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise