LiveKit C++ SDK
Real-time audio/video SDK for C++
Loading...
Searching...
No Matches
livekit::RemoteAudioTrack Class Reference

#include <remote_audio_track.h>

Inheritance diagram for livekit::RemoteAudioTrack:
Collaboration diagram for livekit::RemoteAudioTrack:

Public Member Functions

 RemoteAudioTrack (const proto::OwnedTrack &track)
 
std::string to_string () const
 
- Public Member Functions inherited from livekit::Track
const std::string & sid () const noexcept
 
const std::string & name () const noexcept
 
TrackKind kind () const noexcept
 
StreamState stream_state () const noexcept
 
bool muted () const noexcept
 
bool remote () const noexcept
 
std::optional< TrackSource > source () const noexcept
 
std::optional< bool > simulcasted () const noexcept
 
std::optional< uint32_t > width () const noexcept
 
std::optional< uint32_t > height () const noexcept
 
std::optional< std::string > mime_type () const noexcept
 
bool has_handle () const noexcept
 
uintptr_t ffi_handle_id () const noexcept
 
std::future< std::vector< RtcStats > > getStats () const
 
void setStreamState (StreamState s) noexcept
 
void setMuted (bool m) noexcept
 
void setName (std::string n) noexcept
 

Additional Inherited Members

- Protected Member Functions inherited from livekit::Track
 Track (FfiHandle handle, std::string sid, std::string name, TrackKind kind, StreamState state, bool muted, bool remote)
 
void setPublicationFields (std::optional< TrackSource > source, std::optional< bool > simulcasted, std::optional< uint32_t > width, std::optional< uint32_t > height, std::optional< std::string > mime_type)
 

Detailed Description

Represents an audio track published by a remote participant and subscribed to by the local participant.

RemoteAudioTrack instances are created internally when the SDK receives a kTrackSubscribed event. Each instance is owned by its associated RemoteParticipant and delivered to the application via TrackSubscribedEvent.

Applications generally interact with RemoteAudioTrack through events and RemoteTrackPublication, not through direct construction.

Constructor & Destructor Documentation

◆ RemoteAudioTrack()

livekit::RemoteAudioTrack::RemoteAudioTrack ( const proto::OwnedTrack &  track)
explicit

Constructs a RemoteAudioTrack from an internal protocol-level OwnedTrack description provided by the signaling/FFI layer. This constructor is intended for internal SDK use only.

Member Function Documentation

◆ to_string()

std::string livekit::RemoteAudioTrack::to_string ( ) const

Returns a concise, human-readable string summarizing the track, including its SID and name. Useful for debugging and logging.


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