livekit::PlatformAudioSource Class Reference

Audio source backed by WebRTC's platform Audio Device Module. More...

#include <platform_audio.h>

Public Member Functions
	PlatformAudioSource (const PlatformAudioSource &other)=delete
	Copy construction is disabled.
PlatformAudioSource &	operator= (const PlatformAudioSource &other)=delete
	Copy assignment is disabled.
	PlatformAudioSource (PlatformAudioSource &&other) noexcept=default
	Move the platform audio source.
PlatformAudioSource &	operator= (PlatformAudioSource &&other) noexcept=default
	Move-assign the platform audio source.
std::uint64_t	ffiHandleId () const noexcept
	Return the underlying FFI handle ID used in FFI requests.

Friends
class	PlatformAudio

Detailed Description

Audio source backed by WebRTC's platform Audio Device Module.

A PlatformAudioSource captures microphone audio automatically. Unlike AudioSource, callers do not push frames with captureFrame().

Constructor & Destructor Documentation

PlatformAudioSource()

livekit::PlatformAudioSource::PlatformAudioSource ( PlatformAudioSource &&  other )

defaultnoexcept

Move the platform audio source.

Parameters

other

Source to move from.

Note

This operation is not thread-safe.

Member Function Documentation

ffiHandleId()

std::uint64_t livekit::PlatformAudioSource::ffiHandleId ( ) const

inlinenoexcept

Return the underlying FFI handle ID used in FFI requests.

Note

This operation is thread-safe.

operator=()

PlatformAudioSource & livekit::PlatformAudioSource::operator= ( PlatformAudioSource &&  other )

defaultnoexcept

Move-assign the platform audio source.

Parameters

other

Source to move from.

Returns

Reference to this source.

Note

This operation is not thread-safe.

---

The documentation for this class was generated from the following file:

• include/livekit/platform_audio.h