Agora RTC Objective-C API Reference  Refactor
Data Fields
AudioSubscriptionOptions Struct Reference

Data Fields

bool packetOnly
 
size_t bytesPerSample
 
size_t numberOfChannels
 
uint32_t sampleRateHz
 

Detailed Description

The audio subscription options.

Constructor & Destructor Documentation

◆ AudioSubscriptionOptions() [1/2]

◆ AudioSubscriptionOptions() [2/2]

Member Function Documentation

◆ operator=()

AudioSubscriptionOptions& operator= ( const AudioSubscriptionOptions rhs)
inline

Field Documentation

◆ packetOnly

bool packetOnly

Whether to only subscribe to audio packets.

  • true: Only subscribe to audio packets, which means that the SDK does not decode the remote audio stream. You can use this mode to receive audio packets and handle them in your app.
  • false: (Default) The SDK automatically decodes the remote audio stream.
Note
If you set packetOnly as true, other fields in AudioSubscriptionOptions are ignored.

◆ bytesPerSample

size_t bytesPerSample

The number of bytes that you expect for each audio sample.

◆ numberOfChannels

size_t numberOfChannels

The number of audio channels that you expect.

◆ sampleRateHz

uint32_t sampleRateHz

The audio sample rate (Hz) that you expect.