Switchboard SDK
Loading...
Searching...
No Matches
switchboard::OfflineGraphRenderer::AudioFile Struct Reference

Audio file for OfflineGraphRenderer. More...

#include <OfflineGraphRenderer.hpp>

Public Member Functions

 AudioFile (const std::string &filePath, const Codec codec, const uint numberOfChannels, uint sampleRate)
 AudioFile constructor.
 

Public Attributes

std::string filePath
 File path of the audio file.
 
Codec codec
 Codec of the audio file.
 
uint numberOfChannels
 
uint sampleRate
 

Detailed Description

Audio file for OfflineGraphRenderer.

Constructor & Destructor Documentation

◆ AudioFile()

switchboard::OfflineGraphRenderer::AudioFile::AudioFile ( const std::string & filePath,
const Codec codec,
const uint numberOfChannels,
uint sampleRate )
inline

AudioFile constructor.

Parameters
filePathFile path of the audio file.
codecCodec of the audio file.
numberOfChannelsNumber of channels for the audio bus that belongs to the audio file.
sampleRateSample rate for the audio bus that belongs to the audio file.

Member Data Documentation

◆ numberOfChannels

uint switchboard::OfflineGraphRenderer::AudioFile::numberOfChannels

Number of channels for the audio bus that belongs to the audio file. For input files, NUM_CHANNELS_UNDEFINED means that the number of channels of the input audio file will be used. For output files, numberOfChannels must not be NUM_CHANNELS_UNDEFINED.

◆ sampleRate

uint switchboard::OfflineGraphRenderer::AudioFile::sampleRate

Sample rate for the audio bus that belongs to the audio file. For input files, SAMPLE_RATE_UNDEFINED means that the sample rate of the input audio file will be used. For output files, SAMPLE_RATE_UNDEFINED means that the audio graph's processing sample rate will be used.