1. Epic GamesDeveloper
  3. UPixelStreamingAudioComponent

UPixelStreamingAudioComponent

Allows in-engine playback of incoming WebRTC audio from a particular Pixel Streaming player/peer using their mic in the browser.

API > API/Plugins > API/Plugins/PixelStreaming

Inheritance Hierarchy

References

   
Module PixelStreaming
Header /Engine/Plugins/Media/PixelStreaming/Source/PixelStreaming/Public/PixelStreamingAudioComponent.h
Include #include "PixelStreamingAudioComponent.h"

Syntax

UCLASS&40;Blueprintable, ClassGroup&61;&40;PixelStreaming&41;, Meta&61;&40;BlueprintSpawnableComponent&41;&41;  
class UPixelStreamingAudioComponent :  
    public USynthComponent,  
    public IPixelStreamingAudioConsumer

Remarks

Allows in-engine playback of incoming WebRTC audio from a particular Pixel Streaming player/peer using their mic in the browser. Note: Each audio component associates itself with a particular Pixel Streaming player/peer (using the the Pixel Streaming player id).

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bAutoFindPeer If not already listening to a player/peer will try to attach for listening to the "PlayerToHear" each tick.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString PlayerToHear The Pixel Streaming player/peer whose audio we wish to listen to.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FString StreamerToHear The Pixel Streaming streamer of the player that we wish to listen to.

Constructors

  Type Name Description
Protected function  

UPixelStreamingAudioComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category bool True if listening to a connected WebRTC peer through Pixel Streaming.
Public function UFunction BlueprintCallable, Category bool

ListenTo ( FString PlayerToListenTo
)

 Listen to a specific player on the default streamer. If the player is not found this component will be silent.
Public function UFunction BlueprintCallable, Category void

Reset ()

 Stops listening to any connected player/peer and resets internal state so component is ready to listen again.
Public function UFunction BlueprintCallable, Category bool

StreamerListenTo ( FString StreamerId,
FString PlayerToListenTo
)

 Listen to a specific player. If the player is not found this component will be silent.
Public function bool  

Overridden from USynthComponent

  Type Name Description
Protected function Virtual ISoundGeneratorPtr Implemented by the synth component to create a generator object instead of generating audio directly on the synth component.
Protected function Virtual void Called when the synth component begins generating audio in render thread.
Protected function Virtual void Called when the synth has finished generating audio on the render thread.

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void

TickComponent ( float DeltaTime,
ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Overridden from UObject

  Type Name Description
Protected function Virtual void Called before destroying the object.

Overridden from IPixelStreamingAudioConsumer

  Type Name Description
Public function Virtual void

ConsumeRawPCM ( const int16_t* AudioData,
int InSampleRate,
size_t NChannels,
size_t NFrames
)

  
Public function Virtual void  
Public function Virtual void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page