NAP
Public Types | Public Member Functions | List of all members
AudioFormat Class Reference

#include <video.h>

Public Types

enum  EChannelLayout : uint8_t {
  Mono, Stereo, _2Point1, _2_1,
  Surround, _3Point1, _4Point0, _4Point1,
  _2_2, Quad, _5Point0, _5Point1,
  _5Point0_Back, _5Point1_Back, _6Point0, _6Point0_Front,
  Hexagonal, _6Point1, _6Point1_Back, _6Point1_Front,
  _7Point0, _7Point0_Front, _7Point1, _7Point1_Wide,
  _7Point1_Wide_Back, Octagonal, Hexadecagonal, Stereo_Downmix
}
 
enum  ESampleFormat {
  U8, S16, S32, FLT,
  DBL, S64
}
 

Public Member Functions

 AudioFormat (EChannelLayout channelLayout, ESampleFormat sampleFormat, int sampleRate)
 
 AudioFormat (int numChannels, ESampleFormat sampleFormat, int sampleRate)
 
int getSampleRate () const
 
int64_t getChannelLayout () const
 
int getSampleFormat () const
 

Description

Description of an audio format for converting source data to a target format.

Member Enumeration Documentation

◆ EChannelLayout

enum EChannelLayout : uint8_t
strong
Enumerator
Mono 
Stereo 
_2Point1 
_2_1 
Surround 
_3Point1 
_4Point0 
_4Point1 
_2_2 
Quad 
_5Point0 
_5Point1 
_5Point0_Back 
_5Point1_Back 
_6Point0 
_6Point0_Front 
Hexagonal 
_6Point1 
_6Point1_Back 
_6Point1_Front 
_7Point0 
_7Point0_Front 
_7Point1 
_7Point1_Wide 
_7Point1_Wide_Back 
Octagonal 
Hexadecagonal 
Stereo_Downmix 

◆ ESampleFormat

enum ESampleFormat
strong

Video sample format

Enumerator
U8 

unsigned 8 bits

S16 

signed 16 bits

S32 

signed 32 bits

FLT 

float

DBL 

double

S64 

signed 64 bits

Constructor & Destructor Documentation

◆ AudioFormat() [1/2]

AudioFormat ( EChannelLayout  channelLayout,
ESampleFormat  sampleFormat,
int  sampleRate 
)

Constructor taking explicit channel layout.

◆ AudioFormat() [2/2]

AudioFormat ( int  numChannels,
ESampleFormat  sampleFormat,
int  sampleRate 
)

Constructor taking number of channels. Uses default channel layout for this number of channels.

Member Function Documentation

◆ getChannelLayout()

int64_t getChannelLayout ( ) const
Returns
ffmpeg-style channel layout (not EChannelLayout)

◆ getSampleFormat()

int getSampleFormat ( ) const
Returns
ffmpeg-style sample format (not ESampleFormat)

◆ getSampleRate()

int getSampleRate ( ) const
Returns
samplerate, in hz.