libASPL
Loading...
Searching...
No Matches
aspl::StreamParameters Struct Reference

Audio stream parameters. More...

#include <aspl/Stream.hpp>

Public Attributes

Direction Direction = Direction::Output
 Stream direction. Used by default implementation of Stream::GetDirection().
 
UInt32 StartingChannel = 1
 Absolute channel number for the first channel in the stream. Used by default implementation of Stream::GetStartingChannel().
 
AudioStreamBasicDescription Format
 Stream format. Used by default implementation of Stream::GetPhysicalFormat(). Default format is:
 
UInt32 Latency = 0
 Additional presentation latency the stream has. Used by default implementation of Stream::GetLatency().
 

Detailed Description

Audio stream parameters.

Definition at line 28 of file Stream.hpp.

Member Data Documentation

◆ Direction

Direction aspl::StreamParameters::Direction = Direction::Output

Stream direction. Used by default implementation of Stream::GetDirection().

Definition at line 32 of file Stream.hpp.

◆ Format

AudioStreamBasicDescription aspl::StreamParameters::Format
Initial value:
= {
.mSampleRate = 44100,
.mFormatID = kAudioFormatLinearPCM,
.mFormatFlags = kAudioFormatFlagIsSignedInteger | kAudioFormatFlagsNativeEndian |
kAudioFormatFlagIsPacked,
.mBitsPerChannel = 16,
.mChannelsPerFrame = 2,
.mBytesPerFrame = 4,
.mFramesPerPacket = 1,
.mBytesPerPacket = 4,
}

Stream format. Used by default implementation of Stream::GetPhysicalFormat(). Default format is:

  • 44100 Hz
  • 2 channels (stereo)
  • 16-bit native-endian signed integers (Int16)
  • interleaved (L R L R ...)

Definition at line 45 of file Stream.hpp.

◆ Latency

UInt32 aspl::StreamParameters::Latency = 0

Additional presentation latency the stream has. Used by default implementation of Stream::GetLatency().

Definition at line 59 of file Stream.hpp.

◆ StartingChannel

UInt32 aspl::StreamParameters::StartingChannel = 1

Absolute channel number for the first channel in the stream. Used by default implementation of Stream::GetStartingChannel().

Definition at line 36 of file Stream.hpp.


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