QuickRTCAudioRenderer class

Dedicated audio stream renderer

Handles audio-only streams properly without needing a visible video element. On web, audio still requires an element in the DOM tree for playback, so this widget creates a minimal RTCVideoView positioned offscreen.

Basic Usage

QuickRTCAudioRenderer(
  stream: participant.audioStream?.stream,
  key: ValueKey('audio_${participant.id}'),
)

Using with RemoteStream

QuickRTCAudioRenderer(
  remoteStream: participant.audioStream,
)

Muting Locally

QuickRTCAudioRenderer(
  stream: audioStream,
  muted: true, // Mutes locally without affecting the source
)
Inheritance

Constructors

QuickRTCAudioRenderer({Key? key, MediaStream? stream, RemoteStream? remoteStream, bool muted = false, VoidCallback? onPlaying, void onError(dynamic error)?})
const

Properties

hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
muted bool
Mute the audio locally (doesn't affect the source track)
final
onError → void Function(dynamic error)?
Called when an error occurs
final
onPlaying VoidCallback?
Called when audio playback starts
final
remoteStream RemoteStream?
RemoteStream convenience accessor
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
stream MediaStream?
The audio stream to render
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() State<QuickRTCAudioRenderer>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object.
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited