Navigation
API > API/Plugins > API/Plugins/PixelStreaming
Inheritance Hierarchy
- ISoundGenerator
- FWebRTCSoundGenerator
References
| Module | PixelStreaming |
| Header | /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamingAudioComponent.h |
| Include | #include "PixelStreamingAudioComponent.h" |
Syntax
class FWebRTCSoundGenerator : public ISoundGenerator
Remarks
An `ISoundGenerator_ implementation to pump some audio from WebRTC into this synth component
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
FThreadSafeBool | bGeneratingAudio | |
 |
FThreadSafeBool | bShouldGenerateAudio |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | AddAudio
(
const int16_t* AudioData, |
|
 |
void | EmptyBuffers () |
|
 |
int32 | ||
 |
int32 | ||
 |
void | SetParameters
(
const FSoundGeneratorInitParams& InitParams |
Overridden from ISoundGenerator
| Type | Name | Description | |
|---|---|---|---|
   |
int32 | Returns the number of samples to render per callback. | |
   |
bool | IsFinished () |
Optional. Can be overridden to end the sound when generating is finished. |
  |
void | Optional. Called on audio generator thread right when the generator begins generating. | |
  |
void | Optional. Called on audio generator thread right when the generator ends generating. | |
  |
int32 | OnGenerateAudio
(
float* OutAudio, |
Called when a new buffer is required. |